]>
git.ipfire.org Git - thirdparty/git.git/blob - contrib/completion/git-completion.bash
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 __git_complete_refs ()
787 local remote dwim pfx cur_="$cur" sfx=" "
789 while test $# != 0; do
791 --remote=*) remote="${1##--remote=}" ;;
792 --dwim) dwim="yes" ;;
793 # --track is an old spelling of --dwim
794 --track) dwim="yes" ;;
795 --pfx=*) pfx="${1##--pfx=}" ;;
796 --cur=*) cur_="${1##--cur=}" ;;
797 --sfx=*) sfx="${1##--sfx=}" ;;
803 __gitcomp_direct "$(__git_refs "$remote" "" "$pfx" "$cur_" "$sfx")"
805 if [ "$dwim" = "yes" ]; then
806 __gitcomp_direct_append "$(__git_dwim_remote_heads "$pfx" "$cur_" "$sfx")"
810 # __git_refs2 requires 1 argument (to pass to __git_refs)
811 # Deprecated: use __git_complete_fetch_refspecs() instead.
815 for i in $(__git_refs "$1"); do
820 # Completes refspecs for fetching from a remote repository.
821 # 1: The remote repository.
822 # 2: A prefix to be added to each listed refspec (optional).
823 # 3: The ref to be completed as a refspec instead of the current word to be
824 # completed (optional)
825 # 4: A suffix to be appended to each listed refspec instead of the default
827 __git_complete_fetch_refspecs ()
829 local i remote="$1" pfx="${2-}" cur_="${3-$cur}" sfx="${4- }"
832 for i in $(__git_refs "$remote" "" "" "$cur_") ; do
838 # __git_refs_remotes requires 1 argument (to pass to ls-remote)
839 __git_refs_remotes ()
842 __git ls-remote "$1" 'refs/heads/*' | \
843 while read -r hash i; do
844 echo "$i:refs/remotes/$1/${i#refs/heads/}"
851 test -d "$__git_repo_path/remotes" && ls -1 "$__git_repo_path/remotes"
855 # Returns true if $1 matches the name of a configured remote, false otherwise.
856 __git_is_configured_remote ()
859 for remote in $(__git_remotes); do
860 if [ "$remote" = "$1" ]; then
867 __git_list_merge_strategies ()
869 LANG=C LC_ALL=C git merge -s help 2>&1 |
870 sed -n -e '/[Aa]vailable strategies are: /,/^$/{
879 __git_merge_strategies=
880 # 'git merge -s help' (and thus detection of the merge strategy
881 # list) fails, unfortunately, if run outside of any git working
882 # tree. __git_merge_strategies is set to the empty string in
883 # that case, and the detection will be repeated the next time it
885 __git_compute_merge_strategies ()
887 test -n "$__git_merge_strategies" ||
888 __git_merge_strategies=$(__git_list_merge_strategies)
891 __git_merge_strategy_options="ours theirs subtree subtree= patience
892 histogram diff-algorithm= ignore-space-change ignore-all-space
893 ignore-space-at-eol renormalize no-renormalize no-renames
894 find-renames find-renames= rename-threshold="
896 __git_complete_revlist_file ()
898 local dequoted_word pfx ls ref cur_="$cur"
907 __git_dequote "$cur_"
909 case "$dequoted_word" in
911 pfx="${dequoted_word%/*}"
912 cur_="${dequoted_word##*/}"
917 cur_="$dequoted_word"
922 case "$COMP_WORDBREAKS" in
924 *) pfx="$ref:$pfx" ;;
927 __gitcomp_file "$(__git ls-tree "$ls" \
933 pfx="${cur_%...*}..."
935 __git_complete_refs --pfx="$pfx" --cur="$cur_"
940 __git_complete_refs --pfx="$pfx" --cur="$cur_"
948 __git_complete_file ()
950 __git_complete_revlist_file
953 __git_complete_revlist ()
955 __git_complete_revlist_file
958 __git_complete_remote_or_refspec ()
960 local cur_="$cur" cmd="${words[1]}"
961 local i c=2 remote="" pfx="" lhs=1 no_complete_refspec=0
962 if [ "$cmd" = "remote" ]; then
965 while [ $c -lt $cword ]; do
968 --mirror) [ "$cmd" = "push" ] && no_complete_refspec=1 ;;
969 -d|--delete) [ "$cmd" = "push" ] && lhs=0 ;;
972 push) no_complete_refspec=1 ;;
979 --multiple) no_complete_refspec=1; break ;;
981 *) remote="$i"; break ;;
985 if [ -z "$remote" ]; then
986 __gitcomp_nl "$(__git_remotes)"
989 if [ $no_complete_refspec = 1 ]; then
992 [ "$remote" = "." ] && remote=
995 case "$COMP_WORDBREAKS" in
997 *) pfx="${cur_%%:*}:" ;;
1009 if [ $lhs = 1 ]; then
1010 __git_complete_fetch_refspecs "$remote" "$pfx" "$cur_"
1012 __git_complete_refs --pfx="$pfx" --cur="$cur_"
1016 if [ $lhs = 1 ]; then
1017 __git_complete_refs --remote="$remote" --pfx="$pfx" --cur="$cur_"
1019 __git_complete_refs --pfx="$pfx" --cur="$cur_"
1023 if [ $lhs = 1 ]; then
1024 __git_complete_refs --pfx="$pfx" --cur="$cur_"
1026 __git_complete_refs --remote="$remote" --pfx="$pfx" --cur="$cur_"
1032 __git_complete_strategy ()
1034 __git_compute_merge_strategies
1037 __gitcomp "$__git_merge_strategies"
1041 __gitcomp "$__git_merge_strategy_options"
1047 __gitcomp "$__git_merge_strategies" "" "${cur##--strategy=}"
1050 --strategy-option=*)
1051 __gitcomp "$__git_merge_strategy_options" "" "${cur##--strategy-option=}"
1059 __git_compute_all_commands ()
1061 test -n "$__git_all_commands" ||
1062 __git_all_commands=$(__git --list-cmds=main,others,alias,nohelpers)
1065 # Lists all set config variables starting with the given section prefix,
1066 # with the prefix removed.
1067 __git_get_config_variables ()
1069 local section="$1" i IFS=$'\n'
1070 for i in $(__git config --name-only --get-regexp "^$section\..*"); do
1071 echo "${i#$section.}"
1075 __git_pretty_aliases ()
1077 __git_get_config_variables "pretty"
1080 # __git_aliased_command requires 1 argument
1081 __git_aliased_command ()
1083 local word cmdline=$(__git config --get "alias.$1")
1084 for word in $cmdline; do
1090 \!*) : shell command alias ;;
1092 *=*) : setting env ;;
1093 git) : git itself ;;
1094 \(\)) : skip parens of shell function definition ;;
1095 {) : skip start of shell helper function ;;
1096 :) : skip null command ;;
1097 \'*) : skip opening quote after sh -c ;;
1105 # Check whether one of the given words is present on the command line,
1106 # and print the first word found.
1108 # Usage: __git_find_on_cmdline [<option>]... "<wordlist>"
1109 # --show-idx: Optionally show the index of the found word in the $words array.
1110 __git_find_on_cmdline ()
1112 local word c=1 show_idx
1114 while test $# -gt 1; do
1116 --show-idx) show_idx=y ;;
1123 while [ $c -lt $cword ]; do
1124 for word in $wordlist; do
1125 if [ "$word" = "${words[c]}" ]; then
1126 if [ -n "$show_idx" ]; then
1138 # Similar to __git_find_on_cmdline, except that it loops backwards and thus
1139 # prints the *last* word found. Useful for finding which of two options that
1140 # supersede each other came last, such as "--guess" and "--no-guess".
1142 # Usage: __git_find_last_on_cmdline [<option>]... "<wordlist>"
1143 # --show-idx: Optionally show the index of the found word in the $words array.
1144 __git_find_last_on_cmdline ()
1146 local word c=$cword show_idx
1148 while test $# -gt 1; do
1150 --show-idx) show_idx=y ;;
1157 while [ $c -gt 1 ]; do
1159 for word in $wordlist; do
1160 if [ "$word" = "${words[c]}" ]; then
1161 if [ -n "$show_idx" ]; then
1172 # Echo the value of an option set on the command line or config
1174 # $1: short option name
1175 # $2: long option name including =
1176 # $3: list of possible values
1177 # $4: config string (optional)
1180 # result="$(__git_get_option_value "-d" "--do-something=" \
1181 # "yes no" "core.doSomething")"
1183 # result is then either empty (no option set) or "yes" or "no"
1185 # __git_get_option_value requires 3 arguments
1186 __git_get_option_value ()
1188 local c short_opt long_opt val
1189 local result= values config_key word
1197 while [ $c -ge 0 ]; do
1199 for val in $values; do
1200 if [ "$short_opt$val" = "$word" ] ||
1201 [ "$long_opt$val" = "$word" ]; then
1209 if [ -n "$config_key" ] && [ -z "$result" ]; then
1210 result="$(__git config "$config_key")"
1216 __git_has_doubledash ()
1219 while [ $c -lt $cword ]; do
1220 if [ "--" = "${words[c]}" ]; then
1228 # Try to count non option arguments passed on the command line for the
1229 # specified git command.
1230 # When options are used, it is necessary to use the special -- option to
1231 # tell the implementation were non option arguments begin.
1232 # XXX this can not be improved, since options can appear everywhere, as
1236 # __git_count_arguments requires 1 argument: the git command executed.
1237 __git_count_arguments ()
1241 # Skip "git" (first argument)
1242 for ((i=1; i < ${#words[@]}; i++)); do
1247 # Good; we can assume that the following are only non
1252 # Skip the specified git command and discard git
1265 __git_whitespacelist="nowarn warn error error-all fix"
1266 __git_patchformat="mbox stgit stgit-series hg mboxrd"
1267 __git_showcurrentpatch="diff raw"
1268 __git_am_inprogress_options="--skip --continue --resolved --abort --quit --show-current-patch"
1272 __git_find_repo_path
1273 if [ -d "$__git_repo_path"/rebase-apply ]; then
1274 __gitcomp "$__git_am_inprogress_options"
1279 __gitcomp "$__git_whitespacelist" "" "${cur##--whitespace=}"
1283 __gitcomp "$__git_patchformat" "" "${cur##--patch-format=}"
1286 --show-current-patch=*)
1287 __gitcomp "$__git_showcurrentpatch" "" "${cur##--show-current-patch=}"
1291 __gitcomp_builtin am "" \
1292 "$__git_am_inprogress_options"
1301 __gitcomp "$__git_whitespacelist" "" "${cur##--whitespace=}"
1305 __gitcomp_builtin apply
1314 __gitcomp "+x -x" "" "${cur##--chmod=}"
1318 __gitcomp_builtin add
1322 local complete_opt="--others --modified --directory --no-empty-directory"
1323 if test -n "$(__git_find_on_cmdline "-u --update")"
1325 complete_opt="--modified"
1327 __git_complete_index_file "$complete_opt"
1334 __gitcomp "$(git archive --list)" "" "${cur##--format=}"
1338 __gitcomp_nl "$(__git_remotes)" "" "${cur##--remote=}"
1342 __gitcomp_builtin archive "--format= --list --verbose --prefix= --worktree-attributes"
1351 __git_has_doubledash && return
1353 local subcommands="start bad good skip reset visualize replay log run"
1354 local subcommand="$(__git_find_on_cmdline "$subcommands")"
1355 if [ -z "$subcommand" ]; then
1356 __git_find_repo_path
1357 if [ -f "$__git_repo_path"/BISECT_START ]; then
1358 __gitcomp "$subcommands"
1360 __gitcomp "replay start"
1365 case "$subcommand" in
1366 bad|good|reset|skip|start)
1374 __git_ref_fieldlist="refname objecttype objectsize objectname upstream push HEAD symref"
1378 local i c=1 only_local_ref="n" has_r="n"
1380 while [ $c -lt $cword ]; do
1383 -d|--delete|-m|--move) only_local_ref="y" ;;
1384 -r|--remotes) has_r="y" ;;
1390 --set-upstream-to=*)
1391 __git_complete_refs --cur="${cur##--set-upstream-to=}"
1394 __gitcomp_builtin branch
1397 if [ $only_local_ref = "y" -a $has_r = "n" ]; then
1398 __gitcomp_direct "$(__git_heads "" "$cur" " ")"
1408 local cmd="${words[2]}"
1411 __gitcomp "create list-heads verify unbundle"
1414 # looking for a file
1419 __git_complete_revlist
1426 # Helper function to decide whether or not we should enable DWIM logic for
1427 # git-switch and git-checkout.
1429 # To decide between the following rules in priority order
1430 # 1) the last provided of "--guess" or "--no-guess" explicitly enable or
1431 # disable completion of DWIM logic respectively.
1432 # 2) If the --no-track option is provided, take this as a hint to disable the
1433 # DWIM completion logic
1434 # 3) If GIT_COMPLETION_CHECKOUT_NO_GUESS is set, disable the DWIM completion
1435 # logic, as requested by the user.
1436 # 4) Enable DWIM logic otherwise.
1438 __git_checkout_default_dwim_mode ()
1440 local last_option dwim_opt="--dwim"
1442 if [ "$GIT_COMPLETION_CHECKOUT_NO_GUESS" = "1" ]; then
1446 # --no-track disables DWIM, but with lower priority than
1447 # --guess/--no-guess
1448 if [ -n "$(__git_find_on_cmdline "--no-track")" ]; then
1452 # Find the last provided --guess or --no-guess
1453 last_option="$(__git_find_last_on_cmdline "--guess --no-guess")"
1454 case "$last_option" in
1468 __git_has_doubledash && return
1472 __gitcomp "diff3 merge" "" "${cur##--conflict=}"
1475 __gitcomp_builtin checkout
1478 local dwim_opt="$(__git_checkout_default_dwim_mode)"
1479 __git_complete_refs $dwim_opt
1484 __git_sequencer_inprogress_options="--continue --quit --abort --skip"
1486 __git_cherry_pick_inprogress_options=$__git_sequencer_inprogress_options
1490 __git_find_repo_path
1491 if [ -f "$__git_repo_path"/CHERRY_PICK_HEAD ]; then
1492 __gitcomp "$__git_cherry_pick_inprogress_options"
1496 __git_complete_strategy && return
1500 __gitcomp_builtin cherry-pick "" \
1501 "$__git_cherry_pick_inprogress_options"
1513 __gitcomp_builtin clean
1518 # XXX should we check for -x option ?
1519 __git_complete_index_file "--others --directory"
1526 __git_complete_config_variable_name_and_value
1532 __git_complete_config_variable_name_and_value \
1533 --cur="${cur##--config=}"
1537 __gitcomp_builtin clone
1543 __git_untracked_file_modes="all no normal"
1556 __gitcomp "default scissors strip verbatim whitespace
1557 " "" "${cur##--cleanup=}"
1560 --reuse-message=*|--reedit-message=*|\
1561 --fixup=*|--squash=*)
1562 __git_complete_refs --cur="${cur#*=}"
1565 --untracked-files=*)
1566 __gitcomp "$__git_untracked_file_modes" "" "${cur##--untracked-files=}"
1570 __gitcomp_builtin commit
1574 if __git rev-parse --verify --quiet HEAD >/dev/null; then
1575 __git_complete_index_file "--committable"
1577 # This is the first commit
1578 __git_complete_index_file "--cached"
1586 __gitcomp_builtin describe
1592 __git_diff_algorithms="myers minimal patience histogram"
1594 __git_diff_submodule_formats="diff log short"
1596 __git_color_moved_opts="no default plain blocks zebra dimmed-zebra"
1598 __git_color_moved_ws_opts="no ignore-space-at-eol ignore-space-change
1599 ignore-all-space allow-indentation-change"
1601 __git_diff_common_options="--stat --numstat --shortstat --summary
1602 --patch-with-stat --name-only --name-status --color
1603 --no-color --color-words --no-renames --check
1604 --color-moved --color-moved= --no-color-moved
1605 --color-moved-ws= --no-color-moved-ws
1606 --full-index --binary --abbrev --diff-filter=
1607 --find-copies-harder --ignore-cr-at-eol
1608 --text --ignore-space-at-eol --ignore-space-change
1609 --ignore-all-space --ignore-blank-lines --exit-code
1610 --quiet --ext-diff --no-ext-diff
1611 --no-prefix --src-prefix= --dst-prefix=
1612 --inter-hunk-context=
1613 --patience --histogram --minimal
1614 --raw --word-diff --word-diff-regex=
1615 --dirstat --dirstat= --dirstat-by-file
1616 --dirstat-by-file= --cumulative
1618 --submodule --submodule= --ignore-submodules
1619 --indent-heuristic --no-indent-heuristic
1620 --textconv --no-textconv
1625 __git_has_doubledash && return
1629 __gitcomp "$__git_diff_algorithms" "" "${cur##--diff-algorithm=}"
1633 __gitcomp "$__git_diff_submodule_formats" "" "${cur##--submodule=}"
1637 __gitcomp "$__git_color_moved_opts" "" "${cur##--color-moved=}"
1641 __gitcomp "$__git_color_moved_ws_opts" "" "${cur##--color-moved-ws=}"
1645 __gitcomp "--cached --staged --pickaxe-all --pickaxe-regex
1646 --base --ours --theirs --no-index
1647 $__git_diff_common_options
1652 __git_complete_revlist_file
1655 __git_mergetools_common="diffuse diffmerge ecmerge emerge kdiff3 meld opendiff
1656 tkdiff vimdiff gvimdiff xxdiff araxis p4merge bc
1662 __git_has_doubledash && return
1666 __gitcomp "$__git_mergetools_common kompare" "" "${cur##--tool=}"
1670 __gitcomp_builtin difftool "$__git_diff_common_options
1671 --base --cached --ours --theirs
1672 --pickaxe-all --pickaxe-regex
1678 __git_complete_revlist_file
1681 __git_fetch_recurse_submodules="yes on-demand no"
1686 --recurse-submodules=*)
1687 __gitcomp "$__git_fetch_recurse_submodules" "" "${cur##--recurse-submodules=}"
1691 __gitcomp "blob:none blob:limit= sparse:oid=" "" "${cur##--filter=}"
1695 __gitcomp_builtin fetch
1699 __git_complete_remote_or_refspec
1702 __git_format_patch_extra_options="
1703 --full-index --not --all --no-prefix --src-prefix=
1704 --dst-prefix= --notes
1707 _git_format_patch ()
1713 " "" "${cur##--thread=}"
1717 __gitcomp_builtin format-patch "$__git_format_patch_extra_options"
1721 __git_complete_revlist
1728 __gitcomp_builtin fsck
1739 # Lists matching symbol names from a tag (as in ctags) file.
1740 # 1: List symbol names matching this word.
1741 # 2: The tag file to list symbol names from.
1742 # 3: A prefix to be added to each listed symbol name (optional).
1743 # 4: A suffix to be appended to each listed symbol name (optional).
1744 __git_match_ctag () {
1745 awk -v pfx="${3-}" -v sfx="${4-}" "
1746 /^${1//\//\\/}/ { print pfx \$1 sfx }
1750 # Complete symbol names from a tag file.
1751 # Usage: __git_complete_symbol [<option>]...
1752 # --tags=<file>: The tag file to list symbol names from instead of the
1754 # --pfx=<prefix>: A prefix to be added to each symbol name.
1755 # --cur=<word>: The current symbol name to be completed. Defaults to
1756 # the current word to be completed.
1757 # --sfx=<suffix>: A suffix to be appended to each symbol name instead
1758 # of the default space.
1759 __git_complete_symbol () {
1760 local tags=tags pfx="" cur_="${cur-}" sfx=" "
1762 while test $# != 0; do
1764 --tags=*) tags="${1##--tags=}" ;;
1765 --pfx=*) pfx="${1##--pfx=}" ;;
1766 --cur=*) cur_="${1##--cur=}" ;;
1767 --sfx=*) sfx="${1##--sfx=}" ;;
1773 if test -r "$tags"; then
1774 __gitcomp_direct "$(__git_match_ctag "$cur_" "$tags" "$pfx" "$sfx")"
1780 __git_has_doubledash && return
1784 __gitcomp_builtin grep
1789 case "$cword,$prev" in
1791 __git_complete_symbol && return
1802 __gitcomp_builtin help
1806 if test -n "$GIT_TESTING_ALL_COMMAND_LIST"
1808 __gitcomp "$GIT_TESTING_ALL_COMMAND_LIST $(__git --list-cmds=alias,list-guide) gitk"
1810 __gitcomp "$(__git --list-cmds=main,nohelpers,alias,list-guide) gitk"
1819 false true umask group all world everybody
1820 " "" "${cur##--shared=}"
1824 __gitcomp_builtin init
1834 __gitcomp_builtin ls-files
1839 # XXX ignore options like --modified and always suggest all cached
1841 __git_complete_index_file "--cached"
1848 __gitcomp_builtin ls-remote
1852 __gitcomp_nl "$(__git_remotes)"
1859 __gitcomp_builtin ls-tree
1867 # Options that go well for log, shortlog and gitk
1868 __git_log_common_options="
1870 --branches --tags --remotes
1871 --first-parent --merges --no-merges
1873 --max-age= --since= --after=
1874 --min-age= --until= --before=
1875 --min-parents= --max-parents=
1876 --no-min-parents --no-max-parents
1878 # Options that go well for log and gitk (not shortlog)
1879 __git_log_gitk_options="
1880 --dense --sparse --full-history
1881 --simplify-merges --simplify-by-decoration
1882 --left-right --notes --no-notes
1884 # Options that go well for log and shortlog (not gitk)
1885 __git_log_shortlog_options="
1886 --author= --committer= --grep=
1887 --all-match --invert-grep
1890 __git_log_pretty_formats="oneline short medium full fuller reference email raw format: tformat: mboxrd"
1891 __git_log_date_formats="relative iso8601 iso8601-strict rfc2822 short local default raw unix format:"
1895 __git_has_doubledash && return
1896 __git_find_repo_path
1899 if [ -f "$__git_repo_path/MERGE_HEAD" ]; then
1902 case "$prev,$cur" in
1904 return # fall back to Bash filename completion
1907 __git_complete_symbol --cur="${cur#:}" --sfx=":"
1911 __git_complete_symbol
1916 --pretty=*|--format=*)
1917 __gitcomp "$__git_log_pretty_formats $(__git_pretty_aliases)
1922 __gitcomp "$__git_log_date_formats" "" "${cur##--date=}"
1926 __gitcomp "full short no" "" "${cur##--decorate=}"
1930 __gitcomp "$__git_diff_algorithms" "" "${cur##--diff-algorithm=}"
1934 __gitcomp "$__git_diff_submodule_formats" "" "${cur##--submodule=}"
1938 __gitcomp "sorted unsorted" "" "${cur##--no-walk=}"
1943 $__git_log_common_options
1944 $__git_log_shortlog_options
1945 $__git_log_gitk_options
1946 --root --topo-order --date-order --reverse
1947 --follow --full-diff
1948 --abbrev-commit --no-abbrev-commit --abbrev=
1949 --relative-date --date=
1950 --pretty= --format= --oneline
1955 --decorate --decorate= --no-decorate
1957 --no-walk --no-walk= --do-walk
1958 --parents --children
1959 --expand-tabs --expand-tabs= --no-expand-tabs
1962 $__git_diff_common_options
1963 --pickaxe-all --pickaxe-regex
1968 return # fall back to Bash filename completion
1971 __git_complete_symbol --cur="${cur#-L:}" --sfx=":"
1975 __git_complete_symbol --pfx="-G" --cur="${cur#-G}"
1979 __git_complete_symbol --pfx="-S" --cur="${cur#-S}"
1983 __git_complete_revlist
1988 __git_complete_strategy && return
1992 __gitcomp_builtin merge
2002 __gitcomp "$__git_mergetools_common tortoisemerge" "" "${cur##--tool=}"
2006 __gitcomp "--tool= --prompt --no-prompt --gui --no-gui"
2016 __gitcomp_builtin merge-base
2027 __gitcomp_builtin mv
2032 if [ $(__git_count_arguments "mv") -gt 0 ]; then
2033 # We need to show both cached and untracked files (including
2034 # empty directories) since this may not be the last argument.
2035 __git_complete_index_file "--cached --others --directory"
2037 __git_complete_index_file "--cached"
2043 local subcommands='add append copy edit get-ref list merge prune remove show'
2044 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2046 case "$subcommand,$cur" in
2048 __gitcomp_builtin notes
2056 __gitcomp "$subcommands --ref"
2060 *,--reuse-message=*|*,--reedit-message=*)
2061 __git_complete_refs --cur="${cur#*=}"
2064 __gitcomp_builtin notes_$subcommand
2067 # this command does not take a ref, do not complete it
2083 __git_complete_strategy && return
2086 --recurse-submodules=*)
2087 __gitcomp "$__git_fetch_recurse_submodules" "" "${cur##--recurse-submodules=}"
2091 __gitcomp_builtin pull
2096 __git_complete_remote_or_refspec
2099 __git_push_recurse_submodules="check on-demand only"
2101 __git_complete_force_with_lease ()
2109 __git_complete_refs --cur="${cur_#*:}"
2112 __git_complete_refs --cur="$cur_"
2121 __gitcomp_nl "$(__git_remotes)"
2124 --recurse-submodules)
2125 __gitcomp "$__git_push_recurse_submodules"
2131 __gitcomp_nl "$(__git_remotes)" "" "${cur##--repo=}"
2134 --recurse-submodules=*)
2135 __gitcomp "$__git_push_recurse_submodules" "" "${cur##--recurse-submodules=}"
2138 --force-with-lease=*)
2139 __git_complete_force_with_lease "${cur##--force-with-lease=}"
2143 __gitcomp_builtin push
2147 __git_complete_remote_or_refspec
2155 --creation-factor= --no-dual-color
2156 $__git_diff_common_options
2161 __git_complete_revlist
2164 __git_rebase_inprogress_options="--continue --skip --abort --quit --show-current-patch"
2165 __git_rebase_interactive_inprogress_options="$__git_rebase_inprogress_options --edit-todo"
2169 __git_find_repo_path
2170 if [ -f "$__git_repo_path"/rebase-merge/interactive ]; then
2171 __gitcomp "$__git_rebase_interactive_inprogress_options"
2173 elif [ -d "$__git_repo_path"/rebase-apply ] || \
2174 [ -d "$__git_repo_path"/rebase-merge ]; then
2175 __gitcomp "$__git_rebase_inprogress_options"
2178 __git_complete_strategy && return
2181 __gitcomp "$__git_whitespacelist" "" "${cur##--whitespace=}"
2185 __git_complete_refs --cur="${cur##--onto=}"
2189 __gitcomp_builtin rebase "" \
2190 "$__git_rebase_interactive_inprogress_options"
2199 local subcommands="show delete expire"
2200 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2202 if [ -z "$subcommand" ]; then
2203 __gitcomp "$subcommands"
2209 __git_send_email_confirm_options="always never auto cc compose"
2210 __git_send_email_suppresscc_options="author self cc bodycc sob cccmd body all"
2215 --to|--cc|--bcc|--from)
2216 __gitcomp "$(__git send-email --dump-aliases)"
2224 $__git_send_email_confirm_options
2225 " "" "${cur##--confirm=}"
2230 $__git_send_email_suppresscc_options
2231 " "" "${cur##--suppress-cc=}"
2235 --smtp-encryption=*)
2236 __gitcomp "ssl tls" "" "${cur##--smtp-encryption=}"
2242 " "" "${cur##--thread=}"
2245 --to=*|--cc=*|--bcc=*|--from=*)
2246 __gitcomp "$(__git send-email --dump-aliases)" "" "${cur#--*=}"
2250 __gitcomp_builtin send-email "--annotate --bcc --cc --cc-cmd --chain-reply-to
2251 --compose --confirm= --dry-run --envelope-sender
2253 --in-reply-to --no-chain-reply-to --no-signed-off-by-cc
2254 --no-suppress-from --no-thread --quiet --reply-to
2255 --signed-off-by-cc --smtp-pass --smtp-server
2256 --smtp-server-port --smtp-encryption= --smtp-user
2257 --subject --suppress-cc= --suppress-from --thread --to
2258 --validate --no-validate
2259 $__git_format_patch_extra_options"
2263 __git_complete_revlist
2274 local untracked_state
2277 --ignore-submodules=*)
2278 __gitcomp "none untracked dirty all" "" "${cur##--ignore-submodules=}"
2281 --untracked-files=*)
2282 __gitcomp "$__git_untracked_file_modes" "" "${cur##--untracked-files=}"
2287 always never auto column row plain dense nodense
2288 " "" "${cur##--column=}"
2292 __gitcomp_builtin status
2297 untracked_state="$(__git_get_option_value "-u" "--untracked-files=" \
2298 "$__git_untracked_file_modes" "status.showUntrackedFiles")"
2300 case "$untracked_state" in
2302 # --ignored option does not matter
2306 complete_opt="--cached --directory --no-empty-directory --others"
2308 if [ -n "$(__git_find_on_cmdline "--ignored")" ]; then
2309 complete_opt="$complete_opt --ignored --exclude=*"
2314 __git_complete_index_file "$complete_opt"
2321 __gitcomp "diff3 merge" "" "${cur##--conflict=}"
2324 __gitcomp_builtin switch
2327 local dwim_opt="$(__git_checkout_default_dwim_mode)" only_local_ref=n
2328 if [ -z "$(__git_find_on_cmdline "-d --detach")" ]; then
2331 # --guess --detach is invalid combination, no
2332 # dwim will be done when --detach is specified
2335 if [ $only_local_ref = y -a -z "$dwim_opt" ]; then
2336 __gitcomp_direct "$(__git_heads "" "$cur" " ")"
2338 __git_complete_refs $dwim_opt
2344 __git_config_get_set_variables ()
2346 local prevword word config_file= c=$cword
2347 while [ $c -gt 1 ]; do
2350 --system|--global|--local|--file=*)
2355 config_file="$word $prevword"
2363 __git config $config_file --name-only --list
2367 __git_compute_config_vars ()
2369 test -n "$__git_config_vars" ||
2370 __git_config_vars="$(git help --config-for-completion | sort -u)"
2373 # Completes possible values of various configuration variables.
2375 # Usage: __git_complete_config_variable_value [<option>]...
2376 # --varname=<word>: The name of the configuration variable whose value is
2377 # to be completed. Defaults to the previous word on the
2379 # --cur=<word>: The current value to be completed. Defaults to the current
2380 # word to be completed.
2381 __git_complete_config_variable_value ()
2383 local varname="$prev" cur_="$cur"
2385 while test $# != 0; do
2387 --varname=*) varname="${1##--varname=}" ;;
2388 --cur=*) cur_="${1##--cur=}" ;;
2394 if [ "${BASH_VERSINFO[0]:-0}" -ge 4 ]; then
2395 varname="${varname,,}"
2397 varname="$(echo "$varname" |tr A-Z a-z)"
2401 branch.*.remote|branch.*.pushremote)
2402 __gitcomp_nl "$(__git_remotes)" "" "$cur_"
2406 __git_complete_refs --cur="$cur_"
2410 __gitcomp "false true merges preserve interactive" "" "$cur_"
2414 __gitcomp_nl "$(__git_remotes)" "" "$cur_"
2418 local remote="${varname#remote.}"
2419 remote="${remote%.fetch}"
2420 if [ -z "$cur_" ]; then
2421 __gitcomp_nl "refs/heads/" "" "" ""
2424 __gitcomp_nl "$(__git_refs_remotes "$remote")" "" "$cur_"
2428 local remote="${varname#remote.}"
2429 remote="${remote%.push}"
2430 __gitcomp_nl "$(__git for-each-ref \
2431 --format='%(refname):%(refname)' refs/heads)" "" "$cur_"
2434 pull.twohead|pull.octopus)
2435 __git_compute_merge_strategies
2436 __gitcomp "$__git_merge_strategies" "" "$cur_"
2440 __gitcomp "false true" "" "$cur_"
2445 normal black red green yellow blue magenta cyan white
2446 bold dim ul blink reverse
2451 __gitcomp "false true always never auto" "" "$cur_"
2455 __gitcomp "$__git_diff_submodule_formats" "" "$cur_"
2459 __gitcomp "man info web html" "" "$cur_"
2463 __gitcomp "$__git_log_date_formats" "" "$cur_"
2466 sendemail.aliasfiletype)
2467 __gitcomp "mutt mailrc pine elm gnus" "" "$cur_"
2471 __gitcomp "$__git_send_email_confirm_options" "" "$cur_"
2474 sendemail.suppresscc)
2475 __gitcomp "$__git_send_email_suppresscc_options" "" "$cur_"
2478 sendemail.transferencoding)
2479 __gitcomp "7bit 8bit quoted-printable base64" "" "$cur_"
2488 # Completes configuration sections, subsections, variable names.
2490 # Usage: __git_complete_config_variable_name [<option>]...
2491 # --cur=<word>: The current configuration section/variable name to be
2492 # completed. Defaults to the current word to be completed.
2493 # --sfx=<suffix>: A suffix to be appended to each fully completed
2494 # configuration variable name (but not to sections or
2495 # subsections) instead of the default space.
2496 __git_complete_config_variable_name ()
2498 local cur_="$cur" sfx
2500 while test $# != 0; do
2502 --cur=*) cur_="${1##--cur=}" ;;
2503 --sfx=*) sfx="${1##--sfx=}" ;;
2511 local pfx="${cur_%.*}."
2513 __gitcomp "remote pushRemote merge mergeOptions rebase" "$pfx" "$cur_" "$sfx"
2517 local pfx="${cur%.*}."
2519 __gitcomp_direct "$(__git_heads "$pfx" "$cur_" ".")"
2520 __gitcomp_nl_append $'autoSetupMerge\nautoSetupRebase\n' "$pfx" "$cur_" "$sfx"
2524 local pfx="${cur_%.*}."
2527 argPrompt cmd confirm needsFile noConsole noRescan
2528 prompt revPrompt revUnmerged title
2529 " "$pfx" "$cur_" "$sfx"
2533 local pfx="${cur_%.*}."
2535 __gitcomp "cmd path" "$pfx" "$cur_" "$sfx"
2539 local pfx="${cur_%.*}."
2541 __gitcomp "cmd path" "$pfx" "$cur_" "$sfx"
2545 local pfx="${cur_%.*}."
2547 __gitcomp "cmd path trustExitCode" "$pfx" "$cur_" "$sfx"
2551 local pfx="${cur_%.*}."
2553 __git_compute_all_commands
2554 __gitcomp_nl "$__git_all_commands" "$pfx" "$cur_" "$sfx"
2558 local pfx="${cur_%.*}."
2561 url proxy fetch push mirror skipDefaultUpdate
2562 receivepack uploadpack tagOpt pushurl
2563 " "$pfx" "$cur_" "$sfx"
2567 local pfx="${cur_%.*}."
2569 __gitcomp_nl "$(__git_remotes)" "$pfx" "$cur_" "."
2570 __gitcomp_nl_append "pushDefault" "$pfx" "$cur_" "$sfx"
2574 local pfx="${cur_%.*}."
2576 __gitcomp "insteadOf pushInsteadOf" "$pfx" "$cur_" "$sfx"
2580 __git_compute_config_vars
2581 __gitcomp "$__git_config_vars" "" "$cur_" "$sfx"
2584 __git_compute_config_vars
2585 __gitcomp "$(echo "$__git_config_vars" |
2598 # Completes '='-separated configuration sections/variable names and values
2599 # for 'git -c section.name=value'.
2601 # Usage: __git_complete_config_variable_name_and_value [<option>]...
2602 # --cur=<word>: The current configuration section/variable name/value to be
2603 # completed. Defaults to the current word to be completed.
2604 __git_complete_config_variable_name_and_value ()
2608 while test $# != 0; do
2610 --cur=*) cur_="${1##--cur=}" ;;
2618 __git_complete_config_variable_value \
2619 --varname="${cur_%%=*}" --cur="${cur_#*=}"
2622 __git_complete_config_variable_name --cur="$cur_" --sfx='='
2630 --get|--get-all|--unset|--unset-all)
2631 __gitcomp_nl "$(__git_config_get_set_variables)"
2635 __git_complete_config_variable_value
2641 __gitcomp_builtin config
2644 __git_complete_config_variable_name
2652 add rename remove set-head set-branches
2653 get-url set-url show prune update
2655 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2656 if [ -z "$subcommand" ]; then
2659 __gitcomp_builtin remote
2662 __gitcomp "$subcommands"
2668 case "$subcommand,$cur" in
2670 __gitcomp_builtin remote_add
2675 __gitcomp_builtin remote_set-head
2678 __gitcomp_builtin remote_set-branches
2680 set-head,*|set-branches,*)
2681 __git_complete_remote_or_refspec
2684 __gitcomp_builtin remote_update
2687 __gitcomp "$(__git_remotes) $(__git_get_config_variables "remotes")"
2690 __gitcomp_builtin remote_set-url
2693 __gitcomp_builtin remote_get-url
2696 __gitcomp_builtin remote_prune
2699 __gitcomp_nl "$(__git_remotes)"
2708 __gitcomp "short medium long" "" "${cur##--format=}"
2712 __gitcomp_builtin replace
2721 local subcommands="clear forget diff remaining status gc"
2722 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2723 if test -z "$subcommand"
2725 __gitcomp "$subcommands"
2732 __git_has_doubledash && return
2736 __gitcomp_builtin reset
2747 __gitcomp "diff3 merge" "" "${cur##--conflict=}"
2750 __git_complete_refs --cur="${cur##--source=}"
2753 __gitcomp_builtin restore
2758 __git_revert_inprogress_options=$__git_sequencer_inprogress_options
2762 __git_find_repo_path
2763 if [ -f "$__git_repo_path"/REVERT_HEAD ]; then
2764 __gitcomp "$__git_revert_inprogress_options"
2767 __git_complete_strategy && return
2770 __gitcomp_builtin revert "" \
2771 "$__git_revert_inprogress_options"
2782 __gitcomp_builtin rm
2787 __git_complete_index_file "--cached"
2792 __git_has_doubledash && return
2797 $__git_log_common_options
2798 $__git_log_shortlog_options
2799 --numbered --summary --email
2804 __git_complete_revlist
2809 __git_has_doubledash && return
2812 --pretty=*|--format=*)
2813 __gitcomp "$__git_log_pretty_formats $(__git_pretty_aliases)
2818 __gitcomp "$__git_diff_algorithms" "" "${cur##--diff-algorithm=}"
2822 __gitcomp "$__git_diff_submodule_formats" "" "${cur##--submodule=}"
2826 __gitcomp "--pretty= --format= --abbrev-commit --no-abbrev-commit
2827 --oneline --show-signature --patch
2828 --expand-tabs --expand-tabs= --no-expand-tabs
2829 $__git_diff_common_options
2834 __git_complete_revlist_file
2841 __gitcomp_builtin show-branch
2845 __git_complete_revlist
2848 _git_sparse_checkout ()
2850 local subcommands="list init set disable"
2851 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2852 if [ -z "$subcommand" ]; then
2853 __gitcomp "$subcommands"
2857 case "$subcommand,$cur" in
2871 local save_opts='--all --keep-index --no-keep-index --quiet --patch --include-untracked'
2872 local subcommands='push list show apply clear drop pop create branch'
2873 local subcommand="$(__git_find_on_cmdline "$subcommands save")"
2874 if [ -n "$(__git_find_on_cmdline "-p")" ]; then
2877 if [ -z "$subcommand" ]; then
2880 __gitcomp "$save_opts"
2883 if [ -z "$(__git_find_on_cmdline "$save_opts")" ]; then
2888 if [ -z "$(__git_find_on_cmdline "$save_opts")" ]; then
2889 __gitcomp "$subcommands"
2894 case "$subcommand,$cur" in
2896 __gitcomp "$save_opts --message"
2899 __gitcomp "$save_opts"
2902 __gitcomp "--index --quiet"
2908 __gitcomp "--name-status --oneline --patch-with-stat"
2910 show,--*|branch,--*)
2913 if [ $cword -eq 3 ]; then
2916 __gitcomp_nl "$(__git stash list \
2917 | sed -n -e 's/:.*//p')"
2920 show,*|apply,*|drop,*|pop,*)
2921 __gitcomp_nl "$(__git stash list \
2922 | sed -n -e 's/:.*//p')"
2932 __git_has_doubledash && return
2934 local subcommands="add status init deinit update set-branch set-url summary foreach sync absorbgitdirs"
2935 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2936 if [ -z "$subcommand" ]; then
2942 __gitcomp "$subcommands"
2948 case "$subcommand,$cur" in
2950 __gitcomp "--branch --force --name --reference --depth"
2953 __gitcomp "--cached --recursive"
2956 __gitcomp "--force --all"
2960 --init --remote --no-fetch
2961 --recommend-shallow --no-recommend-shallow
2962 --force --rebase --merge --reference --depth --recursive --jobs
2966 __gitcomp "--default --branch"
2969 __gitcomp "--cached --files --summary-limit"
2971 foreach,--*|sync,--*)
2972 __gitcomp "--recursive"
2982 init fetch clone rebase dcommit log find-rev
2983 set-tree commit-diff info create-ignore propget
2984 proplist show-ignore show-externals branch tag blame
2985 migrate mkdirs reset gc
2987 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2988 if [ -z "$subcommand" ]; then
2989 __gitcomp "$subcommands"
2991 local remote_opts="--username= --config-dir= --no-auth-cache"
2993 --follow-parent --authors-file= --repack=
2994 --no-metadata --use-svm-props --use-svnsync-props
2995 --log-window-size= --no-checkout --quiet
2996 --repack-flags --use-log-author --localtime
2999 --ignore-paths= --include-paths= $remote_opts
3002 --template= --shared= --trunk= --tags=
3003 --branches= --stdlayout --minimize-url
3004 --no-metadata --use-svm-props --use-svnsync-props
3005 --rewrite-root= --prefix= $remote_opts
3008 --edit --rmdir --find-copies-harder --copy-similarity=
3011 case "$subcommand,$cur" in
3013 __gitcomp "--revision= --fetch-all $fc_opts"
3016 __gitcomp "--revision= $fc_opts $init_opts"
3019 __gitcomp "$init_opts"
3023 --merge --strategy= --verbose --dry-run
3024 --fetch-all --no-rebase --commit-url
3025 --revision --interactive $cmt_opts $fc_opts
3029 __gitcomp "--stdin $cmt_opts $fc_opts"
3031 create-ignore,--*|propget,--*|proplist,--*|show-ignore,--*|\
3032 show-externals,--*|mkdirs,--*)
3033 __gitcomp "--revision="
3037 --limit= --revision= --verbose --incremental
3038 --oneline --show-commit --non-recursive
3039 --authors-file= --color
3044 --merge --verbose --strategy= --local
3045 --fetch-all --dry-run $fc_opts
3049 __gitcomp "--message= --file= --revision= $cmt_opts"
3055 __gitcomp "--dry-run --message --tag"
3058 __gitcomp "--dry-run --message"
3061 __gitcomp "--git-format"
3065 --config-dir= --ignore-paths= --minimize
3066 --no-auth-cache --username=
3070 __gitcomp "--revision= --parent"
3081 while [ $c -lt $cword ]; do
3084 -d|--delete|-v|--verify)
3085 __gitcomp_direct "$(__git_tags "" "$cur" " ")"
3100 __gitcomp_direct "$(__git_tags "" "$cur" " ")"
3110 __gitcomp_builtin tag
3120 __git_complete_worktree_paths ()
3123 __gitcomp_nl "$(git worktree list --porcelain |
3124 # Skip the first entry: it's the path of the main worktree,
3125 # which can't be moved, removed, locked, etc.
3126 sed -n -e '2,$ s/^worktree //p')"
3131 local subcommands="add list lock move prune remove unlock"
3132 local subcommand subcommand_idx
3134 subcommand="$(__git_find_on_cmdline --show-idx "$subcommands")"
3135 subcommand_idx="${subcommand% *}"
3136 subcommand="${subcommand#* }"
3138 case "$subcommand,$cur" in
3140 __gitcomp "$subcommands"
3143 __gitcomp_builtin worktree_$subcommand
3145 add,*) # usage: git worktree add [<options>] <path> [<commit-ish>]
3146 # Here we are not completing an --option, it's either the
3149 -b|-B) # Complete refs for branch to be created/reseted.
3152 -*) # The previous word is an -o|--option without an
3153 # unstuck argument: have to complete the path for
3154 # the new worktree, so don't list anything, but let
3155 # Bash fall back to filename completion.
3157 *) # The previous word is not an --option, so it must
3158 # be either the 'add' subcommand, the unstuck
3159 # argument of an option (e.g. branch for -b|-B), or
3160 # the path for the new worktree.
3161 if [ $cword -eq $((subcommand_idx+1)) ]; then
3162 # Right after the 'add' subcommand: have to
3163 # complete the path, so fall back to Bash
3164 # filename completion.
3167 case "${words[cword-2]}" in
3168 -b|-B) # After '-b <branch>': have to
3169 # complete the path, so fall back
3170 # to Bash filename completion.
3172 *) # After the path: have to complete
3173 # the ref to be checked out.
3181 lock,*|remove,*|unlock,*)
3182 __git_complete_worktree_paths
3185 if [ $cword -eq $((subcommand_idx+1)) ]; then
3186 # The first parameter must be an existing working
3188 __git_complete_worktree_paths
3190 # The second parameter is the destination: it could
3191 # be any path, so don't list anything, but let Bash
3192 # fall back to filename completion.
3199 __git_complete_common () {
3204 __gitcomp_builtin "$command"
3209 __git_cmds_with_parseopt_helper=
3210 __git_support_parseopt_helper () {
3211 test -n "$__git_cmds_with_parseopt_helper" ||
3212 __git_cmds_with_parseopt_helper="$(__git --list-cmds=parseopt)"
3214 case " $__git_cmds_with_parseopt_helper " in
3224 __git_complete_command () {
3226 local completion_func="_git_${command//-/_}"
3227 if ! declare -f $completion_func >/dev/null 2>/dev/null &&
3228 declare -f _completion_loader >/dev/null 2>/dev/null
3230 _completion_loader "git-$command"
3232 if declare -f $completion_func >/dev/null 2>/dev/null
3236 elif __git_support_parseopt_helper "$command"
3238 __git_complete_common "$command"
3247 local i c=1 command __git_dir __git_repo_path
3248 local __git_C_args C_args_count=0
3250 while [ $c -lt $cword ]; do
3253 --git-dir=*) __git_dir="${i#--git-dir=}" ;;
3254 --git-dir) ((c++)) ; __git_dir="${words[c]}" ;;
3255 --bare) __git_dir="." ;;
3256 --help) command="help"; break ;;
3257 -c|--work-tree|--namespace) ((c++)) ;;
3258 -C) __git_C_args[C_args_count++]=-C
3260 __git_C_args[C_args_count++]="${words[c]}"
3263 *) command="$i"; break ;;
3268 if [ -z "$command" ]; then
3270 --git-dir|-C|--work-tree)
3271 # these need a path argument, let's fall back to
3272 # Bash filename completion
3276 __git_complete_config_variable_name_and_value
3280 # we don't support completing these options' arguments
3298 --no-replace-objects
3303 if test -n "$GIT_TESTING_PORCELAIN_COMMAND_LIST"
3305 __gitcomp "$GIT_TESTING_PORCELAIN_COMMAND_LIST"
3307 __gitcomp "$(__git --list-cmds=list-mainporcelain,others,nohelpers,alias,list-complete,config)"
3314 __git_complete_command "$command" && return
3316 local expansion=$(__git_aliased_command "$command")
3317 if [ -n "$expansion" ]; then
3319 __git_complete_command "$expansion"
3325 __git_has_doubledash && return
3327 local __git_repo_path
3328 __git_find_repo_path
3331 if [ -f "$__git_repo_path/MERGE_HEAD" ]; then
3337 $__git_log_common_options
3338 $__git_log_gitk_options
3344 __git_complete_revlist
3347 if [[ -n ${ZSH_VERSION-} ]] &&
3348 # Don't define these functions when sourced from 'git-completion.zsh',
3349 # it has its own implementations.
3350 [[ -z ${GIT_SOURCING_ZSH_COMPLETION-} ]]; then
3351 echo "WARNING: this script is deprecated, please see git-completion.zsh" 1>&2
3353 autoload -U +X compinit && compinit
3359 local cur_="${3-$cur}"
3365 local c IFS=$' \t\n'
3373 array[${#array[@]}+1]="$c"
3376 compadd -Q -S '' -p "${2-}" -a -- array && _ret=0
3387 compadd -Q -- ${=1} && _ret=0
3396 compadd -Q -S "${4- }" -p "${2-}" -- ${=1} && _ret=0
3399 __gitcomp_file_direct ()
3405 compadd -f -- ${=1} && _ret=0
3414 compadd -p "${2-}" -f -- ${=1} && _ret=0
3419 local _ret=1 cur cword prev
3420 cur=${words[CURRENT]}
3421 prev=${words[CURRENT-1]}
3423 emulate ksh -c __${service}_main
3424 let _ret && _default && _ret=0
3428 compdef _git git gitk
3434 local cur words cword prev
3435 _get_comp_words_by_ref -n =: cur words cword prev
3439 # Setup completion for certain functions defined above by setting common
3440 # variables and workarounds.
3441 # This is NOT a public function; use at your own risk.
3444 local wrapper="__git_wrap${2}"
3445 eval "$wrapper () { __git_func_wrap $2 ; }"
3446 complete -o bashdefault -o default -o nospace -F $wrapper $1 2>/dev/null \
3447 || complete -o default -o nospace -F $wrapper $1
3450 # wrapper for backwards compatibility
3453 __git_wrap__git_main
3456 # wrapper for backwards compatibility
3459 __git_wrap__gitk_main
3462 __git_complete git __git_main
3463 __git_complete gitk __gitk_main
3465 # The following are necessary only for Cygwin, and only are needed
3466 # when the user has tab-completed the executable name and consequently
3467 # included the '.exe' suffix.
3469 if [ Cygwin = "$(uname -o 2>/dev/null)" ]; then
3470 __git_complete git.exe __git_main