README.markdown

   1 # fugitive.vim
   2
   3 I'm not going to lie to you; fugitive.vim may very well be the best
   4 Git wrapper of all time.  Check out these features:
   5
   6 Bring up an enhanced version of `git status` with `:G` (also known as
   7 `:Gstatus`).  Press `g?` to bring up a list of maps for numerous operations
   8 including diffing, staging, committing, rebasing, and stashing.
   9
  10 View any blob, tree, commit, or tag in the repository with `:Gedit` (and
  11 `:Gsplit`, `:Gvsplit`, `:Gtabedit`, ...).  Edit a file in the index and
  12 write to it to stage the changes.  Use `:Gdiffsplit` to bring up the staged
  13 version of the file side by side with the working tree version and use
  14 Vim's diff handling capabilities to stage a subset of the file's
  15 changes.
  16
  17 Commit, merge, and rebase with `:Gcommit`, `:Gmerge`, and `:Grebase`, using
  18 the current Vim instance to edit commit messages and the rebase todo list.
  19 Use `:Gpush`, `:Gfetch`, and `:Gpull` to send and retrieve upstream changes.
  20
  21 `:Gblame` brings up an interactive vertical split with `git blame`
  22 output.  Press enter on a line to edit the commit where the line
  23 changed, or `o` to open it in a split.  When you're done, use `:Gedit`
  24 in the historic buffer to go back to the work tree version.
  25
  26 `:Gmove` does a `git mv` on a file and simultaneously renames the
  27 buffer.  `:Gdelete` does a `git rm` on a file and simultaneously deletes
  28 the buffer.
  29
  30 Use `:Ggrep` to search the work tree (or any arbitrary commit) with
  31 `git grep`, skipping over that which is not tracked in the repository.
  32 `:Gclog` and `:Gllog` load all previous commits into the quickfix or location
  33 list.  Give them a range (e.g., using visual mode and `:'<,'>Gclog`) to
  34 iterate over every change to that portion of the current file.
  35
  36 `:Gread` is a variant of `git checkout -- filename` that operates on the
  37 buffer rather than the filename.  This means you can use `u` to undo it
  38 and you never get any warnings about the file changing outside Vim.
  39 `:Gwrite` writes to both the work tree and index versions of a file,
  40 making it like `git add` when called from a work tree file and like
  41 `git checkout` when called from the index or a blob in history.
  42
  43 Use `:Gbrowse` to open the current file on the web front-end of your favorite
  44 hosting provider, with optional line range (try it in visual mode).  Plugins
  45 are available for popular providers such as [GitHub][rhubarb.vim],
  46 [GitLab][fugitive-gitlab.vim], [Bitbucket][fubitive.vim], and
  47 [Gitee][fugitive-gitee.vim].
  48
  49 [rhubarb.vim]: https://github.com/tpope/vim-rhubarb
  50 [fugitive-gitlab.vim]: https://github.com/shumphrey/fugitive-gitlab.vim
  51 [fubitive.vim]: https://github.com/tommcdo/vim-fubitive
  52 [fugitive-gitee.vim]: https://github.com/linuxsuren/fugitive-gitee.vim
  53
  54 Add `%{FugitiveStatusline()}` to `'statusline'` to get an indicator
  55 with the current branch in your statusline.
  56
  57 Last but not least, there's `:Git` for running any arbitrary command.
  58
  59 For more information, see `:help fugitive`.
  60
  61 ## Screencasts
  62
  63 * [A complement to command line git](http://vimcasts.org/e/31)
  64 * [Working with the git index](http://vimcasts.org/e/32)
  65 * [Resolving merge conflicts with vimdiff](http://vimcasts.org/e/33)
  66 * [Browsing the git object database](http://vimcasts.org/e/34)
  67 * [Exploring the history of a git repository](http://vimcasts.org/e/35)
  68
  69 ## Installation
  70
  71 If you don't have a preferred installation method, one option is to install
  72 [pathogen.vim](https://github.com/tpope/vim-pathogen), and then copy
  73 and paste:
  74
  75     cd ~/.vim/bundle
  76     git clone https://github.com/tpope/vim-fugitive.git
  77     vim -u NONE -c "helptags vim-fugitive/doc" -c q
  78
  79 ## FAQ
  80
  81 > Why don't any of the commands exist?
  82
  83 Fugitive cares about the current file, not the current working directory.
  84 Edit a file from the repository.  To avoid the blank window problem, favor
  85 commands like `:split` and `:tabedit` over commands like `:new` and `:tabnew`.
  86
  87 > Why can't I enter my password when I `:Gpush`?
  88
  89 It is highly recommended to use SSH keys or [credentials caching][] to avoid
  90 entering your password on every upstream interaction.  If this isn't an
  91 option, the official solution is to use the `core.askPass` Git option to
  92 request the password via a GUI.  Fugitive will configure this for you
  93 automatically if you have `ssh-askpass` or `git-gui` installed; otherwise it's
  94 your responsibility to set this up.
  95
  96 As an absolute last resort, you can invoke `:Git --paginate push`.  Fugitive
  97 recognizes the pagination request and fires up a `:terminal`, which allows for
  98 interactive password entry.
  99
 100 [credentials caching]: https://help.github.com/en/articles/caching-your-github-password-in-git
 101
 102 ## Self-Promotion
 103
 104 Like fugitive.vim? Follow the repository on
 105 [GitHub](https://github.com/tpope/vim-fugitive) and vote for it on
 106 [vim.org](http://www.vim.org/scripts/script.php?script_id=2975).  And if
 107 you're feeling especially charitable, follow [tpope](http://tpo.pe/) on
 108 [Twitter](http://twitter.com/tpope) and
 109 [GitHub](https://github.com/tpope).
 110
 111 ## License
 112
 113 Copyright (c) Tim Pope.  Distributed under the same terms as Vim itself.
 114 See `:help license`.