Table of Contents

• 1 Introduction

• 2 Installation

  • 2.1 Installing from Melpa
  • 2.2 Installing from the Git Repository
  • 2.3 Post-Installation Tasks

• 3 Getting Started

• 4 Interface Concepts

  • 4.1 Modes and Buffers

    • 4.1.1 Switching Buffers

    • 4.1.2 Naming Buffers

    • 4.1.3 Quitting Windows

    • 4.1.4 Automatic Refreshing of Magit Buffers

    • 4.1.5 Automatic Saving of File-Visiting Buffers

    • 4.1.6 Automatic Reverting of File-Visiting Buffers

      • Risk of Reverting Automatically

  • 4.2 Sections

    • 4.2.1 Section Movement
    • 4.2.2 Section Visibility
    • 4.2.3 Section Hooks
    • 4.2.4 Section Types and Values
    • 4.2.5 Section Options

  • 4.3 Transient Commands

  • 4.4 Transient Arguments and Buffer Variables

  • 4.5 Completion, Confirmation and the Selection

    • 4.5.1 Action Confirmation
    • 4.5.2 Completion and Confirmation
    • 4.5.3 The Selection
    • 4.5.4 The hunk-internal region
    • 4.5.5 Support for Completion Frameworks
    • 4.5.6 Additional Completion Options

  • 4.6 Running Git

    • 4.6.1 Viewing Git Output
    • 4.6.2 Git Process Status
    • 4.6.3 Running Git Manually
    • 4.6.4 Git Executable
    • 4.6.5 Global Git Arguments

• 5 Inspecting

  • 5.1 Status Buffer

    • 5.1.1 Status Sections
    • 5.1.2 Status Header Sections
    • 5.1.3 Status Module Sections
    • 5.1.4 Status Options

  • 5.2 Repository List

  • 5.3 Logging

    • 5.3.1 Refreshing Logs
    • 5.3.2 Log Buffer
    • 5.3.3 Log Margin
    • 5.3.4 Select from Log
    • 5.3.5 Reflog
    • 5.3.6 Cherries

  • 5.4 Diffing

    • 5.4.1 Refreshing Diffs
    • 5.4.2 Commands Available in Diffs
    • 5.4.3 Diff Options
    • 5.4.4 Revision Buffer

  • 5.5 Ediffing

  • 5.6 References Buffer

    • 5.6.1 References Sections

  • 5.7 Bisecting

  • 5.8 Visiting Files and Blobs

    • 5.8.1 General-Purpose Visit Commands
    • 5.8.2 Visiting Files and Blobs from a Diff

  • 5.9 Blaming

• 6 Manipulating

  • 6.1 Creating Repository

  • 6.2 Cloning Repository

  • 6.3 Staging and Unstaging

    • 6.3.1 Staging from File-Visiting Buffers

  • 6.4 Applying

  • 6.5 Committing

    • 6.5.1 Initiating a Commit

    • 6.5.2 Editing Commit Messages

      • Using the Revision Stack
      • Commit Pseudo Headers
      • Commit Mode and Hooks
      • Commit Message Conventions

  • 6.6 Branching

    • 6.6.1 The Two Remotes
    • 6.6.2 Branch Commands
    • 6.6.3 Branch Git Variables
    • 6.6.4 Auxiliary Branch Commands

  • 6.7 Merging

  • 6.8 Resolving Conflicts

  • 6.9 Rebasing

    • 6.9.1 Editing Rebase Sequences
    • 6.9.2 Information About In-Progress Rebase

  • 6.10 Cherry Picking

    • 6.10.1 Reverting

  • 6.11 Resetting

  • 6.12 Stashing

• 7 Transferring

  • 7.1 Remotes

    • 7.1.1 Remote Commands
    • 7.1.2 Remote Git Variables

  • 7.2 Fetching

  • 7.3 Pulling

  • 7.4 Pushing

  • 7.5 Plain Patches

  • 7.6 Maildir Patches

• 8 Miscellaneous

  • 8.1 Tagging

  • 8.2 Notes

  • 8.3 Submodules

    • 8.3.1 Listing Submodules
    • 8.3.2 Submodule Transient

  • 8.4 Subtree

  • 8.5 Worktree

  • 8.6 Bundle

  • 8.7 Common Commands

  • 8.8 Wip Modes

    • 8.8.1 Wip Graph
    • 8.8.2 Legacy Wip Modes

  • 8.9 Commands for Buffers Visiting Files

  • 8.10 Minor Mode for Buffers Visiting Blobs

• 9 Customizing

  • 9.1 Per-Repository Configuration

  • 9.2 Essential Settings

    • 9.2.1 Safety

    • 9.2.2 Performance

      • Microsoft Windows Performance
      • MacOS Performance

    • 9.2.3 Default Bindings

• 10 Plumbing

  • 10.1 Calling Git

    • 10.1.1 Getting a Value from Git
    • 10.1.2 Calling Git for Effect

  • 10.2 Section Plumbing

    • 10.2.1 Creating Sections
    • 10.2.2 Section Selection
    • 10.2.3 Matching Sections

  • 10.3 Refreshing Buffers

  • 10.4 Conventions

    • 10.4.1 Theming Faces

• Appendix A FAQ

  • A.1 FAQ - How to …?

    • A.1.1 How to pronounce Magit?
    • A.1.2 How to show git’s output?
    • A.1.3 How to install the gitman info manual?
    • A.1.4 How to show diffs for gpg-encrypted files?
    • A.1.5 How does branching and pushing work?
    • A.1.6 Can Magit be used as ediff-version-control-package?
    • A.1.7 Should I disable VC?

  • A.2 FAQ - Issues and Errors

    • A.2.1 Magit is slow
    • A.2.2 I changed several thousand files at once and now Magit is unusable
    • A.2.3 I am having problems committing
    • A.2.4 I am using MS Windows and cannot push with Magit
    • A.2.5 I am using OS X and SOMETHING works in shell, but not in Magit
    • A.2.6 Expanding a file to show the diff causes it to disappear
    • A.2.7 Point is wrong in the COMMIT_EDITMSG buffer
    • A.2.8 The mode-line information isn’t always up-to-date
    • A.2.9 A branch and tag sharing the same name breaks SOMETHING
    • A.2.10 My Git hooks work on the command-line but not inside Magit
    • A.2.11 git-commit-mode isn’t used when committing from the command-line
    • A.2.12 Point ends up inside invisible text when jumping to a file-visiting buffer
    • A.2.13 I am unable to stage when using Tramp from MS Windows
    • A.2.14 I am no longer able to save popup defaults

• B Debugging Tools

• Appendix C Keystroke Index

• Appendix D Command Index

• Appendix E Function Index

• Appendix F Variable Index