Difference between revisions of "Magit"

From WikEmacs
Jump to: navigation, search
m (move content to Git page)
(10 intermediate revisions by 5 users not shown)
Line 9: Line 9:
 
'''Magit''' is an Emacs mode for working with Git repositories. It provides a convenient interface for the most common Git operations.
 
'''Magit''' is an Emacs mode for working with Git repositories. It provides a convenient interface for the most common Git operations.
  
= Basic setup =
+
== Basic setup ==
  
 
<source lang="lisp">
 
<source lang="lisp">
Line 16: Line 16:
 
</source>
 
</source>
  
= Helpful keybindings =
+
== Helpful keybindings ==
  
= Common Customization =
+
* {{Command|magit-status}} is the main entry point to Magit. The author recommends [[Key_Bindings|binding]] this command to "a key of your choice". {{Keys|C-x g}} is a common choice:
 +
{{Snippet|(global-set-key (kbd "C-x g") 'magit-status)}}
 +
 
 +
The [http://magit.github.com/magit/magit.html official Magit documentation] is excellent and should be consulted for further information.
 +
 
 +
== Common Customization ==
 +
 
 +
=== Change magit diff colors ===
 +
 
 +
If you want more common colors (green and red), instead of psyche highlighting:
 +
 
 +
(eval-after-load 'magit
 +
    '(progn
 +
    (set-face-foreground 'magit-diff-add "green3")
 +
    (set-face-foreground 'magit-diff-del "red3")
 +
    (when (not window-system)
 +
      (set-face-background 'magit-item-highlight "black"))))
 +
 
 +
=== Use ido to checkout branches ===
 +
 
 +
(setq magit-completing-read-function 'magit-ido-completing-read)
 +
 
 +
== Extensions ==
 +
 
 +
=== magit-filenotify: refresh status buffer when git tree changes ===
 +
 
 +
This module, to be installed with [[ELPA]], comes with a minor mode '''magit-filenotify''' which tracks
 +
changes in the source tree using '''file-notify''' and refreshes the magit
 +
status buffer.  Emacs 24.4 with `file-notify-support' is required for it to
 +
work.
 +
 
 +
home and documentation: https://github.com/magit/magit-filenotify
 +
 
 +
 
 +
== See Also ==
  
= See Also =
 
 
* [[Version Control]]
 
* [[Version Control]]
 
* [[Git]]
 
* [[Git]]
 +
* [[MagitHub]]
 +
 +
== Project Pages ==
  
= Project Pages =
 
 
* [https://github.com/magit/magit GitHub Repo]
 
* [https://github.com/magit/magit GitHub Repo]
* [http://philjackson.github.com/magit/ Magit Project]
+
* [http://magit.github.com/magit/ Magit Project]
 
* [http://github.com/magit/magit/downloads Downloads]
 
* [http://github.com/magit/magit/downloads Downloads]
* [http://philjackson.github.com/magit/magit.html Documentation]
+
* [http://magit.github.com/magit/magit.html Documentation]
  
 
[[Category:Version Control]][[Category:Convenience]][[Category:Third Party Package]]
 
[[Category:Version Control]][[Category:Convenience]][[Category:Third Party Package]]

Revision as of 07:50, 10 April 2014

Magit
Description Git integration for Emacs
Author Phil Jackson
Maintainer Phil Jackson
Source https://github.com/magit/magit

Magit is an Emacs mode for working with Git repositories. It provides a convenient interface for the most common Git operations.

Basic setup

(add-to-list 'load-path "/path/to/magit/directory")
(require 'magit)

Helpful keybindings

  • M-x magit-status is the main entry point to Magit. The author recommends binding this command to "a key of your choice". [C-x g] is a common choice:
(global-set-key (kbd "C-x g") 'magit-status)

The official Magit documentation is excellent and should be consulted for further information.

Common Customization

Change magit diff colors

If you want more common colors (green and red), instead of psyche highlighting:

(eval-after-load 'magit
   '(progn
    (set-face-foreground 'magit-diff-add "green3")
    (set-face-foreground 'magit-diff-del "red3")
    (when (not window-system)
      (set-face-background 'magit-item-highlight "black"))))

Use ido to checkout branches

(setq magit-completing-read-function 'magit-ido-completing-read)

Extensions

magit-filenotify: refresh status buffer when git tree changes

This module, to be installed with ELPA, comes with a minor mode magit-filenotify which tracks changes in the source tree using file-notify and refreshes the magit status buffer. Emacs 24.4 with `file-notify-support' is required for it to work.

home and documentation: https://github.com/magit/magit-filenotify


See Also

Project Pages