aurum / README.markdown

This plugin provides a vim <--> VCS (currently mercurial, git and subversion) integration for your projects. Features:

  • Partially committing changes (:AuRecord).

  • Viewing file state at particular revision (aurum://file, :AuFile).

  • Viewing uncommited changes in a vimdiff, as well as changes between specific revisions (:AuVimDiff). It is also possible to open multiple tabs with all changes to all files viewed as side-by-side diffs.

  • Viewing revisions log (:AuLog). Output is highly customizable.

  • Viewing working directory status (:AuStatus).

  • Commiting changes (:AuCommit), commit messages are remembered in case of rollback (g:aurum_remembermsg).

  • Obtaining various URL’s out of remote repository URL (like URL of the HTML version of the current file with URL fragment pointing to the current line attached: useful for sharing) (:AuHyperlink). For mercurial it also supports git and subversion revisions (in case you are using hg-git and hgsubversion respectively).

  • aurum#changeset(), aurum#repository() and aurum#status() functions that are to be used from modeline.

  • Frontends for various other VCS commands.

Most commands can be reached with a set of mappings (see aurum-mappings), all mappings are customizable.

Plugin’s mercurial driver is able to use mercurial python API as well as its CLI, but remember that the former is much slower and less tested. In order to use mercurial python API you must have vim compiled with +python (mercurial currently does not support python 3) and have mercurial in python’s sys.path (note: on windows msi installer is not adding mercurial to sys.path, so you won’t be able to use its python API).

Plugin requires some additional plugins:

(with their dependencies).

Note: aurum supports VAM. It is prefered that you use it for aurum installation.

Documentation is available online at

Tip: Filter by directory path e.g. /media app.js to search for public/media/app.js.
Tip: Use camelCasing e.g. ProjME to search for
Tip: Filter by extension type e.g. /repo .js to search for all .js files in the /repo directory.
Tip: Separate your search with spaces e.g. /ssh pom.xml to search for src/ssh/pom.xml.
Tip: Use ↑ and ↓ arrow keys to navigate and return to view the file.
Tip: You can also navigate files with Ctrl+j (next) and Ctrl+k (previous) and view the file with Ctrl+o.
Tip: You can also navigate files with Alt+j (next) and Alt+k (previous) and view the file with Alt+o.