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 case "$COMP_WORDBREAKS" in
45 *) COMP_WORDBREAKS="$COMP_WORDBREAKS:"
48 # Discovers the path to the git repository taking any '--git-dir=<path>' and
49 # '-C <path>' options into account and stores it in the $__git_repo_path
51 __git_find_repo_path ()
53 if [ -n "$__git_repo_path" ]; then
54 # we already know where it is
58 if [ -n "${__git_C_args-}" ]; then
59 __git_repo_path="$(git "${__git_C_args[@]}" \
60 ${__git_dir:+--git-dir="$__git_dir"} \
61 rev-parse --absolute-git-dir 2>/dev/null)"
62 elif [ -n "${__git_dir-}" ]; then
63 test -d "$__git_dir" &&
64 __git_repo_path="$__git_dir"
65 elif [ -n "${GIT_DIR-}" ]; then
66 test -d "${GIT_DIR-}" &&
67 __git_repo_path="$GIT_DIR"
68 elif [ -d .git ]; then
71 __git_repo_path="$(git rev-parse --git-dir 2>/dev/null)"
75 # Deprecated: use __git_find_repo_path() and $__git_repo_path instead
76 # __gitdir accepts 0 or 1 arguments (i.e., location)
77 # returns location of .git repo
80 if [ -z "${1-}" ]; then
81 __git_find_repo_path || return 1
82 echo "$__git_repo_path"
83 elif [ -d "$1/.git" ]; then
90 # Runs git with all the options given as argument, respecting any
91 # '--git-dir=<path>' and '-C <path>' options present on the command line
94 git ${__git_C_args:+"${__git_C_args[@]}"} \
95 ${__git_dir:+--git-dir="$__git_dir"} "$@" 2>/dev/null
98 # Removes backslash escaping, single quotes and double quotes from a word,
99 # stores the result in the variable $dequoted_word.
100 # 1: The word to dequote.
103 local rest="$1" len ch
107 while test -n "$rest"; do
108 len=${#dequoted_word}
109 dequoted_word="$dequoted_word${rest%%[\\\'\"]*}"
110 rest="${rest:$((${#dequoted_word}-$len))}"
112 case "${rest:0:1}" in
119 dequoted_word="$dequoted_word$ch"
126 len=${#dequoted_word}
127 dequoted_word="$dequoted_word${rest%%\'*}"
128 rest="${rest:$((${#dequoted_word}-$len+1))}"
132 while test -n "$rest" ; do
133 len=${#dequoted_word}
134 dequoted_word="$dequoted_word${rest%%[\\\"]*}"
135 rest="${rest:$((${#dequoted_word}-$len))}"
136 case "${rest:0:1}" in
141 dequoted_word="$dequoted_word$ch"
146 dequoted_word="$dequoted_word\\$ch"
162 # The following function is based on code from:
164 # bash_completion - programmable completion functions for bash 3.2+
166 # Copyright © 2006-2008, Ian Macdonald <ian@caliban.org>
167 # © 2009-2010, Bash Completion Maintainers
168 # <bash-completion-devel@lists.alioth.debian.org>
170 # This program is free software; you can redistribute it and/or modify
171 # it under the terms of the GNU General Public License as published by
172 # the Free Software Foundation; either version 2, or (at your option)
175 # This program is distributed in the hope that it will be useful,
176 # but WITHOUT ANY WARRANTY; without even the implied warranty of
177 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
178 # GNU General Public License for more details.
180 # You should have received a copy of the GNU General Public License
181 # along with this program; if not, see <http://www.gnu.org/licenses/>.
183 # The latest version of this software can be obtained here:
185 # http://bash-completion.alioth.debian.org/
189 # This function can be used to access a tokenized list of words
190 # on the command line:
192 # __git_reassemble_comp_words_by_ref '=:'
193 # if test "${words_[cword_-1]}" = -w
198 # The argument should be a collection of characters from the list of
199 # word completion separators (COMP_WORDBREAKS) to treat as ordinary
202 # This is roughly equivalent to going back in time and setting
203 # COMP_WORDBREAKS to exclude those characters. The intent is to
204 # make option types like --date=<type> and <rev>:<path> easy to
205 # recognize by treating each shell word as a single token.
207 # It is best not to set COMP_WORDBREAKS directly because the value is
208 # shared with other completion scripts. By the time the completion
209 # function gets called, COMP_WORDS has already been populated so local
210 # changes to COMP_WORDBREAKS have no effect.
212 # Output: words_, cword_, cur_.
214 __git_reassemble_comp_words_by_ref()
216 local exclude i j first
217 # Which word separators to exclude?
218 exclude="${1//[^$COMP_WORDBREAKS]}"
220 if [ -z "$exclude" ]; then
221 words_=("${COMP_WORDS[@]}")
224 # List of word completion separators has shrunk;
225 # re-assemble words to complete.
226 for ((i=0, j=0; i < ${#COMP_WORDS[@]}; i++, j++)); do
227 # Append each nonempty word consisting of just
228 # word separator characters to the current word.
232 [ -n "${COMP_WORDS[$i]}" ] &&
233 # word consists of excluded word separators
234 [ "${COMP_WORDS[$i]//[^$exclude]}" = "${COMP_WORDS[$i]}" ]
236 # Attach to the previous token,
237 # unless the previous token is the command name.
238 if [ $j -ge 2 ] && [ -n "$first" ]; then
242 words_[$j]=${words_[j]}${COMP_WORDS[i]}
243 if [ $i = $COMP_CWORD ]; then
246 if (($i < ${#COMP_WORDS[@]} - 1)); then
253 words_[$j]=${words_[j]}${COMP_WORDS[i]}
254 if [ $i = $COMP_CWORD ]; then
260 if ! type _get_comp_words_by_ref >/dev/null 2>&1; then
261 _get_comp_words_by_ref ()
263 local exclude cur_ words_ cword_
264 if [ "$1" = "-n" ]; then
268 __git_reassemble_comp_words_by_ref "$exclude"
269 cur_=${words_[cword_]}
270 while [ $# -gt 0 ]; do
276 prev=${words_[$cword_-1]}
279 words=("${words_[@]}")
290 # Fills the COMPREPLY array with prefiltered words without any additional
292 # Callers must take care of providing only words that match the current word
293 # to be completed and adding any prefix and/or suffix (trailing space!), if
295 # 1: List of newline-separated matching completion words, complete with
304 # Similar to __gitcomp_direct, but appends to COMPREPLY instead.
305 # Callers must take care of providing only words that match the current word
306 # to be completed and adding any prefix and/or suffix (trailing space!), if
308 # 1: List of newline-separated matching completion words, complete with
310 __gitcomp_direct_append ()
319 local x i=${#COMPREPLY[@]}
321 if [[ "$x" == "$3"* ]]; then
322 COMPREPLY[i++]="$2$x$4"
333 # Generates completion reply, appending a space to possible completion words,
335 # It accepts 1 to 4 arguments:
336 # 1: List of possible completion words.
337 # 2: A prefix to be added to each possible completion word (optional).
338 # 3: Generate possible completion matches for this word (optional).
339 # 4: A suffix to be appended to each possible completion word (optional).
342 local cur_="${3-$cur}"
348 local c i=0 IFS=$' \t\n'
350 if [[ $c == "--" ]]; then
354 if [[ $c == "$cur_"* ]]; then
359 COMPREPLY[i++]="${2-}$c"
364 local c i=0 IFS=$' \t\n'
366 if [[ $c == "--" ]]; then
368 if [[ $c == "$cur_"* ]]; then
369 COMPREPLY[i++]="${2-}$c "
374 if [[ $c == "$cur_"* ]]; then
379 COMPREPLY[i++]="${2-}$c"
386 # Clear the variables caching builtins' options when (re-)sourcing
387 # the completion script.
388 if [[ -n ${ZSH_VERSION-} ]]; then
389 unset $(set |sed -ne 's/^\(__gitcomp_builtin_[a-zA-Z0-9_][a-zA-Z0-9_]*\)=.*/\1/p') 2>/dev/null
391 unset $(compgen -v __gitcomp_builtin_)
394 # This function is equivalent to
396 # __gitcomp "$(git xxx --git-completion-helper) ..."
398 # except that the output is cached. Accept 1-3 arguments:
399 # 1: the git command to execute, this is also the cache key
400 # 2: extra options to be added on top (e.g. negative forms)
401 # 3: options to be excluded
404 # spaces must be replaced with underscore for multi-word
405 # commands, e.g. "git remote add" becomes remote_add.
410 local var=__gitcomp_builtin_"${cmd/-/_}"
412 eval "options=\$$var"
414 if [ -z "$options" ]; then
415 # leading and trailing spaces are significant to make
416 # option removal work correctly.
417 options=" $incl $(__git ${cmd/_/ } --git-completion-helper) " || return
420 options="${options/ $i / }"
422 eval "$var=\"$options\""
428 # Variation of __gitcomp_nl () that appends to the existing list of
429 # completion candidates, COMPREPLY.
430 __gitcomp_nl_append ()
433 __gitcompappend "$1" "${2-}" "${3-$cur}" "${4- }"
436 # Generates completion reply from newline-separated possible completion words
437 # by appending a space to all of them.
438 # It accepts 1 to 4 arguments:
439 # 1: List of possible completion words, separated by a single newline.
440 # 2: A prefix to be added to each possible completion word (optional).
441 # 3: Generate possible completion matches for this word (optional).
442 # 4: A suffix to be appended to each possible completion word instead of
443 # the default space (optional). If specified but empty, nothing is
448 __gitcomp_nl_append "$@"
451 # Fills the COMPREPLY array with prefiltered paths without any additional
453 # Callers must take care of providing only paths that match the current path
454 # to be completed and adding any prefix path components, if necessary.
455 # 1: List of newline-separated matching paths, complete with all prefix
457 __gitcomp_file_direct ()
463 # use a hack to enable file mode in bash < 4
464 compopt -o filenames +o nospace 2>/dev/null ||
465 compgen -f /non-existing-dir/ >/dev/null ||
469 # Generates completion reply with compgen from newline-separated possible
470 # completion filenames.
471 # It accepts 1 to 3 arguments:
472 # 1: List of possible completion filenames, separated by a single newline.
473 # 2: A directory prefix to be added to each possible completion filename
475 # 3: Generate possible completion matches for this word (optional).
480 # XXX does not work when the directory prefix contains a tilde,
481 # since tilde expansion is not applied.
482 # This means that COMPREPLY will be empty and Bash default
483 # completion will be used.
484 __gitcompadd "$1" "${2-}" "${3-$cur}" ""
486 # use a hack to enable file mode in bash < 4
487 compopt -o filenames +o nospace 2>/dev/null ||
488 compgen -f /non-existing-dir/ >/dev/null ||
492 # Execute 'git ls-files', unless the --committable option is specified, in
493 # which case it runs 'git diff-index' to find out the files that can be
494 # committed. It return paths relative to the directory specified in the first
495 # argument, and using the options specified in the second argument.
496 __git_ls_files_helper ()
498 if [ "$2" == "--committable" ]; then
499 __git -C "$1" -c core.quotePath=false diff-index \
500 --name-only --relative HEAD -- "${3//\\/\\\\}*"
502 # NOTE: $2 is not quoted in order to support multiple options
503 __git -C "$1" -c core.quotePath=false ls-files \
504 --exclude-standard $2 -- "${3//\\/\\\\}*"
509 # __git_index_files accepts 1 or 2 arguments:
510 # 1: Options to pass to ls-files (required).
511 # 2: A directory path (optional).
512 # If provided, only files within the specified directory are listed.
513 # Sub directories are never recursed. Path must have a trailing
515 # 3: List only paths matching this path component (optional).
518 local root="$2" match="$3"
520 __git_ls_files_helper "$root" "$1" "$match" |
521 awk -F / -v pfx="${2//\\/\\\\}" '{
526 if (substr(p, 1, 1) != "\"") {
527 # No special characters, easy!
532 # The path is quoted.
537 # Even when a directory name itself does not contain
538 # any special characters, it will still be quoted if
539 # any of its (stripped) trailing path components do.
540 # Because of this we may have seen the same directory
541 # both quoted and unquoted.
543 # We have seen the same directory unquoted,
550 function dequote(p, bs_idx, out, esc, esc_idx, dec) {
551 # Skip opening double quote.
554 # Interpret backslash escape sequences.
555 while ((bs_idx = index(p, "\\")) != 0) {
556 out = out substr(p, 1, bs_idx - 1)
557 esc = substr(p, bs_idx + 1, 1)
558 p = substr(p, bs_idx + 2)
560 if ((esc_idx = index("abtvfr\"\\", esc)) != 0) {
561 # C-style one-character escape sequence.
562 out = out substr("\a\b\t\v\f\r\"\\",
564 } else if (esc == "n") {
565 # Uh-oh, a newline character.
566 # We cannot reliably put a pathname
567 # containing a newline into COMPREPLY,
568 # and the newline would create a mess.
572 # Must be a \nnn octal value, then.
574 substr(p, 1, 1) * 8 + \
576 out = out sprintf("%c", dec)
580 # Drop closing double quote, if there is one.
581 # (There is not any if this is a directory, as it was
582 # already stripped with the trailing path components.)
583 if (substr(p, length(p), 1) == "\"")
584 out = out substr(p, 1, length(p) - 1)
592 # __git_complete_index_file requires 1 argument:
593 # 1: the options to pass to ls-file
595 # The exception is --committable, which finds the files appropriate commit.
596 __git_complete_index_file ()
598 local dequoted_word pfx="" cur_
602 case "$dequoted_word" in
604 pfx="${dequoted_word%/*}/"
605 cur_="${dequoted_word##*/}"
608 cur_="$dequoted_word"
611 __gitcomp_file_direct "$(__git_index_files "$1" "$pfx" "$cur_")"
614 # Lists branches from the local repository.
615 # 1: A prefix to be added to each listed branch (optional).
616 # 2: List only branches matching this word (optional; list all branches if
618 # 3: A suffix to be appended to each listed branch (optional).
621 local pfx="${1-}" cur_="${2-}" sfx="${3-}"
623 __git for-each-ref --format="${pfx//\%/%%}%(refname:strip=2)$sfx" \
624 "refs/heads/$cur_*" "refs/heads/$cur_*/**"
627 # Lists tags from the local repository.
628 # Accepts the same positional parameters as __git_heads() above.
631 local pfx="${1-}" cur_="${2-}" sfx="${3-}"
633 __git for-each-ref --format="${pfx//\%/%%}%(refname:strip=2)$sfx" \
634 "refs/tags/$cur_*" "refs/tags/$cur_*/**"
637 # List unique branches from refs/remotes used for 'git checkout' and 'git
638 # switch' tracking DWIMery.
639 # 1: A prefix to be added to each listed branch (optional)
640 # 2: List only branches matching this word (optional; list all branches if
642 # 3: A suffix to be appended to each listed branch (optional).
643 __git_dwim_remote_heads ()
645 local pfx="${1-}" cur_="${2-}" sfx="${3-}"
646 local fer_pfx="${pfx//\%/%%}" # "escape" for-each-ref format specifiers
648 # employ the heuristic used by git checkout and git switch
649 # Try to find a remote branch that cur_es the completion word
650 # but only output if the branch name is unique
651 __git for-each-ref --format="$fer_pfx%(refname:strip=3)$sfx" \
652 --sort="refname:strip=3" \
653 "refs/remotes/*/$cur_*" "refs/remotes/*/$cur_*/**" | \
657 # Lists refs from the local (by default) or from a remote repository.
658 # It accepts 0, 1 or 2 arguments:
659 # 1: The remote to list refs from (optional; ignored, if set but empty).
660 # Can be the name of a configured remote, a path, or a URL.
661 # 2: In addition to local refs, list unique branches from refs/remotes/ for
662 # 'git checkout's tracking DWIMery (optional; ignored, if set but empty).
663 # 3: A prefix to be added to each listed ref (optional).
664 # 4: List only refs matching this word (optional; list all refs if unset or
666 # 5: A suffix to be appended to each listed ref (optional; ignored, if set
669 # Use __git_complete_refs() instead.
672 local i hash dir track="${2-}"
673 local list_refs_from=path remote="${1-}"
675 local pfx="${3-}" cur_="${4-$cur}" sfx="${5-}"
677 local fer_pfx="${pfx//\%/%%}" # "escape" for-each-ref format specifiers
680 dir="$__git_repo_path"
682 if [ -z "$remote" ]; then
683 if [ -z "$dir" ]; then
687 if __git_is_configured_remote "$remote"; then
688 # configured remote takes precedence over a
689 # local directory with the same name
690 list_refs_from=remote
691 elif [ -d "$remote/.git" ]; then
693 elif [ -d "$remote" ]; then
700 if [ "$list_refs_from" = path ]; then
701 if [[ "$cur_" == ^* ]]; then
710 refs=("$match*" "$match*/**")
714 for i in HEAD FETCH_HEAD ORIG_HEAD MERGE_HEAD REBASE_HEAD; do
717 if [ -e "$dir/$i" ]; then
723 format="refname:strip=2"
724 refs=("refs/tags/$match*" "refs/tags/$match*/**"
725 "refs/heads/$match*" "refs/heads/$match*/**"
726 "refs/remotes/$match*" "refs/remotes/$match*/**")
729 __git_dir="$dir" __git for-each-ref --format="$fer_pfx%($format)$sfx" \
731 if [ -n "$track" ]; then
732 __git_dwim_remote_heads "$pfx" "$match" "$sfx"
738 __git ls-remote "$remote" "$match*" | \
739 while read -r hash i; do
742 *) echo "$pfx$i$sfx" ;;
747 if [ "$list_refs_from" = remote ]; then
749 $match*) echo "${pfx}HEAD$sfx" ;;
751 __git for-each-ref --format="$fer_pfx%(refname:strip=3)$sfx" \
752 "refs/remotes/$remote/$match*" \
753 "refs/remotes/$remote/$match*/**"
757 $match*) query_symref="HEAD" ;;
759 __git ls-remote "$remote" $query_symref \
760 "refs/tags/$match*" "refs/heads/$match*" \
761 "refs/remotes/$match*" |
762 while read -r hash i; do
765 refs/*) echo "$pfx${i#refs/*/}$sfx" ;;
766 *) echo "$pfx$i$sfx" ;; # symbolic refs
774 # Completes refs, short and long, local and remote, symbolic and pseudo.
776 # Usage: __git_complete_refs [<option>]...
777 # --remote=<remote>: The remote to list refs from, can be the name of a
778 # configured remote, a path, or a URL.
779 # --dwim: List unique remote branches for 'git switch's tracking DWIMery.
780 # --pfx=<prefix>: A prefix to be added to each ref.
781 # --cur=<word>: The current ref to be completed. Defaults to the current
782 # word to be completed.
783 # --sfx=<suffix>: A suffix to be appended to each ref instead of the default
785 # --mode=<mode>: What set of refs to complete, one of 'refs' (the default) to
786 # complete all refs, 'heads' to complete only branches. Note
787 # that --remote is only compatible with --mode=refs.
788 __git_complete_refs ()
790 local remote dwim pfx cur_="$cur" sfx=" " mode="refs"
792 while test $# != 0; do
794 --remote=*) remote="${1##--remote=}" ;;
795 --dwim) dwim="yes" ;;
796 # --track is an old spelling of --dwim
797 --track) dwim="yes" ;;
798 --pfx=*) pfx="${1##--pfx=}" ;;
799 --cur=*) cur_="${1##--cur=}" ;;
800 --sfx=*) sfx="${1##--sfx=}" ;;
801 --mode=*) mode="${1##--mode=}" ;;
807 # complete references based on the specified mode
810 __gitcomp_direct "$(__git_refs "$remote" "" "$pfx" "$cur_" "$sfx")" ;;
812 __gitcomp_direct "$(__git_heads "$pfx" "$cur_" "$sfx")" ;;
817 # Append DWIM remote branch names if requested
818 if [ "$dwim" = "yes" ]; then
819 __gitcomp_direct_append "$(__git_dwim_remote_heads "$pfx" "$cur_" "$sfx")"
823 # __git_refs2 requires 1 argument (to pass to __git_refs)
824 # Deprecated: use __git_complete_fetch_refspecs() instead.
828 for i in $(__git_refs "$1"); do
833 # Completes refspecs for fetching from a remote repository.
834 # 1: The remote repository.
835 # 2: A prefix to be added to each listed refspec (optional).
836 # 3: The ref to be completed as a refspec instead of the current word to be
837 # completed (optional)
838 # 4: A suffix to be appended to each listed refspec instead of the default
840 __git_complete_fetch_refspecs ()
842 local i remote="$1" pfx="${2-}" cur_="${3-$cur}" sfx="${4- }"
845 for i in $(__git_refs "$remote" "" "" "$cur_") ; do
851 # __git_refs_remotes requires 1 argument (to pass to ls-remote)
852 __git_refs_remotes ()
855 __git ls-remote "$1" 'refs/heads/*' | \
856 while read -r hash i; do
857 echo "$i:refs/remotes/$1/${i#refs/heads/}"
864 test -d "$__git_repo_path/remotes" && ls -1 "$__git_repo_path/remotes"
868 # Returns true if $1 matches the name of a configured remote, false otherwise.
869 __git_is_configured_remote ()
872 for remote in $(__git_remotes); do
873 if [ "$remote" = "$1" ]; then
880 __git_list_merge_strategies ()
882 LANG=C LC_ALL=C git merge -s help 2>&1 |
883 sed -n -e '/[Aa]vailable strategies are: /,/^$/{
892 __git_merge_strategies=
893 # 'git merge -s help' (and thus detection of the merge strategy
894 # list) fails, unfortunately, if run outside of any git working
895 # tree. __git_merge_strategies is set to the empty string in
896 # that case, and the detection will be repeated the next time it
898 __git_compute_merge_strategies ()
900 test -n "$__git_merge_strategies" ||
901 __git_merge_strategies=$(__git_list_merge_strategies)
904 __git_merge_strategy_options="ours theirs subtree subtree= patience
905 histogram diff-algorithm= ignore-space-change ignore-all-space
906 ignore-space-at-eol renormalize no-renormalize no-renames
907 find-renames find-renames= rename-threshold="
909 __git_complete_revlist_file ()
911 local dequoted_word pfx ls ref cur_="$cur"
920 __git_dequote "$cur_"
922 case "$dequoted_word" in
924 pfx="${dequoted_word%/*}"
925 cur_="${dequoted_word##*/}"
930 cur_="$dequoted_word"
935 case "$COMP_WORDBREAKS" in
937 *) pfx="$ref:$pfx" ;;
940 __gitcomp_file "$(__git ls-tree "$ls" \
946 pfx="${cur_%...*}..."
948 __git_complete_refs --pfx="$pfx" --cur="$cur_"
953 __git_complete_refs --pfx="$pfx" --cur="$cur_"
961 __git_complete_file ()
963 __git_complete_revlist_file
966 __git_complete_revlist ()
968 __git_complete_revlist_file
971 __git_complete_remote_or_refspec ()
973 local cur_="$cur" cmd="${words[1]}"
974 local i c=2 remote="" pfx="" lhs=1 no_complete_refspec=0
975 if [ "$cmd" = "remote" ]; then
978 while [ $c -lt $cword ]; do
981 --mirror) [ "$cmd" = "push" ] && no_complete_refspec=1 ;;
982 -d|--delete) [ "$cmd" = "push" ] && lhs=0 ;;
985 push) no_complete_refspec=1 ;;
992 --multiple) no_complete_refspec=1; break ;;
994 *) remote="$i"; break ;;
998 if [ -z "$remote" ]; then
999 __gitcomp_nl "$(__git_remotes)"
1002 if [ $no_complete_refspec = 1 ]; then
1005 [ "$remote" = "." ] && remote=
1008 case "$COMP_WORDBREAKS" in
1010 *) pfx="${cur_%%:*}:" ;;
1022 if [ $lhs = 1 ]; then
1023 __git_complete_fetch_refspecs "$remote" "$pfx" "$cur_"
1025 __git_complete_refs --pfx="$pfx" --cur="$cur_"
1029 if [ $lhs = 1 ]; then
1030 __git_complete_refs --remote="$remote" --pfx="$pfx" --cur="$cur_"
1032 __git_complete_refs --pfx="$pfx" --cur="$cur_"
1036 if [ $lhs = 1 ]; then
1037 __git_complete_refs --pfx="$pfx" --cur="$cur_"
1039 __git_complete_refs --remote="$remote" --pfx="$pfx" --cur="$cur_"
1045 __git_complete_strategy ()
1047 __git_compute_merge_strategies
1050 __gitcomp "$__git_merge_strategies"
1054 __gitcomp "$__git_merge_strategy_options"
1060 __gitcomp "$__git_merge_strategies" "" "${cur##--strategy=}"
1063 --strategy-option=*)
1064 __gitcomp "$__git_merge_strategy_options" "" "${cur##--strategy-option=}"
1072 __git_compute_all_commands ()
1074 test -n "$__git_all_commands" ||
1075 __git_all_commands=$(__git --list-cmds=main,others,alias,nohelpers)
1078 # Lists all set config variables starting with the given section prefix,
1079 # with the prefix removed.
1080 __git_get_config_variables ()
1082 local section="$1" i IFS=$'\n'
1083 for i in $(__git config --name-only --get-regexp "^$section\..*"); do
1084 echo "${i#$section.}"
1088 __git_pretty_aliases ()
1090 __git_get_config_variables "pretty"
1093 # __git_aliased_command requires 1 argument
1094 __git_aliased_command ()
1096 local word cmdline=$(__git config --get "alias.$1")
1097 for word in $cmdline; do
1103 \!*) : shell command alias ;;
1105 *=*) : setting env ;;
1106 git) : git itself ;;
1107 \(\)) : skip parens of shell function definition ;;
1108 {) : skip start of shell helper function ;;
1109 :) : skip null command ;;
1110 \'*) : skip opening quote after sh -c ;;
1118 # Check whether one of the given words is present on the command line,
1119 # and print the first word found.
1121 # Usage: __git_find_on_cmdline [<option>]... "<wordlist>"
1122 # --show-idx: Optionally show the index of the found word in the $words array.
1123 __git_find_on_cmdline ()
1125 local word c=1 show_idx
1127 while test $# -gt 1; do
1129 --show-idx) show_idx=y ;;
1136 while [ $c -lt $cword ]; do
1137 for word in $wordlist; do
1138 if [ "$word" = "${words[c]}" ]; then
1139 if [ -n "$show_idx" ]; then
1151 # Similar to __git_find_on_cmdline, except that it loops backwards and thus
1152 # prints the *last* word found. Useful for finding which of two options that
1153 # supersede each other came last, such as "--guess" and "--no-guess".
1155 # Usage: __git_find_last_on_cmdline [<option>]... "<wordlist>"
1156 # --show-idx: Optionally show the index of the found word in the $words array.
1157 __git_find_last_on_cmdline ()
1159 local word c=$cword show_idx
1161 while test $# -gt 1; do
1163 --show-idx) show_idx=y ;;
1170 while [ $c -gt 1 ]; do
1172 for word in $wordlist; do
1173 if [ "$word" = "${words[c]}" ]; then
1174 if [ -n "$show_idx" ]; then
1185 # Echo the value of an option set on the command line or config
1187 # $1: short option name
1188 # $2: long option name including =
1189 # $3: list of possible values
1190 # $4: config string (optional)
1193 # result="$(__git_get_option_value "-d" "--do-something=" \
1194 # "yes no" "core.doSomething")"
1196 # result is then either empty (no option set) or "yes" or "no"
1198 # __git_get_option_value requires 3 arguments
1199 __git_get_option_value ()
1201 local c short_opt long_opt val
1202 local result= values config_key word
1210 while [ $c -ge 0 ]; do
1212 for val in $values; do
1213 if [ "$short_opt$val" = "$word" ] ||
1214 [ "$long_opt$val" = "$word" ]; then
1222 if [ -n "$config_key" ] && [ -z "$result" ]; then
1223 result="$(__git config "$config_key")"
1229 __git_has_doubledash ()
1232 while [ $c -lt $cword ]; do
1233 if [ "--" = "${words[c]}" ]; then
1241 # Try to count non option arguments passed on the command line for the
1242 # specified git command.
1243 # When options are used, it is necessary to use the special -- option to
1244 # tell the implementation were non option arguments begin.
1245 # XXX this can not be improved, since options can appear everywhere, as
1249 # __git_count_arguments requires 1 argument: the git command executed.
1250 __git_count_arguments ()
1254 # Skip "git" (first argument)
1255 for ((i=1; i < ${#words[@]}; i++)); do
1260 # Good; we can assume that the following are only non
1265 # Skip the specified git command and discard git
1278 __git_whitespacelist="nowarn warn error error-all fix"
1279 __git_patchformat="mbox stgit stgit-series hg mboxrd"
1280 __git_showcurrentpatch="diff raw"
1281 __git_am_inprogress_options="--skip --continue --resolved --abort --quit --show-current-patch"
1285 __git_find_repo_path
1286 if [ -d "$__git_repo_path"/rebase-apply ]; then
1287 __gitcomp "$__git_am_inprogress_options"
1292 __gitcomp "$__git_whitespacelist" "" "${cur##--whitespace=}"
1296 __gitcomp "$__git_patchformat" "" "${cur##--patch-format=}"
1299 --show-current-patch=*)
1300 __gitcomp "$__git_showcurrentpatch" "" "${cur##--show-current-patch=}"
1304 __gitcomp_builtin am "" \
1305 "$__git_am_inprogress_options"
1314 __gitcomp "$__git_whitespacelist" "" "${cur##--whitespace=}"
1318 __gitcomp_builtin apply
1327 __gitcomp "+x -x" "" "${cur##--chmod=}"
1331 __gitcomp_builtin add
1335 local complete_opt="--others --modified --directory --no-empty-directory"
1336 if test -n "$(__git_find_on_cmdline "-u --update")"
1338 complete_opt="--modified"
1340 __git_complete_index_file "$complete_opt"
1347 __gitcomp "$(git archive --list)" "" "${cur##--format=}"
1351 __gitcomp_nl "$(__git_remotes)" "" "${cur##--remote=}"
1355 __gitcomp_builtin archive "--format= --list --verbose --prefix= --worktree-attributes"
1364 __git_has_doubledash && return
1366 local subcommands="start bad good skip reset visualize replay log run"
1367 local subcommand="$(__git_find_on_cmdline "$subcommands")"
1368 if [ -z "$subcommand" ]; then
1369 __git_find_repo_path
1370 if [ -f "$__git_repo_path"/BISECT_START ]; then
1371 __gitcomp "$subcommands"
1373 __gitcomp "replay start"
1378 case "$subcommand" in
1379 bad|good|reset|skip|start)
1387 __git_ref_fieldlist="refname objecttype objectsize objectname upstream push HEAD symref"
1391 local i c=1 only_local_ref="n" has_r="n"
1393 while [ $c -lt $cword ]; do
1396 -d|--delete|-m|--move) only_local_ref="y" ;;
1397 -r|--remotes) has_r="y" ;;
1403 --set-upstream-to=*)
1404 __git_complete_refs --cur="${cur##--set-upstream-to=}"
1407 __gitcomp_builtin branch
1410 if [ $only_local_ref = "y" -a $has_r = "n" ]; then
1411 __gitcomp_direct "$(__git_heads "" "$cur" " ")"
1421 local cmd="${words[2]}"
1424 __gitcomp "create list-heads verify unbundle"
1427 # looking for a file
1432 __git_complete_revlist
1439 # Helper function to decide whether or not we should enable DWIM logic for
1440 # git-switch and git-checkout.
1442 # To decide between the following rules in priority order
1443 # 1) the last provided of "--guess" or "--no-guess" explicitly enable or
1444 # disable completion of DWIM logic respectively.
1445 # 2) If the --no-track option is provided, take this as a hint to disable the
1446 # DWIM completion logic
1447 # 3) If GIT_COMPLETION_CHECKOUT_NO_GUESS is set, disable the DWIM completion
1448 # logic, as requested by the user.
1449 # 4) Enable DWIM logic otherwise.
1451 __git_checkout_default_dwim_mode ()
1453 local last_option dwim_opt="--dwim"
1455 if [ "$GIT_COMPLETION_CHECKOUT_NO_GUESS" = "1" ]; then
1459 # --no-track disables DWIM, but with lower priority than
1460 # --guess/--no-guess
1461 if [ -n "$(__git_find_on_cmdline "--no-track")" ]; then
1465 # Find the last provided --guess or --no-guess
1466 last_option="$(__git_find_last_on_cmdline "--guess --no-guess")"
1467 case "$last_option" in
1481 __git_has_doubledash && return
1485 __gitcomp "diff3 merge" "" "${cur##--conflict=}"
1488 __gitcomp_builtin checkout
1491 local dwim_opt="$(__git_checkout_default_dwim_mode)"
1493 if [ -n "$(__git_find_on_cmdline "-d --detach")" ]; then
1494 __git_complete_refs --mode="refs"
1496 __git_complete_refs $dwim_opt --mode="refs"
1502 __git_sequencer_inprogress_options="--continue --quit --abort --skip"
1504 __git_cherry_pick_inprogress_options=$__git_sequencer_inprogress_options
1508 __git_find_repo_path
1509 if [ -f "$__git_repo_path"/CHERRY_PICK_HEAD ]; then
1510 __gitcomp "$__git_cherry_pick_inprogress_options"
1514 __git_complete_strategy && return
1518 __gitcomp_builtin cherry-pick "" \
1519 "$__git_cherry_pick_inprogress_options"
1531 __gitcomp_builtin clean
1536 # XXX should we check for -x option ?
1537 __git_complete_index_file "--others --directory"
1544 __git_complete_config_variable_name_and_value
1550 __git_complete_config_variable_name_and_value \
1551 --cur="${cur##--config=}"
1555 __gitcomp_builtin clone
1561 __git_untracked_file_modes="all no normal"
1574 __gitcomp "default scissors strip verbatim whitespace
1575 " "" "${cur##--cleanup=}"
1578 --reuse-message=*|--reedit-message=*|\
1579 --fixup=*|--squash=*)
1580 __git_complete_refs --cur="${cur#*=}"
1583 --untracked-files=*)
1584 __gitcomp "$__git_untracked_file_modes" "" "${cur##--untracked-files=}"
1588 __gitcomp_builtin commit
1592 if __git rev-parse --verify --quiet HEAD >/dev/null; then
1593 __git_complete_index_file "--committable"
1595 # This is the first commit
1596 __git_complete_index_file "--cached"
1604 __gitcomp_builtin describe
1610 __git_diff_algorithms="myers minimal patience histogram"
1612 __git_diff_submodule_formats="diff log short"
1614 __git_color_moved_opts="no default plain blocks zebra dimmed-zebra"
1616 __git_color_moved_ws_opts="no ignore-space-at-eol ignore-space-change
1617 ignore-all-space allow-indentation-change"
1619 __git_diff_common_options="--stat --numstat --shortstat --summary
1620 --patch-with-stat --name-only --name-status --color
1621 --no-color --color-words --no-renames --check
1622 --color-moved --color-moved= --no-color-moved
1623 --color-moved-ws= --no-color-moved-ws
1624 --full-index --binary --abbrev --diff-filter=
1625 --find-copies-harder --ignore-cr-at-eol
1626 --text --ignore-space-at-eol --ignore-space-change
1627 --ignore-all-space --ignore-blank-lines --exit-code
1628 --quiet --ext-diff --no-ext-diff
1629 --no-prefix --src-prefix= --dst-prefix=
1630 --inter-hunk-context=
1631 --patience --histogram --minimal
1632 --raw --word-diff --word-diff-regex=
1633 --dirstat --dirstat= --dirstat-by-file
1634 --dirstat-by-file= --cumulative
1636 --submodule --submodule= --ignore-submodules
1637 --indent-heuristic --no-indent-heuristic
1638 --textconv --no-textconv
1643 __git_has_doubledash && return
1647 __gitcomp "$__git_diff_algorithms" "" "${cur##--diff-algorithm=}"
1651 __gitcomp "$__git_diff_submodule_formats" "" "${cur##--submodule=}"
1655 __gitcomp "$__git_color_moved_opts" "" "${cur##--color-moved=}"
1659 __gitcomp "$__git_color_moved_ws_opts" "" "${cur##--color-moved-ws=}"
1663 __gitcomp "--cached --staged --pickaxe-all --pickaxe-regex
1664 --base --ours --theirs --no-index
1665 $__git_diff_common_options
1670 __git_complete_revlist_file
1673 __git_mergetools_common="diffuse diffmerge ecmerge emerge kdiff3 meld opendiff
1674 tkdiff vimdiff gvimdiff xxdiff araxis p4merge bc
1680 __git_has_doubledash && return
1684 __gitcomp "$__git_mergetools_common kompare" "" "${cur##--tool=}"
1688 __gitcomp_builtin difftool "$__git_diff_common_options
1689 --base --cached --ours --theirs
1690 --pickaxe-all --pickaxe-regex
1696 __git_complete_revlist_file
1699 __git_fetch_recurse_submodules="yes on-demand no"
1704 --recurse-submodules=*)
1705 __gitcomp "$__git_fetch_recurse_submodules" "" "${cur##--recurse-submodules=}"
1709 __gitcomp "blob:none blob:limit= sparse:oid=" "" "${cur##--filter=}"
1713 __gitcomp_builtin fetch
1717 __git_complete_remote_or_refspec
1720 __git_format_patch_extra_options="
1721 --full-index --not --all --no-prefix --src-prefix=
1722 --dst-prefix= --notes
1725 _git_format_patch ()
1731 " "" "${cur##--thread=}"
1735 __gitcomp_builtin format-patch "$__git_format_patch_extra_options"
1739 __git_complete_revlist
1746 __gitcomp_builtin fsck
1757 # Lists matching symbol names from a tag (as in ctags) file.
1758 # 1: List symbol names matching this word.
1759 # 2: The tag file to list symbol names from.
1760 # 3: A prefix to be added to each listed symbol name (optional).
1761 # 4: A suffix to be appended to each listed symbol name (optional).
1762 __git_match_ctag () {
1763 awk -v pfx="${3-}" -v sfx="${4-}" "
1764 /^${1//\//\\/}/ { print pfx \$1 sfx }
1768 # Complete symbol names from a tag file.
1769 # Usage: __git_complete_symbol [<option>]...
1770 # --tags=<file>: The tag file to list symbol names from instead of the
1772 # --pfx=<prefix>: A prefix to be added to each symbol name.
1773 # --cur=<word>: The current symbol name to be completed. Defaults to
1774 # the current word to be completed.
1775 # --sfx=<suffix>: A suffix to be appended to each symbol name instead
1776 # of the default space.
1777 __git_complete_symbol () {
1778 local tags=tags pfx="" cur_="${cur-}" sfx=" "
1780 while test $# != 0; do
1782 --tags=*) tags="${1##--tags=}" ;;
1783 --pfx=*) pfx="${1##--pfx=}" ;;
1784 --cur=*) cur_="${1##--cur=}" ;;
1785 --sfx=*) sfx="${1##--sfx=}" ;;
1791 if test -r "$tags"; then
1792 __gitcomp_direct "$(__git_match_ctag "$cur_" "$tags" "$pfx" "$sfx")"
1798 __git_has_doubledash && return
1802 __gitcomp_builtin grep
1807 case "$cword,$prev" in
1809 __git_complete_symbol && return
1820 __gitcomp_builtin help
1824 if test -n "$GIT_TESTING_ALL_COMMAND_LIST"
1826 __gitcomp "$GIT_TESTING_ALL_COMMAND_LIST $(__git --list-cmds=alias,list-guide) gitk"
1828 __gitcomp "$(__git --list-cmds=main,nohelpers,alias,list-guide) gitk"
1837 false true umask group all world everybody
1838 " "" "${cur##--shared=}"
1842 __gitcomp_builtin init
1852 __gitcomp_builtin ls-files
1857 # XXX ignore options like --modified and always suggest all cached
1859 __git_complete_index_file "--cached"
1866 __gitcomp_builtin ls-remote
1870 __gitcomp_nl "$(__git_remotes)"
1877 __gitcomp_builtin ls-tree
1885 # Options that go well for log, shortlog and gitk
1886 __git_log_common_options="
1888 --branches --tags --remotes
1889 --first-parent --merges --no-merges
1891 --max-age= --since= --after=
1892 --min-age= --until= --before=
1893 --min-parents= --max-parents=
1894 --no-min-parents --no-max-parents
1896 # Options that go well for log and gitk (not shortlog)
1897 __git_log_gitk_options="
1898 --dense --sparse --full-history
1899 --simplify-merges --simplify-by-decoration
1900 --left-right --notes --no-notes
1902 # Options that go well for log and shortlog (not gitk)
1903 __git_log_shortlog_options="
1904 --author= --committer= --grep=
1905 --all-match --invert-grep
1908 __git_log_pretty_formats="oneline short medium full fuller reference email raw format: tformat: mboxrd"
1909 __git_log_date_formats="relative iso8601 iso8601-strict rfc2822 short local default raw unix format:"
1913 __git_has_doubledash && return
1914 __git_find_repo_path
1917 if [ -f "$__git_repo_path/MERGE_HEAD" ]; then
1920 case "$prev,$cur" in
1922 return # fall back to Bash filename completion
1925 __git_complete_symbol --cur="${cur#:}" --sfx=":"
1929 __git_complete_symbol
1934 --pretty=*|--format=*)
1935 __gitcomp "$__git_log_pretty_formats $(__git_pretty_aliases)
1940 __gitcomp "$__git_log_date_formats" "" "${cur##--date=}"
1944 __gitcomp "full short no" "" "${cur##--decorate=}"
1948 __gitcomp "$__git_diff_algorithms" "" "${cur##--diff-algorithm=}"
1952 __gitcomp "$__git_diff_submodule_formats" "" "${cur##--submodule=}"
1956 __gitcomp "sorted unsorted" "" "${cur##--no-walk=}"
1961 $__git_log_common_options
1962 $__git_log_shortlog_options
1963 $__git_log_gitk_options
1964 --root --topo-order --date-order --reverse
1965 --follow --full-diff
1966 --abbrev-commit --no-abbrev-commit --abbrev=
1967 --relative-date --date=
1968 --pretty= --format= --oneline
1973 --decorate --decorate= --no-decorate
1975 --no-walk --no-walk= --do-walk
1976 --parents --children
1977 --expand-tabs --expand-tabs= --no-expand-tabs
1980 $__git_diff_common_options
1981 --pickaxe-all --pickaxe-regex
1986 return # fall back to Bash filename completion
1989 __git_complete_symbol --cur="${cur#-L:}" --sfx=":"
1993 __git_complete_symbol --pfx="-G" --cur="${cur#-G}"
1997 __git_complete_symbol --pfx="-S" --cur="${cur#-S}"
2001 __git_complete_revlist
2006 __git_complete_strategy && return
2010 __gitcomp_builtin merge
2020 __gitcomp "$__git_mergetools_common tortoisemerge" "" "${cur##--tool=}"
2024 __gitcomp "--tool= --prompt --no-prompt --gui --no-gui"
2034 __gitcomp_builtin merge-base
2045 __gitcomp_builtin mv
2050 if [ $(__git_count_arguments "mv") -gt 0 ]; then
2051 # We need to show both cached and untracked files (including
2052 # empty directories) since this may not be the last argument.
2053 __git_complete_index_file "--cached --others --directory"
2055 __git_complete_index_file "--cached"
2061 local subcommands='add append copy edit get-ref list merge prune remove show'
2062 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2064 case "$subcommand,$cur" in
2066 __gitcomp_builtin notes
2074 __gitcomp "$subcommands --ref"
2078 *,--reuse-message=*|*,--reedit-message=*)
2079 __git_complete_refs --cur="${cur#*=}"
2082 __gitcomp_builtin notes_$subcommand
2085 # this command does not take a ref, do not complete it
2101 __git_complete_strategy && return
2104 --recurse-submodules=*)
2105 __gitcomp "$__git_fetch_recurse_submodules" "" "${cur##--recurse-submodules=}"
2109 __gitcomp_builtin pull
2114 __git_complete_remote_or_refspec
2117 __git_push_recurse_submodules="check on-demand only"
2119 __git_complete_force_with_lease ()
2127 __git_complete_refs --cur="${cur_#*:}"
2130 __git_complete_refs --cur="$cur_"
2139 __gitcomp_nl "$(__git_remotes)"
2142 --recurse-submodules)
2143 __gitcomp "$__git_push_recurse_submodules"
2149 __gitcomp_nl "$(__git_remotes)" "" "${cur##--repo=}"
2152 --recurse-submodules=*)
2153 __gitcomp "$__git_push_recurse_submodules" "" "${cur##--recurse-submodules=}"
2156 --force-with-lease=*)
2157 __git_complete_force_with_lease "${cur##--force-with-lease=}"
2161 __gitcomp_builtin push
2165 __git_complete_remote_or_refspec
2173 --creation-factor= --no-dual-color
2174 $__git_diff_common_options
2179 __git_complete_revlist
2182 __git_rebase_inprogress_options="--continue --skip --abort --quit --show-current-patch"
2183 __git_rebase_interactive_inprogress_options="$__git_rebase_inprogress_options --edit-todo"
2187 __git_find_repo_path
2188 if [ -f "$__git_repo_path"/rebase-merge/interactive ]; then
2189 __gitcomp "$__git_rebase_interactive_inprogress_options"
2191 elif [ -d "$__git_repo_path"/rebase-apply ] || \
2192 [ -d "$__git_repo_path"/rebase-merge ]; then
2193 __gitcomp "$__git_rebase_inprogress_options"
2196 __git_complete_strategy && return
2199 __gitcomp "$__git_whitespacelist" "" "${cur##--whitespace=}"
2203 __git_complete_refs --cur="${cur##--onto=}"
2207 __gitcomp_builtin rebase "" \
2208 "$__git_rebase_interactive_inprogress_options"
2217 local subcommands="show delete expire"
2218 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2220 if [ -z "$subcommand" ]; then
2221 __gitcomp "$subcommands"
2227 __git_send_email_confirm_options="always never auto cc compose"
2228 __git_send_email_suppresscc_options="author self cc bodycc sob cccmd body all"
2233 --to|--cc|--bcc|--from)
2234 __gitcomp "$(__git send-email --dump-aliases)"
2242 $__git_send_email_confirm_options
2243 " "" "${cur##--confirm=}"
2248 $__git_send_email_suppresscc_options
2249 " "" "${cur##--suppress-cc=}"
2253 --smtp-encryption=*)
2254 __gitcomp "ssl tls" "" "${cur##--smtp-encryption=}"
2260 " "" "${cur##--thread=}"
2263 --to=*|--cc=*|--bcc=*|--from=*)
2264 __gitcomp "$(__git send-email --dump-aliases)" "" "${cur#--*=}"
2268 __gitcomp_builtin send-email "--annotate --bcc --cc --cc-cmd --chain-reply-to
2269 --compose --confirm= --dry-run --envelope-sender
2271 --in-reply-to --no-chain-reply-to --no-signed-off-by-cc
2272 --no-suppress-from --no-thread --quiet --reply-to
2273 --signed-off-by-cc --smtp-pass --smtp-server
2274 --smtp-server-port --smtp-encryption= --smtp-user
2275 --subject --suppress-cc= --suppress-from --thread --to
2276 --validate --no-validate
2277 $__git_format_patch_extra_options"
2281 __git_complete_revlist
2292 local untracked_state
2295 --ignore-submodules=*)
2296 __gitcomp "none untracked dirty all" "" "${cur##--ignore-submodules=}"
2299 --untracked-files=*)
2300 __gitcomp "$__git_untracked_file_modes" "" "${cur##--untracked-files=}"
2305 always never auto column row plain dense nodense
2306 " "" "${cur##--column=}"
2310 __gitcomp_builtin status
2315 untracked_state="$(__git_get_option_value "-u" "--untracked-files=" \
2316 "$__git_untracked_file_modes" "status.showUntrackedFiles")"
2318 case "$untracked_state" in
2320 # --ignored option does not matter
2324 complete_opt="--cached --directory --no-empty-directory --others"
2326 if [ -n "$(__git_find_on_cmdline "--ignored")" ]; then
2327 complete_opt="$complete_opt --ignored --exclude=*"
2332 __git_complete_index_file "$complete_opt"
2339 __gitcomp "diff3 merge" "" "${cur##--conflict=}"
2342 __gitcomp_builtin switch
2345 local dwim_opt="$(__git_checkout_default_dwim_mode)"
2347 if [ -n "$(__git_find_on_cmdline "-d --detach")" ]; then
2348 __git_complete_refs --mode="refs"
2350 __git_complete_refs $dwim_opt --mode="heads"
2356 __git_config_get_set_variables ()
2358 local prevword word config_file= c=$cword
2359 while [ $c -gt 1 ]; do
2362 --system|--global|--local|--file=*)
2367 config_file="$word $prevword"
2375 __git config $config_file --name-only --list
2379 __git_compute_config_vars ()
2381 test -n "$__git_config_vars" ||
2382 __git_config_vars="$(git help --config-for-completion | sort -u)"
2385 # Completes possible values of various configuration variables.
2387 # Usage: __git_complete_config_variable_value [<option>]...
2388 # --varname=<word>: The name of the configuration variable whose value is
2389 # to be completed. Defaults to the previous word on the
2391 # --cur=<word>: The current value to be completed. Defaults to the current
2392 # word to be completed.
2393 __git_complete_config_variable_value ()
2395 local varname="$prev" cur_="$cur"
2397 while test $# != 0; do
2399 --varname=*) varname="${1##--varname=}" ;;
2400 --cur=*) cur_="${1##--cur=}" ;;
2406 if [ "${BASH_VERSINFO[0]:-0}" -ge 4 ]; then
2407 varname="${varname,,}"
2409 varname="$(echo "$varname" |tr A-Z a-z)"
2413 branch.*.remote|branch.*.pushremote)
2414 __gitcomp_nl "$(__git_remotes)" "" "$cur_"
2418 __git_complete_refs --cur="$cur_"
2422 __gitcomp "false true merges preserve interactive" "" "$cur_"
2426 __gitcomp_nl "$(__git_remotes)" "" "$cur_"
2430 local remote="${varname#remote.}"
2431 remote="${remote%.fetch}"
2432 if [ -z "$cur_" ]; then
2433 __gitcomp_nl "refs/heads/" "" "" ""
2436 __gitcomp_nl "$(__git_refs_remotes "$remote")" "" "$cur_"
2440 local remote="${varname#remote.}"
2441 remote="${remote%.push}"
2442 __gitcomp_nl "$(__git for-each-ref \
2443 --format='%(refname):%(refname)' refs/heads)" "" "$cur_"
2446 pull.twohead|pull.octopus)
2447 __git_compute_merge_strategies
2448 __gitcomp "$__git_merge_strategies" "" "$cur_"
2452 __gitcomp "false true" "" "$cur_"
2457 normal black red green yellow blue magenta cyan white
2458 bold dim ul blink reverse
2463 __gitcomp "false true always never auto" "" "$cur_"
2467 __gitcomp "$__git_diff_submodule_formats" "" "$cur_"
2471 __gitcomp "man info web html" "" "$cur_"
2475 __gitcomp "$__git_log_date_formats" "" "$cur_"
2478 sendemail.aliasfiletype)
2479 __gitcomp "mutt mailrc pine elm gnus" "" "$cur_"
2483 __gitcomp "$__git_send_email_confirm_options" "" "$cur_"
2486 sendemail.suppresscc)
2487 __gitcomp "$__git_send_email_suppresscc_options" "" "$cur_"
2490 sendemail.transferencoding)
2491 __gitcomp "7bit 8bit quoted-printable base64" "" "$cur_"
2500 # Completes configuration sections, subsections, variable names.
2502 # Usage: __git_complete_config_variable_name [<option>]...
2503 # --cur=<word>: The current configuration section/variable name to be
2504 # completed. Defaults to the current word to be completed.
2505 # --sfx=<suffix>: A suffix to be appended to each fully completed
2506 # configuration variable name (but not to sections or
2507 # subsections) instead of the default space.
2508 __git_complete_config_variable_name ()
2510 local cur_="$cur" sfx
2512 while test $# != 0; do
2514 --cur=*) cur_="${1##--cur=}" ;;
2515 --sfx=*) sfx="${1##--sfx=}" ;;
2523 local pfx="${cur_%.*}."
2525 __gitcomp "remote pushRemote merge mergeOptions rebase" "$pfx" "$cur_" "$sfx"
2529 local pfx="${cur%.*}."
2531 __gitcomp_direct "$(__git_heads "$pfx" "$cur_" ".")"
2532 __gitcomp_nl_append $'autoSetupMerge\nautoSetupRebase\n' "$pfx" "$cur_" "$sfx"
2536 local pfx="${cur_%.*}."
2539 argPrompt cmd confirm needsFile noConsole noRescan
2540 prompt revPrompt revUnmerged title
2541 " "$pfx" "$cur_" "$sfx"
2545 local pfx="${cur_%.*}."
2547 __gitcomp "cmd path" "$pfx" "$cur_" "$sfx"
2551 local pfx="${cur_%.*}."
2553 __gitcomp "cmd path" "$pfx" "$cur_" "$sfx"
2557 local pfx="${cur_%.*}."
2559 __gitcomp "cmd path trustExitCode" "$pfx" "$cur_" "$sfx"
2563 local pfx="${cur_%.*}."
2565 __git_compute_all_commands
2566 __gitcomp_nl "$__git_all_commands" "$pfx" "$cur_" "$sfx"
2570 local pfx="${cur_%.*}."
2573 url proxy fetch push mirror skipDefaultUpdate
2574 receivepack uploadpack tagOpt pushurl
2575 " "$pfx" "$cur_" "$sfx"
2579 local pfx="${cur_%.*}."
2581 __gitcomp_nl "$(__git_remotes)" "$pfx" "$cur_" "."
2582 __gitcomp_nl_append "pushDefault" "$pfx" "$cur_" "$sfx"
2586 local pfx="${cur_%.*}."
2588 __gitcomp "insteadOf pushInsteadOf" "$pfx" "$cur_" "$sfx"
2592 __git_compute_config_vars
2593 __gitcomp "$__git_config_vars" "" "$cur_" "$sfx"
2596 __git_compute_config_vars
2597 __gitcomp "$(echo "$__git_config_vars" |
2610 # Completes '='-separated configuration sections/variable names and values
2611 # for 'git -c section.name=value'.
2613 # Usage: __git_complete_config_variable_name_and_value [<option>]...
2614 # --cur=<word>: The current configuration section/variable name/value to be
2615 # completed. Defaults to the current word to be completed.
2616 __git_complete_config_variable_name_and_value ()
2620 while test $# != 0; do
2622 --cur=*) cur_="${1##--cur=}" ;;
2630 __git_complete_config_variable_value \
2631 --varname="${cur_%%=*}" --cur="${cur_#*=}"
2634 __git_complete_config_variable_name --cur="$cur_" --sfx='='
2642 --get|--get-all|--unset|--unset-all)
2643 __gitcomp_nl "$(__git_config_get_set_variables)"
2647 __git_complete_config_variable_value
2653 __gitcomp_builtin config
2656 __git_complete_config_variable_name
2664 add rename remove set-head set-branches
2665 get-url set-url show prune update
2667 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2668 if [ -z "$subcommand" ]; then
2671 __gitcomp_builtin remote
2674 __gitcomp "$subcommands"
2680 case "$subcommand,$cur" in
2682 __gitcomp_builtin remote_add
2687 __gitcomp_builtin remote_set-head
2690 __gitcomp_builtin remote_set-branches
2692 set-head,*|set-branches,*)
2693 __git_complete_remote_or_refspec
2696 __gitcomp_builtin remote_update
2699 __gitcomp "$(__git_remotes) $(__git_get_config_variables "remotes")"
2702 __gitcomp_builtin remote_set-url
2705 __gitcomp_builtin remote_get-url
2708 __gitcomp_builtin remote_prune
2711 __gitcomp_nl "$(__git_remotes)"
2720 __gitcomp "short medium long" "" "${cur##--format=}"
2724 __gitcomp_builtin replace
2733 local subcommands="clear forget diff remaining status gc"
2734 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2735 if test -z "$subcommand"
2737 __gitcomp "$subcommands"
2744 __git_has_doubledash && return
2748 __gitcomp_builtin reset
2759 __gitcomp "diff3 merge" "" "${cur##--conflict=}"
2762 __git_complete_refs --cur="${cur##--source=}"
2765 __gitcomp_builtin restore
2770 __git_revert_inprogress_options=$__git_sequencer_inprogress_options
2774 __git_find_repo_path
2775 if [ -f "$__git_repo_path"/REVERT_HEAD ]; then
2776 __gitcomp "$__git_revert_inprogress_options"
2779 __git_complete_strategy && return
2782 __gitcomp_builtin revert "" \
2783 "$__git_revert_inprogress_options"
2794 __gitcomp_builtin rm
2799 __git_complete_index_file "--cached"
2804 __git_has_doubledash && return
2809 $__git_log_common_options
2810 $__git_log_shortlog_options
2811 --numbered --summary --email
2816 __git_complete_revlist
2821 __git_has_doubledash && return
2824 --pretty=*|--format=*)
2825 __gitcomp "$__git_log_pretty_formats $(__git_pretty_aliases)
2830 __gitcomp "$__git_diff_algorithms" "" "${cur##--diff-algorithm=}"
2834 __gitcomp "$__git_diff_submodule_formats" "" "${cur##--submodule=}"
2838 __gitcomp "--pretty= --format= --abbrev-commit --no-abbrev-commit
2839 --oneline --show-signature --patch
2840 --expand-tabs --expand-tabs= --no-expand-tabs
2841 $__git_diff_common_options
2846 __git_complete_revlist_file
2853 __gitcomp_builtin show-branch
2857 __git_complete_revlist
2860 _git_sparse_checkout ()
2862 local subcommands="list init set disable"
2863 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2864 if [ -z "$subcommand" ]; then
2865 __gitcomp "$subcommands"
2869 case "$subcommand,$cur" in
2883 local save_opts='--all --keep-index --no-keep-index --quiet --patch --include-untracked'
2884 local subcommands='push list show apply clear drop pop create branch'
2885 local subcommand="$(__git_find_on_cmdline "$subcommands save")"
2886 if [ -n "$(__git_find_on_cmdline "-p")" ]; then
2889 if [ -z "$subcommand" ]; then
2892 __gitcomp "$save_opts"
2895 if [ -z "$(__git_find_on_cmdline "$save_opts")" ]; then
2900 if [ -z "$(__git_find_on_cmdline "$save_opts")" ]; then
2901 __gitcomp "$subcommands"
2906 case "$subcommand,$cur" in
2908 __gitcomp "$save_opts --message"
2911 __gitcomp "$save_opts"
2914 __gitcomp "--index --quiet"
2920 __gitcomp "--name-status --oneline --patch-with-stat"
2922 show,--*|branch,--*)
2925 if [ $cword -eq 3 ]; then
2928 __gitcomp_nl "$(__git stash list \
2929 | sed -n -e 's/:.*//p')"
2932 show,*|apply,*|drop,*|pop,*)
2933 __gitcomp_nl "$(__git stash list \
2934 | sed -n -e 's/:.*//p')"
2944 __git_has_doubledash && return
2946 local subcommands="add status init deinit update set-branch set-url summary foreach sync absorbgitdirs"
2947 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2948 if [ -z "$subcommand" ]; then
2954 __gitcomp "$subcommands"
2960 case "$subcommand,$cur" in
2962 __gitcomp "--branch --force --name --reference --depth"
2965 __gitcomp "--cached --recursive"
2968 __gitcomp "--force --all"
2972 --init --remote --no-fetch
2973 --recommend-shallow --no-recommend-shallow
2974 --force --rebase --merge --reference --depth --recursive --jobs
2978 __gitcomp "--default --branch"
2981 __gitcomp "--cached --files --summary-limit"
2983 foreach,--*|sync,--*)
2984 __gitcomp "--recursive"
2994 init fetch clone rebase dcommit log find-rev
2995 set-tree commit-diff info create-ignore propget
2996 proplist show-ignore show-externals branch tag blame
2997 migrate mkdirs reset gc
2999 local subcommand="$(__git_find_on_cmdline "$subcommands")"
3000 if [ -z "$subcommand" ]; then
3001 __gitcomp "$subcommands"
3003 local remote_opts="--username= --config-dir= --no-auth-cache"
3005 --follow-parent --authors-file= --repack=
3006 --no-metadata --use-svm-props --use-svnsync-props
3007 --log-window-size= --no-checkout --quiet
3008 --repack-flags --use-log-author --localtime
3011 --ignore-paths= --include-paths= $remote_opts
3014 --template= --shared= --trunk= --tags=
3015 --branches= --stdlayout --minimize-url
3016 --no-metadata --use-svm-props --use-svnsync-props
3017 --rewrite-root= --prefix= $remote_opts
3020 --edit --rmdir --find-copies-harder --copy-similarity=
3023 case "$subcommand,$cur" in
3025 __gitcomp "--revision= --fetch-all $fc_opts"
3028 __gitcomp "--revision= $fc_opts $init_opts"
3031 __gitcomp "$init_opts"
3035 --merge --strategy= --verbose --dry-run
3036 --fetch-all --no-rebase --commit-url
3037 --revision --interactive $cmt_opts $fc_opts
3041 __gitcomp "--stdin $cmt_opts $fc_opts"
3043 create-ignore,--*|propget,--*|proplist,--*|show-ignore,--*|\
3044 show-externals,--*|mkdirs,--*)
3045 __gitcomp "--revision="
3049 --limit= --revision= --verbose --incremental
3050 --oneline --show-commit --non-recursive
3051 --authors-file= --color
3056 --merge --verbose --strategy= --local
3057 --fetch-all --dry-run $fc_opts
3061 __gitcomp "--message= --file= --revision= $cmt_opts"
3067 __gitcomp "--dry-run --message --tag"
3070 __gitcomp "--dry-run --message"
3073 __gitcomp "--git-format"
3077 --config-dir= --ignore-paths= --minimize
3078 --no-auth-cache --username=
3082 __gitcomp "--revision= --parent"
3093 while [ $c -lt $cword ]; do
3096 -d|--delete|-v|--verify)
3097 __gitcomp_direct "$(__git_tags "" "$cur" " ")"
3112 __gitcomp_direct "$(__git_tags "" "$cur" " ")"
3122 __gitcomp_builtin tag
3132 __git_complete_worktree_paths ()
3135 __gitcomp_nl "$(git worktree list --porcelain |
3136 # Skip the first entry: it's the path of the main worktree,
3137 # which can't be moved, removed, locked, etc.
3138 sed -n -e '2,$ s/^worktree //p')"
3143 local subcommands="add list lock move prune remove unlock"
3144 local subcommand subcommand_idx
3146 subcommand="$(__git_find_on_cmdline --show-idx "$subcommands")"
3147 subcommand_idx="${subcommand% *}"
3148 subcommand="${subcommand#* }"
3150 case "$subcommand,$cur" in
3152 __gitcomp "$subcommands"
3155 __gitcomp_builtin worktree_$subcommand
3157 add,*) # usage: git worktree add [<options>] <path> [<commit-ish>]
3158 # Here we are not completing an --option, it's either the
3161 -b|-B) # Complete refs for branch to be created/reseted.
3164 -*) # The previous word is an -o|--option without an
3165 # unstuck argument: have to complete the path for
3166 # the new worktree, so don't list anything, but let
3167 # Bash fall back to filename completion.
3169 *) # The previous word is not an --option, so it must
3170 # be either the 'add' subcommand, the unstuck
3171 # argument of an option (e.g. branch for -b|-B), or
3172 # the path for the new worktree.
3173 if [ $cword -eq $((subcommand_idx+1)) ]; then
3174 # Right after the 'add' subcommand: have to
3175 # complete the path, so fall back to Bash
3176 # filename completion.
3179 case "${words[cword-2]}" in
3180 -b|-B) # After '-b <branch>': have to
3181 # complete the path, so fall back
3182 # to Bash filename completion.
3184 *) # After the path: have to complete
3185 # the ref to be checked out.
3193 lock,*|remove,*|unlock,*)
3194 __git_complete_worktree_paths
3197 if [ $cword -eq $((subcommand_idx+1)) ]; then
3198 # The first parameter must be an existing working
3200 __git_complete_worktree_paths
3202 # The second parameter is the destination: it could
3203 # be any path, so don't list anything, but let Bash
3204 # fall back to filename completion.
3211 __git_complete_common () {
3216 __gitcomp_builtin "$command"
3221 __git_cmds_with_parseopt_helper=
3222 __git_support_parseopt_helper () {
3223 test -n "$__git_cmds_with_parseopt_helper" ||
3224 __git_cmds_with_parseopt_helper="$(__git --list-cmds=parseopt)"
3226 case " $__git_cmds_with_parseopt_helper " in
3236 __git_complete_command () {
3238 local completion_func="_git_${command//-/_}"
3239 if ! declare -f $completion_func >/dev/null 2>/dev/null &&
3240 declare -f _completion_loader >/dev/null 2>/dev/null
3242 _completion_loader "git-$command"
3244 if declare -f $completion_func >/dev/null 2>/dev/null
3248 elif __git_support_parseopt_helper "$command"
3250 __git_complete_common "$command"
3259 local i c=1 command __git_dir __git_repo_path
3260 local __git_C_args C_args_count=0
3262 while [ $c -lt $cword ]; do
3265 --git-dir=*) __git_dir="${i#--git-dir=}" ;;
3266 --git-dir) ((c++)) ; __git_dir="${words[c]}" ;;
3267 --bare) __git_dir="." ;;
3268 --help) command="help"; break ;;
3269 -c|--work-tree|--namespace) ((c++)) ;;
3270 -C) __git_C_args[C_args_count++]=-C
3272 __git_C_args[C_args_count++]="${words[c]}"
3275 *) command="$i"; break ;;
3280 if [ -z "$command" ]; then
3282 --git-dir|-C|--work-tree)
3283 # these need a path argument, let's fall back to
3284 # Bash filename completion
3288 __git_complete_config_variable_name_and_value
3292 # we don't support completing these options' arguments
3310 --no-replace-objects
3315 if test -n "$GIT_TESTING_PORCELAIN_COMMAND_LIST"
3317 __gitcomp "$GIT_TESTING_PORCELAIN_COMMAND_LIST"
3319 __gitcomp "$(__git --list-cmds=list-mainporcelain,others,nohelpers,alias,list-complete,config)"
3326 __git_complete_command "$command" && return
3328 local expansion=$(__git_aliased_command "$command")
3329 if [ -n "$expansion" ]; then
3331 __git_complete_command "$expansion"
3337 __git_has_doubledash && return
3339 local __git_repo_path
3340 __git_find_repo_path
3343 if [ -f "$__git_repo_path/MERGE_HEAD" ]; then
3349 $__git_log_common_options
3350 $__git_log_gitk_options
3356 __git_complete_revlist
3359 if [[ -n ${ZSH_VERSION-} ]] &&
3360 # Don't define these functions when sourced from 'git-completion.zsh',
3361 # it has its own implementations.
3362 [[ -z ${GIT_SOURCING_ZSH_COMPLETION-} ]]; then
3363 echo "WARNING: this script is deprecated, please see git-completion.zsh" 1>&2
3365 autoload -U +X compinit && compinit
3371 local cur_="${3-$cur}"
3377 local c IFS=$' \t\n'
3385 array[${#array[@]}+1]="$c"
3388 compadd -Q -S '' -p "${2-}" -a -- array && _ret=0
3399 compadd -Q -- ${=1} && _ret=0
3408 compadd -Q -S "${4- }" -p "${2-}" -- ${=1} && _ret=0
3411 __gitcomp_file_direct ()
3417 compadd -f -- ${=1} && _ret=0
3426 compadd -p "${2-}" -f -- ${=1} && _ret=0
3431 local _ret=1 cur cword prev
3432 cur=${words[CURRENT]}
3433 prev=${words[CURRENT-1]}
3435 emulate ksh -c __${service}_main
3436 let _ret && _default && _ret=0
3440 compdef _git git gitk
3446 local cur words cword prev
3447 _get_comp_words_by_ref -n =: cur words cword prev
3451 # Setup completion for certain functions defined above by setting common
3452 # variables and workarounds.
3453 # This is NOT a public function; use at your own risk.
3456 local wrapper="__git_wrap${2}"
3457 eval "$wrapper () { __git_func_wrap $2 ; }"
3458 complete -o bashdefault -o default -o nospace -F $wrapper $1 2>/dev/null \
3459 || complete -o default -o nospace -F $wrapper $1
3462 # wrapper for backwards compatibility
3465 __git_wrap__git_main
3468 # wrapper for backwards compatibility
3471 __git_wrap__gitk_main
3474 __git_complete git __git_main
3475 __git_complete gitk __gitk_main
3477 # The following are necessary only for Cygwin, and only are needed
3478 # when the user has tab-completed the executable name and consequently
3479 # included the '.exe' suffix.
3481 if [ Cygwin = "$(uname -o 2>/dev/null)" ]; then
3482 __git_complete git.exe __git_main