The Magit wiki contains a list of FREQUENTLY ASKED QUESTIONS, please do consult it.
Magit is in FEATURE FREEZE, keep that in mind when making feature requests.
Magit is an interface to the version control system Git, implemented as an Emacs package.
Unlike the VC package which is part of Emacs and strives to provide a unified interface to various version control systems, Magit only supports Git and can therefore better take advantage of its native features.
Magit 2.0.50 requires at least GNU Emacs 24.4 and Git 1.9.4.
You are looking at the README.md
of the development branch. For
instructions on how to install the stable version of Magit see the
extended installation instructions instead.
First uninstall all instances of magit
, git-commit-mode
and
git-rebase-mode
that you have currently installed. Doing this,
and doing it carefully (e.g. did you also install Magit using your
distributions package manager at some point?), is very important.
It only takes a few minutes to do this, but if everyone does it, then
that will save me hours of investigating "impossible" issues, which I
cannot actually reproduce myself.
Then install package dash
using install-package
. This is now
the only external dependency; the libraries git-commit.el
and
git-rebase.el
are now part of the Magit repository. (These
libraries were previously part of the Git-Modes repository and their
names used to end with -mode.el
).
Then clone the Magit repository and check out the "next" branch:
$ git clone git://github.com/magit/magit.git ~/.emacs.d/site-lisp/magit
$ cd ~/.emacs.d/site-lisp/magit
$ git checkout next
Then compile the libraries:
$ make lisp
Finally add this to your init file:
(add-to-list 'load-path "~/.emacs.d/site-lisp/magit")
(require 'magit)
To update Magit use:
$ git pull
$ make clean lisp
To view all available targets use make help
.
When something doesn't work as expected please see the FAQ, and the list of open issues, and use the search box at the top of the latter to find older related issues. If everything else fails ask for help on the Emacs Stackexchange site or the mailing list.
Magit is hosted on Github. Please contribute by reporting bugs and suggesting features on the issue tracker or by making code contributions using pull requests. Before opening a pull request read the brief contribution guidelines.
Please also consider supporting development by making a monetary donation. Thank you!
Magit was started by Marius Vollmer and is now maintained by Jonas Bernoulli. Other Magitians (former maintainers) are Nicolas Dudebout, Peter J. Weisberg, Phil Jackson, Rémi Vanicat, and Yann Hodique.
Many more people have contributed code and suggested features.
Thanks to all of you, may (the history of) the source be with you!