3 # zsh completion wrapper for git
5 # Copyright (c) 2012-2020 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 "${${funcsourcetrace[1]%:*}:A:h}"/git-completion.bash
37 "$HOME/.local/share/bash-completion/completions/git"
38 '/usr/local/share/bash-completion/completions/git'
39 "$bash_completion/git"
40 '/etc/bash_completion.d/git' # old debian
42 for e in $locations; do
43 test -f $e && script="$e" && break
47 local old_complete="$functions[complete]"
50 GIT_SOURCING_ZSH_COMPLETION=y . "$script"
51 functions[complete]="$old_complete"
55 compadd -p "${2-}" -S "${3- }" -q -- ${=1} && _ret=0
62 IFS=$' \t\n' __gitcompadd "$1" "${2-}" "${4- }"
69 local cur_="${3-$cur}"
71 [[ "$cur_" == *= ]] && return
73 local c IFS=$' \t\n' sfx
75 if [[ $c == "--" ]]; then
76 [[ "$cur_" == --no-* ]] && continue
77 __gitcompadd "--no-..."
81 if [[ -z "${4+set}" ]]; then
83 *=) c="${c%=}"; sfx="=" ;;
90 __gitcompadd "$c" "${2-}" "$sfx"
98 # words that don't end up in space
99 compadd -p "${2-}" -S "${4- }" -q -- ${${(f)1}:#*\ } && _ret=0
100 # words that end in space
101 compadd -p "${2-}" -S " ${4- }" -q -- ${${(M)${(f)1}:#*\ }% } && _ret=0
108 compadd -f -p "${2-}" -- ${(f)1} && _ret=0
113 __gitcomp_nl "$1" "" "" ""
116 __gitcomp_file_direct ()
118 __gitcomp_file "$1" ""
121 __git_complete_command ()
128 local completion_func="_git_${command//-/_}"
129 if (( $+functions[$completion_func] )); then
130 emulate ksh -c $completion_func
132 elif emulate ksh -c "__git_support_parseopt_helper $command"; then
133 emulate ksh -c "__git_complete_common $command"
140 __git_zsh_bash_func ()
146 __git_complete_command "$command" && return
148 local expansion=$(__git_aliased_command "$command")
149 if [ -n "$expansion" ]; then
151 __git_complete_command "$expansion"
155 __git_zsh_cmd_common ()
159 add:'add file contents to the index'
160 bisect:'find by binary search the change that introduced a bug'
161 branch:'list, create, or delete branches'
162 checkout:'checkout a branch or paths to the working tree'
163 clone:'clone a repository into a new directory'
164 commit:'record changes to the repository'
165 diff:'show changes between commits, commit and working tree, etc'
166 fetch:'download objects and refs from another repository'
167 grep:'print lines matching a pattern'
168 init:'create an empty Git repository or reinitialize an existing one'
169 log:'show commit logs'
170 merge:'join two or more development histories together'
171 mv:'move or rename a file, a directory, or a symlink'
172 pull:'fetch from and merge with another repository or a local branch'
173 push:'update remote refs along with associated objects'
174 rebase:'forward-port local commits to the updated upstream head'
175 reset:'reset current HEAD to the specified state'
176 restore:'restore working tree files'
177 rm:'remove files from the working tree and from the index'
178 show:'show various types of objects'
179 status:'show the working tree status'
180 switch:'switch branches'
181 tag:'create, list, delete or verify a tag object signed with GPG')
182 _describe -t common-commands 'common commands' list && _ret=0
185 __git_zsh_cmd_alias ()
188 list=(${${(0)"$(git config -z --get-regexp '^alias\.*')"}#alias.})
189 list=(${(f)"$(printf "%s:alias for '%s'\n" ${(f@)list})"})
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
205 local -a __git_C_args
208 '(-p --paginate -P --no-pager)'{-p,--paginate}'[pipe all output into ''less'']' \
209 '(-p --paginate -P --no-pager)'{-P,--no-pager}'[do not pipe git output into a pager]' \
210 '(--bare)--git-dir=[set the path to the repository]: :_directories' \
211 '(--git-dir)--bare[treat the repository as a bare repository]' \
212 '(- :)--version[prints the git suite version]' \
213 '--exec-path=[path to where your core git programs are installed]: :_directories' \
214 '(- :)--exec-path[print the path where your core git programs are installed]' \
215 '(- :)--html-path[print the path where git''s HTML documentation is installed]' \
216 '(- :)--info-path[print the path where the Info files are installed]' \
217 '(- :)--man-path[print the manpath (see `man(1)`) for the man pages]' \
218 '--work-tree=[set the path to the working tree]: :_directories' \
219 '--namespace=[set the git namespace]:' \
220 '--no-replace-objects[do not use replacement refs to replace git objects]' \
221 '(- :)--help[prints the synopsis and a list of the most commonly used commands]: :->arg' \
222 '*-C[run as if git was started in the given path]: :_directories' \
223 '*-c[pass a configuration parameter to the command]: :->config' \
225 '(-)*:: :->arg' && return
229 _tags common-commands alias-commands all-commands
231 _requested common-commands && __git_zsh_cmd_common
232 _requested alias-commands && __git_zsh_cmd_alias
233 _requested all-commands && __git_zsh_cmd_all
239 emulate ksh -c __git_complete_config_variable_name_and_value
242 local command="${words[1]}" __git_dir __git_cmd_idx=1
244 if (( $+opt_args[--bare] )); then
247 __git_dir=${~opt_args[--git-dir]}
250 for x in ${(s.:.)opt_args[-C]}; do
251 __git_C_args+=('-C' ${~x})
254 (( $+opt_args[--help] )) && command='help'
256 words=( git ${words[@]} )
258 __git_zsh_bash_func $command
266 local cur cword prev __git_cmd_idx=0
268 cur=${words[CURRENT]}
269 prev=${words[CURRENT-1]}
272 if (( $+functions[__${service}_zsh_main] )); then
273 __${service}_zsh_main
274 elif (( $+functions[__${service}_main] )); then
275 emulate ksh -c __${service}_main
276 elif (( $+functions[_${service}] )); then
277 emulate ksh -c _${service}
278 elif (( $+functions[_${service//-/_}] )); then
279 emulate ksh -c _${service//-/_}
282 let _ret && _default && _ret=0