1 # bash/zsh completion support for core Git.
3 # Copyright (C) 2006,2007 Shawn O. Pearce <spearce@spearce.org>
4 # Conceptually based on gitcompletion (http://gitweb.hawaga.org.uk/).
5 # Distributed under the GNU General Public License, version 2.0.
7 # The contained completion routines provide support for completing:
9 # *) local and remote branch names
10 # *) local and remote tag names
11 # *) .git/remotes file names
12 # *) git 'subcommands'
13 # *) git email aliases for git-send-email
14 # *) tree paths within 'ref:path/to/file' expressions
15 # *) file paths within current working directory and index
16 # *) common --long-options
18 # To use these routines:
20 # 1) Copy this file to somewhere (e.g. ~/.git-completion.bash).
21 # 2) Add the following line to your .bashrc/.zshrc:
22 # source ~/.git-completion.bash
23 # 3) Consider changing your PS1 to also show the current branch,
24 # see git-prompt.sh for details.
26 # If you use complex aliases of form '!f() { ... }; f', you can use the null
27 # command ':' as the first command in the function body to declare the desired
28 # completion style. For example '!f() { : git commit ; ... }; f' will
29 # tell the completion to use commit completion. This also works with aliases
30 # of form "!sh -c '...'". For example, "!sh -c ': git commit ; ... '".
32 # Compatible with bash 3.2.57.
34 # You can set the following environment variables to influence the behavior of
35 # the completion routines:
37 # GIT_COMPLETION_CHECKOUT_NO_GUESS
39 # When set to "1", do not include "DWIM" suggestions in git-checkout
40 # and git-switch completion (e.g., completing "foo" when "origin/foo"
43 # GIT_COMPLETION_SHOW_ALL
45 # When set to "1" suggest all options, including options which are
46 # typically hidden (e.g. '--allow-empty' for 'git commit').
48 case "$COMP_WORDBREAKS" in
50 *) COMP_WORDBREAKS="$COMP_WORDBREAKS:"
53 # Discovers the path to the git repository taking any '--git-dir=<path>' and
54 # '-C <path>' options into account and stores it in the $__git_repo_path
56 __git_find_repo_path ()
58 if [ -n "${__git_repo_path-}" ]; then
59 # we already know where it is
63 if [ -n "${__git_C_args-}" ]; then
64 __git_repo_path="$(git "${__git_C_args[@]}" \
65 ${__git_dir:+--git-dir="$__git_dir"} \
66 rev-parse --absolute-git-dir 2>/dev/null)"
67 elif [ -n "${__git_dir-}" ]; then
68 test -d "$__git_dir" &&
69 __git_repo_path="$__git_dir"
70 elif [ -n "${GIT_DIR-}" ]; then
71 test -d "${GIT_DIR-}" &&
72 __git_repo_path="$GIT_DIR"
73 elif [ -d .git ]; then
76 __git_repo_path="$(git rev-parse --git-dir 2>/dev/null)"
80 # Deprecated: use __git_find_repo_path() and $__git_repo_path instead
81 # __gitdir accepts 0 or 1 arguments (i.e., location)
82 # returns location of .git repo
85 if [ -z "${1-}" ]; then
86 __git_find_repo_path || return 1
87 echo "$__git_repo_path"
88 elif [ -d "$1/.git" ]; then
95 # Runs git with all the options given as argument, respecting any
96 # '--git-dir=<path>' and '-C <path>' options present on the command line
99 git ${__git_C_args:+"${__git_C_args[@]}"} \
100 ${__git_dir:+--git-dir="$__git_dir"} "$@" 2>/dev/null
103 # Removes backslash escaping, single quotes and double quotes from a word,
104 # stores the result in the variable $dequoted_word.
105 # 1: The word to dequote.
108 local rest="$1" len ch
112 while test -n "$rest"; do
113 len=${#dequoted_word}
114 dequoted_word="$dequoted_word${rest%%[\\\'\"]*}"
115 rest="${rest:$((${#dequoted_word}-$len))}"
117 case "${rest:0:1}" in
124 dequoted_word="$dequoted_word$ch"
131 len=${#dequoted_word}
132 dequoted_word="$dequoted_word${rest%%\'*}"
133 rest="${rest:$((${#dequoted_word}-$len+1))}"
137 while test -n "$rest" ; do
138 len=${#dequoted_word}
139 dequoted_word="$dequoted_word${rest%%[\\\"]*}"
140 rest="${rest:$((${#dequoted_word}-$len))}"
141 case "${rest:0:1}" in
146 dequoted_word="$dequoted_word$ch"
151 dequoted_word="$dequoted_word\\$ch"
167 # The following function is based on code from:
169 # bash_completion - programmable completion functions for bash 3.2+
171 # Copyright © 2006-2008, Ian Macdonald <ian@caliban.org>
172 # © 2009-2010, Bash Completion Maintainers
173 # <bash-completion-devel@lists.alioth.debian.org>
175 # This program is free software; you can redistribute it and/or modify
176 # it under the terms of the GNU General Public License as published by
177 # the Free Software Foundation; either version 2, or (at your option)
180 # This program is distributed in the hope that it will be useful,
181 # but WITHOUT ANY WARRANTY; without even the implied warranty of
182 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
183 # GNU General Public License for more details.
185 # You should have received a copy of the GNU General Public License
186 # along with this program; if not, see <http://www.gnu.org/licenses/>.
188 # The latest version of this software can be obtained here:
190 # http://bash-completion.alioth.debian.org/
194 # This function can be used to access a tokenized list of words
195 # on the command line:
197 # __git_reassemble_comp_words_by_ref '=:'
198 # if test "${words_[cword_-1]}" = -w
203 # The argument should be a collection of characters from the list of
204 # word completion separators (COMP_WORDBREAKS) to treat as ordinary
207 # This is roughly equivalent to going back in time and setting
208 # COMP_WORDBREAKS to exclude those characters. The intent is to
209 # make option types like --date=<type> and <rev>:<path> easy to
210 # recognize by treating each shell word as a single token.
212 # It is best not to set COMP_WORDBREAKS directly because the value is
213 # shared with other completion scripts. By the time the completion
214 # function gets called, COMP_WORDS has already been populated so local
215 # changes to COMP_WORDBREAKS have no effect.
217 # Output: words_, cword_, cur_.
219 __git_reassemble_comp_words_by_ref()
221 local exclude i j first
222 # Which word separators to exclude?
223 exclude="${1//[^$COMP_WORDBREAKS]}"
225 if [ -z "$exclude" ]; then
226 words_=("${COMP_WORDS[@]}")
229 # List of word completion separators has shrunk;
230 # re-assemble words to complete.
231 for ((i=0, j=0; i < ${#COMP_WORDS[@]}; i++, j++)); do
232 # Append each nonempty word consisting of just
233 # word separator characters to the current word.
237 [ -n "${COMP_WORDS[$i]}" ] &&
238 # word consists of excluded word separators
239 [ "${COMP_WORDS[$i]//[^$exclude]}" = "${COMP_WORDS[$i]}" ]
241 # Attach to the previous token,
242 # unless the previous token is the command name.
243 if [ $j -ge 2 ] && [ -n "$first" ]; then
247 words_[$j]=${words_[j]}${COMP_WORDS[i]}
248 if [ $i = $COMP_CWORD ]; then
251 if (($i < ${#COMP_WORDS[@]} - 1)); then
258 words_[$j]=${words_[j]}${COMP_WORDS[i]}
259 if [ $i = $COMP_CWORD ]; then
265 if ! type _get_comp_words_by_ref >/dev/null 2>&1; then
266 _get_comp_words_by_ref ()
268 local exclude cur_ words_ cword_
269 if [ "$1" = "-n" ]; then
273 __git_reassemble_comp_words_by_ref "$exclude"
274 cur_=${words_[cword_]}
275 while [ $# -gt 0 ]; do
281 prev=${words_[$cword_-1]}
284 words=("${words_[@]}")
295 # Fills the COMPREPLY array with prefiltered words without any additional
297 # Callers must take care of providing only words that match the current word
298 # to be completed and adding any prefix and/or suffix (trailing space!), if
300 # 1: List of newline-separated matching completion words, complete with
309 # Similar to __gitcomp_direct, but appends to COMPREPLY instead.
310 # Callers must take care of providing only words that match the current word
311 # to be completed and adding any prefix and/or suffix (trailing space!), if
313 # 1: List of newline-separated matching completion words, complete with
315 __gitcomp_direct_append ()
324 local x i=${#COMPREPLY[@]}
326 if [[ "$x" == "$3"* ]]; then
327 COMPREPLY[i++]="$2$x$4"
338 # Generates completion reply, appending a space to possible completion words,
340 # It accepts 1 to 4 arguments:
341 # 1: List of possible completion words.
342 # 2: A prefix to be added to each possible completion word (optional).
343 # 3: Generate possible completion matches for this word (optional).
344 # 4: A suffix to be appended to each possible completion word (optional).
347 local cur_="${3-$cur}"
353 local c i=0 IFS=$' \t\n'
355 if [[ $c == "--" ]]; then
359 if [[ $c == "$cur_"* ]]; then
364 COMPREPLY[i++]="${2-}$c"
369 local c i=0 IFS=$' \t\n'
371 if [[ $c == "--" ]]; then
373 if [[ $c == "$cur_"* ]]; then
374 COMPREPLY[i++]="${2-}$c "
379 if [[ $c == "$cur_"* ]]; then
384 COMPREPLY[i++]="${2-}$c"
391 # Clear the variables caching builtins' options when (re-)sourcing
392 # the completion script.
393 if [[ -n ${ZSH_VERSION-} ]]; then
394 unset ${(M)${(k)parameters[@]}:#__gitcomp_builtin_*} 2>/dev/null
396 unset $(compgen -v __gitcomp_builtin_)
399 # This function is equivalent to
401 # __gitcomp "$(git xxx --git-completion-helper) ..."
403 # except that the output is cached. Accept 1-3 arguments:
404 # 1: the git command to execute, this is also the cache key
405 # 2: extra options to be added on top (e.g. negative forms)
406 # 3: options to be excluded
409 # spaces must be replaced with underscore for multi-word
410 # commands, e.g. "git remote add" becomes remote_add.
415 local var=__gitcomp_builtin_"${cmd/-/_}"
417 eval "options=\${$var-}"
419 local completion_helper
420 if [ "$GIT_COMPLETION_SHOW_ALL" = "1" ]; then
421 completion_helper="--git-completion-helper-all"
423 completion_helper="--git-completion-helper"
426 if [ -z "$options" ]; then
427 # leading and trailing spaces are significant to make
428 # option removal work correctly.
429 options=" $incl $(__git ${cmd/_/ } $completion_helper) " || return
432 options="${options/ $i / }"
434 eval "$var=\"$options\""
440 # Variation of __gitcomp_nl () that appends to the existing list of
441 # completion candidates, COMPREPLY.
442 __gitcomp_nl_append ()
445 __gitcompappend "$1" "${2-}" "${3-$cur}" "${4- }"
448 # Generates completion reply from newline-separated possible completion words
449 # by appending a space to all of them.
450 # It accepts 1 to 4 arguments:
451 # 1: List of possible completion words, separated by a single newline.
452 # 2: A prefix to be added to each possible completion word (optional).
453 # 3: Generate possible completion matches for this word (optional).
454 # 4: A suffix to be appended to each possible completion word instead of
455 # the default space (optional). If specified but empty, nothing is
460 __gitcomp_nl_append "$@"
463 # Fills the COMPREPLY array with prefiltered paths without any additional
465 # Callers must take care of providing only paths that match the current path
466 # to be completed and adding any prefix path components, if necessary.
467 # 1: List of newline-separated matching paths, complete with all prefix
469 __gitcomp_file_direct ()
475 # use a hack to enable file mode in bash < 4
476 compopt -o filenames +o nospace 2>/dev/null ||
477 compgen -f /non-existing-dir/ >/dev/null ||
481 # Generates completion reply with compgen from newline-separated possible
482 # completion filenames.
483 # It accepts 1 to 3 arguments:
484 # 1: List of possible completion filenames, separated by a single newline.
485 # 2: A directory prefix to be added to each possible completion filename
487 # 3: Generate possible completion matches for this word (optional).
492 # XXX does not work when the directory prefix contains a tilde,
493 # since tilde expansion is not applied.
494 # This means that COMPREPLY will be empty and Bash default
495 # completion will be used.
496 __gitcompadd "$1" "${2-}" "${3-$cur}" ""
498 # use a hack to enable file mode in bash < 4
499 compopt -o filenames +o nospace 2>/dev/null ||
500 compgen -f /non-existing-dir/ >/dev/null ||
504 # Execute 'git ls-files', unless the --committable option is specified, in
505 # which case it runs 'git diff-index' to find out the files that can be
506 # committed. It return paths relative to the directory specified in the first
507 # argument, and using the options specified in the second argument.
508 __git_ls_files_helper ()
510 if [ "$2" == "--committable" ]; then
511 __git -C "$1" -c core.quotePath=false diff-index \
512 --name-only --relative HEAD -- "${3//\\/\\\\}*"
514 # NOTE: $2 is not quoted in order to support multiple options
515 __git -C "$1" -c core.quotePath=false ls-files \
516 --exclude-standard $2 -- "${3//\\/\\\\}*"
521 # __git_index_files accepts 1 or 2 arguments:
522 # 1: Options to pass to ls-files (required).
523 # 2: A directory path (optional).
524 # If provided, only files within the specified directory are listed.
525 # Sub directories are never recursed. Path must have a trailing
527 # 3: List only paths matching this path component (optional).
530 local root="$2" match="$3"
532 __git_ls_files_helper "$root" "$1" "${match:-?}" |
533 awk -F / -v pfx="${2//\\/\\\\}" '{
538 if (substr(p, 1, 1) != "\"") {
539 # No special characters, easy!
544 # The path is quoted.
549 # Even when a directory name itself does not contain
550 # any special characters, it will still be quoted if
551 # any of its (stripped) trailing path components do.
552 # Because of this we may have seen the same directory
553 # both quoted and unquoted.
555 # We have seen the same directory unquoted,
562 function dequote(p, bs_idx, out, esc, esc_idx, dec) {
563 # Skip opening double quote.
566 # Interpret backslash escape sequences.
567 while ((bs_idx = index(p, "\\")) != 0) {
568 out = out substr(p, 1, bs_idx - 1)
569 esc = substr(p, bs_idx + 1, 1)
570 p = substr(p, bs_idx + 2)
572 if ((esc_idx = index("abtvfr\"\\", esc)) != 0) {
573 # C-style one-character escape sequence.
574 out = out substr("\a\b\t\v\f\r\"\\",
576 } else if (esc == "n") {
577 # Uh-oh, a newline character.
578 # We cannot reliably put a pathname
579 # containing a newline into COMPREPLY,
580 # and the newline would create a mess.
584 # Must be a \nnn octal value, then.
586 substr(p, 1, 1) * 8 + \
588 out = out sprintf("%c", dec)
592 # Drop closing double quote, if there is one.
593 # (There is not any if this is a directory, as it was
594 # already stripped with the trailing path components.)
595 if (substr(p, length(p), 1) == "\"")
596 out = out substr(p, 1, length(p) - 1)
604 # __git_complete_index_file requires 1 argument:
605 # 1: the options to pass to ls-file
607 # The exception is --committable, which finds the files appropriate commit.
608 __git_complete_index_file ()
610 local dequoted_word pfx="" cur_
614 case "$dequoted_word" in
616 pfx="${dequoted_word%/*}/"
617 cur_="${dequoted_word##*/}"
620 cur_="$dequoted_word"
623 __gitcomp_file_direct "$(__git_index_files "$1" "$pfx" "$cur_")"
626 # Lists branches from the local repository.
627 # 1: A prefix to be added to each listed branch (optional).
628 # 2: List only branches matching this word (optional; list all branches if
630 # 3: A suffix to be appended to each listed branch (optional).
633 local pfx="${1-}" cur_="${2-}" sfx="${3-}"
635 __git for-each-ref --format="${pfx//\%/%%}%(refname:strip=2)$sfx" \
636 "refs/heads/$cur_*" "refs/heads/$cur_*/**"
639 # Lists branches from remote repositories.
640 # 1: A prefix to be added to each listed branch (optional).
641 # 2: List only branches matching this word (optional; list all branches if
643 # 3: A suffix to be appended to each listed branch (optional).
644 __git_remote_heads ()
646 local pfx="${1-}" cur_="${2-}" sfx="${3-}"
648 __git for-each-ref --format="${pfx//\%/%%}%(refname:strip=2)$sfx" \
649 "refs/remotes/$cur_*" "refs/remotes/$cur_*/**"
652 # Lists tags from the local repository.
653 # Accepts the same positional parameters as __git_heads() above.
656 local pfx="${1-}" cur_="${2-}" sfx="${3-}"
658 __git for-each-ref --format="${pfx//\%/%%}%(refname:strip=2)$sfx" \
659 "refs/tags/$cur_*" "refs/tags/$cur_*/**"
662 # List unique branches from refs/remotes used for 'git checkout' and 'git
663 # switch' tracking DWIMery.
664 # 1: A prefix to be added to each listed branch (optional)
665 # 2: List only branches matching this word (optional; list all branches if
667 # 3: A suffix to be appended to each listed branch (optional).
668 __git_dwim_remote_heads ()
670 local pfx="${1-}" cur_="${2-}" sfx="${3-}"
671 local fer_pfx="${pfx//\%/%%}" # "escape" for-each-ref format specifiers
673 # employ the heuristic used by git checkout and git switch
674 # Try to find a remote branch that cur_es the completion word
675 # but only output if the branch name is unique
676 __git for-each-ref --format="$fer_pfx%(refname:strip=3)$sfx" \
677 --sort="refname:strip=3" \
678 "refs/remotes/*/$cur_*" "refs/remotes/*/$cur_*/**" | \
682 # Lists refs from the local (by default) or from a remote repository.
683 # It accepts 0, 1 or 2 arguments:
684 # 1: The remote to list refs from (optional; ignored, if set but empty).
685 # Can be the name of a configured remote, a path, or a URL.
686 # 2: In addition to local refs, list unique branches from refs/remotes/ for
687 # 'git checkout's tracking DWIMery (optional; ignored, if set but empty).
688 # 3: A prefix to be added to each listed ref (optional).
689 # 4: List only refs matching this word (optional; list all refs if unset or
691 # 5: A suffix to be appended to each listed ref (optional; ignored, if set
694 # Use __git_complete_refs() instead.
697 local i hash dir track="${2-}"
698 local list_refs_from=path remote="${1-}"
700 local pfx="${3-}" cur_="${4-$cur}" sfx="${5-}"
702 local fer_pfx="${pfx//\%/%%}" # "escape" for-each-ref format specifiers
705 dir="$__git_repo_path"
707 if [ -z "$remote" ]; then
708 if [ -z "$dir" ]; then
712 if __git_is_configured_remote "$remote"; then
713 # configured remote takes precedence over a
714 # local directory with the same name
715 list_refs_from=remote
716 elif [ -d "$remote/.git" ]; then
718 elif [ -d "$remote" ]; then
725 if [ "$list_refs_from" = path ]; then
726 if [[ "$cur_" == ^* ]]; then
735 refs=("$match*" "$match*/**")
739 for i in HEAD FETCH_HEAD ORIG_HEAD MERGE_HEAD REBASE_HEAD; do
742 if [ -e "$dir/$i" ]; then
748 format="refname:strip=2"
749 refs=("refs/tags/$match*" "refs/tags/$match*/**"
750 "refs/heads/$match*" "refs/heads/$match*/**"
751 "refs/remotes/$match*" "refs/remotes/$match*/**")
754 __git_dir="$dir" __git for-each-ref --format="$fer_pfx%($format)$sfx" \
756 if [ -n "$track" ]; then
757 __git_dwim_remote_heads "$pfx" "$match" "$sfx"
763 __git ls-remote "$remote" "$match*" | \
764 while read -r hash i; do
767 *) echo "$pfx$i$sfx" ;;
772 if [ "$list_refs_from" = remote ]; then
774 $match*) echo "${pfx}HEAD$sfx" ;;
776 __git for-each-ref --format="$fer_pfx%(refname:strip=3)$sfx" \
777 "refs/remotes/$remote/$match*" \
778 "refs/remotes/$remote/$match*/**"
782 $match*) query_symref="HEAD" ;;
784 __git ls-remote "$remote" $query_symref \
785 "refs/tags/$match*" "refs/heads/$match*" \
786 "refs/remotes/$match*" |
787 while read -r hash i; do
790 refs/*) echo "$pfx${i#refs/*/}$sfx" ;;
791 *) echo "$pfx$i$sfx" ;; # symbolic refs
799 # Completes refs, short and long, local and remote, symbolic and pseudo.
801 # Usage: __git_complete_refs [<option>]...
802 # --remote=<remote>: The remote to list refs from, can be the name of a
803 # configured remote, a path, or a URL.
804 # --dwim: List unique remote branches for 'git switch's tracking DWIMery.
805 # --pfx=<prefix>: A prefix to be added to each ref.
806 # --cur=<word>: The current ref to be completed. Defaults to the current
807 # word to be completed.
808 # --sfx=<suffix>: A suffix to be appended to each ref instead of the default
810 # --mode=<mode>: What set of refs to complete, one of 'refs' (the default) to
811 # complete all refs, 'heads' to complete only branches, or
812 # 'remote-heads' to complete only remote branches. Note that
813 # --remote is only compatible with --mode=refs.
814 __git_complete_refs ()
816 local remote= dwim= pfx= cur_="$cur" sfx=" " mode="refs"
818 while test $# != 0; do
820 --remote=*) remote="${1##--remote=}" ;;
821 --dwim) dwim="yes" ;;
822 # --track is an old spelling of --dwim
823 --track) dwim="yes" ;;
824 --pfx=*) pfx="${1##--pfx=}" ;;
825 --cur=*) cur_="${1##--cur=}" ;;
826 --sfx=*) sfx="${1##--sfx=}" ;;
827 --mode=*) mode="${1##--mode=}" ;;
833 # complete references based on the specified mode
836 __gitcomp_direct "$(__git_refs "$remote" "" "$pfx" "$cur_" "$sfx")" ;;
838 __gitcomp_direct "$(__git_heads "$pfx" "$cur_" "$sfx")" ;;
840 __gitcomp_direct "$(__git_remote_heads "$pfx" "$cur_" "$sfx")" ;;
845 # Append DWIM remote branch names if requested
846 if [ "$dwim" = "yes" ]; then
847 __gitcomp_direct_append "$(__git_dwim_remote_heads "$pfx" "$cur_" "$sfx")"
851 # __git_refs2 requires 1 argument (to pass to __git_refs)
852 # Deprecated: use __git_complete_fetch_refspecs() instead.
856 for i in $(__git_refs "$1"); do
861 # Completes refspecs for fetching from a remote repository.
862 # 1: The remote repository.
863 # 2: A prefix to be added to each listed refspec (optional).
864 # 3: The ref to be completed as a refspec instead of the current word to be
865 # completed (optional)
866 # 4: A suffix to be appended to each listed refspec instead of the default
868 __git_complete_fetch_refspecs ()
870 local i remote="$1" pfx="${2-}" cur_="${3-$cur}" sfx="${4- }"
873 for i in $(__git_refs "$remote" "" "" "$cur_") ; do
879 # __git_refs_remotes requires 1 argument (to pass to ls-remote)
880 __git_refs_remotes ()
883 __git ls-remote "$1" 'refs/heads/*' | \
884 while read -r hash i; do
885 echo "$i:refs/remotes/$1/${i#refs/heads/}"
892 test -d "$__git_repo_path/remotes" && ls -1 "$__git_repo_path/remotes"
896 # Returns true if $1 matches the name of a configured remote, false otherwise.
897 __git_is_configured_remote ()
900 for remote in $(__git_remotes); do
901 if [ "$remote" = "$1" ]; then
908 __git_list_merge_strategies ()
910 LANG=C LC_ALL=C git merge -s help 2>&1 |
911 sed -n -e '/[Aa]vailable strategies are: /,/^$/{
920 __git_merge_strategies=
921 # 'git merge -s help' (and thus detection of the merge strategy
922 # list) fails, unfortunately, if run outside of any git working
923 # tree. __git_merge_strategies is set to the empty string in
924 # that case, and the detection will be repeated the next time it
926 __git_compute_merge_strategies ()
928 test -n "$__git_merge_strategies" ||
929 __git_merge_strategies=$(__git_list_merge_strategies)
932 __git_merge_strategy_options="ours theirs subtree subtree= patience
933 histogram diff-algorithm= ignore-space-change ignore-all-space
934 ignore-space-at-eol renormalize no-renormalize no-renames
935 find-renames find-renames= rename-threshold="
937 __git_complete_revlist_file ()
939 local dequoted_word pfx ls ref cur_="$cur"
948 __git_dequote "$cur_"
950 case "$dequoted_word" in
952 pfx="${dequoted_word%/*}"
953 cur_="${dequoted_word##*/}"
958 cur_="$dequoted_word"
963 case "$COMP_WORDBREAKS" in
965 *) pfx="$ref:$pfx" ;;
968 __gitcomp_file "$(__git ls-tree "$ls" \
974 pfx="${cur_%...*}..."
976 __git_complete_refs --pfx="$pfx" --cur="$cur_"
981 __git_complete_refs --pfx="$pfx" --cur="$cur_"
989 __git_complete_file ()
991 __git_complete_revlist_file
994 __git_complete_revlist ()
996 __git_complete_revlist_file
999 __git_complete_remote_or_refspec ()
1001 local cur_="$cur" cmd="${words[1]}"
1002 local i c=2 remote="" pfx="" lhs=1 no_complete_refspec=0
1003 if [ "$cmd" = "remote" ]; then
1006 while [ $c -lt $cword ]; do
1009 --mirror) [ "$cmd" = "push" ] && no_complete_refspec=1 ;;
1010 -d|--delete) [ "$cmd" = "push" ] && lhs=0 ;;
1013 push) no_complete_refspec=1 ;;
1020 --multiple) no_complete_refspec=1; break ;;
1022 *) remote="$i"; break ;;
1026 if [ -z "$remote" ]; then
1027 __gitcomp_nl "$(__git_remotes)"
1030 if [ $no_complete_refspec = 1 ]; then
1033 [ "$remote" = "." ] && remote=
1036 case "$COMP_WORDBREAKS" in
1038 *) pfx="${cur_%%:*}:" ;;
1050 if [ $lhs = 1 ]; then
1051 __git_complete_fetch_refspecs "$remote" "$pfx" "$cur_"
1053 __git_complete_refs --pfx="$pfx" --cur="$cur_"
1057 if [ $lhs = 1 ]; then
1058 __git_complete_refs --remote="$remote" --pfx="$pfx" --cur="$cur_"
1060 __git_complete_refs --pfx="$pfx" --cur="$cur_"
1064 if [ $lhs = 1 ]; then
1065 __git_complete_refs --pfx="$pfx" --cur="$cur_"
1067 __git_complete_refs --remote="$remote" --pfx="$pfx" --cur="$cur_"
1073 __git_complete_strategy ()
1075 __git_compute_merge_strategies
1078 __gitcomp "$__git_merge_strategies"
1082 __gitcomp "$__git_merge_strategy_options"
1088 __gitcomp "$__git_merge_strategies" "" "${cur##--strategy=}"
1091 --strategy-option=*)
1092 __gitcomp "$__git_merge_strategy_options" "" "${cur##--strategy-option=}"
1100 __git_compute_all_commands ()
1102 test -n "$__git_all_commands" ||
1103 __git_all_commands=$(__git --list-cmds=main,others,alias,nohelpers)
1106 # Lists all set config variables starting with the given section prefix,
1107 # with the prefix removed.
1108 __git_get_config_variables ()
1110 local section="$1" i IFS=$'\n'
1111 for i in $(__git config --name-only --get-regexp "^$section\..*"); do
1112 echo "${i#$section.}"
1116 __git_pretty_aliases ()
1118 __git_get_config_variables "pretty"
1121 # __git_aliased_command requires 1 argument
1122 __git_aliased_command ()
1124 local word cmdline=$(__git config --get "alias.$1")
1125 for word in $cmdline; do
1131 \!*) : shell command alias ;;
1133 *=*) : setting env ;;
1134 git) : git itself ;;
1135 \(\)) : skip parens of shell function definition ;;
1136 {) : skip start of shell helper function ;;
1137 :) : skip null command ;;
1138 \'*) : skip opening quote after sh -c ;;
1146 # Check whether one of the given words is present on the command line,
1147 # and print the first word found.
1149 # Usage: __git_find_on_cmdline [<option>]... "<wordlist>"
1150 # --show-idx: Optionally show the index of the found word in the $words array.
1151 __git_find_on_cmdline ()
1153 local word c=1 show_idx
1155 while test $# -gt 1; do
1157 --show-idx) show_idx=y ;;
1164 while [ $c -lt $cword ]; do
1165 for word in $wordlist; do
1166 if [ "$word" = "${words[c]}" ]; then
1167 if [ -n "${show_idx-}" ]; then
1179 # Similar to __git_find_on_cmdline, except that it loops backwards and thus
1180 # prints the *last* word found. Useful for finding which of two options that
1181 # supersede each other came last, such as "--guess" and "--no-guess".
1183 # Usage: __git_find_last_on_cmdline [<option>]... "<wordlist>"
1184 # --show-idx: Optionally show the index of the found word in the $words array.
1185 __git_find_last_on_cmdline ()
1187 local word c=$cword show_idx
1189 while test $# -gt 1; do
1191 --show-idx) show_idx=y ;;
1198 while [ $c -gt 1 ]; do
1200 for word in $wordlist; do
1201 if [ "$word" = "${words[c]}" ]; then
1202 if [ -n "$show_idx" ]; then
1213 # Echo the value of an option set on the command line or config
1215 # $1: short option name
1216 # $2: long option name including =
1217 # $3: list of possible values
1218 # $4: config string (optional)
1221 # result="$(__git_get_option_value "-d" "--do-something=" \
1222 # "yes no" "core.doSomething")"
1224 # result is then either empty (no option set) or "yes" or "no"
1226 # __git_get_option_value requires 3 arguments
1227 __git_get_option_value ()
1229 local c short_opt long_opt val
1230 local result= values config_key word
1238 while [ $c -ge 0 ]; do
1240 for val in $values; do
1241 if [ "$short_opt$val" = "$word" ] ||
1242 [ "$long_opt$val" = "$word" ]; then
1250 if [ -n "$config_key" ] && [ -z "$result" ]; then
1251 result="$(__git config "$config_key")"
1257 __git_has_doubledash ()
1260 while [ $c -lt $cword ]; do
1261 if [ "--" = "${words[c]}" ]; then
1269 # Try to count non option arguments passed on the command line for the
1270 # specified git command.
1271 # When options are used, it is necessary to use the special -- option to
1272 # tell the implementation were non option arguments begin.
1273 # XXX this can not be improved, since options can appear everywhere, as
1277 # __git_count_arguments requires 1 argument: the git command executed.
1278 __git_count_arguments ()
1282 # Skip "git" (first argument)
1283 for ((i=1; i < ${#words[@]}; i++)); do
1288 # Good; we can assume that the following are only non
1293 # Skip the specified git command and discard git
1306 __git_whitespacelist="nowarn warn error error-all fix"
1307 __git_patchformat="mbox stgit stgit-series hg mboxrd"
1308 __git_showcurrentpatch="diff raw"
1309 __git_am_inprogress_options="--skip --continue --resolved --abort --quit --show-current-patch"
1313 __git_find_repo_path
1314 if [ -d "$__git_repo_path"/rebase-apply ]; then
1315 __gitcomp "$__git_am_inprogress_options"
1320 __gitcomp "$__git_whitespacelist" "" "${cur##--whitespace=}"
1324 __gitcomp "$__git_patchformat" "" "${cur##--patch-format=}"
1327 --show-current-patch=*)
1328 __gitcomp "$__git_showcurrentpatch" "" "${cur##--show-current-patch=}"
1332 __gitcomp_builtin am "" \
1333 "$__git_am_inprogress_options"
1342 __gitcomp "$__git_whitespacelist" "" "${cur##--whitespace=}"
1346 __gitcomp_builtin apply
1355 __gitcomp "+x -x" "" "${cur##--chmod=}"
1359 __gitcomp_builtin add
1363 local complete_opt="--others --modified --directory --no-empty-directory"
1364 if test -n "$(__git_find_on_cmdline "-u --update")"
1366 complete_opt="--modified"
1368 __git_complete_index_file "$complete_opt"
1375 __gitcomp "$(git archive --list)" "" "${cur##--format=}"
1379 __gitcomp_nl "$(__git_remotes)" "" "${cur##--remote=}"
1383 __gitcomp_builtin archive "--format= --list --verbose --prefix= --worktree-attributes"
1392 __git_has_doubledash && return
1394 local subcommands="start bad good skip reset visualize replay log run"
1395 local subcommand="$(__git_find_on_cmdline "$subcommands")"
1396 if [ -z "$subcommand" ]; then
1397 __git_find_repo_path
1398 if [ -f "$__git_repo_path"/BISECT_START ]; then
1399 __gitcomp "$subcommands"
1401 __gitcomp "replay start"
1406 case "$subcommand" in
1407 bad|good|reset|skip|start)
1415 __git_ref_fieldlist="refname objecttype objectsize objectname upstream push HEAD symref"
1419 local i c=1 only_local_ref="n" has_r="n"
1421 while [ $c -lt $cword ]; do
1424 -d|--delete|-m|--move) only_local_ref="y" ;;
1425 -r|--remotes) has_r="y" ;;
1431 --set-upstream-to=*)
1432 __git_complete_refs --cur="${cur##--set-upstream-to=}"
1435 __gitcomp_builtin branch
1438 if [ $only_local_ref = "y" -a $has_r = "n" ]; then
1439 __gitcomp_direct "$(__git_heads "" "$cur" " ")"
1449 local cmd="${words[2]}"
1452 __gitcomp "create list-heads verify unbundle"
1455 # looking for a file
1460 __git_complete_revlist
1467 # Helper function to decide whether or not we should enable DWIM logic for
1468 # git-switch and git-checkout.
1470 # To decide between the following rules in priority order
1471 # 1) the last provided of "--guess" or "--no-guess" explicitly enable or
1472 # disable completion of DWIM logic respectively.
1473 # 2) If the --no-track option is provided, take this as a hint to disable the
1474 # DWIM completion logic
1475 # 3) If GIT_COMPLETION_CHECKOUT_NO_GUESS is set, disable the DWIM completion
1476 # logic, as requested by the user.
1477 # 4) Enable DWIM logic otherwise.
1479 __git_checkout_default_dwim_mode ()
1481 local last_option dwim_opt="--dwim"
1483 if [ "${GIT_COMPLETION_CHECKOUT_NO_GUESS-}" = "1" ]; then
1487 # --no-track disables DWIM, but with lower priority than
1488 # --guess/--no-guess
1489 if [ -n "$(__git_find_on_cmdline "--no-track")" ]; then
1493 # Find the last provided --guess or --no-guess
1494 last_option="$(__git_find_last_on_cmdline "--guess --no-guess")"
1495 case "$last_option" in
1509 __git_has_doubledash && return
1513 __gitcomp "diff3 merge" "" "${cur##--conflict=}"
1516 __gitcomp_builtin checkout
1519 local dwim_opt="$(__git_checkout_default_dwim_mode)"
1520 local prevword prevword="${words[cword-1]}"
1524 # Complete local branches (and DWIM branch
1525 # remote branch names) for an option argument
1526 # specifying a new branch name. This is for
1527 # convenience, assuming new branches are
1528 # possibly based on pre-existing branch names.
1529 __git_complete_refs $dwim_opt --mode="heads"
1536 # At this point, we've already handled special completion for
1537 # the arguments to -b/-B, and --orphan. There are 3 main
1538 # things left we can possibly complete:
1539 # 1) a start-point for -b/-B, -d/--detach, or --orphan
1540 # 2) a remote head, for --track
1541 # 3) an arbitrary reference, possibly including DWIM names
1544 if [ -n "$(__git_find_on_cmdline "-b -B -d --detach --orphan")" ]; then
1545 __git_complete_refs --mode="refs"
1546 elif [ -n "$(__git_find_on_cmdline "--track")" ]; then
1547 __git_complete_refs --mode="remote-heads"
1549 __git_complete_refs $dwim_opt --mode="refs"
1555 __git_sequencer_inprogress_options="--continue --quit --abort --skip"
1557 __git_cherry_pick_inprogress_options=$__git_sequencer_inprogress_options
1561 __git_find_repo_path
1562 if [ -f "$__git_repo_path"/CHERRY_PICK_HEAD ]; then
1563 __gitcomp "$__git_cherry_pick_inprogress_options"
1567 __git_complete_strategy && return
1571 __gitcomp_builtin cherry-pick "" \
1572 "$__git_cherry_pick_inprogress_options"
1584 __gitcomp_builtin clean
1589 # XXX should we check for -x option ?
1590 __git_complete_index_file "--others --directory"
1597 __git_complete_config_variable_name_and_value
1603 __git_complete_config_variable_name_and_value \
1604 --cur="${cur##--config=}"
1608 __gitcomp_builtin clone
1614 __git_untracked_file_modes="all no normal"
1627 __gitcomp "default scissors strip verbatim whitespace
1628 " "" "${cur##--cleanup=}"
1631 --reuse-message=*|--reedit-message=*|\
1632 --fixup=*|--squash=*)
1633 __git_complete_refs --cur="${cur#*=}"
1636 --untracked-files=*)
1637 __gitcomp "$__git_untracked_file_modes" "" "${cur##--untracked-files=}"
1641 __gitcomp_builtin commit
1645 if __git rev-parse --verify --quiet HEAD >/dev/null; then
1646 __git_complete_index_file "--committable"
1648 # This is the first commit
1649 __git_complete_index_file "--cached"
1657 __gitcomp_builtin describe
1663 __git_diff_algorithms="myers minimal patience histogram"
1665 __git_diff_submodule_formats="diff log short"
1667 __git_color_moved_opts="no default plain blocks zebra dimmed-zebra"
1669 __git_color_moved_ws_opts="no ignore-space-at-eol ignore-space-change
1670 ignore-all-space allow-indentation-change"
1672 __git_diff_common_options="--stat --numstat --shortstat --summary
1673 --patch-with-stat --name-only --name-status --color
1674 --no-color --color-words --no-renames --check
1675 --color-moved --color-moved= --no-color-moved
1676 --color-moved-ws= --no-color-moved-ws
1677 --full-index --binary --abbrev --diff-filter=
1678 --find-copies-harder --ignore-cr-at-eol
1679 --text --ignore-space-at-eol --ignore-space-change
1680 --ignore-all-space --ignore-blank-lines --exit-code
1681 --quiet --ext-diff --no-ext-diff
1682 --no-prefix --src-prefix= --dst-prefix=
1683 --inter-hunk-context=
1684 --patience --histogram --minimal
1685 --raw --word-diff --word-diff-regex=
1686 --dirstat --dirstat= --dirstat-by-file
1687 --dirstat-by-file= --cumulative
1689 --submodule --submodule= --ignore-submodules
1690 --indent-heuristic --no-indent-heuristic
1691 --textconv --no-textconv
1696 __git_has_doubledash && return
1700 __gitcomp "$__git_diff_algorithms" "" "${cur##--diff-algorithm=}"
1704 __gitcomp "$__git_diff_submodule_formats" "" "${cur##--submodule=}"
1708 __gitcomp "$__git_color_moved_opts" "" "${cur##--color-moved=}"
1712 __gitcomp "$__git_color_moved_ws_opts" "" "${cur##--color-moved-ws=}"
1716 __gitcomp "--cached --staged --pickaxe-all --pickaxe-regex
1717 --base --ours --theirs --no-index
1718 $__git_diff_common_options
1723 __git_complete_revlist_file
1726 __git_mergetools_common="diffuse diffmerge ecmerge emerge kdiff3 meld opendiff
1727 tkdiff vimdiff nvimdiff gvimdiff xxdiff araxis p4merge
1728 bc codecompare smerge
1733 __git_has_doubledash && return
1737 __gitcomp "$__git_mergetools_common kompare" "" "${cur##--tool=}"
1741 __gitcomp_builtin difftool "$__git_diff_common_options
1742 --base --cached --ours --theirs
1743 --pickaxe-all --pickaxe-regex
1749 __git_complete_revlist_file
1752 __git_fetch_recurse_submodules="yes on-demand no"
1757 --recurse-submodules=*)
1758 __gitcomp "$__git_fetch_recurse_submodules" "" "${cur##--recurse-submodules=}"
1762 __gitcomp "blob:none blob:limit= sparse:oid=" "" "${cur##--filter=}"
1766 __gitcomp_builtin fetch
1770 __git_complete_remote_or_refspec
1773 __git_format_patch_extra_options="
1774 --full-index --not --all --no-prefix --src-prefix=
1775 --dst-prefix= --notes
1778 _git_format_patch ()
1784 " "" "${cur##--thread=}"
1788 __gitcomp_builtin format-patch "$__git_format_patch_extra_options"
1792 __git_complete_revlist
1799 __gitcomp_builtin fsck
1810 # Lists matching symbol names from a tag (as in ctags) file.
1811 # 1: List symbol names matching this word.
1812 # 2: The tag file to list symbol names from.
1813 # 3: A prefix to be added to each listed symbol name (optional).
1814 # 4: A suffix to be appended to each listed symbol name (optional).
1815 __git_match_ctag () {
1816 awk -v pfx="${3-}" -v sfx="${4-}" "
1817 /^${1//\//\\/}/ { print pfx \$1 sfx }
1821 # Complete symbol names from a tag file.
1822 # Usage: __git_complete_symbol [<option>]...
1823 # --tags=<file>: The tag file to list symbol names from instead of the
1825 # --pfx=<prefix>: A prefix to be added to each symbol name.
1826 # --cur=<word>: The current symbol name to be completed. Defaults to
1827 # the current word to be completed.
1828 # --sfx=<suffix>: A suffix to be appended to each symbol name instead
1829 # of the default space.
1830 __git_complete_symbol () {
1831 local tags=tags pfx="" cur_="${cur-}" sfx=" "
1833 while test $# != 0; do
1835 --tags=*) tags="${1##--tags=}" ;;
1836 --pfx=*) pfx="${1##--pfx=}" ;;
1837 --cur=*) cur_="${1##--cur=}" ;;
1838 --sfx=*) sfx="${1##--sfx=}" ;;
1844 if test -r "$tags"; then
1845 __gitcomp_direct "$(__git_match_ctag "$cur_" "$tags" "$pfx" "$sfx")"
1851 __git_has_doubledash && return
1855 __gitcomp_builtin grep
1860 case "$cword,$prev" in
1862 __git_complete_symbol && return
1873 __gitcomp_builtin help
1877 if test -n "$GIT_TESTING_ALL_COMMAND_LIST"
1879 __gitcomp "$GIT_TESTING_ALL_COMMAND_LIST $(__git --list-cmds=alias,list-guide) gitk"
1881 __gitcomp "$(__git --list-cmds=main,nohelpers,alias,list-guide) gitk"
1890 false true umask group all world everybody
1891 " "" "${cur##--shared=}"
1895 __gitcomp_builtin init
1905 __gitcomp_builtin ls-files
1910 # XXX ignore options like --modified and always suggest all cached
1912 __git_complete_index_file "--cached"
1919 __gitcomp_builtin ls-remote
1923 __gitcomp_nl "$(__git_remotes)"
1930 __gitcomp_builtin ls-tree
1938 # Options that go well for log, shortlog and gitk
1939 __git_log_common_options="
1941 --branches --tags --remotes
1942 --first-parent --merges --no-merges
1944 --max-age= --since= --after=
1945 --min-age= --until= --before=
1946 --min-parents= --max-parents=
1947 --no-min-parents --no-max-parents
1949 # Options that go well for log and gitk (not shortlog)
1950 __git_log_gitk_options="
1951 --dense --sparse --full-history
1952 --simplify-merges --simplify-by-decoration
1953 --left-right --notes --no-notes
1955 # Options that go well for log and shortlog (not gitk)
1956 __git_log_shortlog_options="
1957 --author= --committer= --grep=
1958 --all-match --invert-grep
1961 __git_log_pretty_formats="oneline short medium full fuller reference email raw format: tformat: mboxrd"
1962 __git_log_date_formats="relative iso8601 iso8601-strict rfc2822 short local default raw unix format:"
1966 __git_has_doubledash && return
1967 __git_find_repo_path
1970 if [ -f "$__git_repo_path/MERGE_HEAD" ]; then
1973 case "$prev,$cur" in
1975 return # fall back to Bash filename completion
1978 __git_complete_symbol --cur="${cur#:}" --sfx=":"
1982 __git_complete_symbol
1987 --pretty=*|--format=*)
1988 __gitcomp "$__git_log_pretty_formats $(__git_pretty_aliases)
1993 __gitcomp "$__git_log_date_formats" "" "${cur##--date=}"
1997 __gitcomp "full short no" "" "${cur##--decorate=}"
2001 __gitcomp "$__git_diff_algorithms" "" "${cur##--diff-algorithm=}"
2005 __gitcomp "$__git_diff_submodule_formats" "" "${cur##--submodule=}"
2009 __gitcomp "sorted unsorted" "" "${cur##--no-walk=}"
2014 $__git_log_common_options
2015 $__git_log_shortlog_options
2016 $__git_log_gitk_options
2017 --root --topo-order --date-order --reverse
2018 --follow --full-diff
2019 --abbrev-commit --no-abbrev-commit --abbrev=
2020 --relative-date --date=
2021 --pretty= --format= --oneline
2026 --decorate --decorate= --no-decorate
2028 --no-walk --no-walk= --do-walk
2029 --parents --children
2030 --expand-tabs --expand-tabs= --no-expand-tabs
2033 $__git_diff_common_options
2034 --pickaxe-all --pickaxe-regex
2040 return # fall back to Bash filename completion
2043 __git_complete_symbol --cur="${cur#-L:}" --sfx=":"
2047 __git_complete_symbol --pfx="-G" --cur="${cur#-G}"
2051 __git_complete_symbol --pfx="-S" --cur="${cur#-S}"
2055 __git_complete_revlist
2060 __git_complete_strategy && return
2064 __gitcomp_builtin merge
2074 __gitcomp "$__git_mergetools_common tortoisemerge" "" "${cur##--tool=}"
2078 __gitcomp "--tool= --prompt --no-prompt --gui --no-gui"
2088 __gitcomp_builtin merge-base
2099 __gitcomp_builtin mv
2104 if [ $(__git_count_arguments "mv") -gt 0 ]; then
2105 # We need to show both cached and untracked files (including
2106 # empty directories) since this may not be the last argument.
2107 __git_complete_index_file "--cached --others --directory"
2109 __git_complete_index_file "--cached"
2115 local subcommands='add append copy edit get-ref list merge prune remove show'
2116 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2118 case "$subcommand,$cur" in
2120 __gitcomp_builtin notes
2128 __gitcomp "$subcommands --ref"
2132 *,--reuse-message=*|*,--reedit-message=*)
2133 __git_complete_refs --cur="${cur#*=}"
2136 __gitcomp_builtin notes_$subcommand
2139 # this command does not take a ref, do not complete it
2155 __git_complete_strategy && return
2158 --recurse-submodules=*)
2159 __gitcomp "$__git_fetch_recurse_submodules" "" "${cur##--recurse-submodules=}"
2163 __gitcomp_builtin pull
2168 __git_complete_remote_or_refspec
2171 __git_push_recurse_submodules="check on-demand only"
2173 __git_complete_force_with_lease ()
2181 __git_complete_refs --cur="${cur_#*:}"
2184 __git_complete_refs --cur="$cur_"
2193 __gitcomp_nl "$(__git_remotes)"
2196 --recurse-submodules)
2197 __gitcomp "$__git_push_recurse_submodules"
2203 __gitcomp_nl "$(__git_remotes)" "" "${cur##--repo=}"
2206 --recurse-submodules=*)
2207 __gitcomp "$__git_push_recurse_submodules" "" "${cur##--recurse-submodules=}"
2210 --force-with-lease=*)
2211 __git_complete_force_with_lease "${cur##--force-with-lease=}"
2215 __gitcomp_builtin push
2219 __git_complete_remote_or_refspec
2227 --creation-factor= --no-dual-color
2228 $__git_diff_common_options
2233 __git_complete_revlist
2236 __git_rebase_inprogress_options="--continue --skip --abort --quit --show-current-patch"
2237 __git_rebase_interactive_inprogress_options="$__git_rebase_inprogress_options --edit-todo"
2241 __git_find_repo_path
2242 if [ -f "$__git_repo_path"/rebase-merge/interactive ]; then
2243 __gitcomp "$__git_rebase_interactive_inprogress_options"
2245 elif [ -d "$__git_repo_path"/rebase-apply ] || \
2246 [ -d "$__git_repo_path"/rebase-merge ]; then
2247 __gitcomp "$__git_rebase_inprogress_options"
2250 __git_complete_strategy && return
2253 __gitcomp "$__git_whitespacelist" "" "${cur##--whitespace=}"
2257 __git_complete_refs --cur="${cur##--onto=}"
2261 __gitcomp_builtin rebase "" \
2262 "$__git_rebase_interactive_inprogress_options"
2271 local subcommands="show delete expire"
2272 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2274 if [ -z "$subcommand" ]; then
2275 __gitcomp "$subcommands"
2281 __git_send_email_confirm_options="always never auto cc compose"
2282 __git_send_email_suppresscc_options="author self cc bodycc sob cccmd body all"
2287 --to|--cc|--bcc|--from)
2288 __gitcomp "$(__git send-email --dump-aliases)"
2296 $__git_send_email_confirm_options
2297 " "" "${cur##--confirm=}"
2302 $__git_send_email_suppresscc_options
2303 " "" "${cur##--suppress-cc=}"
2307 --smtp-encryption=*)
2308 __gitcomp "ssl tls" "" "${cur##--smtp-encryption=}"
2314 " "" "${cur##--thread=}"
2317 --to=*|--cc=*|--bcc=*|--from=*)
2318 __gitcomp "$(__git send-email --dump-aliases)" "" "${cur#--*=}"
2322 __gitcomp_builtin send-email "--annotate --bcc --cc --cc-cmd --chain-reply-to
2323 --compose --confirm= --dry-run --envelope-sender
2325 --in-reply-to --no-chain-reply-to --no-signed-off-by-cc
2326 --no-suppress-from --no-thread --quiet --reply-to
2327 --signed-off-by-cc --smtp-pass --smtp-server
2328 --smtp-server-port --smtp-encryption= --smtp-user
2329 --subject --suppress-cc= --suppress-from --thread --to
2330 --validate --no-validate
2331 $__git_format_patch_extra_options"
2335 __git_complete_revlist
2346 local untracked_state
2349 --ignore-submodules=*)
2350 __gitcomp "none untracked dirty all" "" "${cur##--ignore-submodules=}"
2353 --untracked-files=*)
2354 __gitcomp "$__git_untracked_file_modes" "" "${cur##--untracked-files=}"
2359 always never auto column row plain dense nodense
2360 " "" "${cur##--column=}"
2364 __gitcomp_builtin status
2369 untracked_state="$(__git_get_option_value "-u" "--untracked-files=" \
2370 "$__git_untracked_file_modes" "status.showUntrackedFiles")"
2372 case "$untracked_state" in
2374 # --ignored option does not matter
2378 complete_opt="--cached --directory --no-empty-directory --others"
2380 if [ -n "$(__git_find_on_cmdline "--ignored")" ]; then
2381 complete_opt="$complete_opt --ignored --exclude=*"
2386 __git_complete_index_file "$complete_opt"
2393 __gitcomp "diff3 merge" "" "${cur##--conflict=}"
2396 __gitcomp_builtin switch
2399 local dwim_opt="$(__git_checkout_default_dwim_mode)"
2400 local prevword prevword="${words[cword-1]}"
2404 # Complete local branches (and DWIM branch
2405 # remote branch names) for an option argument
2406 # specifying a new branch name. This is for
2407 # convenience, assuming new branches are
2408 # possibly based on pre-existing branch names.
2409 __git_complete_refs $dwim_opt --mode="heads"
2416 # Unlike in git checkout, git switch --orphan does not take
2417 # a start point. Thus we really have nothing to complete after
2419 if [ -n "$(__git_find_on_cmdline "--orphan")" ]; then
2423 # At this point, we've already handled special completion for
2424 # -c/-C, and --orphan. There are 3 main things left to
2426 # 1) a start-point for -c/-C or -d/--detach
2427 # 2) a remote head, for --track
2428 # 3) a branch name, possibly including DWIM remote branches
2430 if [ -n "$(__git_find_on_cmdline "-c -C -d --detach")" ]; then
2431 __git_complete_refs --mode="refs"
2432 elif [ -n "$(__git_find_on_cmdline "--track")" ]; then
2433 __git_complete_refs --mode="remote-heads"
2435 __git_complete_refs $dwim_opt --mode="heads"
2441 __git_config_get_set_variables ()
2443 local prevword word config_file= c=$cword
2444 while [ $c -gt 1 ]; do
2447 --system|--global|--local|--file=*)
2452 config_file="$word $prevword"
2460 __git config $config_file --name-only --list
2464 __git_compute_config_vars ()
2466 test -n "$__git_config_vars" ||
2467 __git_config_vars="$(git help --config-for-completion | sort -u)"
2470 # Completes possible values of various configuration variables.
2472 # Usage: __git_complete_config_variable_value [<option>]...
2473 # --varname=<word>: The name of the configuration variable whose value is
2474 # to be completed. Defaults to the previous word on the
2476 # --cur=<word>: The current value to be completed. Defaults to the current
2477 # word to be completed.
2478 __git_complete_config_variable_value ()
2480 local varname="$prev" cur_="$cur"
2482 while test $# != 0; do
2484 --varname=*) varname="${1##--varname=}" ;;
2485 --cur=*) cur_="${1##--cur=}" ;;
2491 if [ "${BASH_VERSINFO[0]:-0}" -ge 4 ]; then
2492 varname="${varname,,}"
2494 varname="$(echo "$varname" |tr A-Z a-z)"
2498 branch.*.remote|branch.*.pushremote)
2499 __gitcomp_nl "$(__git_remotes)" "" "$cur_"
2503 __git_complete_refs --cur="$cur_"
2507 __gitcomp "false true merges preserve interactive" "" "$cur_"
2511 __gitcomp_nl "$(__git_remotes)" "" "$cur_"
2515 local remote="${varname#remote.}"
2516 remote="${remote%.fetch}"
2517 if [ -z "$cur_" ]; then
2518 __gitcomp_nl "refs/heads/" "" "" ""
2521 __gitcomp_nl "$(__git_refs_remotes "$remote")" "" "$cur_"
2525 local remote="${varname#remote.}"
2526 remote="${remote%.push}"
2527 __gitcomp_nl "$(__git for-each-ref \
2528 --format='%(refname):%(refname)' refs/heads)" "" "$cur_"
2531 pull.twohead|pull.octopus)
2532 __git_compute_merge_strategies
2533 __gitcomp "$__git_merge_strategies" "" "$cur_"
2537 __gitcomp "false true" "" "$cur_"
2542 normal black red green yellow blue magenta cyan white
2543 bold dim ul blink reverse
2548 __gitcomp "false true always never auto" "" "$cur_"
2552 __gitcomp "$__git_diff_submodule_formats" "" "$cur_"
2556 __gitcomp "man info web html" "" "$cur_"
2560 __gitcomp "$__git_log_date_formats" "" "$cur_"
2563 sendemail.aliasfiletype)
2564 __gitcomp "mutt mailrc pine elm gnus" "" "$cur_"
2568 __gitcomp "$__git_send_email_confirm_options" "" "$cur_"
2571 sendemail.suppresscc)
2572 __gitcomp "$__git_send_email_suppresscc_options" "" "$cur_"
2575 sendemail.transferencoding)
2576 __gitcomp "7bit 8bit quoted-printable base64" "" "$cur_"
2585 # Completes configuration sections, subsections, variable names.
2587 # Usage: __git_complete_config_variable_name [<option>]...
2588 # --cur=<word>: The current configuration section/variable name to be
2589 # completed. Defaults to the current word to be completed.
2590 # --sfx=<suffix>: A suffix to be appended to each fully completed
2591 # configuration variable name (but not to sections or
2592 # subsections) instead of the default space.
2593 __git_complete_config_variable_name ()
2595 local cur_="$cur" sfx
2597 while test $# != 0; do
2599 --cur=*) cur_="${1##--cur=}" ;;
2600 --sfx=*) sfx="${1##--sfx=}" ;;
2608 local pfx="${cur_%.*}."
2610 __gitcomp "remote pushRemote merge mergeOptions rebase" "$pfx" "$cur_" "$sfx"
2614 local pfx="${cur%.*}."
2616 __gitcomp_direct "$(__git_heads "$pfx" "$cur_" ".")"
2617 __gitcomp_nl_append $'autoSetupMerge\nautoSetupRebase\n' "$pfx" "$cur_" "$sfx"
2621 local pfx="${cur_%.*}."
2624 argPrompt cmd confirm needsFile noConsole noRescan
2625 prompt revPrompt revUnmerged title
2626 " "$pfx" "$cur_" "$sfx"
2630 local pfx="${cur_%.*}."
2632 __gitcomp "cmd path" "$pfx" "$cur_" "$sfx"
2636 local pfx="${cur_%.*}."
2638 __gitcomp "cmd path" "$pfx" "$cur_" "$sfx"
2642 local pfx="${cur_%.*}."
2644 __gitcomp "cmd path trustExitCode" "$pfx" "$cur_" "$sfx"
2648 local pfx="${cur_%.*}."
2650 __git_compute_all_commands
2651 __gitcomp_nl "$__git_all_commands" "$pfx" "$cur_" "$sfx"
2655 local pfx="${cur_%.*}."
2658 url proxy fetch push mirror skipDefaultUpdate
2659 receivepack uploadpack tagOpt pushurl
2660 " "$pfx" "$cur_" "$sfx"
2664 local pfx="${cur_%.*}."
2666 __gitcomp_nl "$(__git_remotes)" "$pfx" "$cur_" "."
2667 __gitcomp_nl_append "pushDefault" "$pfx" "$cur_" "$sfx"
2671 local pfx="${cur_%.*}."
2673 __gitcomp "insteadOf pushInsteadOf" "$pfx" "$cur_" "$sfx"
2677 __git_compute_config_vars
2678 __gitcomp "$__git_config_vars" "" "$cur_" "$sfx"
2681 __git_compute_config_vars
2682 __gitcomp "$(echo "$__git_config_vars" |
2695 # Completes '='-separated configuration sections/variable names and values
2696 # for 'git -c section.name=value'.
2698 # Usage: __git_complete_config_variable_name_and_value [<option>]...
2699 # --cur=<word>: The current configuration section/variable name/value to be
2700 # completed. Defaults to the current word to be completed.
2701 __git_complete_config_variable_name_and_value ()
2705 while test $# != 0; do
2707 --cur=*) cur_="${1##--cur=}" ;;
2715 __git_complete_config_variable_value \
2716 --varname="${cur_%%=*}" --cur="${cur_#*=}"
2719 __git_complete_config_variable_name --cur="$cur_" --sfx='='
2727 --get|--get-all|--unset|--unset-all)
2728 __gitcomp_nl "$(__git_config_get_set_variables)"
2732 __git_complete_config_variable_value
2738 __gitcomp_builtin config
2741 __git_complete_config_variable_name
2749 add rename remove set-head set-branches
2750 get-url set-url show prune update
2752 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2753 if [ -z "$subcommand" ]; then
2756 __gitcomp_builtin remote
2759 __gitcomp "$subcommands"
2765 case "$subcommand,$cur" in
2767 __gitcomp_builtin remote_add
2772 __gitcomp_builtin remote_set-head
2775 __gitcomp_builtin remote_set-branches
2777 set-head,*|set-branches,*)
2778 __git_complete_remote_or_refspec
2781 __gitcomp_builtin remote_update
2784 __gitcomp "$(__git_remotes) $(__git_get_config_variables "remotes")"
2787 __gitcomp_builtin remote_set-url
2790 __gitcomp_builtin remote_get-url
2793 __gitcomp_builtin remote_prune
2796 __gitcomp_nl "$(__git_remotes)"
2805 __gitcomp "short medium long" "" "${cur##--format=}"
2809 __gitcomp_builtin replace
2818 local subcommands="clear forget diff remaining status gc"
2819 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2820 if test -z "$subcommand"
2822 __gitcomp "$subcommands"
2829 __git_has_doubledash && return
2833 __gitcomp_builtin reset
2844 __gitcomp "diff3 merge" "" "${cur##--conflict=}"
2847 __git_complete_refs --cur="${cur##--source=}"
2850 __gitcomp_builtin restore
2855 __git_revert_inprogress_options=$__git_sequencer_inprogress_options
2859 __git_find_repo_path
2860 if [ -f "$__git_repo_path"/REVERT_HEAD ]; then
2861 __gitcomp "$__git_revert_inprogress_options"
2864 __git_complete_strategy && return
2867 __gitcomp_builtin revert "" \
2868 "$__git_revert_inprogress_options"
2879 __gitcomp_builtin rm
2884 __git_complete_index_file "--cached"
2889 __git_has_doubledash && return
2894 $__git_log_common_options
2895 $__git_log_shortlog_options
2896 --numbered --summary --email
2901 __git_complete_revlist
2906 __git_has_doubledash && return
2909 --pretty=*|--format=*)
2910 __gitcomp "$__git_log_pretty_formats $(__git_pretty_aliases)
2915 __gitcomp "$__git_diff_algorithms" "" "${cur##--diff-algorithm=}"
2919 __gitcomp "$__git_diff_submodule_formats" "" "${cur##--submodule=}"
2923 __gitcomp "$__git_color_moved_opts" "" "${cur##--color-moved=}"
2927 __gitcomp "$__git_color_moved_ws_opts" "" "${cur##--color-moved-ws=}"
2931 __gitcomp "--pretty= --format= --abbrev-commit --no-abbrev-commit
2932 --oneline --show-signature --patch
2933 --expand-tabs --expand-tabs= --no-expand-tabs
2934 $__git_diff_common_options
2939 __git_complete_revlist_file
2946 __gitcomp_builtin show-branch
2950 __git_complete_revlist
2953 _git_sparse_checkout ()
2955 local subcommands="list init set disable"
2956 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2957 if [ -z "$subcommand" ]; then
2958 __gitcomp "$subcommands"
2962 case "$subcommand,$cur" in
2976 local save_opts='--all --keep-index --no-keep-index --quiet --patch --include-untracked'
2977 local subcommands='push list show apply clear drop pop create branch'
2978 local subcommand="$(__git_find_on_cmdline "$subcommands save")"
2979 if [ -z "$subcommand" -a -n "$(__git_find_on_cmdline "-p")" ]; then
2982 if [ -z "$subcommand" ]; then
2985 __gitcomp "$save_opts"
2988 if [ -z "$(__git_find_on_cmdline "$save_opts")" ]; then
2993 if [ -z "$(__git_find_on_cmdline "$save_opts")" ]; then
2994 __gitcomp "$subcommands"
2999 case "$subcommand,$cur" in
3001 __gitcomp "$save_opts --message"
3004 __gitcomp "$save_opts"
3007 __gitcomp "--index --quiet"
3013 __gitcomp "--name-status --oneline --patch-with-stat"
3015 show,--*|branch,--*)
3018 if [ $cword -eq 3 ]; then
3021 __gitcomp_nl "$(__git stash list \
3022 | sed -n -e 's/:.*//p')"
3025 show,*|apply,*|drop,*|pop,*)
3026 __gitcomp_nl "$(__git stash list \
3027 | sed -n -e 's/:.*//p')"
3037 __git_has_doubledash && return
3039 local subcommands="add status init deinit update set-branch set-url summary foreach sync absorbgitdirs"
3040 local subcommand="$(__git_find_on_cmdline "$subcommands")"
3041 if [ -z "$subcommand" ]; then
3047 __gitcomp "$subcommands"
3053 case "$subcommand,$cur" in
3055 __gitcomp "--branch --force --name --reference --depth"
3058 __gitcomp "--cached --recursive"
3061 __gitcomp "--force --all"
3065 --init --remote --no-fetch
3066 --recommend-shallow --no-recommend-shallow
3067 --force --rebase --merge --reference --depth --recursive --jobs
3071 __gitcomp "--default --branch"
3074 __gitcomp "--cached --files --summary-limit"
3076 foreach,--*|sync,--*)
3077 __gitcomp "--recursive"
3087 init fetch clone rebase dcommit log find-rev
3088 set-tree commit-diff info create-ignore propget
3089 proplist show-ignore show-externals branch tag blame
3090 migrate mkdirs reset gc
3092 local subcommand="$(__git_find_on_cmdline "$subcommands")"
3093 if [ -z "$subcommand" ]; then
3094 __gitcomp "$subcommands"
3096 local remote_opts="--username= --config-dir= --no-auth-cache"
3098 --follow-parent --authors-file= --repack=
3099 --no-metadata --use-svm-props --use-svnsync-props
3100 --log-window-size= --no-checkout --quiet
3101 --repack-flags --use-log-author --localtime
3104 --ignore-paths= --include-paths= $remote_opts
3107 --template= --shared= --trunk= --tags=
3108 --branches= --stdlayout --minimize-url
3109 --no-metadata --use-svm-props --use-svnsync-props
3110 --rewrite-root= --prefix= $remote_opts
3113 --edit --rmdir --find-copies-harder --copy-similarity=
3116 case "$subcommand,$cur" in
3118 __gitcomp "--revision= --fetch-all $fc_opts"
3121 __gitcomp "--revision= $fc_opts $init_opts"
3124 __gitcomp "$init_opts"
3128 --merge --strategy= --verbose --dry-run
3129 --fetch-all --no-rebase --commit-url
3130 --revision --interactive $cmt_opts $fc_opts
3134 __gitcomp "--stdin $cmt_opts $fc_opts"
3136 create-ignore,--*|propget,--*|proplist,--*|show-ignore,--*|\
3137 show-externals,--*|mkdirs,--*)
3138 __gitcomp "--revision="
3142 --limit= --revision= --verbose --incremental
3143 --oneline --show-commit --non-recursive
3144 --authors-file= --color
3149 --merge --verbose --strategy= --local
3150 --fetch-all --dry-run $fc_opts
3154 __gitcomp "--message= --file= --revision= $cmt_opts"
3160 __gitcomp "--dry-run --message --tag"
3163 __gitcomp "--dry-run --message"
3166 __gitcomp "--git-format"
3170 --config-dir= --ignore-paths= --minimize
3171 --no-auth-cache --username=
3175 __gitcomp "--revision= --parent"
3186 while [ $c -lt $cword ]; do
3189 -d|--delete|-v|--verify)
3190 __gitcomp_direct "$(__git_tags "" "$cur" " ")"
3205 __gitcomp_direct "$(__git_tags "" "$cur" " ")"
3215 __gitcomp_builtin tag
3225 __git_complete_worktree_paths ()
3228 __gitcomp_nl "$(git worktree list --porcelain |
3229 # Skip the first entry: it's the path of the main worktree,
3230 # which can't be moved, removed, locked, etc.
3231 sed -n -e '2,$ s/^worktree //p')"
3236 local subcommands="add list lock move prune remove unlock"
3237 local subcommand subcommand_idx
3239 subcommand="$(__git_find_on_cmdline --show-idx "$subcommands")"
3240 subcommand_idx="${subcommand% *}"
3241 subcommand="${subcommand#* }"
3243 case "$subcommand,$cur" in
3245 __gitcomp "$subcommands"
3248 __gitcomp_builtin worktree_$subcommand
3250 add,*) # usage: git worktree add [<options>] <path> [<commit-ish>]
3251 # Here we are not completing an --option, it's either the
3254 -b|-B) # Complete refs for branch to be created/reseted.
3257 -*) # The previous word is an -o|--option without an
3258 # unstuck argument: have to complete the path for
3259 # the new worktree, so don't list anything, but let
3260 # Bash fall back to filename completion.
3262 *) # The previous word is not an --option, so it must
3263 # be either the 'add' subcommand, the unstuck
3264 # argument of an option (e.g. branch for -b|-B), or
3265 # the path for the new worktree.
3266 if [ $cword -eq $((subcommand_idx+1)) ]; then
3267 # Right after the 'add' subcommand: have to
3268 # complete the path, so fall back to Bash
3269 # filename completion.
3272 case "${words[cword-2]}" in
3273 -b|-B) # After '-b <branch>': have to
3274 # complete the path, so fall back
3275 # to Bash filename completion.
3277 *) # After the path: have to complete
3278 # the ref to be checked out.
3286 lock,*|remove,*|unlock,*)
3287 __git_complete_worktree_paths
3290 if [ $cword -eq $((subcommand_idx+1)) ]; then
3291 # The first parameter must be an existing working
3293 __git_complete_worktree_paths
3295 # The second parameter is the destination: it could
3296 # be any path, so don't list anything, but let Bash
3297 # fall back to filename completion.
3304 __git_complete_common () {
3309 __gitcomp_builtin "$command"
3314 __git_cmds_with_parseopt_helper=
3315 __git_support_parseopt_helper () {
3316 test -n "$__git_cmds_with_parseopt_helper" ||
3317 __git_cmds_with_parseopt_helper="$(__git --list-cmds=parseopt)"
3319 case " $__git_cmds_with_parseopt_helper " in
3329 __git_complete_command () {
3331 local completion_func="_git_${command//-/_}"
3332 if ! declare -f $completion_func >/dev/null 2>/dev/null &&
3333 declare -f _completion_loader >/dev/null 2>/dev/null
3335 _completion_loader "git-$command"
3337 if declare -f $completion_func >/dev/null 2>/dev/null
3341 elif __git_support_parseopt_helper "$command"
3343 __git_complete_common "$command"
3352 local i c=1 command __git_dir __git_repo_path
3353 local __git_C_args C_args_count=0
3355 while [ $c -lt $cword ]; do
3358 --git-dir=*) __git_dir="${i#--git-dir=}" ;;
3359 --git-dir) ((c++)) ; __git_dir="${words[c]}" ;;
3360 --bare) __git_dir="." ;;
3361 --help) command="help"; break ;;
3362 -c|--work-tree|--namespace) ((c++)) ;;
3363 -C) __git_C_args[C_args_count++]=-C
3365 __git_C_args[C_args_count++]="${words[c]}"
3368 *) command="$i"; break ;;
3373 if [ -z "${command-}" ]; then
3375 --git-dir|-C|--work-tree)
3376 # these need a path argument, let's fall back to
3377 # Bash filename completion
3381 __git_complete_config_variable_name_and_value
3385 # we don't support completing these options' arguments
3403 --no-replace-objects
3408 if test -n "${GIT_TESTING_PORCELAIN_COMMAND_LIST-}"
3410 __gitcomp "$GIT_TESTING_PORCELAIN_COMMAND_LIST"
3412 __gitcomp "$(__git --list-cmds=list-mainporcelain,others,nohelpers,alias,list-complete,config)"
3419 __git_complete_command "$command" && return
3421 local expansion=$(__git_aliased_command "$command")
3422 if [ -n "$expansion" ]; then
3424 __git_complete_command "$expansion"
3430 __git_has_doubledash && return
3432 local __git_repo_path
3433 __git_find_repo_path
3436 if [ -f "$__git_repo_path/MERGE_HEAD" ]; then
3442 $__git_log_common_options
3443 $__git_log_gitk_options
3449 __git_complete_revlist
3452 if [[ -n ${ZSH_VERSION-} ]] &&
3453 # Don't define these functions when sourced from 'git-completion.zsh',
3454 # it has its own implementations.
3455 [[ -z ${GIT_SOURCING_ZSH_COMPLETION-} ]]; then
3456 echo "WARNING: this script is deprecated, please see git-completion.zsh" 1>&2
3458 autoload -U +X compinit && compinit
3464 local cur_="${3-$cur}"
3470 local c IFS=$' \t\n'
3478 array[${#array[@]}+1]="$c"
3481 compadd -Q -S '' -p "${2-}" -a -- array && _ret=0
3492 compadd -Q -- ${=1} && _ret=0
3501 compadd -Q -S "${4- }" -p "${2-}" -- ${=1} && _ret=0
3504 __gitcomp_file_direct ()
3510 compadd -f -- ${=1} && _ret=0
3519 compadd -p "${2-}" -f -- ${=1} && _ret=0
3524 local _ret=1 cur cword prev
3525 cur=${words[CURRENT]}
3526 prev=${words[CURRENT-1]}
3528 emulate ksh -c __${service}_main
3529 let _ret && _default && _ret=0
3533 compdef _git git gitk
3539 local cur words cword prev
3540 _get_comp_words_by_ref -n =: cur words cword prev
3544 # Setup completion for certain functions defined above by setting common
3545 # variables and workarounds.
3546 # This is NOT a public function; use at your own risk.
3549 local wrapper="__git_wrap${2}"
3550 eval "$wrapper () { __git_func_wrap $2 ; }"
3551 complete -o bashdefault -o default -o nospace -F $wrapper $1 2>/dev/null \
3552 || complete -o default -o nospace -F $wrapper $1
3555 # wrapper for backwards compatibility
3558 __git_wrap__git_main
3561 # wrapper for backwards compatibility
3564 __git_wrap__gitk_main
3567 __git_complete git __git_main
3568 __git_complete gitk __gitk_main
3570 # The following are necessary only for Cygwin, and only are needed
3571 # when the user has tab-completed the executable name and consequently
3572 # included the '.exe' suffix.
3574 if [ Cygwin = "$(uname -o 2>/dev/null)" ]; then
3575 __git_complete git.exe __git_main