Magit User Manual: Top

Magit User Manual

Magit is an interface to the version control system Git, implemented as an Emacs package. Magit aspires to be a complete Git porcelain. While we cannot (yet) claim that Magit wraps and improves upon each and every Git command, it is complete enough to allow even experienced Git users to perform almost all of their daily version control tasks directly from within Emacs. While many fine Git clients exist, only Magit and Git itself deserve to be called porcelains.

This manual is for Magit version 2.13.0.

You can redistribute this document and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This document is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

• Introduction:

• Installation:

• Getting Started:

• Interface Concepts:

• Inspecting:

• Manipulating:

• Transferring:

• Miscellaneous:

• Customizing:

• Plumbing:

• FAQ:

• Debugging Tools:

• Keystroke Index:

• Command Index:

• Function Index:

• Variable Index:

— The Detailed Node Listing —

Installation

• Installing from an Elpa Archive:

• Installing from the Git Repository:

• Post-Installation Tasks:


Interface Concepts

• Modes and Buffers:

• Sections:

• Popup Buffers and Prefix Commands:

• Completion, Confirmation and the Selection:

• Running Git:


Modes and Buffers

• Switching Buffers:

• Naming Buffers:

• Quitting Windows:

• Automatic Refreshing of Magit Buffers:

• Automatic Saving of File-Visiting Buffers:

• Automatic Reverting of File-Visiting Buffers:



Sections

• Section Movement:

• Section Visibility:

• Section Hooks:

• Section Types and Values:

• Section Options:



Completion, Confirmation and the Selection

• Action Confirmation:

• Completion and Confirmation:

• The Selection:

• The hunk-internal region:

• Support for Completion Frameworks:

• Additional Completion Options:



Running Git

• Viewing Git Output:

• Git Process Status:

• Running Git Manually:

• Git Executable:

• Global Git Arguments:



Inspecting

• Status Buffer:

• Repository List:

• Logging:

• Diffing:

• Ediffing:

• References Buffer:

• Bisecting:

• Visiting Blobs:

• Blaming:


Status Buffer

• Status Sections:

• Status Header Sections:

• Status Module Sections:

• Status Options:



Logging

• Refreshing Logs:

• Log Buffer:

• Log Margin:

• Select from Log:

• Reflog:

• Cherries:



Diffing

• Refreshing Diffs:

• Diff Buffer:

• Diff Options:

• Revision Buffer:



References Buffer

• References Sections:



Manipulating

• Repository Setup:

• Staging and Unstaging:

• Applying:

• Committing:

• Branching:

• Merging:

• Resolving Conflicts:

• Rebasing:

• Cherry Picking:

• Resetting:

• Stashing:


Staging and Unstaging

• Staging from File-Visiting Buffers:



Committing

• Initiating a Commit:

• Editing Commit Messages:



Branching

• The Two Remotes:

• The Branch Popup:

• The Branch Config Popup:

• Auxillary Branch Commands:



Rebasing

• Editing Rebase Sequences:

• Information About In-Progress Rebase:



Cherry Picking

• Reverting:



Transferring

• Remotes:

• Fetching:

• Pulling:

• Pushing:

• Creating and Sending Patches:

• Applying Patches:


Remotes

• The Remote Popup:

• The Remote Config Popup:



Miscellaneous

• Tagging:

• Notes:

• Submodules:

• Subtree:

• Worktree:

• Common Commands:

• Wip Modes:

• Minor Mode for Buffers Visiting Files:

• Minor Mode for Buffers Visiting Blobs:


Submodules

• Listing Submodules:

• Submodule Popup:



Customizing

• Per-Repository Configuration:

• Essential Settings:


Essential Settings

• Safety:

• Performance:



Plumbing

• Calling Git:

• Section Plumbing:

• Refreshing Buffers:

• Conventions:


Calling Git

• Getting a Value from Git:

• Calling Git for Effect:



Section Plumbing

• Creating Sections:

• Section Selection:

• Matching Sections:



Conventions

• Theming Faces:

FAQ

• FAQ - How to …?:

• FAQ - Issues and Errors:


FAQ - How to …?

• How to show git's output?:

• How to install the gitman info manual?:

• How to show diffs for gpg-encrypted files?:

• How does branching and pushing work?:

• Can Magit be used as ediff-version-control-package?:



FAQ - Issues and Errors

• Magit is slow:

• I changed several thousand files at once and now Magit is unusable:

• I am having problems committing:

• I am using MS Windows and cannot push with Magit:

• I am using OS X and SOMETHING works in shell, but not in Magit:

• Diffs contain control sequences:

• Expanding a file to show the diff causes it to disappear:

• Point is wrong in the COMMIT_EDITMSG buffer:

• The mode-line information isn't always up-to-date:

• Emacs 24.5 hangs when loading Magit:

• A branch and tag sharing the same name breaks SOMETHING:

• My Git hooks work on the command line but not in Magit:

Magit User Manual

Table of Contents

Magit User Manual