MANUAL.adoc

 1This project is a friendly fork of the official Git completion
 2(`contrib/completion`) and prompt scripts for Bash, Zsh, and possibly other
 3shells.
 4
 5Most Git developers use the Bash shell, for which the completion scripts work
 6rather well, however, Zsh is typically neglected. I've sent many patches to fix
 7the issues, many have been merged, but many have been ignored, thus the need for
 8a canonical location of a good, working Zsh completion.
 9
10There are advantages for Bash users too. Currently the scripts under `contrib` are tied to the
11specific Git version, for example the completion scripts of version v2.40
12(https://git.kernel.org/pub/scm/git/git.git/plain/contrib/completion/git-completion.bash?h=v2.40.0[git-completion.bash])
13have issues with older versions of Git (e.g. v2.33); the ones in
14this project don't.
15
16With `git-completion` you can be sure you are using the latest completion that
17works in both shells, and any Git version.
18
19This is a sister project of the
20https://github.com/ohmyzsh/ohmyzsh/tree/master/plugins/gitfast[Oh My Zsh
21gitfast] plugin (that I also maintain), which has similar needs.
22
23== Installation ==
24
25* https://github.com/felipec/git-completion/wiki/Bash[Bash instructions]
26* https://github.com/felipec/git-completion/wiki/Zsh[Zsh instructions]
27
28== Improvements from upstream ==
29
30This is a short list of the benefits you get:
31
32* Easier installation
33* Tons of bug fixes
34* Works with older versions of git
35* Zsh: much more options
36* Zsh: quoting works properly
37* Zsh: automatic suffix removal
38
39For a full list of all the patches on top of upstream git check
40https://github.com/felipec/git-completion/wiki/Patches[Patches].