Git Support - Vim Plug-In

Git Support – Vim Plug-In

plug-in
overview

download
vim.org

view on
GitHub

root menu

Git Support - Vim Plug-In

( version 0.9.4 )

View the Readme
Read the Git Support Help File

What's new?

New Plug-in Versions Released – Jul/Aug 2016

More plug-ins
overview
Bash IDE
C/C++ IDE
LaTeX IDE
Lua IDE
Perl IDE
Vim Script IDE

Features

Features
Integration of Git for Vim/gVim: use Git from within Vim and eliminate the need for context switches quickly add the file in the current buffer or show its diff the output of commands like "git status" is redirected into buffers ... the commit can be manipulated from right there show the stash, logs, branches, tags, remotes, ... show the Git help in a buffer, or open it in the browser each buffer comes with a short help: press `<SHIFT+F1>` run arbitrary Git commands and optionally redirect their output into a buffer start gitk with arguments: `:GitK --all` comes with a menu, which also severs as an overview of the plug-in's functionality custom menu for often used combination of arguments configurable syntax highlighting designed to match Git's own highlighting automatic folds for diffs and logs

Integration of Git for Vim/gVim:

use Git from within Vim and eliminate the need for context switches
quickly add the file in the current buffer or show its diff
the output of commands like "git status" is redirected into buffers
... the commit can be manipulated from right there

show the stash, logs, branches, tags, remotes, ...
show the Git help in a buffer, or open it in the browser
each buffer comes with a short help: press <SHIFT+F1>
run arbitrary Git commands and optionally redirect their output into a buffer
start gitk with arguments: :GitK --all

comes with a menu, which also severs as an overview of the plug-in's functionality
custom menu for often used combination of arguments
configurable syntax highlighting designed to match Git's own highlighting
automatic folds for diffs and logs

Menus Explanation

Menu Main : the main menu

Provides quick access to various important commands, such as status and log.

Arbitrary commands are run via :Git .... Their output can be redirected into a buffer by using :Git! .... Example:

:Git! config --list

These buffers may look like this:

status buffer	run commands

Menu Commands : execute Git commands

This menu contains all commands Git Support provides. Each menu entry opens the command line:

:GitLog |

Now you can add parameters before executing the command:

:GitLog -n20 -- somefile.txt

Some commands open a buffer containing the requested information:

remotes, branches, tags	stash

diff	log

Start gitk with arguments:

:GitK --all

Commands which require user interaction can be started in an external xterm (U*IX) or using the Git Bash (under Windows):

:GitBash add --patch %

Menu File : manage the current file

Acts on the file in the current buffer.

Use the menu to add, checkout, and reset the file. Show the unstaged and staged changes, using diff and diff --cached, respectively.

Run blame, which supports ranges. Show the log of the file, which includes the diffstat for every commit.

Menu Specials : some helpful commands

The menu provides various specialized versions of commands. Each command comes with its own help entry, such as :help :GitGrepTop.

For short commit messages use:

:GitCommitMsg Fix a minor issue in the previous commit

For taking the commit message from the current file:

:GitCommitFile %

For commiting a merge:

:GitCommitMerge

This will take the standard commit message from BASEDIR/.git/MERGE_MSG and commit instantly:

Merge remote-tracking branch 'origin/master'

Conflicts:
	somedir/thefile.txt

To run grep within the context of the top-level directory:

:GitGrepTop someword

To merge the upstream branch (the branch is determined automatically, but further arguments are accepted):

:GitMergeUpstream --ff-only

Menu Custom : custom commands

A configurable menu for custom commands. This provides a place for often used combinations of flags and other complicated commands. For the configuration of the custom menu see :help gitsupport-menus.

Git Support comes with example menu entries:

To search the repository for the word under the cursor:

custom -> grep, word under cursor

To grep through the log:

custom -> log, grep ...

To perform a fast-forward only merge:

custom -> merge, fast-forward only

Menu Edit : jump to config files

Open the config file of the repository in a new window ...

:GitEdit config-local

or open the global one:

:GitEdit config-global

The command :GitEdit has tab-completion.

Jump to the .gitignore file of the repository ...

:GitEdit ignore-local

or the private one .git/info/exclude:

:GitEdit ignore-private

Page updated: July 18 2020 / Mail to: Wolfgang Mehner