]>
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
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 cannot 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 is not 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 # --dwim: List unique remote branches for 'git switch'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 dwim pfx cur_="$cur" sfx=" "
762 while test $# != 0; do
764 --remote=*) remote="${1##--remote=}" ;;
765 --dwim) dwim="yes" ;;
766 # --track is an old spelling of --dwim
767 --track) dwim="yes" ;;
768 --pfx=*) pfx="${1##--pfx=}" ;;
769 --cur=*) cur_="${1##--cur=}" ;;
770 --sfx=*) sfx="${1##--sfx=}" ;;
776 __gitcomp_direct "$(__git_refs "$remote" "$dwim" "$pfx" "$cur_" "$sfx")"
779 # __git_refs2 requires 1 argument (to pass to __git_refs)
780 # Deprecated: use __git_complete_fetch_refspecs() instead.
784 for i in $(__git_refs "$1"); do
789 # Completes refspecs for fetching from a remote repository.
790 # 1: The remote repository.
791 # 2: A prefix to be added to each listed refspec (optional).
792 # 3: The ref to be completed as a refspec instead of the current word to be
793 # completed (optional)
794 # 4: A suffix to be appended to each listed refspec instead of the default
796 __git_complete_fetch_refspecs ()
798 local i remote="$1" pfx="${2-}" cur_="${3-$cur}" sfx="${4- }"
801 for i in $(__git_refs "$remote" "" "" "$cur_") ; do
807 # __git_refs_remotes requires 1 argument (to pass to ls-remote)
808 __git_refs_remotes ()
811 __git ls-remote "$1" 'refs/heads/*' | \
812 while read -r hash i; do
813 echo "$i:refs/remotes/$1/${i#refs/heads/}"
820 test -d "$__git_repo_path/remotes" && ls -1 "$__git_repo_path/remotes"
824 # Returns true if $1 matches the name of a configured remote, false otherwise.
825 __git_is_configured_remote ()
828 for remote in $(__git_remotes); do
829 if [ "$remote" = "$1" ]; then
836 __git_list_merge_strategies ()
838 LANG=C LC_ALL=C git merge -s help 2>&1 |
839 sed -n -e '/[Aa]vailable strategies are: /,/^$/{
848 __git_merge_strategies=
849 # 'git merge -s help' (and thus detection of the merge strategy
850 # list) fails, unfortunately, if run outside of any git working
851 # tree. __git_merge_strategies is set to the empty string in
852 # that case, and the detection will be repeated the next time it
854 __git_compute_merge_strategies ()
856 test -n "$__git_merge_strategies" ||
857 __git_merge_strategies=$(__git_list_merge_strategies)
860 __git_merge_strategy_options="ours theirs subtree subtree= patience
861 histogram diff-algorithm= ignore-space-change ignore-all-space
862 ignore-space-at-eol renormalize no-renormalize no-renames
863 find-renames find-renames= rename-threshold="
865 __git_complete_revlist_file ()
867 local dequoted_word pfx ls ref cur_="$cur"
876 __git_dequote "$cur_"
878 case "$dequoted_word" in
880 pfx="${dequoted_word%/*}"
881 cur_="${dequoted_word##*/}"
886 cur_="$dequoted_word"
891 case "$COMP_WORDBREAKS" in
893 *) pfx="$ref:$pfx" ;;
896 __gitcomp_file "$(__git ls-tree "$ls" \
902 pfx="${cur_%...*}..."
904 __git_complete_refs --pfx="$pfx" --cur="$cur_"
909 __git_complete_refs --pfx="$pfx" --cur="$cur_"
917 __git_complete_file ()
919 __git_complete_revlist_file
922 __git_complete_revlist ()
924 __git_complete_revlist_file
927 __git_complete_remote_or_refspec ()
929 local cur_="$cur" cmd="${words[1]}"
930 local i c=2 remote="" pfx="" lhs=1 no_complete_refspec=0
931 if [ "$cmd" = "remote" ]; then
934 while [ $c -lt $cword ]; do
937 --mirror) [ "$cmd" = "push" ] && no_complete_refspec=1 ;;
938 -d|--delete) [ "$cmd" = "push" ] && lhs=0 ;;
941 push) no_complete_refspec=1 ;;
948 --multiple) no_complete_refspec=1; break ;;
950 *) remote="$i"; break ;;
954 if [ -z "$remote" ]; then
955 __gitcomp_nl "$(__git_remotes)"
958 if [ $no_complete_refspec = 1 ]; then
961 [ "$remote" = "." ] && remote=
964 case "$COMP_WORDBREAKS" in
966 *) pfx="${cur_%%:*}:" ;;
978 if [ $lhs = 1 ]; then
979 __git_complete_fetch_refspecs "$remote" "$pfx" "$cur_"
981 __git_complete_refs --pfx="$pfx" --cur="$cur_"
985 if [ $lhs = 1 ]; then
986 __git_complete_refs --remote="$remote" --pfx="$pfx" --cur="$cur_"
988 __git_complete_refs --pfx="$pfx" --cur="$cur_"
992 if [ $lhs = 1 ]; then
993 __git_complete_refs --pfx="$pfx" --cur="$cur_"
995 __git_complete_refs --remote="$remote" --pfx="$pfx" --cur="$cur_"
1001 __git_complete_strategy ()
1003 __git_compute_merge_strategies
1006 __gitcomp "$__git_merge_strategies"
1010 __gitcomp "$__git_merge_strategy_options"
1016 __gitcomp "$__git_merge_strategies" "" "${cur##--strategy=}"
1019 --strategy-option=*)
1020 __gitcomp "$__git_merge_strategy_options" "" "${cur##--strategy-option=}"
1028 __git_compute_all_commands ()
1030 test -n "$__git_all_commands" ||
1031 __git_all_commands=$(__git --list-cmds=main,others,alias,nohelpers)
1034 # Lists all set config variables starting with the given section prefix,
1035 # with the prefix removed.
1036 __git_get_config_variables ()
1038 local section="$1" i IFS=$'\n'
1039 for i in $(__git config --name-only --get-regexp "^$section\..*"); do
1040 echo "${i#$section.}"
1044 __git_pretty_aliases ()
1046 __git_get_config_variables "pretty"
1049 # __git_aliased_command requires 1 argument
1050 __git_aliased_command ()
1052 local word cmdline=$(__git config --get "alias.$1")
1053 for word in $cmdline; do
1059 \!*) : shell command alias ;;
1061 *=*) : setting env ;;
1062 git) : git itself ;;
1063 \(\)) : skip parens of shell function definition ;;
1064 {) : skip start of shell helper function ;;
1065 :) : skip null command ;;
1066 \'*) : skip opening quote after sh -c ;;
1074 # Check whether one of the given words is present on the command line,
1075 # and print the first word found.
1077 # Usage: __git_find_on_cmdline [<option>]... "<wordlist>"
1078 # --show-idx: Optionally show the index of the found word in the $words array.
1079 __git_find_on_cmdline ()
1081 local word c=1 show_idx
1083 while test $# -gt 1; do
1085 --show-idx) show_idx=y ;;
1092 while [ $c -lt $cword ]; do
1093 for word in $wordlist; do
1094 if [ "$word" = "${words[c]}" ]; then
1095 if [ -n "$show_idx" ]; then
1107 # Echo the value of an option set on the command line or config
1109 # $1: short option name
1110 # $2: long option name including =
1111 # $3: list of possible values
1112 # $4: config string (optional)
1115 # result="$(__git_get_option_value "-d" "--do-something=" \
1116 # "yes no" "core.doSomething")"
1118 # result is then either empty (no option set) or "yes" or "no"
1120 # __git_get_option_value requires 3 arguments
1121 __git_get_option_value ()
1123 local c short_opt long_opt val
1124 local result= values config_key word
1132 while [ $c -ge 0 ]; do
1134 for val in $values; do
1135 if [ "$short_opt$val" = "$word" ] ||
1136 [ "$long_opt$val" = "$word" ]; then
1144 if [ -n "$config_key" ] && [ -z "$result" ]; then
1145 result="$(__git config "$config_key")"
1151 __git_has_doubledash ()
1154 while [ $c -lt $cword ]; do
1155 if [ "--" = "${words[c]}" ]; then
1163 # Try to count non option arguments passed on the command line for the
1164 # specified git command.
1165 # When options are used, it is necessary to use the special -- option to
1166 # tell the implementation were non option arguments begin.
1167 # XXX this can not be improved, since options can appear everywhere, as
1171 # __git_count_arguments requires 1 argument: the git command executed.
1172 __git_count_arguments ()
1176 # Skip "git" (first argument)
1177 for ((i=1; i < ${#words[@]}; i++)); do
1182 # Good; we can assume that the following are only non
1187 # Skip the specified git command and discard git
1200 __git_whitespacelist="nowarn warn error error-all fix"
1201 __git_patchformat="mbox stgit stgit-series hg mboxrd"
1202 __git_showcurrentpatch="diff raw"
1203 __git_am_inprogress_options="--skip --continue --resolved --abort --quit --show-current-patch"
1207 __git_find_repo_path
1208 if [ -d "$__git_repo_path"/rebase-apply ]; then
1209 __gitcomp "$__git_am_inprogress_options"
1214 __gitcomp "$__git_whitespacelist" "" "${cur##--whitespace=}"
1218 __gitcomp "$__git_patchformat" "" "${cur##--patch-format=}"
1221 --show-current-patch=*)
1222 __gitcomp "$__git_showcurrentpatch" "" "${cur##--show-current-patch=}"
1226 __gitcomp_builtin am "" \
1227 "$__git_am_inprogress_options"
1236 __gitcomp "$__git_whitespacelist" "" "${cur##--whitespace=}"
1240 __gitcomp_builtin apply
1249 __gitcomp "+x -x" "" "${cur##--chmod=}"
1253 __gitcomp_builtin add
1257 local complete_opt="--others --modified --directory --no-empty-directory"
1258 if test -n "$(__git_find_on_cmdline "-u --update")"
1260 complete_opt="--modified"
1262 __git_complete_index_file "$complete_opt"
1269 __gitcomp "$(git archive --list)" "" "${cur##--format=}"
1273 __gitcomp_nl "$(__git_remotes)" "" "${cur##--remote=}"
1277 __gitcomp_builtin archive "--format= --list --verbose --prefix= --worktree-attributes"
1286 __git_has_doubledash && return
1288 local subcommands="start bad good skip reset visualize replay log run"
1289 local subcommand="$(__git_find_on_cmdline "$subcommands")"
1290 if [ -z "$subcommand" ]; then
1291 __git_find_repo_path
1292 if [ -f "$__git_repo_path"/BISECT_START ]; then
1293 __gitcomp "$subcommands"
1295 __gitcomp "replay start"
1300 case "$subcommand" in
1301 bad|good|reset|skip|start)
1309 __git_ref_fieldlist="refname objecttype objectsize objectname upstream push HEAD symref"
1313 local i c=1 only_local_ref="n" has_r="n"
1315 while [ $c -lt $cword ]; do
1318 -d|--delete|-m|--move) only_local_ref="y" ;;
1319 -r|--remotes) has_r="y" ;;
1325 --set-upstream-to=*)
1326 __git_complete_refs --cur="${cur##--set-upstream-to=}"
1329 __gitcomp_builtin branch
1332 if [ $only_local_ref = "y" -a $has_r = "n" ]; then
1333 __gitcomp_direct "$(__git_heads "" "$cur" " ")"
1343 local cmd="${words[2]}"
1346 __gitcomp "create list-heads verify unbundle"
1349 # looking for a file
1354 __git_complete_revlist
1363 __git_has_doubledash && return
1367 __gitcomp "diff3 merge" "" "${cur##--conflict=}"
1370 __gitcomp_builtin checkout
1373 # check if --track, --no-track, or --no-guess was specified
1374 # if so, disable DWIM mode
1375 local flags="--track --no-track --no-guess" dwim_opt="--dwim"
1376 if [ "$GIT_COMPLETION_CHECKOUT_NO_GUESS" = "1" ] ||
1377 [ -n "$(__git_find_on_cmdline "$flags")" ]; then
1380 __git_complete_refs $dwim_opt
1385 __git_sequencer_inprogress_options="--continue --quit --abort --skip"
1387 __git_cherry_pick_inprogress_options=$__git_sequencer_inprogress_options
1391 __git_find_repo_path
1392 if [ -f "$__git_repo_path"/CHERRY_PICK_HEAD ]; then
1393 __gitcomp "$__git_cherry_pick_inprogress_options"
1397 __git_complete_strategy && return
1401 __gitcomp_builtin cherry-pick "" \
1402 "$__git_cherry_pick_inprogress_options"
1414 __gitcomp_builtin clean
1419 # XXX should we check for -x option ?
1420 __git_complete_index_file "--others --directory"
1427 __git_complete_config_variable_name_and_value
1433 __git_complete_config_variable_name_and_value \
1434 --cur="${cur##--config=}"
1438 __gitcomp_builtin clone
1444 __git_untracked_file_modes="all no normal"
1457 __gitcomp "default scissors strip verbatim whitespace
1458 " "" "${cur##--cleanup=}"
1461 --reuse-message=*|--reedit-message=*|\
1462 --fixup=*|--squash=*)
1463 __git_complete_refs --cur="${cur#*=}"
1466 --untracked-files=*)
1467 __gitcomp "$__git_untracked_file_modes" "" "${cur##--untracked-files=}"
1471 __gitcomp_builtin commit
1475 if __git rev-parse --verify --quiet HEAD >/dev/null; then
1476 __git_complete_index_file "--committable"
1478 # This is the first commit
1479 __git_complete_index_file "--cached"
1487 __gitcomp_builtin describe
1493 __git_diff_algorithms="myers minimal patience histogram"
1495 __git_diff_submodule_formats="diff log short"
1497 __git_color_moved_opts="no default plain blocks zebra dimmed-zebra"
1499 __git_color_moved_ws_opts="no ignore-space-at-eol ignore-space-change
1500 ignore-all-space allow-indentation-change"
1502 __git_diff_common_options="--stat --numstat --shortstat --summary
1503 --patch-with-stat --name-only --name-status --color
1504 --no-color --color-words --no-renames --check
1505 --color-moved --color-moved= --no-color-moved
1506 --color-moved-ws= --no-color-moved-ws
1507 --full-index --binary --abbrev --diff-filter=
1508 --find-copies-harder --ignore-cr-at-eol
1509 --text --ignore-space-at-eol --ignore-space-change
1510 --ignore-all-space --ignore-blank-lines --exit-code
1511 --quiet --ext-diff --no-ext-diff
1512 --no-prefix --src-prefix= --dst-prefix=
1513 --inter-hunk-context=
1514 --patience --histogram --minimal
1515 --raw --word-diff --word-diff-regex=
1516 --dirstat --dirstat= --dirstat-by-file
1517 --dirstat-by-file= --cumulative
1519 --submodule --submodule= --ignore-submodules
1520 --indent-heuristic --no-indent-heuristic
1521 --textconv --no-textconv
1526 __git_has_doubledash && return
1530 __gitcomp "$__git_diff_algorithms" "" "${cur##--diff-algorithm=}"
1534 __gitcomp "$__git_diff_submodule_formats" "" "${cur##--submodule=}"
1538 __gitcomp "$__git_color_moved_opts" "" "${cur##--color-moved=}"
1542 __gitcomp "$__git_color_moved_ws_opts" "" "${cur##--color-moved-ws=}"
1546 __gitcomp "--cached --staged --pickaxe-all --pickaxe-regex
1547 --base --ours --theirs --no-index
1548 $__git_diff_common_options
1553 __git_complete_revlist_file
1556 __git_mergetools_common="diffuse diffmerge ecmerge emerge kdiff3 meld opendiff
1557 tkdiff vimdiff gvimdiff xxdiff araxis p4merge bc
1563 __git_has_doubledash && return
1567 __gitcomp "$__git_mergetools_common kompare" "" "${cur##--tool=}"
1571 __gitcomp_builtin difftool "$__git_diff_common_options
1572 --base --cached --ours --theirs
1573 --pickaxe-all --pickaxe-regex
1579 __git_complete_revlist_file
1582 __git_fetch_recurse_submodules="yes on-demand no"
1587 --recurse-submodules=*)
1588 __gitcomp "$__git_fetch_recurse_submodules" "" "${cur##--recurse-submodules=}"
1592 __gitcomp "blob:none blob:limit= sparse:oid=" "" "${cur##--filter=}"
1596 __gitcomp_builtin fetch
1600 __git_complete_remote_or_refspec
1603 __git_format_patch_extra_options="
1604 --full-index --not --all --no-prefix --src-prefix=
1605 --dst-prefix= --notes
1608 _git_format_patch ()
1614 " "" "${cur##--thread=}"
1618 __gitcomp_builtin format-patch "$__git_format_patch_extra_options"
1622 __git_complete_revlist
1629 __gitcomp_builtin fsck
1640 # Lists matching symbol names from a tag (as in ctags) file.
1641 # 1: List symbol names matching this word.
1642 # 2: The tag file to list symbol names from.
1643 # 3: A prefix to be added to each listed symbol name (optional).
1644 # 4: A suffix to be appended to each listed symbol name (optional).
1645 __git_match_ctag () {
1646 awk -v pfx="${3-}" -v sfx="${4-}" "
1647 /^${1//\//\\/}/ { print pfx \$1 sfx }
1651 # Complete symbol names from a tag file.
1652 # Usage: __git_complete_symbol [<option>]...
1653 # --tags=<file>: The tag file to list symbol names from instead of the
1655 # --pfx=<prefix>: A prefix to be added to each symbol name.
1656 # --cur=<word>: The current symbol name to be completed. Defaults to
1657 # the current word to be completed.
1658 # --sfx=<suffix>: A suffix to be appended to each symbol name instead
1659 # of the default space.
1660 __git_complete_symbol () {
1661 local tags=tags pfx="" cur_="${cur-}" sfx=" "
1663 while test $# != 0; do
1665 --tags=*) tags="${1##--tags=}" ;;
1666 --pfx=*) pfx="${1##--pfx=}" ;;
1667 --cur=*) cur_="${1##--cur=}" ;;
1668 --sfx=*) sfx="${1##--sfx=}" ;;
1674 if test -r "$tags"; then
1675 __gitcomp_direct "$(__git_match_ctag "$cur_" "$tags" "$pfx" "$sfx")"
1681 __git_has_doubledash && return
1685 __gitcomp_builtin grep
1690 case "$cword,$prev" in
1692 __git_complete_symbol && return
1703 __gitcomp_builtin help
1707 if test -n "$GIT_TESTING_ALL_COMMAND_LIST"
1709 __gitcomp "$GIT_TESTING_ALL_COMMAND_LIST $(__git --list-cmds=alias,list-guide) gitk"
1711 __gitcomp "$(__git --list-cmds=main,nohelpers,alias,list-guide) gitk"
1720 false true umask group all world everybody
1721 " "" "${cur##--shared=}"
1725 __gitcomp_builtin init
1735 __gitcomp_builtin ls-files
1740 # XXX ignore options like --modified and always suggest all cached
1742 __git_complete_index_file "--cached"
1749 __gitcomp_builtin ls-remote
1753 __gitcomp_nl "$(__git_remotes)"
1760 __gitcomp_builtin ls-tree
1768 # Options that go well for log, shortlog and gitk
1769 __git_log_common_options="
1771 --branches --tags --remotes
1772 --first-parent --merges --no-merges
1774 --max-age= --since= --after=
1775 --min-age= --until= --before=
1776 --min-parents= --max-parents=
1777 --no-min-parents --no-max-parents
1779 # Options that go well for log and gitk (not shortlog)
1780 __git_log_gitk_options="
1781 --dense --sparse --full-history
1782 --simplify-merges --simplify-by-decoration
1783 --left-right --notes --no-notes
1785 # Options that go well for log and shortlog (not gitk)
1786 __git_log_shortlog_options="
1787 --author= --committer= --grep=
1788 --all-match --invert-grep
1791 __git_log_pretty_formats="oneline short medium full fuller reference email raw format: tformat: mboxrd"
1792 __git_log_date_formats="relative iso8601 iso8601-strict rfc2822 short local default raw unix format:"
1796 __git_has_doubledash && return
1797 __git_find_repo_path
1800 if [ -f "$__git_repo_path/MERGE_HEAD" ]; then
1803 case "$prev,$cur" in
1805 return # fall back to Bash filename completion
1808 __git_complete_symbol --cur="${cur#:}" --sfx=":"
1812 __git_complete_symbol
1817 --pretty=*|--format=*)
1818 __gitcomp "$__git_log_pretty_formats $(__git_pretty_aliases)
1823 __gitcomp "$__git_log_date_formats" "" "${cur##--date=}"
1827 __gitcomp "full short no" "" "${cur##--decorate=}"
1831 __gitcomp "$__git_diff_algorithms" "" "${cur##--diff-algorithm=}"
1835 __gitcomp "$__git_diff_submodule_formats" "" "${cur##--submodule=}"
1839 __gitcomp "sorted unsorted" "" "${cur##--no-walk=}"
1844 $__git_log_common_options
1845 $__git_log_shortlog_options
1846 $__git_log_gitk_options
1847 --root --topo-order --date-order --reverse
1848 --follow --full-diff
1849 --abbrev-commit --no-abbrev-commit --abbrev=
1850 --relative-date --date=
1851 --pretty= --format= --oneline
1856 --decorate --decorate= --no-decorate
1858 --no-walk --no-walk= --do-walk
1859 --parents --children
1860 --expand-tabs --expand-tabs= --no-expand-tabs
1863 $__git_diff_common_options
1864 --pickaxe-all --pickaxe-regex
1869 return # fall back to Bash filename completion
1872 __git_complete_symbol --cur="${cur#-L:}" --sfx=":"
1876 __git_complete_symbol --pfx="-G" --cur="${cur#-G}"
1880 __git_complete_symbol --pfx="-S" --cur="${cur#-S}"
1884 __git_complete_revlist
1889 __git_complete_strategy && return
1893 __gitcomp_builtin merge
1903 __gitcomp "$__git_mergetools_common tortoisemerge" "" "${cur##--tool=}"
1907 __gitcomp "--tool= --prompt --no-prompt --gui --no-gui"
1917 __gitcomp_builtin merge-base
1928 __gitcomp_builtin mv
1933 if [ $(__git_count_arguments "mv") -gt 0 ]; then
1934 # We need to show both cached and untracked files (including
1935 # empty directories) since this may not be the last argument.
1936 __git_complete_index_file "--cached --others --directory"
1938 __git_complete_index_file "--cached"
1944 local subcommands='add append copy edit get-ref list merge prune remove show'
1945 local subcommand="$(__git_find_on_cmdline "$subcommands")"
1947 case "$subcommand,$cur" in
1949 __gitcomp_builtin notes
1957 __gitcomp "$subcommands --ref"
1961 *,--reuse-message=*|*,--reedit-message=*)
1962 __git_complete_refs --cur="${cur#*=}"
1965 __gitcomp_builtin notes_$subcommand
1968 # this command does not take a ref, do not complete it
1984 __git_complete_strategy && return
1987 --recurse-submodules=*)
1988 __gitcomp "$__git_fetch_recurse_submodules" "" "${cur##--recurse-submodules=}"
1992 __gitcomp_builtin pull
1997 __git_complete_remote_or_refspec
2000 __git_push_recurse_submodules="check on-demand only"
2002 __git_complete_force_with_lease ()
2010 __git_complete_refs --cur="${cur_#*:}"
2013 __git_complete_refs --cur="$cur_"
2022 __gitcomp_nl "$(__git_remotes)"
2025 --recurse-submodules)
2026 __gitcomp "$__git_push_recurse_submodules"
2032 __gitcomp_nl "$(__git_remotes)" "" "${cur##--repo=}"
2035 --recurse-submodules=*)
2036 __gitcomp "$__git_push_recurse_submodules" "" "${cur##--recurse-submodules=}"
2039 --force-with-lease=*)
2040 __git_complete_force_with_lease "${cur##--force-with-lease=}"
2044 __gitcomp_builtin push
2048 __git_complete_remote_or_refspec
2056 --creation-factor= --no-dual-color
2057 $__git_diff_common_options
2062 __git_complete_revlist
2065 __git_rebase_inprogress_options="--continue --skip --abort --quit --show-current-patch"
2066 __git_rebase_interactive_inprogress_options="$__git_rebase_inprogress_options --edit-todo"
2070 __git_find_repo_path
2071 if [ -f "$__git_repo_path"/rebase-merge/interactive ]; then
2072 __gitcomp "$__git_rebase_interactive_inprogress_options"
2074 elif [ -d "$__git_repo_path"/rebase-apply ] || \
2075 [ -d "$__git_repo_path"/rebase-merge ]; then
2076 __gitcomp "$__git_rebase_inprogress_options"
2079 __git_complete_strategy && return
2082 __gitcomp "$__git_whitespacelist" "" "${cur##--whitespace=}"
2086 __git_complete_refs --cur="${cur##--onto=}"
2090 __gitcomp_builtin rebase "" \
2091 "$__git_rebase_interactive_inprogress_options"
2100 local subcommands="show delete expire"
2101 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2103 if [ -z "$subcommand" ]; then
2104 __gitcomp "$subcommands"
2110 __git_send_email_confirm_options="always never auto cc compose"
2111 __git_send_email_suppresscc_options="author self cc bodycc sob cccmd body all"
2116 --to|--cc|--bcc|--from)
2117 __gitcomp "$(__git send-email --dump-aliases)"
2125 $__git_send_email_confirm_options
2126 " "" "${cur##--confirm=}"
2131 $__git_send_email_suppresscc_options
2132 " "" "${cur##--suppress-cc=}"
2136 --smtp-encryption=*)
2137 __gitcomp "ssl tls" "" "${cur##--smtp-encryption=}"
2143 " "" "${cur##--thread=}"
2146 --to=*|--cc=*|--bcc=*|--from=*)
2147 __gitcomp "$(__git send-email --dump-aliases)" "" "${cur#--*=}"
2151 __gitcomp_builtin send-email "--annotate --bcc --cc --cc-cmd --chain-reply-to
2152 --compose --confirm= --dry-run --envelope-sender
2154 --in-reply-to --no-chain-reply-to --no-signed-off-by-cc
2155 --no-suppress-from --no-thread --quiet --reply-to
2156 --signed-off-by-cc --smtp-pass --smtp-server
2157 --smtp-server-port --smtp-encryption= --smtp-user
2158 --subject --suppress-cc= --suppress-from --thread --to
2159 --validate --no-validate
2160 $__git_format_patch_extra_options"
2164 __git_complete_revlist
2175 local untracked_state
2178 --ignore-submodules=*)
2179 __gitcomp "none untracked dirty all" "" "${cur##--ignore-submodules=}"
2182 --untracked-files=*)
2183 __gitcomp "$__git_untracked_file_modes" "" "${cur##--untracked-files=}"
2188 always never auto column row plain dense nodense
2189 " "" "${cur##--column=}"
2193 __gitcomp_builtin status
2198 untracked_state="$(__git_get_option_value "-u" "--untracked-files=" \
2199 "$__git_untracked_file_modes" "status.showUntrackedFiles")"
2201 case "$untracked_state" in
2203 # --ignored option does not matter
2207 complete_opt="--cached --directory --no-empty-directory --others"
2209 if [ -n "$(__git_find_on_cmdline "--ignored")" ]; then
2210 complete_opt="$complete_opt --ignored --exclude=*"
2215 __git_complete_index_file "$complete_opt"
2222 __gitcomp "diff3 merge" "" "${cur##--conflict=}"
2225 __gitcomp_builtin switch
2228 # check if --track, --no-track, or --no-guess was specified
2229 # if so, disable DWIM mode
2230 local dwim_opt="--dwim" only_local_ref=n
2231 if [ "$GIT_COMPLETION_CHECKOUT_NO_GUESS" = "1" ] ||
2232 [ -n "$(__git_find_on_cmdline "--track --no-track --no-guess")" ]; then
2235 # explicit --guess enables DWIM mode regardless of
2236 # $GIT_COMPLETION_CHECKOUT_NO_GUESS
2237 if [ -n "$(__git_find_on_cmdline "--guess")" ]; then
2240 if [ -z "$(__git_find_on_cmdline "-d --detach")" ]; then
2243 # --guess --detach is invalid combination, no
2244 # dwim will be done when --detach is specified
2247 if [ $only_local_ref = y -a -z "$dwim_opt" ]; then
2248 __gitcomp_direct "$(__git_heads "" "$cur" " ")"
2250 __git_complete_refs $dwim_opt
2256 __git_config_get_set_variables ()
2258 local prevword word config_file= c=$cword
2259 while [ $c -gt 1 ]; do
2262 --system|--global|--local|--file=*)
2267 config_file="$word $prevword"
2275 __git config $config_file --name-only --list
2279 __git_compute_config_vars ()
2281 test -n "$__git_config_vars" ||
2282 __git_config_vars="$(git help --config-for-completion | sort -u)"
2285 # Completes possible values of various configuration variables.
2287 # Usage: __git_complete_config_variable_value [<option>]...
2288 # --varname=<word>: The name of the configuration variable whose value is
2289 # to be completed. Defaults to the previous word on the
2291 # --cur=<word>: The current value to be completed. Defaults to the current
2292 # word to be completed.
2293 __git_complete_config_variable_value ()
2295 local varname="$prev" cur_="$cur"
2297 while test $# != 0; do
2299 --varname=*) varname="${1##--varname=}" ;;
2300 --cur=*) cur_="${1##--cur=}" ;;
2306 if [ "${BASH_VERSINFO[0]:-0}" -ge 4 ]; then
2307 varname="${varname,,}"
2309 varname="$(echo "$varname" |tr A-Z a-z)"
2313 branch.*.remote|branch.*.pushremote)
2314 __gitcomp_nl "$(__git_remotes)" "" "$cur_"
2318 __git_complete_refs --cur="$cur_"
2322 __gitcomp "false true merges preserve interactive" "" "$cur_"
2326 __gitcomp_nl "$(__git_remotes)" "" "$cur_"
2330 local remote="${varname#remote.}"
2331 remote="${remote%.fetch}"
2332 if [ -z "$cur_" ]; then
2333 __gitcomp_nl "refs/heads/" "" "" ""
2336 __gitcomp_nl "$(__git_refs_remotes "$remote")" "" "$cur_"
2340 local remote="${varname#remote.}"
2341 remote="${remote%.push}"
2342 __gitcomp_nl "$(__git for-each-ref \
2343 --format='%(refname):%(refname)' refs/heads)" "" "$cur_"
2346 pull.twohead|pull.octopus)
2347 __git_compute_merge_strategies
2348 __gitcomp "$__git_merge_strategies" "" "$cur_"
2352 __gitcomp "false true" "" "$cur_"
2357 normal black red green yellow blue magenta cyan white
2358 bold dim ul blink reverse
2363 __gitcomp "false true always never auto" "" "$cur_"
2367 __gitcomp "$__git_diff_submodule_formats" "" "$cur_"
2371 __gitcomp "man info web html" "" "$cur_"
2375 __gitcomp "$__git_log_date_formats" "" "$cur_"
2378 sendemail.aliasfiletype)
2379 __gitcomp "mutt mailrc pine elm gnus" "" "$cur_"
2383 __gitcomp "$__git_send_email_confirm_options" "" "$cur_"
2386 sendemail.suppresscc)
2387 __gitcomp "$__git_send_email_suppresscc_options" "" "$cur_"
2390 sendemail.transferencoding)
2391 __gitcomp "7bit 8bit quoted-printable base64" "" "$cur_"
2400 # Completes configuration sections, subsections, variable names.
2402 # Usage: __git_complete_config_variable_name [<option>]...
2403 # --cur=<word>: The current configuration section/variable name to be
2404 # completed. Defaults to the current word to be completed.
2405 # --sfx=<suffix>: A suffix to be appended to each fully completed
2406 # configuration variable name (but not to sections or
2407 # subsections) instead of the default space.
2408 __git_complete_config_variable_name ()
2410 local cur_="$cur" sfx
2412 while test $# != 0; do
2414 --cur=*) cur_="${1##--cur=}" ;;
2415 --sfx=*) sfx="${1##--sfx=}" ;;
2423 local pfx="${cur_%.*}."
2425 __gitcomp "remote pushRemote merge mergeOptions rebase" "$pfx" "$cur_" "$sfx"
2429 local pfx="${cur%.*}."
2431 __gitcomp_direct "$(__git_heads "$pfx" "$cur_" ".")"
2432 __gitcomp_nl_append $'autoSetupMerge\nautoSetupRebase\n' "$pfx" "$cur_" "$sfx"
2436 local pfx="${cur_%.*}."
2439 argPrompt cmd confirm needsFile noConsole noRescan
2440 prompt revPrompt revUnmerged title
2441 " "$pfx" "$cur_" "$sfx"
2445 local pfx="${cur_%.*}."
2447 __gitcomp "cmd path" "$pfx" "$cur_" "$sfx"
2451 local pfx="${cur_%.*}."
2453 __gitcomp "cmd path" "$pfx" "$cur_" "$sfx"
2457 local pfx="${cur_%.*}."
2459 __gitcomp "cmd path trustExitCode" "$pfx" "$cur_" "$sfx"
2463 local pfx="${cur_%.*}."
2465 __git_compute_all_commands
2466 __gitcomp_nl "$__git_all_commands" "$pfx" "$cur_" "$sfx"
2470 local pfx="${cur_%.*}."
2473 url proxy fetch push mirror skipDefaultUpdate
2474 receivepack uploadpack tagOpt pushurl
2475 " "$pfx" "$cur_" "$sfx"
2479 local pfx="${cur_%.*}."
2481 __gitcomp_nl "$(__git_remotes)" "$pfx" "$cur_" "."
2482 __gitcomp_nl_append "pushDefault" "$pfx" "$cur_" "$sfx"
2486 local pfx="${cur_%.*}."
2488 __gitcomp "insteadOf pushInsteadOf" "$pfx" "$cur_" "$sfx"
2492 __git_compute_config_vars
2493 __gitcomp "$__git_config_vars" "" "$cur_" "$sfx"
2496 __git_compute_config_vars
2497 __gitcomp "$(echo "$__git_config_vars" |
2510 # Completes '='-separated configuration sections/variable names and values
2511 # for 'git -c section.name=value'.
2513 # Usage: __git_complete_config_variable_name_and_value [<option>]...
2514 # --cur=<word>: The current configuration section/variable name/value to be
2515 # completed. Defaults to the current word to be completed.
2516 __git_complete_config_variable_name_and_value ()
2520 while test $# != 0; do
2522 --cur=*) cur_="${1##--cur=}" ;;
2530 __git_complete_config_variable_value \
2531 --varname="${cur_%%=*}" --cur="${cur_#*=}"
2534 __git_complete_config_variable_name --cur="$cur_" --sfx='='
2542 --get|--get-all|--unset|--unset-all)
2543 __gitcomp_nl "$(__git_config_get_set_variables)"
2547 __git_complete_config_variable_value
2553 __gitcomp_builtin config
2556 __git_complete_config_variable_name
2564 add rename remove set-head set-branches
2565 get-url set-url show prune update
2567 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2568 if [ -z "$subcommand" ]; then
2571 __gitcomp_builtin remote
2574 __gitcomp "$subcommands"
2580 case "$subcommand,$cur" in
2582 __gitcomp_builtin remote_add
2587 __gitcomp_builtin remote_set-head
2590 __gitcomp_builtin remote_set-branches
2592 set-head,*|set-branches,*)
2593 __git_complete_remote_or_refspec
2596 __gitcomp_builtin remote_update
2599 __gitcomp "$(__git_remotes) $(__git_get_config_variables "remotes")"
2602 __gitcomp_builtin remote_set-url
2605 __gitcomp_builtin remote_get-url
2608 __gitcomp_builtin remote_prune
2611 __gitcomp_nl "$(__git_remotes)"
2620 __gitcomp "short medium long" "" "${cur##--format=}"
2624 __gitcomp_builtin replace
2633 local subcommands="clear forget diff remaining status gc"
2634 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2635 if test -z "$subcommand"
2637 __gitcomp "$subcommands"
2644 __git_has_doubledash && return
2648 __gitcomp_builtin reset
2659 __gitcomp "diff3 merge" "" "${cur##--conflict=}"
2662 __git_complete_refs --cur="${cur##--source=}"
2665 __gitcomp_builtin restore
2670 __git_revert_inprogress_options=$__git_sequencer_inprogress_options
2674 __git_find_repo_path
2675 if [ -f "$__git_repo_path"/REVERT_HEAD ]; then
2676 __gitcomp "$__git_revert_inprogress_options"
2679 __git_complete_strategy && return
2682 __gitcomp_builtin revert "" \
2683 "$__git_revert_inprogress_options"
2694 __gitcomp_builtin rm
2699 __git_complete_index_file "--cached"
2704 __git_has_doubledash && return
2709 $__git_log_common_options
2710 $__git_log_shortlog_options
2711 --numbered --summary --email
2716 __git_complete_revlist
2721 __git_has_doubledash && return
2724 --pretty=*|--format=*)
2725 __gitcomp "$__git_log_pretty_formats $(__git_pretty_aliases)
2730 __gitcomp "$__git_diff_algorithms" "" "${cur##--diff-algorithm=}"
2734 __gitcomp "$__git_diff_submodule_formats" "" "${cur##--submodule=}"
2738 __gitcomp "--pretty= --format= --abbrev-commit --no-abbrev-commit
2739 --oneline --show-signature --patch
2740 --expand-tabs --expand-tabs= --no-expand-tabs
2741 $__git_diff_common_options
2746 __git_complete_revlist_file
2753 __gitcomp_builtin show-branch
2757 __git_complete_revlist
2760 _git_sparse_checkout ()
2762 local subcommands="list init set disable"
2763 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2764 if [ -z "$subcommand" ]; then
2765 __gitcomp "$subcommands"
2769 case "$subcommand,$cur" in
2783 local save_opts='--all --keep-index --no-keep-index --quiet --patch --include-untracked'
2784 local subcommands='push list show apply clear drop pop create branch'
2785 local subcommand="$(__git_find_on_cmdline "$subcommands save")"
2786 if [ -n "$(__git_find_on_cmdline "-p")" ]; then
2789 if [ -z "$subcommand" ]; then
2792 __gitcomp "$save_opts"
2795 if [ -z "$(__git_find_on_cmdline "$save_opts")" ]; then
2800 if [ -z "$(__git_find_on_cmdline "$save_opts")" ]; then
2801 __gitcomp "$subcommands"
2806 case "$subcommand,$cur" in
2808 __gitcomp "$save_opts --message"
2811 __gitcomp "$save_opts"
2814 __gitcomp "--index --quiet"
2820 __gitcomp "--name-status --oneline --patch-with-stat"
2822 show,--*|branch,--*)
2825 if [ $cword -eq 3 ]; then
2828 __gitcomp_nl "$(__git stash list \
2829 | sed -n -e 's/:.*//p')"
2832 show,*|apply,*|drop,*|pop,*)
2833 __gitcomp_nl "$(__git stash list \
2834 | sed -n -e 's/:.*//p')"
2844 __git_has_doubledash && return
2846 local subcommands="add status init deinit update set-branch set-url summary foreach sync absorbgitdirs"
2847 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2848 if [ -z "$subcommand" ]; then
2854 __gitcomp "$subcommands"
2860 case "$subcommand,$cur" in
2862 __gitcomp "--branch --force --name --reference --depth"
2865 __gitcomp "--cached --recursive"
2868 __gitcomp "--force --all"
2872 --init --remote --no-fetch
2873 --recommend-shallow --no-recommend-shallow
2874 --force --rebase --merge --reference --depth --recursive --jobs
2878 __gitcomp "--default --branch"
2881 __gitcomp "--cached --files --summary-limit"
2883 foreach,--*|sync,--*)
2884 __gitcomp "--recursive"
2894 init fetch clone rebase dcommit log find-rev
2895 set-tree commit-diff info create-ignore propget
2896 proplist show-ignore show-externals branch tag blame
2897 migrate mkdirs reset gc
2899 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2900 if [ -z "$subcommand" ]; then
2901 __gitcomp "$subcommands"
2903 local remote_opts="--username= --config-dir= --no-auth-cache"
2905 --follow-parent --authors-file= --repack=
2906 --no-metadata --use-svm-props --use-svnsync-props
2907 --log-window-size= --no-checkout --quiet
2908 --repack-flags --use-log-author --localtime
2911 --ignore-paths= --include-paths= $remote_opts
2914 --template= --shared= --trunk= --tags=
2915 --branches= --stdlayout --minimize-url
2916 --no-metadata --use-svm-props --use-svnsync-props
2917 --rewrite-root= --prefix= $remote_opts
2920 --edit --rmdir --find-copies-harder --copy-similarity=
2923 case "$subcommand,$cur" in
2925 __gitcomp "--revision= --fetch-all $fc_opts"
2928 __gitcomp "--revision= $fc_opts $init_opts"
2931 __gitcomp "$init_opts"
2935 --merge --strategy= --verbose --dry-run
2936 --fetch-all --no-rebase --commit-url
2937 --revision --interactive $cmt_opts $fc_opts
2941 __gitcomp "--stdin $cmt_opts $fc_opts"
2943 create-ignore,--*|propget,--*|proplist,--*|show-ignore,--*|\
2944 show-externals,--*|mkdirs,--*)
2945 __gitcomp "--revision="
2949 --limit= --revision= --verbose --incremental
2950 --oneline --show-commit --non-recursive
2951 --authors-file= --color
2956 --merge --verbose --strategy= --local
2957 --fetch-all --dry-run $fc_opts
2961 __gitcomp "--message= --file= --revision= $cmt_opts"
2967 __gitcomp "--dry-run --message --tag"
2970 __gitcomp "--dry-run --message"
2973 __gitcomp "--git-format"
2977 --config-dir= --ignore-paths= --minimize
2978 --no-auth-cache --username=
2982 __gitcomp "--revision= --parent"
2993 while [ $c -lt $cword ]; do
2996 -d|--delete|-v|--verify)
2997 __gitcomp_direct "$(__git_tags "" "$cur" " ")"
3012 __gitcomp_direct "$(__git_tags "" "$cur" " ")"
3022 __gitcomp_builtin tag
3032 __git_complete_worktree_paths ()
3035 __gitcomp_nl "$(git worktree list --porcelain |
3036 # Skip the first entry: it's the path of the main worktree,
3037 # which can't be moved, removed, locked, etc.
3038 sed -n -e '2,$ s/^worktree //p')"
3043 local subcommands="add list lock move prune remove unlock"
3044 local subcommand subcommand_idx
3046 subcommand="$(__git_find_on_cmdline --show-idx "$subcommands")"
3047 subcommand_idx="${subcommand% *}"
3048 subcommand="${subcommand#* }"
3050 case "$subcommand,$cur" in
3052 __gitcomp "$subcommands"
3055 __gitcomp_builtin worktree_$subcommand
3057 add,*) # usage: git worktree add [<options>] <path> [<commit-ish>]
3058 # Here we are not completing an --option, it's either the
3061 -b|-B) # Complete refs for branch to be created/reseted.
3064 -*) # The previous word is an -o|--option without an
3065 # unstuck argument: have to complete the path for
3066 # the new worktree, so don't list anything, but let
3067 # Bash fall back to filename completion.
3069 *) # The previous word is not an --option, so it must
3070 # be either the 'add' subcommand, the unstuck
3071 # argument of an option (e.g. branch for -b|-B), or
3072 # the path for the new worktree.
3073 if [ $cword -eq $((subcommand_idx+1)) ]; then
3074 # Right after the 'add' subcommand: have to
3075 # complete the path, so fall back to Bash
3076 # filename completion.
3079 case "${words[cword-2]}" in
3080 -b|-B) # After '-b <branch>': have to
3081 # complete the path, so fall back
3082 # to Bash filename completion.
3084 *) # After the path: have to complete
3085 # the ref to be checked out.
3093 lock,*|remove,*|unlock,*)
3094 __git_complete_worktree_paths
3097 if [ $cword -eq $((subcommand_idx+1)) ]; then
3098 # The first parameter must be an existing working
3100 __git_complete_worktree_paths
3102 # The second parameter is the destination: it could
3103 # be any path, so don't list anything, but let Bash
3104 # fall back to filename completion.
3111 __git_complete_common () {
3116 __gitcomp_builtin "$command"
3121 __git_cmds_with_parseopt_helper=
3122 __git_support_parseopt_helper () {
3123 test -n "$__git_cmds_with_parseopt_helper" ||
3124 __git_cmds_with_parseopt_helper="$(__git --list-cmds=parseopt)"
3126 case " $__git_cmds_with_parseopt_helper " in
3136 __git_complete_command () {
3138 local completion_func="_git_${command//-/_}"
3139 if ! declare -f $completion_func >/dev/null 2>/dev/null &&
3140 declare -f _completion_loader >/dev/null 2>/dev/null
3142 _completion_loader "git-$command"
3144 if declare -f $completion_func >/dev/null 2>/dev/null
3148 elif __git_support_parseopt_helper "$command"
3150 __git_complete_common "$command"
3159 local i c=1 command __git_dir __git_repo_path
3160 local __git_C_args C_args_count=0
3162 while [ $c -lt $cword ]; do
3165 --git-dir=*) __git_dir="${i#--git-dir=}" ;;
3166 --git-dir) ((c++)) ; __git_dir="${words[c]}" ;;
3167 --bare) __git_dir="." ;;
3168 --help) command="help"; break ;;
3169 -c|--work-tree|--namespace) ((c++)) ;;
3170 -C) __git_C_args[C_args_count++]=-C
3172 __git_C_args[C_args_count++]="${words[c]}"
3175 *) command="$i"; break ;;
3180 if [ -z "$command" ]; then
3182 --git-dir|-C|--work-tree)
3183 # these need a path argument, let's fall back to
3184 # Bash filename completion
3188 __git_complete_config_variable_name_and_value
3192 # we don't support completing these options' arguments
3210 --no-replace-objects
3215 if test -n "$GIT_TESTING_PORCELAIN_COMMAND_LIST"
3217 __gitcomp "$GIT_TESTING_PORCELAIN_COMMAND_LIST"
3219 __gitcomp "$(__git --list-cmds=list-mainporcelain,others,nohelpers,alias,list-complete,config)"
3226 __git_complete_command "$command" && return
3228 local expansion=$(__git_aliased_command "$command")
3229 if [ -n "$expansion" ]; then
3231 __git_complete_command "$expansion"
3237 __git_has_doubledash && return
3239 local __git_repo_path
3240 __git_find_repo_path
3243 if [ -f "$__git_repo_path/MERGE_HEAD" ]; then
3249 $__git_log_common_options
3250 $__git_log_gitk_options
3256 __git_complete_revlist
3259 if [[ -n ${ZSH_VERSION-} ]] &&
3260 # Don't define these functions when sourced from 'git-completion.zsh',
3261 # it has its own implementations.
3262 [[ -z ${GIT_SOURCING_ZSH_COMPLETION-} ]]; then
3263 echo "WARNING: this script is deprecated, please see git-completion.zsh" 1>&2
3265 autoload -U +X compinit && compinit
3271 local cur_="${3-$cur}"
3277 local c IFS=$' \t\n'
3285 array[${#array[@]}+1]="$c"
3288 compadd -Q -S '' -p "${2-}" -a -- array && _ret=0
3299 compadd -Q -- ${=1} && _ret=0
3308 compadd -Q -S "${4- }" -p "${2-}" -- ${=1} && _ret=0
3311 __gitcomp_file_direct ()
3317 compadd -f -- ${=1} && _ret=0
3326 compadd -p "${2-}" -f -- ${=1} && _ret=0
3331 local _ret=1 cur cword prev
3332 cur=${words[CURRENT]}
3333 prev=${words[CURRENT-1]}
3335 emulate ksh -c __${service}_main
3336 let _ret && _default && _ret=0
3340 compdef _git git gitk
3346 local cur words cword prev
3347 _get_comp_words_by_ref -n =: cur words cword prev
3351 # Setup completion for certain functions defined above by setting common
3352 # variables and workarounds.
3353 # This is NOT a public function; use at your own risk.
3356 local wrapper="__git_wrap${2}"
3357 eval "$wrapper () { __git_func_wrap $2 ; }"
3358 complete -o bashdefault -o default -o nospace -F $wrapper $1 2>/dev/null \
3359 || complete -o default -o nospace -F $wrapper $1
3362 # wrapper for backwards compatibility
3365 __git_wrap__git_main
3368 # wrapper for backwards compatibility
3371 __git_wrap__gitk_main
3374 __git_complete git __git_main
3375 __git_complete gitk __gitk_main
3377 # The following are necessary only for Cygwin, and only are needed
3378 # when the user has tab-completed the executable name and consequently
3379 # included the '.exe' suffix.
3381 if [ Cygwin = "$(uname -o 2>/dev/null)" ]; then
3382 __git_complete git.exe __git_main