File: magit.el.html

Magit is a text-based Git user interface that puts an unmatched focus on streamlining workflows. Commands are invoked using short mnemonic key sequences that take the cursor’s position in the highly actionable interface into account to provide context-sensitive behavior.

With Magit you can do nearly everything that you can do when using Git on the command-line, but at greater speed and while taking advantage of advanced features that previously seemed too daunting to use on a daily basis. Many users will find that by using Magit they can become more effective Git user.

Defined variables (4)

magit-define-global-key-bindingsWhich set of key bindings to add to the global keymap, if any.
magit-openpgp-default-signing-keyFingerprint of your default Openpgp key used for signing.
magit-shell-command-verbose-promptWhether to show the working directory when reading a command.
magit-versionThe version of Magit that you’re using.

Defined functions (14)

magit--shell-command(COMMAND &optional DIRECTORY)
magit-dispatch()
magit-git-command(COMMAND)
magit-git-command-topdir(COMMAND)
magit-maybe-define-global-key-bindings(&optional FORCE)
magit-read-gpg-secret-key(PROMPT &optional INITIAL-INPUT HISTORY PREDICATE DEFAULT)
magit-read-gpg-signing-key(PROMPT &optional INITIAL-INPUT HISTORY)
magit-read-shell-command(&optional TOPLEVEL INITIAL-INPUT)
magit-run()
magit-shell-command(COMMAND)
magit-shell-command-topdir(COMMAND)
magit-version(&optional PRINT-DEST)
magit:--gpg-sign()
magit:--signoff()

Defined faces (27)

magit-branch-currentFace for current branch.
magit-branch-localFace for local branches.
magit-branch-remoteFace for remote branch head labels shown in log buffer.
magit-branch-remote-headFace for current branch.
magit-branch-upstreamFace for upstream branch. This face is only used in logs and it gets combined with ‘magit-branch-local’, ‘magit-branch-remote’ and/or ‘magit-branch-remote-head’.
magit-branch-warningFace for warning about (missing) branch.
magit-cherry-equivalentFace for equivalent cherry commits.
magit-cherry-unmatchedFace for unmatched cherry commits.
magit-dimmedFace for text that shouldn’t stand out.
magit-filenameFace for filenames.
magit-hashFace for the commit object name in the log output.
magit-headFace for the symbolic ref ‘HEAD’.
magit-header-lineFace for the ‘header-line’ in some Magit modes. Note that some modes, such as ‘magit-log-select-mode’, have their own faces for the ‘header-line’, or for parts of the ‘header-line’.
magit-keywordFace for parts of commit messages inside brackets.
magit-keyword-squashFace for squash! and similar keywords in commit messages.
magit-refnameFace for refnames without a dedicated face.
magit-refname-pullreqFace for pullreq refnames.
magit-refname-stashFace for stash refnames.
magit-refname-wipFace for wip refnames.
magit-signature-badFace for bad signatures.
magit-signature-errorFace for signatures that cannot be checked (e.g., missing key).
magit-signature-expiredFace for signatures that have expired.
magit-signature-expired-keyFace for signatures made by an expired key.
magit-signature-goodFace for good signatures.
magit-signature-revokedFace for signatures made by a revoked key.
magit-signature-untrustedFace for good untrusted signatures.
magit-tagFace for tag labels shown in log buffer.