3 # zsh completion wrapper for git
5 # Copyright (c) 2012-2013 Felipe Contreras <felipe.contreras@gmail.com>
7 # You need git's bash completion script installed somewhere, by default it
8 # would be the location bash-completion uses.
10 # If your script is somewhere else, you can configure it on your ~/.zshrc:
12 # zstyle ':completion:*:*:git:*' script ~/.git-completion.sh
14 # The recommended way to install this script is to copy to '~/.zsh/_git', and
15 # then add the following to your ~/.zshrc file:
17 # fpath=(~/.zsh $fpath)
25 zstyle -T ':completion:*:*:git:*' tag-order && \
26 zstyle ':completion:*:*:git:*' tag-order 'common-commands'
28 zstyle -s ":completion:*:*:git:*" script script
29 if [ -z "$script" ]; then
33 $(dirname ${funcsourcetrace[1]%:*})/git-completion.bash
34 '/etc/bash_completion.d/git' # fedora, old debian
35 '/usr/share/bash-completion/completions/git' # arch, ubuntu, new debian
36 '/usr/share/bash-completion/git' # gentoo
38 for e in $locations; do
39 test -f $e && script="$e" && break
42 ZSH_VERSION='' . "$script"
48 local cur_="${3-$cur}"
65 compadd -Q -S '' -p "${2-}" -a -- array && _ret=0
76 compadd -Q -S "${4- }" -p "${2-}" -- ${=1} && _ret=0
79 __gitcomp_nl_append ()
84 compadd -Q -S "${4- }" -p "${2-}" -- ${=1} && _ret=0
93 compadd -Q -p "${2-}" -f -- ${=1} && _ret=0
96 __git_zsh_bash_func ()
102 local completion_func="_git_${command//-/_}"
103 declare -f $completion_func >/dev/null && $completion_func && return
105 local expansion=$(__git_aliased_command "$command")
106 if [ -n "$expansion" ]; then
108 completion_func="_git_${expansion//-/_}"
109 declare -f $completion_func >/dev/null && $completion_func
113 __git_zsh_cmd_common ()
117 add:'add file contents to the index'
118 bisect:'find by binary search the change that introduced a bug'
119 branch:'list, create, or delete branches'
120 checkout:'checkout a branch or paths to the working tree'
121 clone:'clone a repository into a new directory'
122 commit:'record changes to the repository'
123 diff:'show changes between commits, commit and working tree, etc'
124 fetch:'download objects and refs from another repository'
125 grep:'print lines matching a pattern'
126 init:'create an empty Git repository or reinitialize an existing one'
127 log:'show commit logs'
128 merge:'join two or more development histories together'
129 mv:'move or rename a file, a directory, or a symlink'
130 pull:'fetch from and merge with another repository or a local branch'
131 push:'update remote refs along with associated objects'
132 rebase:'forward-port local commits to the updated upstream head'
133 reset:'reset current HEAD to the specified state'
134 rm:'remove files from the working tree and from the index'
135 show:'show various types of objects'
136 status:'show the working tree status'
137 tag:'create, list, delete or verify a tag object signed with GPG')
138 _describe -t common-commands 'common commands' list && _ret=0
141 __git_zsh_cmd_alias ()
144 list=(${${${(0)"$(git config -z --get-regexp '^alias\.')"}#alias.}%$'\n'*})
145 _describe -t alias-commands 'aliases' list $* && _ret=0
151 emulate ksh -c __git_compute_all_commands
152 list=( ${=__git_all_commands} )
153 _describe -t all-commands 'all commands' list && _ret=0
158 local curcontext="$curcontext" state state_descr line
162 orig_words=( ${words[@]} )
165 '(-p --paginate --no-pager)'{-p,--paginate}'[pipe all output into ''less'']' \
166 '(-p --paginate)--no-pager[do not pipe git output into a pager]' \
167 '--git-dir=-[set the path to the repository]: :_directories' \
168 '--bare[treat the repository as a bare repository]' \
169 '(- :)--version[prints the git suite version]' \
170 '--exec-path=-[path to where your core git programs are installed]:: :_directories' \
171 '--html-path[print the path where git''s HTML documentation is installed]' \
172 '--info-path[print the path where the Info files are installed]' \
173 '--man-path[print the manpath (see `man(1)`) for the man pages]' \
174 '--work-tree=-[set the path to the working tree]: :_directories' \
175 '--namespace=-[set the git namespace]' \
176 '--no-replace-objects[do not use replacement refs to replace git objects]' \
177 '(- :)--help[prints the synopsis and a list of the most commonly used commands]: :->arg' \
179 '(-)*:: :->arg' && return
184 'alias-commands:alias:__git_zsh_cmd_alias' \
185 'common-commands:common:__git_zsh_cmd_common' \
186 'all-commands:all:__git_zsh_cmd_all' && _ret=0
189 local command="${words[1]}" __git_dir
191 if (( $+opt_args[--bare] )); then
194 __git_dir=${opt_args[--git-dir]}
197 (( $+opt_args[--help] )) && command='help'
199 words=( ${orig_words[@]} )
201 __git_zsh_bash_func $command
211 cur=${words[CURRENT]}
212 prev=${words[CURRENT-1]}
215 if (( $+functions[__${service}_zsh_main] )); then
216 __${service}_zsh_main
218 emulate ksh -c __${service}_main
221 let _ret && _default && _ret=0