Need help with orgit?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

155 Stars 13 Forks 75 Commits 0 Opened issues


Support for Org links to Magit buffers

Services available


Need anything else?

Contributors list

Link to Magit buffers from Org documents

This package defines several Org link types, which can be used to link to certain Magit buffers. Use the command

while such a buffer is current to store a link. Later you can insert it into an Org buffer using the command


The three link types defined here take these forms:

orgit:/path/to/repo/            links to a magit-status buffer
orgit-log:/path/to/repo/::REV   links to a magit-log buffer
orgit-rev:/path/to/repo/::ARGS  links to a magit-revision buffer


only the first revision was stored in
links, and all other revisions were discarded. All other arguments were also discarded and Magit's usual mechanism for determining the switches and options was used instead.

For backward compatibility, and because it is the common case and looks best, ARGS by default has the form

as before. However if linking to a log buffer that shows the log for multiple revisions, then
is used instead. If
is non-nil, then
(("REV"...) ("ARG"...) [("FILE"...)])
is always used, which allows restoring the buffer most faithfully.


When an Org file containing such links is exported, then the url of the remote configured with

is used to generate a web url according to
. That webpage should present approximately the same information as the Magit buffer would.

Both the remote to be considered the public remote, as well as the actual web urls can be defined in individual repositories using Git variables.

To use a remote different from

but still use
to generate the web urls, use:
git config orgit.remote REMOTE-NAME

To explicitly define the web urls, use something like:

git config orgit.status
git config orgit.log
git config orgit.rev

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.