3 # zsh completion wrapper for git
5 # Copyright (c) 2012-2013 Felipe Contreras <felipe.contreras@gmail.com>
7 # The recommended way to install this script is to make a copy of it as a
8 # file named '_git' inside any directory in your fpath.
10 # For example, create a directory '~/.zsh/', copy this file to '~/.zsh/_git',
11 # and then add the following to your ~/.zshrc file:
13 # fpath=(~/.zsh $fpath)
15 # You need git's bash completion script installed. By default bash-completion's
16 # location will be used (e.g. pkg-config --variable=completionsdir bash-completion).
18 # If your bash completion script is somewhere else, you can specify the
19 # location in your ~/.zshrc:
21 # zstyle ':completion:*:*:git:*' script ~/.git-completion.bash
24 zstyle -T ':completion:*:*:git:*' tag-order && \
25 zstyle ':completion:*:*:git:*' tag-order 'common-commands'
27 zstyle -s ":completion:*:*:git:*" script script
28 if [ -z "$script" ]; then
30 local e bash_completion
32 bash_completion=$(pkg-config --variable=completionsdir bash-completion 2>/dev/null) ||
33 bash_completion='/usr/share/bash-completion/completions/'
36 "$(dirname ${funcsourcetrace[1]%:*})"/git-completion.bash
37 "$HOME/.local/share/bash-completion/completions/git"
38 "$bash_completion/git"
39 '/etc/bash_completion.d/git' # old debian
41 for e in $locations; do
42 test -f $e && script="$e" && break
46 local old_complete="$functions[complete]"
48 GIT_SOURCING_ZSH_COMPLETION=y . "$script"
49 functions[complete]="$old_complete"
55 local cur_="${3-$cur}"
64 if [[ $c == "--" ]]; then
75 compadd -Q -S '' -p "${2-}" -a -- array && _ret=0
81 if [[ $c == "--" ]]; then
94 compadd -Q -S '' -p "${2-}" -a -- array && _ret=0
104 compadd -Q -S '' -- ${(f)1} && _ret=0
107 __gitcomp_direct_append ()
109 __gitcomp_direct "$@"
117 compadd -Q -S "${4- }" -p "${2-}" -- ${(f)1} && _ret=0
120 __gitcomp_nl_append ()
125 __gitcomp_file_direct ()
129 compadd -f -- ${(f)1} && _ret=0
136 compadd -f -p "${2-}" -- ${(f)1} && _ret=0
139 __git_zsh_bash_func ()
145 local completion_func="_git_${command//-/_}"
146 declare -f $completion_func >/dev/null && $completion_func && return
148 local expansion=$(__git_aliased_command "$command")
149 if [ -n "$expansion" ]; then
151 completion_func="_git_${expansion//-/_}"
152 declare -f $completion_func >/dev/null && $completion_func
156 __git_zsh_cmd_common ()
160 add:'add file contents to the index'
161 bisect:'find by binary search the change that introduced a bug'
162 branch:'list, create, or delete branches'
163 checkout:'checkout a branch or paths to the working tree'
164 clone:'clone a repository into a new directory'
165 commit:'record changes to the repository'
166 diff:'show changes between commits, commit and working tree, etc'
167 fetch:'download objects and refs from another repository'
168 grep:'print lines matching a pattern'
169 init:'create an empty Git repository or reinitialize an existing one'
170 log:'show commit logs'
171 merge:'join two or more development histories together'
172 mv:'move or rename a file, a directory, or a symlink'
173 pull:'fetch from and merge with another repository or a local branch'
174 push:'update remote refs along with associated objects'
175 rebase:'forward-port local commits to the updated upstream head'
176 reset:'reset current HEAD to the specified state'
177 restore:'restore working tree files'
178 rm:'remove files from the working tree and from the index'
179 show:'show various types of objects'
180 status:'show the working tree status'
181 switch:'switch branches'
182 tag:'create, list, delete or verify a tag object signed with GPG')
183 _describe -t common-commands 'common commands' list && _ret=0
186 __git_zsh_cmd_alias ()
189 list=(${${${(0)"$(git config -z --get-regexp '^alias\.')"}#alias.}%$'\n'*})
190 _describe -t alias-commands 'aliases' list $* && _ret=0
196 emulate ksh -c __git_compute_all_commands
197 list=( ${=__git_all_commands} )
198 _describe -t all-commands 'all commands' list && _ret=0
203 local curcontext="$curcontext" state state_descr line
207 orig_words=( ${words[@]} )
210 '(-p --paginate --no-pager)'{-p,--paginate}'[pipe all output into ''less'']' \
211 '(-p --paginate)--no-pager[do not pipe git output into a pager]' \
212 '--git-dir=-[set the path to the repository]: :_directories' \
213 '--bare[treat the repository as a bare repository]' \
214 '(- :)--version[prints the git suite version]' \
215 '--exec-path=-[path to where your core git programs are installed]:: :_directories' \
216 '--html-path[print the path where git''s HTML documentation is installed]' \
217 '--info-path[print the path where the Info files are installed]' \
218 '--man-path[print the manpath (see `man(1)`) for the man pages]' \
219 '--work-tree=-[set the path to the working tree]: :_directories' \
220 '--namespace=-[set the git namespace]' \
221 '--no-replace-objects[do not use replacement refs to replace git objects]' \
222 '(- :)--help[prints the synopsis and a list of the most commonly used commands]: :->arg' \
224 '(-)*:: :->arg' && return
229 'alias-commands:alias:__git_zsh_cmd_alias' \
230 'common-commands:common:__git_zsh_cmd_common' \
231 'all-commands:all:__git_zsh_cmd_all' && _ret=0
234 local command="${words[1]}" __git_dir
236 if (( $+opt_args[--bare] )); then
239 __git_dir=${opt_args[--git-dir]}
242 (( $+opt_args[--help] )) && command='help'
244 words=( ${orig_words[@]} )
246 __git_zsh_bash_func $command
256 cur=${words[CURRENT]}
257 prev=${words[CURRENT-1]}
260 if (( $+functions[__${service}_zsh_main] )); then
261 __${service}_zsh_main
262 elif (( $+functions[__${service}_main] )); then
263 emulate ksh -c __${service}_main
264 elif (( $+functions[_${service}] )); then
265 emulate ksh -c _${service}
266 elif (( $+functions[_${service//-/_}] )); then
267 emulate ksh -c _${service//-/_}
270 let _ret && _default && _ret=0