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
306 local x i=${#COMPREPLY[@]}
308 if [[ "$x" == "$3"* ]]; then
309 COMPREPLY[i++]="$2$x$4"
320 # Generates completion reply, appending a space to possible completion words,
322 # It accepts 1 to 4 arguments:
323 # 1: List of possible completion words.
324 # 2: A prefix to be added to each possible completion word (optional).
325 # 3: Generate possible completion matches for this word (optional).
326 # 4: A suffix to be appended to each possible completion word (optional).
329 local cur_="${3-$cur}"
335 local c i=0 IFS=$' \t\n'
337 if [[ $c == "--" ]]; then
341 if [[ $c == "$cur_"* ]]; then
346 COMPREPLY[i++]="${2-}$c"
351 local c i=0 IFS=$' \t\n'
353 if [[ $c == "--" ]]; then
355 if [[ $c == "$cur_"* ]]; then
356 COMPREPLY[i++]="${2-}$c "
361 if [[ $c == "$cur_"* ]]; then
366 COMPREPLY[i++]="${2-}$c"
373 # Clear the variables caching builtins' options when (re-)sourcing
374 # the completion script.
375 if [[ -n ${ZSH_VERSION-} ]]; then
376 unset $(set |sed -ne 's/^\(__gitcomp_builtin_[a-zA-Z0-9_][a-zA-Z0-9_]*\)=.*/\1/p') 2>/dev/null
378 unset $(compgen -v __gitcomp_builtin_)
381 # This function is equivalent to
383 # __gitcomp "$(git xxx --git-completion-helper) ..."
385 # except that the output is cached. Accept 1-3 arguments:
386 # 1: the git command to execute, this is also the cache key
387 # 2: extra options to be added on top (e.g. negative forms)
388 # 3: options to be excluded
391 # spaces must be replaced with underscore for multi-word
392 # commands, e.g. "git remote add" becomes remote_add.
397 local var=__gitcomp_builtin_"${cmd/-/_}"
399 eval "options=\$$var"
401 if [ -z "$options" ]; then
402 # leading and trailing spaces are significant to make
403 # option removal work correctly.
404 options=" $incl $(__git ${cmd/_/ } --git-completion-helper) " || return
407 options="${options/ $i / }"
409 eval "$var=\"$options\""
415 # Variation of __gitcomp_nl () that appends to the existing list of
416 # completion candidates, COMPREPLY.
417 __gitcomp_nl_append ()
420 __gitcompappend "$1" "${2-}" "${3-$cur}" "${4- }"
423 # Generates completion reply from newline-separated possible completion words
424 # by appending a space to all of them.
425 # It accepts 1 to 4 arguments:
426 # 1: List of possible completion words, separated by a single newline.
427 # 2: A prefix to be added to each possible completion word (optional).
428 # 3: Generate possible completion matches for this word (optional).
429 # 4: A suffix to be appended to each possible completion word instead of
430 # the default space (optional). If specified but empty, nothing is
435 __gitcomp_nl_append "$@"
438 # Fills the COMPREPLY array with prefiltered paths without any additional
440 # Callers must take care of providing only paths that match the current path
441 # to be completed and adding any prefix path components, if necessary.
442 # 1: List of newline-separated matching paths, complete with all prefix
444 __gitcomp_file_direct ()
450 # use a hack to enable file mode in bash < 4
451 compopt -o filenames +o nospace 2>/dev/null ||
452 compgen -f /non-existing-dir/ >/dev/null ||
456 # Generates completion reply with compgen from newline-separated possible
457 # completion filenames.
458 # It accepts 1 to 3 arguments:
459 # 1: List of possible completion filenames, separated by a single newline.
460 # 2: A directory prefix to be added to each possible completion filename
462 # 3: Generate possible completion matches for this word (optional).
467 # XXX does not work when the directory prefix contains a tilde,
468 # since tilde expansion is not applied.
469 # This means that COMPREPLY will be empty and Bash default
470 # completion will be used.
471 __gitcompadd "$1" "${2-}" "${3-$cur}" ""
473 # use a hack to enable file mode in bash < 4
474 compopt -o filenames +o nospace 2>/dev/null ||
475 compgen -f /non-existing-dir/ >/dev/null ||
479 # Execute 'git ls-files', unless the --committable option is specified, in
480 # which case it runs 'git diff-index' to find out the files that can be
481 # committed. It return paths relative to the directory specified in the first
482 # argument, and using the options specified in the second argument.
483 __git_ls_files_helper ()
485 if [ "$2" == "--committable" ]; then
486 __git -C "$1" -c core.quotePath=false diff-index \
487 --name-only --relative HEAD -- "${3//\\/\\\\}*"
489 # NOTE: $2 is not quoted in order to support multiple options
490 __git -C "$1" -c core.quotePath=false ls-files \
491 --exclude-standard $2 -- "${3//\\/\\\\}*"
496 # __git_index_files accepts 1 or 2 arguments:
497 # 1: Options to pass to ls-files (required).
498 # 2: A directory path (optional).
499 # If provided, only files within the specified directory are listed.
500 # Sub directories are never recursed. Path must have a trailing
502 # 3: List only paths matching this path component (optional).
505 local root="$2" match="$3"
507 __git_ls_files_helper "$root" "$1" "$match" |
508 awk -F / -v pfx="${2//\\/\\\\}" '{
513 if (substr(p, 1, 1) != "\"") {
514 # No special characters, easy!
519 # The path is quoted.
524 # Even when a directory name itself does not contain
525 # any special characters, it will still be quoted if
526 # any of its (stripped) trailing path components do.
527 # Because of this we may have seen the same directory
528 # both quoted and unquoted.
530 # We have seen the same directory unquoted,
537 function dequote(p, bs_idx, out, esc, esc_idx, dec) {
538 # Skip opening double quote.
541 # Interpret backslash escape sequences.
542 while ((bs_idx = index(p, "\\")) != 0) {
543 out = out substr(p, 1, bs_idx - 1)
544 esc = substr(p, bs_idx + 1, 1)
545 p = substr(p, bs_idx + 2)
547 if ((esc_idx = index("abtvfr\"\\", esc)) != 0) {
548 # C-style one-character escape sequence.
549 out = out substr("\a\b\t\v\f\r\"\\",
551 } else if (esc == "n") {
552 # Uh-oh, a newline character.
553 # We cant reliably put a pathname
554 # containing a newline into COMPREPLY,
555 # and the newline would create a mess.
559 # Must be a \nnn octal value, then.
561 substr(p, 1, 1) * 8 + \
563 out = out sprintf("%c", dec)
567 # Drop closing double quote, if there is one.
568 # (There isnt any if this is a directory, as it was
569 # already stripped with the trailing path components.)
570 if (substr(p, length(p), 1) == "\"")
571 out = out substr(p, 1, length(p) - 1)
579 # __git_complete_index_file requires 1 argument:
580 # 1: the options to pass to ls-file
582 # The exception is --committable, which finds the files appropriate commit.
583 __git_complete_index_file ()
585 local dequoted_word pfx="" cur_
589 case "$dequoted_word" in
591 pfx="${dequoted_word%/*}/"
592 cur_="${dequoted_word##*/}"
595 cur_="$dequoted_word"
598 __gitcomp_file_direct "$(__git_index_files "$1" "$pfx" "$cur_")"
601 # Lists branches from the local repository.
602 # 1: A prefix to be added to each listed branch (optional).
603 # 2: List only branches matching this word (optional; list all branches if
605 # 3: A suffix to be appended to each listed branch (optional).
608 local pfx="${1-}" cur_="${2-}" sfx="${3-}"
610 __git for-each-ref --format="${pfx//\%/%%}%(refname:strip=2)$sfx" \
611 "refs/heads/$cur_*" "refs/heads/$cur_*/**"
614 # Lists tags from the local repository.
615 # Accepts the same positional parameters as __git_heads() above.
618 local pfx="${1-}" cur_="${2-}" sfx="${3-}"
620 __git for-each-ref --format="${pfx//\%/%%}%(refname:strip=2)$sfx" \
621 "refs/tags/$cur_*" "refs/tags/$cur_*/**"
624 # Lists refs from the local (by default) or from a remote repository.
625 # It accepts 0, 1 or 2 arguments:
626 # 1: The remote to list refs from (optional; ignored, if set but empty).
627 # Can be the name of a configured remote, a path, or a URL.
628 # 2: In addition to local refs, list unique branches from refs/remotes/ for
629 # 'git checkout's tracking DWIMery (optional; ignored, if set but empty).
630 # 3: A prefix to be added to each listed ref (optional).
631 # 4: List only refs matching this word (optional; list all refs if unset or
633 # 5: A suffix to be appended to each listed ref (optional; ignored, if set
636 # Use __git_complete_refs() instead.
639 local i hash dir track="${2-}"
640 local list_refs_from=path remote="${1-}"
642 local pfx="${3-}" cur_="${4-$cur}" sfx="${5-}"
644 local fer_pfx="${pfx//\%/%%}" # "escape" for-each-ref format specifiers
647 dir="$__git_repo_path"
649 if [ -z "$remote" ]; then
650 if [ -z "$dir" ]; then
654 if __git_is_configured_remote "$remote"; then
655 # configured remote takes precedence over a
656 # local directory with the same name
657 list_refs_from=remote
658 elif [ -d "$remote/.git" ]; then
660 elif [ -d "$remote" ]; then
667 if [ "$list_refs_from" = path ]; then
668 if [[ "$cur_" == ^* ]]; then
677 refs=("$match*" "$match*/**")
681 for i in HEAD FETCH_HEAD ORIG_HEAD MERGE_HEAD REBASE_HEAD; do
684 if [ -e "$dir/$i" ]; then
690 format="refname:strip=2"
691 refs=("refs/tags/$match*" "refs/tags/$match*/**"
692 "refs/heads/$match*" "refs/heads/$match*/**"
693 "refs/remotes/$match*" "refs/remotes/$match*/**")
696 __git_dir="$dir" __git for-each-ref --format="$fer_pfx%($format)$sfx" \
698 if [ -n "$track" ]; then
699 # employ the heuristic used by git checkout
700 # Try to find a remote branch that matches the completion word
701 # but only output if the branch name is unique
702 __git for-each-ref --format="$fer_pfx%(refname:strip=3)$sfx" \
703 --sort="refname:strip=3" \
704 "refs/remotes/*/$match*" "refs/remotes/*/$match*/**" | \
711 __git ls-remote "$remote" "$match*" | \
712 while read -r hash i; do
715 *) echo "$pfx$i$sfx" ;;
720 if [ "$list_refs_from" = remote ]; then
722 $match*) echo "${pfx}HEAD$sfx" ;;
724 __git for-each-ref --format="$fer_pfx%(refname:strip=3)$sfx" \
725 "refs/remotes/$remote/$match*" \
726 "refs/remotes/$remote/$match*/**"
730 $match*) query_symref="HEAD" ;;
732 __git ls-remote "$remote" $query_symref \
733 "refs/tags/$match*" "refs/heads/$match*" \
734 "refs/remotes/$match*" |
735 while read -r hash i; do
738 refs/*) echo "$pfx${i#refs/*/}$sfx" ;;
739 *) echo "$pfx$i$sfx" ;; # symbolic refs
747 # Completes refs, short and long, local and remote, symbolic and pseudo.
749 # Usage: __git_complete_refs [<option>]...
750 # --remote=<remote>: The remote to list refs from, can be the name of a
751 # configured remote, a path, or a URL.
752 # --track: List unique remote branches for 'git checkout's tracking DWIMery.
753 # --pfx=<prefix>: A prefix to be added to each ref.
754 # --cur=<word>: The current ref to be completed. Defaults to the current
755 # word to be completed.
756 # --sfx=<suffix>: A suffix to be appended to each ref instead of the default
758 __git_complete_refs ()
760 local remote track pfx cur_="$cur" sfx=" "
762 while test $# != 0; do
764 --remote=*) remote="${1##--remote=}" ;;
765 --track) track="yes" ;;
766 --pfx=*) pfx="${1##--pfx=}" ;;
767 --cur=*) cur_="${1##--cur=}" ;;
768 --sfx=*) sfx="${1##--sfx=}" ;;
774 __gitcomp_direct "$(__git_refs "$remote" "$track" "$pfx" "$cur_" "$sfx")"
777 # __git_refs2 requires 1 argument (to pass to __git_refs)
778 # Deprecated: use __git_complete_fetch_refspecs() instead.
782 for i in $(__git_refs "$1"); do
787 # Completes refspecs for fetching from a remote repository.
788 # 1: The remote repository.
789 # 2: A prefix to be added to each listed refspec (optional).
790 # 3: The ref to be completed as a refspec instead of the current word to be
791 # completed (optional)
792 # 4: A suffix to be appended to each listed refspec instead of the default
794 __git_complete_fetch_refspecs ()
796 local i remote="$1" pfx="${2-}" cur_="${3-$cur}" sfx="${4- }"
799 for i in $(__git_refs "$remote" "" "" "$cur_") ; do
805 # __git_refs_remotes requires 1 argument (to pass to ls-remote)
806 __git_refs_remotes ()
809 __git ls-remote "$1" 'refs/heads/*' | \
810 while read -r hash i; do
811 echo "$i:refs/remotes/$1/${i#refs/heads/}"
818 test -d "$__git_repo_path/remotes" && ls -1 "$__git_repo_path/remotes"
822 # Returns true if $1 matches the name of a configured remote, false otherwise.
823 __git_is_configured_remote ()
826 for remote in $(__git_remotes); do
827 if [ "$remote" = "$1" ]; then
834 __git_list_merge_strategies ()
836 LANG=C LC_ALL=C git merge -s help 2>&1 |
837 sed -n -e '/[Aa]vailable strategies are: /,/^$/{
846 __git_merge_strategies=
847 # 'git merge -s help' (and thus detection of the merge strategy
848 # list) fails, unfortunately, if run outside of any git working
849 # tree. __git_merge_strategies is set to the empty string in
850 # that case, and the detection will be repeated the next time it
852 __git_compute_merge_strategies ()
854 test -n "$__git_merge_strategies" ||
855 __git_merge_strategies=$(__git_list_merge_strategies)
858 __git_merge_strategy_options="ours theirs subtree subtree= patience
859 histogram diff-algorithm= ignore-space-change ignore-all-space
860 ignore-space-at-eol renormalize no-renormalize no-renames
861 find-renames find-renames= rename-threshold="
863 __git_complete_revlist_file ()
865 local dequoted_word pfx ls ref cur_="$cur"
874 __git_dequote "$cur_"
876 case "$dequoted_word" in
878 pfx="${dequoted_word%/*}"
879 cur_="${dequoted_word##*/}"
884 cur_="$dequoted_word"
889 case "$COMP_WORDBREAKS" in
891 *) pfx="$ref:$pfx" ;;
894 __gitcomp_file "$(__git ls-tree "$ls" \
900 pfx="${cur_%...*}..."
902 __git_complete_refs --pfx="$pfx" --cur="$cur_"
907 __git_complete_refs --pfx="$pfx" --cur="$cur_"
915 __git_complete_file ()
917 __git_complete_revlist_file
920 __git_complete_revlist ()
922 __git_complete_revlist_file
925 __git_complete_remote_or_refspec ()
927 local cur_="$cur" cmd="${words[1]}"
928 local i c=2 remote="" pfx="" lhs=1 no_complete_refspec=0
929 if [ "$cmd" = "remote" ]; then
932 while [ $c -lt $cword ]; do
935 --mirror) [ "$cmd" = "push" ] && no_complete_refspec=1 ;;
936 -d|--delete) [ "$cmd" = "push" ] && lhs=0 ;;
939 push) no_complete_refspec=1 ;;
946 --multiple) no_complete_refspec=1; break ;;
948 *) remote="$i"; break ;;
952 if [ -z "$remote" ]; then
953 __gitcomp_nl "$(__git_remotes)"
956 if [ $no_complete_refspec = 1 ]; then
959 [ "$remote" = "." ] && remote=
962 case "$COMP_WORDBREAKS" in
964 *) pfx="${cur_%%:*}:" ;;
976 if [ $lhs = 1 ]; then
977 __git_complete_fetch_refspecs "$remote" "$pfx" "$cur_"
979 __git_complete_refs --pfx="$pfx" --cur="$cur_"
983 if [ $lhs = 1 ]; then
984 __git_complete_refs --remote="$remote" --pfx="$pfx" --cur="$cur_"
986 __git_complete_refs --pfx="$pfx" --cur="$cur_"
990 if [ $lhs = 1 ]; then
991 __git_complete_refs --pfx="$pfx" --cur="$cur_"
993 __git_complete_refs --remote="$remote" --pfx="$pfx" --cur="$cur_"
999 __git_complete_strategy ()
1001 __git_compute_merge_strategies
1004 __gitcomp "$__git_merge_strategies"
1008 __gitcomp "$__git_merge_strategy_options"
1014 __gitcomp "$__git_merge_strategies" "" "${cur##--strategy=}"
1017 --strategy-option=*)
1018 __gitcomp "$__git_merge_strategy_options" "" "${cur##--strategy-option=}"
1026 __git_compute_all_commands ()
1028 test -n "$__git_all_commands" ||
1029 __git_all_commands=$(__git --list-cmds=main,others,alias,nohelpers)
1032 # Lists all set config variables starting with the given section prefix,
1033 # with the prefix removed.
1034 __git_get_config_variables ()
1036 local section="$1" i IFS=$'\n'
1037 for i in $(__git config --name-only --get-regexp "^$section\..*"); do
1038 echo "${i#$section.}"
1042 __git_pretty_aliases ()
1044 __git_get_config_variables "pretty"
1047 # __git_aliased_command requires 1 argument
1048 __git_aliased_command ()
1050 local word cmdline=$(__git config --get "alias.$1")
1051 for word in $cmdline; do
1057 \!*) : shell command alias ;;
1059 *=*) : setting env ;;
1060 git) : git itself ;;
1061 \(\)) : skip parens of shell function definition ;;
1062 {) : skip start of shell helper function ;;
1063 :) : skip null command ;;
1064 \'*) : skip opening quote after sh -c ;;
1072 # __git_find_on_cmdline requires 1 argument
1073 __git_find_on_cmdline ()
1075 local word subcommand c=1
1076 while [ $c -lt $cword ]; do
1078 for subcommand in $1; do
1079 if [ "$subcommand" = "$word" ]; then
1088 # Echo the value of an option set on the command line or config
1090 # $1: short option name
1091 # $2: long option name including =
1092 # $3: list of possible values
1093 # $4: config string (optional)
1096 # result="$(__git_get_option_value "-d" "--do-something=" \
1097 # "yes no" "core.doSomething")"
1099 # result is then either empty (no option set) or "yes" or "no"
1101 # __git_get_option_value requires 3 arguments
1102 __git_get_option_value ()
1104 local c short_opt long_opt val
1105 local result= values config_key word
1113 while [ $c -ge 0 ]; do
1115 for val in $values; do
1116 if [ "$short_opt$val" = "$word" ] ||
1117 [ "$long_opt$val" = "$word" ]; then
1125 if [ -n "$config_key" ] && [ -z "$result" ]; then
1126 result="$(__git config "$config_key")"
1132 __git_has_doubledash ()
1135 while [ $c -lt $cword ]; do
1136 if [ "--" = "${words[c]}" ]; then
1144 # Try to count non option arguments passed on the command line for the
1145 # specified git command.
1146 # When options are used, it is necessary to use the special -- option to
1147 # tell the implementation were non option arguments begin.
1148 # XXX this can not be improved, since options can appear everywhere, as
1152 # __git_count_arguments requires 1 argument: the git command executed.
1153 __git_count_arguments ()
1157 # Skip "git" (first argument)
1158 for ((i=1; i < ${#words[@]}; i++)); do
1163 # Good; we can assume that the following are only non
1168 # Skip the specified git command and discard git
1181 __git_whitespacelist="nowarn warn error error-all fix"
1182 __git_patchformat="mbox stgit stgit-series hg mboxrd"
1183 __git_am_inprogress_options="--skip --continue --resolved --abort --quit --show-current-patch"
1187 __git_find_repo_path
1188 if [ -d "$__git_repo_path"/rebase-apply ]; then
1189 __gitcomp "$__git_am_inprogress_options"
1194 __gitcomp "$__git_whitespacelist" "" "${cur##--whitespace=}"
1198 __gitcomp "$__git_patchformat" "" "${cur##--patch-format=}"
1202 __gitcomp_builtin am "" \
1203 "$__git_am_inprogress_options"
1212 __gitcomp "$__git_whitespacelist" "" "${cur##--whitespace=}"
1216 __gitcomp_builtin apply
1225 __gitcomp "+x -x" "" "${cur##--chmod=}"
1229 __gitcomp_builtin add
1233 local complete_opt="--others --modified --directory --no-empty-directory"
1234 if test -n "$(__git_find_on_cmdline "-u --update")"
1236 complete_opt="--modified"
1238 __git_complete_index_file "$complete_opt"
1245 __gitcomp "$(git archive --list)" "" "${cur##--format=}"
1249 __gitcomp_nl "$(__git_remotes)" "" "${cur##--remote=}"
1254 --format= --list --verbose
1255 --prefix= --remote= --exec= --output
1265 __git_has_doubledash && return
1267 local subcommands="start bad good skip reset visualize replay log run"
1268 local subcommand="$(__git_find_on_cmdline "$subcommands")"
1269 if [ -z "$subcommand" ]; then
1270 __git_find_repo_path
1271 if [ -f "$__git_repo_path"/BISECT_START ]; then
1272 __gitcomp "$subcommands"
1274 __gitcomp "replay start"
1279 case "$subcommand" in
1280 bad|good|reset|skip|start)
1288 __git_ref_fieldlist="refname objecttype objectsize objectname upstream push HEAD symref"
1292 local i c=1 only_local_ref="n" has_r="n"
1294 while [ $c -lt $cword ]; do
1297 -d|--delete|-m|--move) only_local_ref="y" ;;
1298 -r|--remotes) has_r="y" ;;
1304 --set-upstream-to=*)
1305 __git_complete_refs --cur="${cur##--set-upstream-to=}"
1308 __gitcomp_builtin branch
1311 if [ $only_local_ref = "y" -a $has_r = "n" ]; then
1312 __gitcomp_direct "$(__git_heads "" "$cur" " ")"
1322 local cmd="${words[2]}"
1325 __gitcomp "create list-heads verify unbundle"
1328 # looking for a file
1333 __git_complete_revlist
1342 __git_has_doubledash && return
1346 __gitcomp "diff3 merge" "" "${cur##--conflict=}"
1349 __gitcomp_builtin checkout
1352 # check if --track, --no-track, or --no-guess was specified
1353 # if so, disable DWIM mode
1354 local flags="--track --no-track --no-guess" track_opt="--track"
1355 if [ "$GIT_COMPLETION_CHECKOUT_NO_GUESS" = "1" ] ||
1356 [ -n "$(__git_find_on_cmdline "$flags")" ]; then
1359 __git_complete_refs $track_opt
1364 __git_sequencer_inprogress_options="--continue --quit --abort --skip"
1366 __git_cherry_pick_inprogress_options=$__git_sequencer_inprogress_options
1370 __git_find_repo_path
1371 if [ -f "$__git_repo_path"/CHERRY_PICK_HEAD ]; then
1372 __gitcomp "$__git_cherry_pick_inprogress_options"
1376 __git_complete_strategy && return
1380 __gitcomp_builtin cherry-pick "" \
1381 "$__git_cherry_pick_inprogress_options"
1393 __gitcomp_builtin clean
1398 # XXX should we check for -x option ?
1399 __git_complete_index_file "--others --directory"
1406 __git_complete_config_variable_name_and_value
1412 __git_complete_config_variable_name_and_value \
1413 --cur="${cur##--config=}"
1417 __gitcomp_builtin clone
1423 __git_untracked_file_modes="all no normal"
1436 __gitcomp "default scissors strip verbatim whitespace
1437 " "" "${cur##--cleanup=}"
1440 --reuse-message=*|--reedit-message=*|\
1441 --fixup=*|--squash=*)
1442 __git_complete_refs --cur="${cur#*=}"
1445 --untracked-files=*)
1446 __gitcomp "$__git_untracked_file_modes" "" "${cur##--untracked-files=}"
1450 __gitcomp_builtin commit
1454 if __git rev-parse --verify --quiet HEAD >/dev/null; then
1455 __git_complete_index_file "--committable"
1457 # This is the first commit
1458 __git_complete_index_file "--cached"
1466 __gitcomp_builtin describe
1472 __git_diff_algorithms="myers minimal patience histogram"
1474 __git_diff_submodule_formats="diff log short"
1476 __git_diff_common_options="--stat --numstat --shortstat --summary
1477 --patch-with-stat --name-only --name-status --color
1478 --no-color --color-words --no-renames --check
1479 --full-index --binary --abbrev --diff-filter=
1480 --find-copies-harder --ignore-cr-at-eol
1481 --text --ignore-space-at-eol --ignore-space-change
1482 --ignore-all-space --ignore-blank-lines --exit-code
1483 --quiet --ext-diff --no-ext-diff
1484 --no-prefix --src-prefix= --dst-prefix=
1485 --inter-hunk-context=
1486 --patience --histogram --minimal
1487 --raw --word-diff --word-diff-regex=
1488 --dirstat --dirstat= --dirstat-by-file
1489 --dirstat-by-file= --cumulative
1491 --submodule --submodule= --ignore-submodules
1496 __git_has_doubledash && return
1500 __gitcomp "$__git_diff_algorithms" "" "${cur##--diff-algorithm=}"
1504 __gitcomp "$__git_diff_submodule_formats" "" "${cur##--submodule=}"
1508 __gitcomp "--cached --staged --pickaxe-all --pickaxe-regex
1509 --base --ours --theirs --no-index
1510 $__git_diff_common_options
1515 __git_complete_revlist_file
1518 __git_mergetools_common="diffuse diffmerge ecmerge emerge kdiff3 meld opendiff
1519 tkdiff vimdiff gvimdiff xxdiff araxis p4merge bc
1525 __git_has_doubledash && return
1529 __gitcomp "$__git_mergetools_common kompare" "" "${cur##--tool=}"
1533 __gitcomp_builtin difftool "$__git_diff_common_options
1534 --base --cached --ours --theirs
1535 --pickaxe-all --pickaxe-regex
1541 __git_complete_revlist_file
1544 __git_fetch_recurse_submodules="yes on-demand no"
1549 --recurse-submodules=*)
1550 __gitcomp "$__git_fetch_recurse_submodules" "" "${cur##--recurse-submodules=}"
1554 __gitcomp "blob:none blob:limit= sparse:oid=" "" "${cur##--filter=}"
1558 __gitcomp_builtin fetch
1562 __git_complete_remote_or_refspec
1565 __git_format_patch_extra_options="
1566 --full-index --not --all --no-prefix --src-prefix=
1567 --dst-prefix= --notes
1570 _git_format_patch ()
1576 " "" "${cur##--thread=}"
1580 __gitcomp_builtin format-patch "$__git_format_patch_extra_options"
1584 __git_complete_revlist
1591 __gitcomp_builtin fsck
1602 # Lists matching symbol names from a tag (as in ctags) file.
1603 # 1: List symbol names matching this word.
1604 # 2: The tag file to list symbol names from.
1605 # 3: A prefix to be added to each listed symbol name (optional).
1606 # 4: A suffix to be appended to each listed symbol name (optional).
1607 __git_match_ctag () {
1608 awk -v pfx="${3-}" -v sfx="${4-}" "
1609 /^${1//\//\\/}/ { print pfx \$1 sfx }
1613 # Complete symbol names from a tag file.
1614 # Usage: __git_complete_symbol [<option>]...
1615 # --tags=<file>: The tag file to list symbol names from instead of the
1617 # --pfx=<prefix>: A prefix to be added to each symbol name.
1618 # --cur=<word>: The current symbol name to be completed. Defaults to
1619 # the current word to be completed.
1620 # --sfx=<suffix>: A suffix to be appended to each symbol name instead
1621 # of the default space.
1622 __git_complete_symbol () {
1623 local tags=tags pfx="" cur_="${cur-}" sfx=" "
1625 while test $# != 0; do
1627 --tags=*) tags="${1##--tags=}" ;;
1628 --pfx=*) pfx="${1##--pfx=}" ;;
1629 --cur=*) cur_="${1##--cur=}" ;;
1630 --sfx=*) sfx="${1##--sfx=}" ;;
1636 if test -r "$tags"; then
1637 __gitcomp_direct "$(__git_match_ctag "$cur_" "$tags" "$pfx" "$sfx")"
1643 __git_has_doubledash && return
1647 __gitcomp_builtin grep
1652 case "$cword,$prev" in
1654 __git_complete_symbol && return
1665 __gitcomp_builtin help
1669 if test -n "$GIT_TESTING_ALL_COMMAND_LIST"
1671 __gitcomp "$GIT_TESTING_ALL_COMMAND_LIST $(__git --list-cmds=alias,list-guide) gitk"
1673 __gitcomp "$(__git --list-cmds=main,nohelpers,alias,list-guide) gitk"
1682 false true umask group all world everybody
1683 " "" "${cur##--shared=}"
1687 __gitcomp_builtin init
1697 __gitcomp_builtin ls-files
1702 # XXX ignore options like --modified and always suggest all cached
1704 __git_complete_index_file "--cached"
1711 __gitcomp_builtin ls-remote
1715 __gitcomp_nl "$(__git_remotes)"
1722 __gitcomp_builtin ls-tree
1730 # Options that go well for log, shortlog and gitk
1731 __git_log_common_options="
1733 --branches --tags --remotes
1734 --first-parent --merges --no-merges
1736 --max-age= --since= --after=
1737 --min-age= --until= --before=
1738 --min-parents= --max-parents=
1739 --no-min-parents --no-max-parents
1741 # Options that go well for log and gitk (not shortlog)
1742 __git_log_gitk_options="
1743 --dense --sparse --full-history
1744 --simplify-merges --simplify-by-decoration
1745 --left-right --notes --no-notes
1747 # Options that go well for log and shortlog (not gitk)
1748 __git_log_shortlog_options="
1749 --author= --committer= --grep=
1750 --all-match --invert-grep
1753 __git_log_pretty_formats="oneline short medium full fuller email raw format: mboxrd"
1754 __git_log_date_formats="relative iso8601 iso8601-strict rfc2822 short local default raw unix format:"
1758 __git_has_doubledash && return
1759 __git_find_repo_path
1762 if [ -f "$__git_repo_path/MERGE_HEAD" ]; then
1765 case "$prev,$cur" in
1767 return # fall back to Bash filename completion
1770 __git_complete_symbol --cur="${cur#:}" --sfx=":"
1774 __git_complete_symbol
1779 --pretty=*|--format=*)
1780 __gitcomp "$__git_log_pretty_formats $(__git_pretty_aliases)
1785 __gitcomp "$__git_log_date_formats" "" "${cur##--date=}"
1789 __gitcomp "full short no" "" "${cur##--decorate=}"
1793 __gitcomp "$__git_diff_algorithms" "" "${cur##--diff-algorithm=}"
1797 __gitcomp "$__git_diff_submodule_formats" "" "${cur##--submodule=}"
1802 $__git_log_common_options
1803 $__git_log_shortlog_options
1804 $__git_log_gitk_options
1805 --root --topo-order --date-order --reverse
1806 --follow --full-diff
1807 --abbrev-commit --abbrev=
1808 --relative-date --date=
1809 --pretty= --format= --oneline
1814 --decorate --decorate=
1816 --parents --children
1818 $__git_diff_common_options
1819 --pickaxe-all --pickaxe-regex
1824 return # fall back to Bash filename completion
1827 __git_complete_symbol --cur="${cur#-L:}" --sfx=":"
1831 __git_complete_symbol --pfx="-G" --cur="${cur#-G}"
1835 __git_complete_symbol --pfx="-S" --cur="${cur#-S}"
1839 __git_complete_revlist
1844 __git_complete_strategy && return
1848 __gitcomp_builtin merge
1858 __gitcomp "$__git_mergetools_common tortoisemerge" "" "${cur##--tool=}"
1862 __gitcomp "--tool= --prompt --no-prompt --gui --no-gui"
1872 __gitcomp_builtin merge-base
1883 __gitcomp_builtin mv
1888 if [ $(__git_count_arguments "mv") -gt 0 ]; then
1889 # We need to show both cached and untracked files (including
1890 # empty directories) since this may not be the last argument.
1891 __git_complete_index_file "--cached --others --directory"
1893 __git_complete_index_file "--cached"
1899 local subcommands='add append copy edit get-ref list merge prune remove show'
1900 local subcommand="$(__git_find_on_cmdline "$subcommands")"
1902 case "$subcommand,$cur" in
1904 __gitcomp_builtin notes
1912 __gitcomp "$subcommands --ref"
1916 *,--reuse-message=*|*,--reedit-message=*)
1917 __git_complete_refs --cur="${cur#*=}"
1920 __gitcomp_builtin notes_$subcommand
1923 # this command does not take a ref, do not complete it
1939 __git_complete_strategy && return
1942 --recurse-submodules=*)
1943 __gitcomp "$__git_fetch_recurse_submodules" "" "${cur##--recurse-submodules=}"
1947 __gitcomp_builtin pull
1952 __git_complete_remote_or_refspec
1955 __git_push_recurse_submodules="check on-demand only"
1957 __git_complete_force_with_lease ()
1965 __git_complete_refs --cur="${cur_#*:}"
1968 __git_complete_refs --cur="$cur_"
1977 __gitcomp_nl "$(__git_remotes)"
1980 --recurse-submodules)
1981 __gitcomp "$__git_push_recurse_submodules"
1987 __gitcomp_nl "$(__git_remotes)" "" "${cur##--repo=}"
1990 --recurse-submodules=*)
1991 __gitcomp "$__git_push_recurse_submodules" "" "${cur##--recurse-submodules=}"
1994 --force-with-lease=*)
1995 __git_complete_force_with_lease "${cur##--force-with-lease=}"
1999 __gitcomp_builtin push
2003 __git_complete_remote_or_refspec
2011 --creation-factor= --no-dual-color
2012 $__git_diff_common_options
2017 __git_complete_revlist
2022 __git_find_repo_path
2023 if [ -f "$__git_repo_path"/rebase-merge/interactive ]; then
2024 __gitcomp "--continue --skip --abort --quit --edit-todo --show-current-patch"
2026 elif [ -d "$__git_repo_path"/rebase-apply ] || \
2027 [ -d "$__git_repo_path"/rebase-merge ]; then
2028 __gitcomp "--continue --skip --abort --quit --show-current-patch"
2031 __git_complete_strategy && return
2034 __gitcomp "$__git_whitespacelist" "" "${cur##--whitespace=}"
2039 --onto --merge --strategy --interactive
2040 --rebase-merges --preserve-merges --stat --no-stat
2041 --committer-date-is-author-date --ignore-date
2042 --ignore-whitespace --whitespace=
2043 --autosquash --no-autosquash
2044 --fork-point --no-fork-point
2045 --autostash --no-autostash
2046 --verify --no-verify --keep-base
2047 --keep-empty --root --force-rebase --no-ff
2059 local subcommands="show delete expire"
2060 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2062 if [ -z "$subcommand" ]; then
2063 __gitcomp "$subcommands"
2069 __git_send_email_confirm_options="always never auto cc compose"
2070 __git_send_email_suppresscc_options="author self cc bodycc sob cccmd body all"
2075 --to|--cc|--bcc|--from)
2076 __gitcomp "$(__git send-email --dump-aliases)"
2084 $__git_send_email_confirm_options
2085 " "" "${cur##--confirm=}"
2090 $__git_send_email_suppresscc_options
2091 " "" "${cur##--suppress-cc=}"
2095 --smtp-encryption=*)
2096 __gitcomp "ssl tls" "" "${cur##--smtp-encryption=}"
2102 " "" "${cur##--thread=}"
2105 --to=*|--cc=*|--bcc=*|--from=*)
2106 __gitcomp "$(__git send-email --dump-aliases)" "" "${cur#--*=}"
2110 __gitcomp_builtin send-email "--annotate --bcc --cc --cc-cmd --chain-reply-to
2111 --compose --confirm= --dry-run --envelope-sender
2113 --in-reply-to --no-chain-reply-to --no-signed-off-by-cc
2114 --no-suppress-from --no-thread --quiet --reply-to
2115 --signed-off-by-cc --smtp-pass --smtp-server
2116 --smtp-server-port --smtp-encryption= --smtp-user
2117 --subject --suppress-cc= --suppress-from --thread --to
2118 --validate --no-validate
2119 $__git_format_patch_extra_options"
2123 __git_complete_revlist
2134 local untracked_state
2137 --ignore-submodules=*)
2138 __gitcomp "none untracked dirty all" "" "${cur##--ignore-submodules=}"
2141 --untracked-files=*)
2142 __gitcomp "$__git_untracked_file_modes" "" "${cur##--untracked-files=}"
2147 always never auto column row plain dense nodense
2148 " "" "${cur##--column=}"
2152 __gitcomp_builtin status
2157 untracked_state="$(__git_get_option_value "-u" "--untracked-files=" \
2158 "$__git_untracked_file_modes" "status.showUntrackedFiles")"
2160 case "$untracked_state" in
2162 # --ignored option does not matter
2166 complete_opt="--cached --directory --no-empty-directory --others"
2168 if [ -n "$(__git_find_on_cmdline "--ignored")" ]; then
2169 complete_opt="$complete_opt --ignored --exclude=*"
2174 __git_complete_index_file "$complete_opt"
2181 __gitcomp "diff3 merge" "" "${cur##--conflict=}"
2184 __gitcomp_builtin switch
2187 # check if --track, --no-track, or --no-guess was specified
2188 # if so, disable DWIM mode
2189 local track_opt="--track" only_local_ref=n
2190 if [ "$GIT_COMPLETION_CHECKOUT_NO_GUESS" = "1" ] ||
2191 [ -n "$(__git_find_on_cmdline "--track --no-track --no-guess")" ]; then
2194 # explicit --guess enables DWIM mode regardless of
2195 # $GIT_COMPLETION_CHECKOUT_NO_GUESS
2196 if [ -n "$(__git_find_on_cmdline "--guess")" ]; then
2199 if [ -z "$(__git_find_on_cmdline "-d --detach")" ]; then
2202 # --guess --detach is invalid combination, no
2203 # dwim will be done when --detach is specified
2206 if [ $only_local_ref = y -a -z "$track_opt" ]; then
2207 __gitcomp_direct "$(__git_heads "" "$cur" " ")"
2209 __git_complete_refs $track_opt
2215 __git_config_get_set_variables ()
2217 local prevword word config_file= c=$cword
2218 while [ $c -gt 1 ]; do
2221 --system|--global|--local|--file=*)
2226 config_file="$word $prevword"
2234 __git config $config_file --name-only --list
2238 __git_compute_config_vars ()
2240 test -n "$__git_config_vars" ||
2241 __git_config_vars="$(git help --config-for-completion | sort -u)"
2244 # Completes possible values of various configuration variables.
2246 # Usage: __git_complete_config_variable_value [<option>]...
2247 # --varname=<word>: The name of the configuration variable whose value is
2248 # to be completed. Defaults to the previous word on the
2250 # --cur=<word>: The current value to be completed. Defaults to the current
2251 # word to be completed.
2252 __git_complete_config_variable_value ()
2254 local varname="$prev" cur_="$cur"
2256 while test $# != 0; do
2258 --varname=*) varname="${1##--varname=}" ;;
2259 --cur=*) cur_="${1##--cur=}" ;;
2265 if [ "${BASH_VERSINFO[0]:-0}" -ge 4 ]; then
2266 varname="${varname,,}"
2268 varname="$(echo "$varname" |tr A-Z a-z)"
2272 branch.*.remote|branch.*.pushremote)
2273 __gitcomp_nl "$(__git_remotes)" "" "$cur_"
2277 __git_complete_refs --cur="$cur_"
2281 __gitcomp "false true merges preserve interactive" "" "$cur_"
2285 __gitcomp_nl "$(__git_remotes)" "" "$cur_"
2289 local remote="${varname#remote.}"
2290 remote="${remote%.fetch}"
2291 if [ -z "$cur_" ]; then
2292 __gitcomp_nl "refs/heads/" "" "" ""
2295 __gitcomp_nl "$(__git_refs_remotes "$remote")" "" "$cur_"
2299 local remote="${varname#remote.}"
2300 remote="${remote%.push}"
2301 __gitcomp_nl "$(__git for-each-ref \
2302 --format='%(refname):%(refname)' refs/heads)" "" "$cur_"
2305 pull.twohead|pull.octopus)
2306 __git_compute_merge_strategies
2307 __gitcomp "$__git_merge_strategies" "" "$cur_"
2311 __gitcomp "false true" "" "$cur_"
2316 normal black red green yellow blue magenta cyan white
2317 bold dim ul blink reverse
2322 __gitcomp "false true always never auto" "" "$cur_"
2326 __gitcomp "$__git_diff_submodule_formats" "" "$cur_"
2330 __gitcomp "man info web html" "" "$cur_"
2334 __gitcomp "$__git_log_date_formats" "" "$cur_"
2337 sendemail.aliasfiletype)
2338 __gitcomp "mutt mailrc pine elm gnus" "" "$cur_"
2342 __gitcomp "$__git_send_email_confirm_options" "" "$cur_"
2345 sendemail.suppresscc)
2346 __gitcomp "$__git_send_email_suppresscc_options" "" "$cur_"
2349 sendemail.transferencoding)
2350 __gitcomp "7bit 8bit quoted-printable base64" "" "$cur_"
2359 # Completes configuration sections, subsections, variable names.
2361 # Usage: __git_complete_config_variable_name [<option>]...
2362 # --cur=<word>: The current configuration section/variable name to be
2363 # completed. Defaults to the current word to be completed.
2364 # --sfx=<suffix>: A suffix to be appended to each fully completed
2365 # configuration variable name (but not to sections or
2366 # subsections) instead of the default space.
2367 __git_complete_config_variable_name ()
2369 local cur_="$cur" sfx
2371 while test $# != 0; do
2373 --cur=*) cur_="${1##--cur=}" ;;
2374 --sfx=*) sfx="${1##--sfx=}" ;;
2382 local pfx="${cur_%.*}."
2384 __gitcomp "remote pushRemote merge mergeOptions rebase" "$pfx" "$cur_" "$sfx"
2388 local pfx="${cur%.*}."
2390 __gitcomp_direct "$(__git_heads "$pfx" "$cur_" ".")"
2391 __gitcomp_nl_append $'autoSetupMerge\nautoSetupRebase\n' "$pfx" "$cur_" "$sfx"
2395 local pfx="${cur_%.*}."
2398 argPrompt cmd confirm needsFile noConsole noRescan
2399 prompt revPrompt revUnmerged title
2400 " "$pfx" "$cur_" "$sfx"
2404 local pfx="${cur_%.*}."
2406 __gitcomp "cmd path" "$pfx" "$cur_" "$sfx"
2410 local pfx="${cur_%.*}."
2412 __gitcomp "cmd path" "$pfx" "$cur_" "$sfx"
2416 local pfx="${cur_%.*}."
2418 __gitcomp "cmd path trustExitCode" "$pfx" "$cur_" "$sfx"
2422 local pfx="${cur_%.*}."
2424 __git_compute_all_commands
2425 __gitcomp_nl "$__git_all_commands" "$pfx" "$cur_" "$sfx"
2429 local pfx="${cur_%.*}."
2432 url proxy fetch push mirror skipDefaultUpdate
2433 receivepack uploadpack tagOpt pushurl
2434 " "$pfx" "$cur_" "$sfx"
2438 local pfx="${cur_%.*}."
2440 __gitcomp_nl "$(__git_remotes)" "$pfx" "$cur_" "."
2441 __gitcomp_nl_append "pushDefault" "$pfx" "$cur_" "$sfx"
2445 local pfx="${cur_%.*}."
2447 __gitcomp "insteadOf pushInsteadOf" "$pfx" "$cur_" "$sfx"
2451 __git_compute_config_vars
2452 __gitcomp "$__git_config_vars" "" "$cur_" "$sfx"
2455 __git_compute_config_vars
2456 __gitcomp "$(echo "$__git_config_vars" |
2469 # Completes '='-separated configuration sections/variable names and values
2470 # for 'git -c section.name=value'.
2472 # Usage: __git_complete_config_variable_name_and_value [<option>]...
2473 # --cur=<word>: The current configuration section/variable name/value to be
2474 # completed. Defaults to the current word to be completed.
2475 __git_complete_config_variable_name_and_value ()
2479 while test $# != 0; do
2481 --cur=*) cur_="${1##--cur=}" ;;
2489 __git_complete_config_variable_value \
2490 --varname="${cur_%%=*}" --cur="${cur_#*=}"
2493 __git_complete_config_variable_name --cur="$cur_" --sfx='='
2501 --get|--get-all|--unset|--unset-all)
2502 __gitcomp_nl "$(__git_config_get_set_variables)"
2506 __git_complete_config_variable_value
2512 __gitcomp_builtin config
2515 __git_complete_config_variable_name
2523 add rename remove set-head set-branches
2524 get-url set-url show prune update
2526 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2527 if [ -z "$subcommand" ]; then
2530 __gitcomp_builtin remote
2533 __gitcomp "$subcommands"
2539 case "$subcommand,$cur" in
2541 __gitcomp_builtin remote_add
2546 __gitcomp_builtin remote_set-head
2549 __gitcomp_builtin remote_set-branches
2551 set-head,*|set-branches,*)
2552 __git_complete_remote_or_refspec
2555 __gitcomp_builtin remote_update
2558 __gitcomp "$(__git_remotes) $(__git_get_config_variables "remotes")"
2561 __gitcomp_builtin remote_set-url
2564 __gitcomp_builtin remote_get-url
2567 __gitcomp_builtin remote_prune
2570 __gitcomp_nl "$(__git_remotes)"
2579 __gitcomp "short medium long" "" "${cur##--format=}"
2583 __gitcomp_builtin replace
2592 local subcommands="clear forget diff remaining status gc"
2593 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2594 if test -z "$subcommand"
2596 __gitcomp "$subcommands"
2603 __git_has_doubledash && return
2607 __gitcomp_builtin reset
2618 __gitcomp "diff3 merge" "" "${cur##--conflict=}"
2621 __git_complete_refs --cur="${cur##--source=}"
2624 __gitcomp_builtin restore
2629 __git_revert_inprogress_options=$__git_sequencer_inprogress_options
2633 __git_find_repo_path
2634 if [ -f "$__git_repo_path"/REVERT_HEAD ]; then
2635 __gitcomp "$__git_revert_inprogress_options"
2638 __git_complete_strategy && return
2641 __gitcomp_builtin revert "" \
2642 "$__git_revert_inprogress_options"
2653 __gitcomp_builtin rm
2658 __git_complete_index_file "--cached"
2663 __git_has_doubledash && return
2668 $__git_log_common_options
2669 $__git_log_shortlog_options
2670 --numbered --summary --email
2675 __git_complete_revlist
2680 __git_has_doubledash && return
2683 --pretty=*|--format=*)
2684 __gitcomp "$__git_log_pretty_formats $(__git_pretty_aliases)
2689 __gitcomp "$__git_diff_algorithms" "" "${cur##--diff-algorithm=}"
2693 __gitcomp "$__git_diff_submodule_formats" "" "${cur##--submodule=}"
2697 __gitcomp "--pretty= --format= --abbrev-commit --oneline
2699 $__git_diff_common_options
2704 __git_complete_revlist_file
2711 __gitcomp_builtin show-branch
2715 __git_complete_revlist
2720 local save_opts='--all --keep-index --no-keep-index --quiet --patch --include-untracked'
2721 local subcommands='push list show apply clear drop pop create branch'
2722 local subcommand="$(__git_find_on_cmdline "$subcommands save")"
2723 if [ -n "$(__git_find_on_cmdline "-p")" ]; then
2726 if [ -z "$subcommand" ]; then
2729 __gitcomp "$save_opts"
2732 if [ -z "$(__git_find_on_cmdline "$save_opts")" ]; then
2737 if [ -z "$(__git_find_on_cmdline "$save_opts")" ]; then
2738 __gitcomp "$subcommands"
2743 case "$subcommand,$cur" in
2745 __gitcomp "$save_opts --message"
2748 __gitcomp "$save_opts"
2751 __gitcomp "--index --quiet"
2757 __gitcomp "--name-status --oneline --patch-with-stat"
2759 show,--*|branch,--*)
2762 if [ $cword -eq 3 ]; then
2765 __gitcomp_nl "$(__git stash list \
2766 | sed -n -e 's/:.*//p')"
2769 show,*|apply,*|drop,*|pop,*)
2770 __gitcomp_nl "$(__git stash list \
2771 | sed -n -e 's/:.*//p')"
2781 __git_has_doubledash && return
2783 local subcommands="add status init deinit update set-branch summary foreach sync absorbgitdirs"
2784 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2785 if [ -z "$subcommand" ]; then
2791 __gitcomp "$subcommands"
2797 case "$subcommand,$cur" in
2799 __gitcomp "--branch --force --name --reference --depth"
2802 __gitcomp "--cached --recursive"
2805 __gitcomp "--force --all"
2809 --init --remote --no-fetch
2810 --recommend-shallow --no-recommend-shallow
2811 --force --rebase --merge --reference --depth --recursive --jobs
2815 __gitcomp "--default --branch"
2818 __gitcomp "--cached --files --summary-limit"
2820 foreach,--*|sync,--*)
2821 __gitcomp "--recursive"
2831 init fetch clone rebase dcommit log find-rev
2832 set-tree commit-diff info create-ignore propget
2833 proplist show-ignore show-externals branch tag blame
2834 migrate mkdirs reset gc
2836 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2837 if [ -z "$subcommand" ]; then
2838 __gitcomp "$subcommands"
2840 local remote_opts="--username= --config-dir= --no-auth-cache"
2842 --follow-parent --authors-file= --repack=
2843 --no-metadata --use-svm-props --use-svnsync-props
2844 --log-window-size= --no-checkout --quiet
2845 --repack-flags --use-log-author --localtime
2847 --ignore-paths= --include-paths= $remote_opts
2850 --template= --shared= --trunk= --tags=
2851 --branches= --stdlayout --minimize-url
2852 --no-metadata --use-svm-props --use-svnsync-props
2853 --rewrite-root= --prefix= $remote_opts
2856 --edit --rmdir --find-copies-harder --copy-similarity=
2859 case "$subcommand,$cur" in
2861 __gitcomp "--revision= --fetch-all $fc_opts"
2864 __gitcomp "--revision= $fc_opts $init_opts"
2867 __gitcomp "$init_opts"
2871 --merge --strategy= --verbose --dry-run
2872 --fetch-all --no-rebase --commit-url
2873 --revision --interactive $cmt_opts $fc_opts
2877 __gitcomp "--stdin $cmt_opts $fc_opts"
2879 create-ignore,--*|propget,--*|proplist,--*|show-ignore,--*|\
2880 show-externals,--*|mkdirs,--*)
2881 __gitcomp "--revision="
2885 --limit= --revision= --verbose --incremental
2886 --oneline --show-commit --non-recursive
2887 --authors-file= --color
2892 --merge --verbose --strategy= --local
2893 --fetch-all --dry-run $fc_opts
2897 __gitcomp "--message= --file= --revision= $cmt_opts"
2903 __gitcomp "--dry-run --message --tag"
2906 __gitcomp "--dry-run --message"
2909 __gitcomp "--git-format"
2913 --config-dir= --ignore-paths= --minimize
2914 --no-auth-cache --username=
2918 __gitcomp "--revision= --parent"
2929 while [ $c -lt $cword ]; do
2932 -d|--delete|-v|--verify)
2933 __gitcomp_direct "$(__git_tags "" "$cur" " ")"
2948 __gitcomp_direct "$(__git_tags "" "$cur" " ")"
2958 __gitcomp_builtin tag
2970 local subcommands="add list lock move prune remove unlock"
2971 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2972 if [ -z "$subcommand" ]; then
2973 __gitcomp "$subcommands"
2975 case "$subcommand,$cur" in
2977 __gitcomp_builtin worktree_add
2980 __gitcomp_builtin worktree_list
2983 __gitcomp_builtin worktree_lock
2986 __gitcomp_builtin worktree_prune
2997 __git_complete_common () {
3002 __gitcomp_builtin "$command"
3007 __git_cmds_with_parseopt_helper=
3008 __git_support_parseopt_helper () {
3009 test -n "$__git_cmds_with_parseopt_helper" ||
3010 __git_cmds_with_parseopt_helper="$(__git --list-cmds=parseopt)"
3012 case " $__git_cmds_with_parseopt_helper " in
3022 __git_complete_command () {
3024 local completion_func="_git_${command//-/_}"
3025 if ! declare -f $completion_func >/dev/null 2>/dev/null &&
3026 declare -f _completion_loader >/dev/null 2>/dev/null
3028 _completion_loader "git-$command"
3030 if declare -f $completion_func >/dev/null 2>/dev/null
3034 elif __git_support_parseopt_helper "$command"
3036 __git_complete_common "$command"
3045 local i c=1 command __git_dir __git_repo_path
3046 local __git_C_args C_args_count=0
3048 while [ $c -lt $cword ]; do
3051 --git-dir=*) __git_dir="${i#--git-dir=}" ;;
3052 --git-dir) ((c++)) ; __git_dir="${words[c]}" ;;
3053 --bare) __git_dir="." ;;
3054 --help) command="help"; break ;;
3055 -c|--work-tree|--namespace) ((c++)) ;;
3056 -C) __git_C_args[C_args_count++]=-C
3058 __git_C_args[C_args_count++]="${words[c]}"
3061 *) command="$i"; break ;;
3066 if [ -z "$command" ]; then
3068 --git-dir|-C|--work-tree)
3069 # these need a path argument, let's fall back to
3070 # Bash filename completion
3074 __git_complete_config_variable_name_and_value
3078 # we don't support completing these options' arguments
3096 --no-replace-objects
3101 if test -n "$GIT_TESTING_PORCELAIN_COMMAND_LIST"
3103 __gitcomp "$GIT_TESTING_PORCELAIN_COMMAND_LIST"
3105 __gitcomp "$(__git --list-cmds=list-mainporcelain,others,nohelpers,alias,list-complete,config)"
3112 __git_complete_command "$command" && return
3114 local expansion=$(__git_aliased_command "$command")
3115 if [ -n "$expansion" ]; then
3117 __git_complete_command "$expansion"
3123 __git_has_doubledash && return
3125 local __git_repo_path
3126 __git_find_repo_path
3129 if [ -f "$__git_repo_path/MERGE_HEAD" ]; then
3135 $__git_log_common_options
3136 $__git_log_gitk_options
3142 __git_complete_revlist
3145 if [[ -n ${ZSH_VERSION-} ]] &&
3146 # Don't define these functions when sourced from 'git-completion.zsh',
3147 # it has its own implementations.
3148 [[ -z ${GIT_SOURCING_ZSH_COMPLETION-} ]]; then
3149 echo "WARNING: this script is deprecated, please see git-completion.zsh" 1>&2
3151 autoload -U +X compinit && compinit
3157 local cur_="${3-$cur}"
3163 local c IFS=$' \t\n'
3171 array[${#array[@]}+1]="$c"
3174 compadd -Q -S '' -p "${2-}" -a -- array && _ret=0
3185 compadd -Q -- ${=1} && _ret=0
3194 compadd -Q -S "${4- }" -p "${2-}" -- ${=1} && _ret=0
3197 __gitcomp_file_direct ()
3203 compadd -f -- ${=1} && _ret=0
3212 compadd -p "${2-}" -f -- ${=1} && _ret=0
3217 local _ret=1 cur cword prev
3218 cur=${words[CURRENT]}
3219 prev=${words[CURRENT-1]}
3221 emulate ksh -c __${service}_main
3222 let _ret && _default && _ret=0
3226 compdef _git git gitk
3232 local cur words cword prev
3233 _get_comp_words_by_ref -n =: cur words cword prev
3237 # Setup completion for certain functions defined above by setting common
3238 # variables and workarounds.
3239 # This is NOT a public function; use at your own risk.
3242 local wrapper="__git_wrap${2}"
3243 eval "$wrapper () { __git_func_wrap $2 ; }"
3244 complete -o bashdefault -o default -o nospace -F $wrapper $1 2>/dev/null \
3245 || complete -o default -o nospace -F $wrapper $1
3248 # wrapper for backwards compatibility
3251 __git_wrap__git_main
3254 # wrapper for backwards compatibility
3257 __git_wrap__gitk_main
3260 __git_complete git __git_main
3261 __git_complete gitk __gitk_main
3263 # The following are necessary only for Cygwin, and only are needed
3264 # when the user has tab-completed the executable name and consequently
3265 # included the '.exe' suffix.
3267 if [ Cygwin = "$(uname -o 2>/dev/null)" ]; then
3268 __git_complete git.exe __git_main