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 # *) tree paths within 'ref:path/to/file' expressions
14 # *) file paths within current working directory and index
15 # *) common --long-options
17 # To use these routines:
19 # 1) Copy this file to somewhere (e.g. ~/.git-completion.sh).
20 # 2) Add the following line to your .bashrc/.zshrc:
21 # source ~/.git-completion.sh
22 # 3) Consider changing your PS1 to also show the current branch,
23 # see git-prompt.sh for details.
25 # If you use complex aliases of form '!f() { ... }; f', you can use the null
26 # command ':' as the first command in the function body to declare the desired
27 # completion style. For example '!f() { : git commit ; ... }; f' will
28 # tell the completion to use commit completion. This also works with aliases
29 # of form "!sh -c '...'". For example, "!sh -c ': git commit ; ... '".
31 case "$COMP_WORDBREAKS" in
33 *) COMP_WORDBREAKS="$COMP_WORDBREAKS:"
36 # __gitdir accepts 0 or 1 arguments (i.e., location)
37 # returns location of .git repo
40 if [ -z "${1-}" ]; then
41 if [ -n "${__git_dir-}" ]; then
43 elif [ -n "${GIT_DIR-}" ]; then
44 test -d "${GIT_DIR-}" || return 1
46 elif [ -d .git ]; then
49 git rev-parse --git-dir 2>/dev/null
51 elif [ -d "$1/.git" ]; then
58 # The following function is based on code from:
60 # bash_completion - programmable completion functions for bash 3.2+
62 # Copyright © 2006-2008, Ian Macdonald <ian@caliban.org>
63 # © 2009-2010, Bash Completion Maintainers
64 # <bash-completion-devel@lists.alioth.debian.org>
66 # This program is free software; you can redistribute it and/or modify
67 # it under the terms of the GNU General Public License as published by
68 # the Free Software Foundation; either version 2, or (at your option)
71 # This program is distributed in the hope that it will be useful,
72 # but WITHOUT ANY WARRANTY; without even the implied warranty of
73 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
74 # GNU General Public License for more details.
76 # You should have received a copy of the GNU General Public License
77 # along with this program; if not, write to the Free Software Foundation,
78 # Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
80 # The latest version of this software can be obtained here:
82 # http://bash-completion.alioth.debian.org/
86 # This function can be used to access a tokenized list of words
87 # on the command line:
89 # __git_reassemble_comp_words_by_ref '=:'
90 # if test "${words_[cword_-1]}" = -w
95 # The argument should be a collection of characters from the list of
96 # word completion separators (COMP_WORDBREAKS) to treat as ordinary
99 # This is roughly equivalent to going back in time and setting
100 # COMP_WORDBREAKS to exclude those characters. The intent is to
101 # make option types like --date=<type> and <rev>:<path> easy to
102 # recognize by treating each shell word as a single token.
104 # It is best not to set COMP_WORDBREAKS directly because the value is
105 # shared with other completion scripts. By the time the completion
106 # function gets called, COMP_WORDS has already been populated so local
107 # changes to COMP_WORDBREAKS have no effect.
109 # Output: words_, cword_, cur_.
111 __git_reassemble_comp_words_by_ref()
113 local exclude i j first
114 # Which word separators to exclude?
115 exclude="${1//[^$COMP_WORDBREAKS]}"
117 if [ -z "$exclude" ]; then
118 words_=("${COMP_WORDS[@]}")
121 # List of word completion separators has shrunk;
122 # re-assemble words to complete.
123 for ((i=0, j=0; i < ${#COMP_WORDS[@]}; i++, j++)); do
124 # Append each nonempty word consisting of just
125 # word separator characters to the current word.
129 [ -n "${COMP_WORDS[$i]}" ] &&
130 # word consists of excluded word separators
131 [ "${COMP_WORDS[$i]//[^$exclude]}" = "${COMP_WORDS[$i]}" ]
133 # Attach to the previous token,
134 # unless the previous token is the command name.
135 if [ $j -ge 2 ] && [ -n "$first" ]; then
139 words_[$j]=${words_[j]}${COMP_WORDS[i]}
140 if [ $i = $COMP_CWORD ]; then
143 if (($i < ${#COMP_WORDS[@]} - 1)); then
150 words_[$j]=${words_[j]}${COMP_WORDS[i]}
151 if [ $i = $COMP_CWORD ]; then
157 if ! type _get_comp_words_by_ref >/dev/null 2>&1; then
158 _get_comp_words_by_ref ()
160 local exclude cur_ words_ cword_
161 if [ "$1" = "-n" ]; then
165 __git_reassemble_comp_words_by_ref "$exclude"
166 cur_=${words_[cword_]}
167 while [ $# -gt 0 ]; do
173 prev=${words_[$cword_-1]}
176 words=("${words_[@]}")
189 local i=${#COMPREPLY[@]}
191 if [[ "$x" == "$3"* ]]; then
192 COMPREPLY[i++]="$2$x$4"
203 # Generates completion reply, appending a space to possible completion words,
205 # It accepts 1 to 4 arguments:
206 # 1: List of possible completion words.
207 # 2: A prefix to be added to each possible completion word (optional).
208 # 3: Generate possible completion matches for this word (optional).
209 # 4: A suffix to be appended to each possible completion word (optional).
212 local cur_="${3-$cur}"
218 local c i=0 IFS=$' \t\n'
221 if [[ $c == "$cur_"* ]]; then
226 COMPREPLY[i++]="${2-}$c"
233 # Variation of __gitcomp_nl () that appends to the existing list of
234 # completion candidates, COMPREPLY.
235 __gitcomp_nl_append ()
238 __gitcompappend "$1" "${2-}" "${3-$cur}" "${4- }"
241 # Generates completion reply from newline-separated possible completion words
242 # by appending a space to all of them.
243 # It accepts 1 to 4 arguments:
244 # 1: List of possible completion words, separated by a single newline.
245 # 2: A prefix to be added to each possible completion word (optional).
246 # 3: Generate possible completion matches for this word (optional).
247 # 4: A suffix to be appended to each possible completion word instead of
248 # the default space (optional). If specified but empty, nothing is
253 __gitcomp_nl_append "$@"
256 # Generates completion reply with compgen from newline-separated possible
257 # completion filenames.
258 # It accepts 1 to 3 arguments:
259 # 1: List of possible completion filenames, separated by a single newline.
260 # 2: A directory prefix to be added to each possible completion filename
262 # 3: Generate possible completion matches for this word (optional).
267 # XXX does not work when the directory prefix contains a tilde,
268 # since tilde expansion is not applied.
269 # This means that COMPREPLY will be empty and Bash default
270 # completion will be used.
271 __gitcompadd "$1" "${2-}" "${3-$cur}" ""
273 # use a hack to enable file mode in bash < 4
274 compopt -o filenames +o nospace 2>/dev/null ||
275 compgen -f /non-existing-dir/ > /dev/null
278 # Execute 'git ls-files', unless the --committable option is specified, in
279 # which case it runs 'git diff-index' to find out the files that can be
280 # committed. It return paths relative to the directory specified in the first
281 # argument, and using the options specified in the second argument.
282 __git_ls_files_helper ()
284 if [ "$2" == "--committable" ]; then
285 git -C "$1" diff-index --name-only --relative HEAD
287 # NOTE: $2 is not quoted in order to support multiple options
288 git -C "$1" ls-files --exclude-standard $2
293 # __git_index_files accepts 1 or 2 arguments:
294 # 1: Options to pass to ls-files (required).
295 # 2: A directory path (optional).
296 # If provided, only files within the specified directory are listed.
297 # Sub directories are never recursed. Path must have a trailing
301 local dir="$(__gitdir)" root="${2-.}" file
303 if [ -d "$dir" ]; then
304 __git_ls_files_helper "$root" "$1" |
305 while read -r file; do
307 ?*/*) echo "${file%%/*}" ;;
316 local dir="$(__gitdir)"
317 if [ -d "$dir" ]; then
318 git --git-dir="$dir" for-each-ref --format='%(refname:short)' \
326 local dir="$(__gitdir)"
327 if [ -d "$dir" ]; then
328 git --git-dir="$dir" for-each-ref --format='%(refname:short)' \
334 # __git_refs accepts 0, 1 (to pass to __gitdir), or 2 arguments
335 # presence of 2nd argument means use the guess heuristic employed
336 # by checkout for tracking branches
339 local i hash dir="$(__gitdir "${1-}")" track="${2-}"
341 if [ -d "$dir" ]; then
349 for i in HEAD FETCH_HEAD ORIG_HEAD MERGE_HEAD; do
350 if [ -e "$dir/$i" ]; then echo $i; fi
352 format="refname:short"
353 refs="refs/tags refs/heads refs/remotes"
356 git --git-dir="$dir" for-each-ref --format="%($format)" \
358 if [ -n "$track" ]; then
359 # employ the heuristic used by git checkout
360 # Try to find a remote branch that matches the completion word
361 # but only output if the branch name is unique
363 git --git-dir="$dir" for-each-ref --shell --format="ref=%(refname:short)" \
365 while read -r entry; do
368 if [[ "$ref" == "$cur"* ]]; then
371 done | sort | uniq -u
377 git ls-remote "$dir" "$cur*" 2>/dev/null | \
378 while read -r hash i; do
387 git for-each-ref --format="%(refname:short)" -- \
388 "refs/remotes/$dir/" 2>/dev/null | sed -e "s#^$dir/##"
393 # __git_refs2 requires 1 argument (to pass to __git_refs)
397 for i in $(__git_refs "$1"); do
402 # __git_refs_remotes requires 1 argument (to pass to ls-remote)
403 __git_refs_remotes ()
406 git ls-remote "$1" 'refs/heads/*' 2>/dev/null | \
407 while read -r hash i; do
408 echo "$i:refs/remotes/$1/${i#refs/heads/}"
414 local i IFS=$'\n' d="$(__gitdir)"
415 test -d "$d/remotes" && ls -1 "$d/remotes"
416 for i in $(git --git-dir="$d" config --get-regexp 'remote\..*\.url' 2>/dev/null); do
422 __git_list_merge_strategies ()
424 git merge -s help 2>&1 |
425 sed -n -e '/[Aa]vailable strategies are: /,/^$/{
434 __git_merge_strategies=
435 # 'git merge -s help' (and thus detection of the merge strategy
436 # list) fails, unfortunately, if run outside of any git working
437 # tree. __git_merge_strategies is set to the empty string in
438 # that case, and the detection will be repeated the next time it
440 __git_compute_merge_strategies ()
442 test -n "$__git_merge_strategies" ||
443 __git_merge_strategies=$(__git_list_merge_strategies)
446 __git_complete_revlist_file ()
448 local pfx ls ref cur_="$cur"
468 case "$COMP_WORDBREAKS" in
470 *) pfx="$ref:$pfx" ;;
473 __gitcomp_nl "$(git --git-dir="$(__gitdir)" ls-tree "$ls" 2>/dev/null \
474 | sed '/^100... blob /{
490 pfx="${cur_%...*}..."
492 __gitcomp_nl "$(__git_refs)" "$pfx" "$cur_"
497 __gitcomp_nl "$(__git_refs)" "$pfx" "$cur_"
500 __gitcomp_nl "$(__git_refs)"
506 # __git_complete_index_file requires 1 argument:
507 # 1: the options to pass to ls-file
509 # The exception is --committable, which finds the files appropriate commit.
510 __git_complete_index_file ()
512 local pfx="" cur_="$cur"
522 __gitcomp_file "$(__git_index_files "$1" ${pfx:+"$pfx"})" "$pfx" "$cur_"
525 __git_complete_file ()
527 __git_complete_revlist_file
530 __git_complete_revlist ()
532 __git_complete_revlist_file
535 __git_complete_remote_or_refspec ()
537 local cur_="$cur" cmd="${words[1]}"
538 local i c=2 remote="" pfx="" lhs=1 no_complete_refspec=0
539 if [ "$cmd" = "remote" ]; then
542 while [ $c -lt $cword ]; do
545 --mirror) [ "$cmd" = "push" ] && no_complete_refspec=1 ;;
548 push) no_complete_refspec=1 ;;
556 *) remote="$i"; break ;;
560 if [ -z "$remote" ]; then
561 __gitcomp_nl "$(__git_remotes)"
564 if [ $no_complete_refspec = 1 ]; then
567 [ "$remote" = "." ] && remote=
570 case "$COMP_WORDBREAKS" in
572 *) pfx="${cur_%%:*}:" ;;
584 if [ $lhs = 1 ]; then
585 __gitcomp_nl "$(__git_refs2 "$remote")" "$pfx" "$cur_"
587 __gitcomp_nl "$(__git_refs)" "$pfx" "$cur_"
591 if [ $lhs = 1 ]; then
592 __gitcomp_nl "$(__git_refs "$remote")" "$pfx" "$cur_"
594 __gitcomp_nl "$(__git_refs)" "$pfx" "$cur_"
598 if [ $lhs = 1 ]; then
599 __gitcomp_nl "$(__git_refs)" "$pfx" "$cur_"
601 __gitcomp_nl "$(__git_refs "$remote")" "$pfx" "$cur_"
607 __git_complete_strategy ()
609 __git_compute_merge_strategies
612 __gitcomp "$__git_merge_strategies"
617 __gitcomp "$__git_merge_strategies" "" "${cur##--strategy=}"
625 if test -n "${GIT_TESTING_COMMAND_COMPLETION:-}"
627 printf "%s" "${GIT_TESTING_COMMAND_COMPLETION}"
629 git help -a|egrep '^ [a-zA-Z0-9]'
633 __git_list_all_commands ()
636 for i in $(__git_commands)
639 *--*) : helper pattern;;
646 __git_compute_all_commands ()
648 test -n "$__git_all_commands" ||
649 __git_all_commands=$(__git_list_all_commands)
652 __git_list_porcelain_commands ()
655 __git_compute_all_commands
656 for i in $__git_all_commands
659 *--*) : helper pattern;;
660 applymbox) : ask gittus;;
661 applypatch) : ask gittus;;
662 archimport) : import;;
663 cat-file) : plumbing;;
664 check-attr) : plumbing;;
665 check-ignore) : plumbing;;
666 check-mailmap) : plumbing;;
667 check-ref-format) : plumbing;;
668 checkout-index) : plumbing;;
669 commit-tree) : plumbing;;
670 count-objects) : infrequent;;
671 credential-cache) : credentials helper;;
672 credential-store) : credentials helper;;
673 cvsexportcommit) : export;;
674 cvsimport) : import;;
675 cvsserver) : daemon;;
677 diff-files) : plumbing;;
678 diff-index) : plumbing;;
679 diff-tree) : plumbing;;
680 fast-import) : import;;
681 fast-export) : export;;
682 fsck-objects) : plumbing;;
683 fetch-pack) : plumbing;;
684 fmt-merge-msg) : plumbing;;
685 for-each-ref) : plumbing;;
686 hash-object) : plumbing;;
687 http-*) : transport;;
688 index-pack) : plumbing;;
689 init-db) : deprecated;;
690 local-fetch) : plumbing;;
691 ls-files) : plumbing;;
692 ls-remote) : plumbing;;
693 ls-tree) : plumbing;;
694 mailinfo) : plumbing;;
695 mailsplit) : plumbing;;
696 merge-*) : plumbing;;
699 pack-objects) : plumbing;;
700 pack-redundant) : plumbing;;
701 pack-refs) : plumbing;;
702 parse-remote) : plumbing;;
703 patch-id) : plumbing;;
705 prune-packed) : plumbing;;
706 quiltimport) : import;;
707 read-tree) : plumbing;;
708 receive-pack) : plumbing;;
709 remote-*) : transport;;
711 rev-list) : plumbing;;
712 rev-parse) : plumbing;;
713 runstatus) : plumbing;;
714 sh-setup) : internal;;
716 show-ref) : plumbing;;
717 send-pack) : plumbing;;
718 show-index) : plumbing;;
720 stripspace) : plumbing;;
721 symbolic-ref) : plumbing;;
722 unpack-file) : plumbing;;
723 unpack-objects) : plumbing;;
724 update-index) : plumbing;;
725 update-ref) : plumbing;;
726 update-server-info) : daemon;;
727 upload-archive) : plumbing;;
728 upload-pack) : plumbing;;
729 write-tree) : plumbing;;
731 verify-pack) : infrequent;;
732 verify-tag) : plumbing;;
738 __git_porcelain_commands=
739 __git_compute_porcelain_commands ()
741 __git_compute_all_commands
742 test -n "$__git_porcelain_commands" ||
743 __git_porcelain_commands=$(__git_list_porcelain_commands)
746 __git_pretty_aliases ()
749 for i in $(git --git-dir="$(__gitdir)" config --get-regexp "pretty\..*" 2>/dev/null); do
762 for i in $(git --git-dir="$(__gitdir)" config --get-regexp "alias\..*" 2>/dev/null); do
772 # __git_aliased_command requires 1 argument
773 __git_aliased_command ()
775 local word cmdline=$(git --git-dir="$(__gitdir)" \
776 config --get "alias.$1")
777 for word in $cmdline; do
783 \!*) : shell command alias ;;
785 *=*) : setting env ;;
787 \(\)) : skip parens of shell function definition ;;
788 {) : skip start of shell helper function ;;
789 :) : skip null command ;;
790 \'*) : skip opening quote after sh -c ;;
798 # __git_find_on_cmdline requires 1 argument
799 __git_find_on_cmdline ()
801 local word subcommand c=1
802 while [ $c -lt $cword ]; do
804 for subcommand in $1; do
805 if [ "$subcommand" = "$word" ]; then
814 __git_has_doubledash ()
817 while [ $c -lt $cword ]; do
818 if [ "--" = "${words[c]}" ]; then
826 # Try to count non option arguments passed on the command line for the
827 # specified git command.
828 # When options are used, it is necessary to use the special -- option to
829 # tell the implementation were non option arguments begin.
830 # XXX this can not be improved, since options can appear everywhere, as
834 # __git_count_arguments requires 1 argument: the git command executed.
835 __git_count_arguments ()
839 # Skip "git" (first argument)
840 for ((i=1; i < ${#words[@]}; i++)); do
845 # Good; we can assume that the following are only non
850 # Skip the specified git command and discard git
863 __git_whitespacelist="nowarn warn error error-all fix"
867 local dir="$(__gitdir)"
868 if [ -d "$dir"/rebase-apply ]; then
869 __gitcomp "--skip --continue --resolved --abort"
874 __gitcomp "$__git_whitespacelist" "" "${cur##--whitespace=}"
879 --3way --committer-date-is-author-date --ignore-date
880 --ignore-whitespace --ignore-space-change
881 --interactive --keep --no-utf8 --signoff --utf8
882 --whitespace= --scissors
892 __gitcomp "$__git_whitespacelist" "" "${cur##--whitespace=}"
897 --stat --numstat --summary --check --index
898 --cached --index-info --reverse --reject --unidiff-zero
899 --apply --no-add --exclude=
900 --ignore-whitespace --ignore-space-change
901 --whitespace= --inaccurate-eof --verbose
912 --interactive --refresh --patch --update --dry-run
913 --ignore-errors --intent-to-add
918 # XXX should we check for --update and --all options ?
919 __git_complete_index_file "--others --modified --directory --no-empty-directory"
926 __gitcomp "$(git archive --list)" "" "${cur##--format=}"
930 __gitcomp_nl "$(__git_remotes)" "" "${cur##--remote=}"
935 --format= --list --verbose
936 --prefix= --remote= --exec=
946 __git_has_doubledash && return
948 local subcommands="start bad good skip reset visualize replay log run"
949 local subcommand="$(__git_find_on_cmdline "$subcommands")"
950 if [ -z "$subcommand" ]; then
951 if [ -f "$(__gitdir)"/BISECT_START ]; then
952 __gitcomp "$subcommands"
954 __gitcomp "replay start"
959 case "$subcommand" in
960 bad|good|reset|skip|start)
961 __gitcomp_nl "$(__git_refs)"
970 local i c=1 only_local_ref="n" has_r="n"
972 while [ $c -lt $cword ]; do
975 -d|-m) only_local_ref="y" ;;
983 __gitcomp "$(__git_refs)" "" "${cur##--set-upstream-to=}"
987 --color --no-color --verbose --abbrev= --no-abbrev
988 --track --no-track --contains --merged --no-merged
989 --set-upstream-to= --edit-description --list
994 if [ $only_local_ref = "y" -a $has_r = "n" ]; then
995 __gitcomp_nl "$(__git_heads)"
997 __gitcomp_nl "$(__git_refs)"
1005 local cmd="${words[2]}"
1008 __gitcomp "create list-heads verify unbundle"
1011 # looking for a file
1016 __git_complete_revlist
1025 __git_has_doubledash && return
1029 __gitcomp "diff3 merge" "" "${cur##--conflict=}"
1033 --quiet --ours --theirs --track --no-track --merge
1034 --conflict= --orphan --patch
1038 # check if --track, --no-track, or --no-guess was specified
1039 # if so, disable DWIM mode
1040 local flags="--track --no-track --no-guess" track=1
1041 if [ -n "$(__git_find_on_cmdline "$flags")" ]; then
1044 __gitcomp_nl "$(__git_refs '' $track)"
1051 __gitcomp "$(__git_refs)"
1056 local dir="$(__gitdir)"
1057 if [ -f "$dir"/CHERRY_PICK_HEAD ]; then
1058 __gitcomp "--continue --quit --abort"
1063 __gitcomp "--edit --no-commit --signoff --strategy= --mainline"
1066 __gitcomp_nl "$(__git_refs)"
1075 __gitcomp "--dry-run --quiet"
1080 # XXX should we check for -x option ?
1081 __git_complete_index_file "--others --directory"
1113 __gitcomp_nl "$(__git_refs)" "" "${cur}"
1120 __gitcomp "default strip verbatim whitespace
1121 " "" "${cur##--cleanup=}"
1124 --reuse-message=*|--reedit-message=*|\
1125 --fixup=*|--squash=*)
1126 __gitcomp_nl "$(__git_refs)" "" "${cur#*=}"
1129 --untracked-files=*)
1130 __gitcomp "all no normal" "" "${cur##--untracked-files=}"
1135 --all --author= --signoff --verify --no-verify
1137 --amend --include --only --interactive
1138 --dry-run --reuse-message= --reedit-message=
1139 --reset-author --file= --message= --template=
1140 --cleanup= --untracked-files --untracked-files=
1141 --verbose --quiet --fixup= --squash=
1146 if git rev-parse --verify --quiet HEAD >/dev/null; then
1147 __git_complete_index_file "--committable"
1149 # This is the first commit
1150 __git_complete_index_file "--cached"
1159 --all --tags --contains --abbrev= --candidates=
1160 --exact-match --debug --long --match --always
1164 __gitcomp_nl "$(__git_refs)"
1167 __git_diff_algorithms="myers minimal patience histogram"
1169 __git_diff_common_options="--stat --numstat --shortstat --summary
1170 --patch-with-stat --name-only --name-status --color
1171 --no-color --color-words --no-renames --check
1172 --full-index --binary --abbrev --diff-filter=
1173 --find-copies-harder
1174 --text --ignore-space-at-eol --ignore-space-change
1175 --ignore-all-space --ignore-blank-lines --exit-code
1176 --quiet --ext-diff --no-ext-diff
1177 --no-prefix --src-prefix= --dst-prefix=
1178 --inter-hunk-context=
1179 --patience --histogram --minimal
1181 --dirstat --dirstat= --dirstat-by-file
1182 --dirstat-by-file= --cumulative
1188 __git_has_doubledash && return
1192 __gitcomp "$__git_diff_algorithms" "" "${cur##--diff-algorithm=}"
1196 __gitcomp "--cached --staged --pickaxe-all --pickaxe-regex
1197 --base --ours --theirs --no-index
1198 $__git_diff_common_options
1203 __git_complete_revlist_file
1206 __git_mergetools_common="diffuse diffmerge ecmerge emerge kdiff3 meld opendiff
1207 tkdiff vimdiff gvimdiff xxdiff araxis p4merge bc codecompare
1212 __git_has_doubledash && return
1216 __gitcomp "$__git_mergetools_common kompare" "" "${cur##--tool=}"
1220 __gitcomp "--cached --staged --pickaxe-all --pickaxe-regex
1221 --base --ours --theirs
1222 --no-renames --diff-filter= --find-copies-harder
1223 --relative --ignore-submodules
1228 __git_complete_revlist_file
1231 __git_fetch_recurse_submodules="yes on-demand no"
1233 __git_fetch_options="
1234 --quiet --verbose --append --upload-pack --force --keep --depth=
1235 --tags --no-tags --all --prune --dry-run --recurse-submodules=
1241 --recurse-submodules=*)
1242 __gitcomp "$__git_fetch_recurse_submodules" "" "${cur##--recurse-submodules=}"
1246 __gitcomp "$__git_fetch_options"
1250 __git_complete_remote_or_refspec
1253 __git_format_patch_options="
1254 --stdout --attach --no-attach --thread --thread= --no-thread
1255 --numbered --start-number --numbered-files --keep-subject --signoff
1256 --signature --no-signature --in-reply-to= --cc= --full-index --binary
1257 --not --all --cover-letter --no-prefix --src-prefix= --dst-prefix=
1258 --inline --suffix= --ignore-if-in-upstream --subject-prefix=
1259 --output-directory --reroll-count --to= --quiet --notes
1262 _git_format_patch ()
1268 " "" "${cur##--thread=}"
1272 __gitcomp "$__git_format_patch_options"
1276 __git_complete_revlist
1284 --tags --root --unreachable --cache --no-reflogs --full
1285 --strict --verbose --lost-found
1296 __gitcomp "--prune --aggressive"
1307 __git_match_ctag() {
1308 awk "/^${1////\\/}/ { print \$1 }" "$2"
1313 __git_has_doubledash && return
1319 --text --ignore-case --word-regexp --invert-match
1320 --full-name --line-number
1321 --extended-regexp --basic-regexp --fixed-strings
1323 --files-with-matches --name-only
1324 --files-without-match
1327 --and --or --not --all-match
1333 case "$cword,$prev" in
1335 if test -r tags; then
1336 __gitcomp_nl "$(__git_match_ctag "$cur" tags)"
1342 __gitcomp_nl "$(__git_refs)"
1349 __gitcomp "--all --info --man --web"
1353 __git_compute_all_commands
1354 __gitcomp "$__git_all_commands $(__git_aliases)
1355 attributes cli core-tutorial cvs-migration
1356 diffcore gitk glossary hooks ignore modules
1357 namespaces repository-layout tutorial tutorial-2
1367 false true umask group all world everybody
1368 " "" "${cur##--shared=}"
1372 __gitcomp "--quiet --bare --template= --shared --shared="
1382 __gitcomp "--cached --deleted --modified --others --ignored
1383 --stage --directory --no-empty-directory --unmerged
1384 --killed --exclude= --exclude-from=
1385 --exclude-per-directory= --exclude-standard
1386 --error-unmatch --with-tree= --full-name
1387 --abbrev --ignored --exclude-per-directory
1393 # XXX ignore options like --modified and always suggest all cached
1395 __git_complete_index_file "--cached"
1400 __gitcomp_nl "$(__git_remotes)"
1408 # Options that go well for log, shortlog and gitk
1409 __git_log_common_options="
1411 --branches --tags --remotes
1412 --first-parent --merges --no-merges
1414 --max-age= --since= --after=
1415 --min-age= --until= --before=
1416 --min-parents= --max-parents=
1417 --no-min-parents --no-max-parents
1419 # Options that go well for log and gitk (not shortlog)
1420 __git_log_gitk_options="
1421 --dense --sparse --full-history
1422 --simplify-merges --simplify-by-decoration
1423 --left-right --notes --no-notes
1425 # Options that go well for log and shortlog (not gitk)
1426 __git_log_shortlog_options="
1427 --author= --committer= --grep=
1431 __git_log_pretty_formats="oneline short medium full fuller email raw format:"
1432 __git_log_date_formats="relative iso8601 rfc2822 short local default raw"
1436 __git_has_doubledash && return
1438 local g="$(git rev-parse --git-dir 2>/dev/null)"
1440 if [ -f "$g/MERGE_HEAD" ]; then
1444 --pretty=*|--format=*)
1445 __gitcomp "$__git_log_pretty_formats $(__git_pretty_aliases)
1450 __gitcomp "$__git_log_date_formats" "" "${cur##--date=}"
1454 __gitcomp "long short" "" "${cur##--decorate=}"
1459 $__git_log_common_options
1460 $__git_log_shortlog_options
1461 $__git_log_gitk_options
1462 --root --topo-order --date-order --reverse
1463 --follow --full-diff
1464 --abbrev-commit --abbrev=
1465 --relative-date --date=
1466 --pretty= --format= --oneline
1470 --decorate --decorate=
1472 --parents --children
1474 $__git_diff_common_options
1475 --pickaxe-all --pickaxe-regex
1480 __git_complete_revlist
1483 # Common merge options shared by git-merge(1) and git-pull(1).
1484 __git_merge_options="
1485 --no-commit --no-stat --log --no-log --squash --strategy
1486 --commit --stat --no-squash --ff --no-ff --ff-only --edit --no-edit
1487 --verify-signatures --no-verify-signatures --gpg-sign
1488 --quiet --verbose --progress --no-progress
1493 __git_complete_strategy && return
1497 __gitcomp "$__git_merge_options
1498 --rerere-autoupdate --no-rerere-autoupdate --abort"
1501 __gitcomp_nl "$(__git_refs)"
1508 __gitcomp "$__git_mergetools_common tortoisemerge" "" "${cur##--tool=}"
1522 __gitcomp "--octopus --independent --is-ancestor --fork-point"
1526 __gitcomp_nl "$(__git_refs)"
1533 __gitcomp "--dry-run"
1538 if [ $(__git_count_arguments "mv") -gt 0 ]; then
1539 # We need to show both cached and untracked files (including
1540 # empty directories) since this may not be the last argument.
1541 __git_complete_index_file "--cached --others --directory"
1543 __git_complete_index_file "--cached"
1549 __gitcomp "--tags --all --stdin"
1554 local subcommands='add append copy edit list prune remove show'
1555 local subcommand="$(__git_find_on_cmdline "$subcommands")"
1557 case "$subcommand,$cur" in
1564 __gitcomp_nl "$(__git_refs)"
1567 __gitcomp "$subcommands --ref"
1571 add,--reuse-message=*|append,--reuse-message=*|\
1572 add,--reedit-message=*|append,--reedit-message=*)
1573 __gitcomp_nl "$(__git_refs)" "" "${cur#*=}"
1576 __gitcomp '--file= --message= --reedit-message=
1583 __gitcomp '--dry-run --verbose'
1592 __gitcomp_nl "$(__git_refs)"
1601 __git_complete_strategy && return
1604 --recurse-submodules=*)
1605 __gitcomp "$__git_fetch_recurse_submodules" "" "${cur##--recurse-submodules=}"
1610 --rebase --no-rebase
1611 $__git_merge_options
1612 $__git_fetch_options
1617 __git_complete_remote_or_refspec
1620 __git_push_recurse_submodules="check on-demand"
1622 __git_complete_force_with_lease ()
1630 __gitcomp_nl "$(__git_refs)" "" "${cur_#*:}"
1633 __gitcomp_nl "$(__git_refs)" "" "$cur_"
1642 __gitcomp_nl "$(__git_remotes)"
1645 --recurse-submodules)
1646 __gitcomp "$__git_push_recurse_submodules"
1652 __gitcomp_nl "$(__git_remotes)" "" "${cur##--repo=}"
1655 --recurse-submodules=*)
1656 __gitcomp "$__git_push_recurse_submodules" "" "${cur##--recurse-submodules=}"
1659 --force-with-lease=*)
1660 __git_complete_force_with_lease "${cur##--force-with-lease=}"
1665 --all --mirror --tags --dry-run --force --verbose
1666 --quiet --prune --delete --follow-tags
1667 --receive-pack= --repo= --set-upstream
1668 --force-with-lease --force-with-lease= --recurse-submodules=
1673 __git_complete_remote_or_refspec
1678 local dir="$(__gitdir)"
1679 if [ -d "$dir"/rebase-apply ] || [ -d "$dir"/rebase-merge ]; then
1680 __gitcomp "--continue --skip --abort"
1683 __git_complete_strategy && return
1686 __gitcomp "$__git_whitespacelist" "" "${cur##--whitespace=}"
1691 --onto --merge --strategy --interactive
1692 --preserve-merges --stat --no-stat
1693 --committer-date-is-author-date --ignore-date
1694 --ignore-whitespace --whitespace=
1695 --autosquash --fork-point --no-fork-point
1700 __gitcomp_nl "$(__git_refs)"
1705 local subcommands="show delete expire"
1706 local subcommand="$(__git_find_on_cmdline "$subcommands")"
1708 if [ -z "$subcommand" ]; then
1709 __gitcomp "$subcommands"
1711 __gitcomp_nl "$(__git_refs)"
1715 __git_send_email_confirm_options="always never auto cc compose"
1716 __git_send_email_suppresscc_options="author self cc bodycc sob cccmd body all"
1723 $__git_send_email_confirm_options
1724 " "" "${cur##--confirm=}"
1729 $__git_send_email_suppresscc_options
1730 " "" "${cur##--suppress-cc=}"
1734 --smtp-encryption=*)
1735 __gitcomp "ssl tls" "" "${cur##--smtp-encryption=}"
1741 " "" "${cur##--thread=}"
1745 __gitcomp "--annotate --bcc --cc --cc-cmd --chain-reply-to
1746 --compose --confirm= --dry-run --envelope-sender
1748 --in-reply-to --no-chain-reply-to --no-signed-off-by-cc
1749 --no-suppress-from --no-thread --quiet
1750 --signed-off-by-cc --smtp-pass --smtp-server
1751 --smtp-server-port --smtp-encryption= --smtp-user
1752 --subject --suppress-cc= --suppress-from --thread --to
1753 --validate --no-validate
1754 $__git_format_patch_options"
1758 __git_complete_revlist
1766 __git_config_get_set_variables ()
1768 local prevword word config_file= c=$cword
1769 while [ $c -gt 1 ]; do
1772 --system|--global|--local|--file=*)
1777 config_file="$word $prevword"
1785 git --git-dir="$(__gitdir)" config $config_file --list 2>/dev/null |
1799 branch.*.remote|branch.*.pushremote)
1800 __gitcomp_nl "$(__git_remotes)"
1804 __gitcomp_nl "$(__git_refs)"
1808 __gitcomp "false true"
1812 __gitcomp_nl "$(__git_remotes)"
1816 local remote="${prev#remote.}"
1817 remote="${remote%.fetch}"
1818 if [ -z "$cur" ]; then
1819 __gitcomp_nl "refs/heads/" "" "" ""
1822 __gitcomp_nl "$(__git_refs_remotes "$remote")"
1826 local remote="${prev#remote.}"
1827 remote="${remote%.push}"
1828 __gitcomp_nl "$(git --git-dir="$(__gitdir)" \
1829 for-each-ref --format='%(refname):%(refname)' \
1833 pull.twohead|pull.octopus)
1834 __git_compute_merge_strategies
1835 __gitcomp "$__git_merge_strategies"
1838 color.branch|color.diff|color.interactive|\
1839 color.showbranch|color.status|color.ui)
1840 __gitcomp "always never auto"
1844 __gitcomp "false true"
1849 normal black red green yellow blue magenta cyan white
1850 bold dim ul blink reverse
1855 __gitcomp "log short"
1859 __gitcomp "man info web html"
1863 __gitcomp "$__git_log_date_formats"
1866 sendemail.aliasesfiletype)
1867 __gitcomp "mutt mailrc pine elm gnus"
1871 __gitcomp "$__git_send_email_confirm_options"
1874 sendemail.suppresscc)
1875 __gitcomp "$__git_send_email_suppresscc_options"
1878 sendemail.transferencoding)
1879 __gitcomp "7bit 8bit quoted-printable base64"
1882 --get|--get-all|--unset|--unset-all)
1883 __gitcomp_nl "$(__git_config_get_set_variables)"
1893 --system --global --local --file=
1894 --list --replace-all
1895 --get --get-all --get-regexp
1896 --add --unset --unset-all
1897 --remove-section --rename-section
1902 local pfx="${cur%.*}." cur_="${cur##*.}"
1903 __gitcomp "remote pushremote merge mergeoptions rebase" "$pfx" "$cur_"
1907 local pfx="${cur%.*}." cur_="${cur#*.}"
1908 __gitcomp_nl "$(__git_heads)" "$pfx" "$cur_" "."
1909 __gitcomp_nl_append $'autosetupmerge\nautosetuprebase\n' "$pfx" "$cur_"
1913 local pfx="${cur%.*}." cur_="${cur##*.}"
1915 argprompt cmd confirm needsfile noconsole norescan
1916 prompt revprompt revunmerged title
1921 local pfx="${cur%.*}." cur_="${cur##*.}"
1922 __gitcomp "cmd path" "$pfx" "$cur_"
1926 local pfx="${cur%.*}." cur_="${cur##*.}"
1927 __gitcomp "cmd path" "$pfx" "$cur_"
1931 local pfx="${cur%.*}." cur_="${cur##*.}"
1932 __gitcomp "cmd path trustExitCode" "$pfx" "$cur_"
1936 local pfx="${cur%.*}." cur_="${cur#*.}"
1937 __git_compute_all_commands
1938 __gitcomp_nl "$__git_all_commands" "$pfx" "$cur_"
1942 local pfx="${cur%.*}." cur_="${cur##*.}"
1944 url proxy fetch push mirror skipDefaultUpdate
1945 receivepack uploadpack tagopt pushurl
1950 local pfx="${cur%.*}." cur_="${cur#*.}"
1951 __gitcomp_nl "$(__git_remotes)" "$pfx" "$cur_" "."
1952 __gitcomp_nl_append "pushdefault" "$pfx" "$cur_"
1956 local pfx="${cur%.*}." cur_="${cur##*.}"
1957 __gitcomp "insteadOf pushInsteadOf" "$pfx" "$cur_"
1963 advice.commitBeforeMerge
1965 advice.implicitIdentity
1966 advice.pushNonFastForward
1967 advice.resolveConflict
1971 apply.ignorewhitespace
1973 branch.autosetupmerge
1974 branch.autosetuprebase
1978 color.branch.current
1983 color.decorate.branch
1984 color.decorate.remoteBranch
1985 color.decorate.stash
1995 color.diff.whitespace
2000 color.grep.linenumber
2003 color.grep.separator
2005 color.interactive.error
2006 color.interactive.header
2007 color.interactive.help
2008 color.interactive.prompt
2013 color.status.changed
2015 color.status.nobranch
2016 color.status.untracked
2017 color.status.updated
2026 core.bigFileThreshold
2029 core.deltaBaseCacheLimit
2034 core.fsyncobjectfiles
2038 core.logAllRefUpdates
2039 core.loosecompression
2042 core.packedGitWindowSize
2044 core.preferSymlinkRefs
2047 core.repositoryFormatVersion
2049 core.sharedRepository
2053 core.warnAmbiguousRefs
2056 diff.autorefreshindex
2058 diff.ignoreSubmodules
2065 diff.suppressBlankEmpty
2071 fetch.recurseSubmodules
2081 format.subjectprefix
2092 gc.reflogexpireunreachable
2096 gitcvs.commitmsgannotation
2097 gitcvs.dbTableNamePrefix
2108 gui.copyblamethreshold
2112 gui.matchtrackingbranch
2113 gui.newbranchtemplate
2114 gui.pruneduringfetch
2115 gui.spellingdictionary
2130 http.sslCertPasswordProtected
2135 i18n.logOutputEncoding
2141 imap.preformattedHTML
2151 interactive.singlekey
2167 mergetool.keepBackup
2168 mergetool.keepTemporaries
2173 notes.rewrite.rebase
2177 pack.deltaCacheLimit
2193 receive.denyCurrentBranch
2194 receive.denyDeleteCurrent
2196 receive.denyNonFastForwards
2199 receive.updateserverinfo
2202 repack.usedeltabaseoffset
2206 sendemail.aliasesfile
2207 sendemail.aliasfiletype
2211 sendemail.chainreplyto
2213 sendemail.envelopesender
2217 sendemail.signedoffbycc
2218 sendemail.smtpdomain
2219 sendemail.smtpencryption
2221 sendemail.smtpserver
2222 sendemail.smtpserveroption
2223 sendemail.smtpserverport
2225 sendemail.suppresscc
2226 sendemail.suppressfrom
2231 status.relativePaths
2232 status.showUntrackedFiles
2233 status.submodulesummary
2236 transfer.unpackLimit
2248 local subcommands="add rename remove set-head set-branches set-url show prune update"
2249 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2250 if [ -z "$subcommand" ]; then
2251 __gitcomp "$subcommands"
2255 case "$subcommand" in
2256 rename|remove|set-url|show|prune)
2257 __gitcomp_nl "$(__git_remotes)"
2259 set-head|set-branches)
2260 __git_complete_remote_or_refspec
2263 local i c='' IFS=$'\n'
2264 for i in $(git --git-dir="$(__gitdir)" config --get-regexp "remotes\..*" 2>/dev/null); do
2277 __gitcomp_nl "$(__git_refs)"
2282 __git_has_doubledash && return
2286 __gitcomp "--merge --mixed --hard --soft --patch"
2290 __gitcomp_nl "$(__git_refs)"
2297 __gitcomp "--edit --mainline --no-edit --no-commit --signoff"
2301 __gitcomp_nl "$(__git_refs)"
2308 __gitcomp "--cached --dry-run --ignore-unmatch --quiet"
2313 __git_complete_index_file "--cached"
2318 __git_has_doubledash && return
2323 $__git_log_common_options
2324 $__git_log_shortlog_options
2325 --numbered --summary
2330 __git_complete_revlist
2335 __git_has_doubledash && return
2338 --pretty=*|--format=*)
2339 __gitcomp "$__git_log_pretty_formats $(__git_pretty_aliases)
2344 __gitcomp "$__git_diff_algorithms" "" "${cur##--diff-algorithm=}"
2348 __gitcomp "--pretty= --format= --abbrev-commit --oneline
2350 $__git_diff_common_options
2355 __git_complete_revlist_file
2363 --all --remotes --topo-order --current --more=
2364 --list --independent --merge-base --no-name
2366 --sha1-name --sparse --topics --reflog
2371 __git_complete_revlist
2376 local save_opts='--keep-index --no-keep-index --quiet --patch'
2377 local subcommands='save list show apply clear drop pop create branch'
2378 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2379 if [ -z "$subcommand" ]; then
2382 __gitcomp "$save_opts"
2385 if [ -z "$(__git_find_on_cmdline "$save_opts")" ]; then
2386 __gitcomp "$subcommands"
2391 case "$subcommand,$cur" in
2393 __gitcomp "$save_opts"
2396 __gitcomp "--index --quiet"
2398 show,--*|drop,--*|branch,--*)
2400 show,*|apply,*|drop,*|pop,*|branch,*)
2401 __gitcomp_nl "$(git --git-dir="$(__gitdir)" stash list \
2402 | sed -n -e 's/:.*//p')"
2412 __git_has_doubledash && return
2414 local subcommands="add status init deinit update summary foreach sync"
2415 if [ -z "$(__git_find_on_cmdline "$subcommands")" ]; then
2418 __gitcomp "--quiet --cached"
2421 __gitcomp "$subcommands"
2431 init fetch clone rebase dcommit log find-rev
2432 set-tree commit-diff info create-ignore propget
2433 proplist show-ignore show-externals branch tag blame
2434 migrate mkdirs reset gc
2436 local subcommand="$(__git_find_on_cmdline "$subcommands")"
2437 if [ -z "$subcommand" ]; then
2438 __gitcomp "$subcommands"
2440 local remote_opts="--username= --config-dir= --no-auth-cache"
2442 --follow-parent --authors-file= --repack=
2443 --no-metadata --use-svm-props --use-svnsync-props
2444 --log-window-size= --no-checkout --quiet
2445 --repack-flags --use-log-author --localtime
2446 --ignore-paths= --include-paths= $remote_opts
2449 --template= --shared= --trunk= --tags=
2450 --branches= --stdlayout --minimize-url
2451 --no-metadata --use-svm-props --use-svnsync-props
2452 --rewrite-root= --prefix= --use-log-author
2453 --add-author-from $remote_opts
2456 --edit --rmdir --find-copies-harder --copy-similarity=
2459 case "$subcommand,$cur" in
2461 __gitcomp "--revision= --fetch-all $fc_opts"
2464 __gitcomp "--revision= $fc_opts $init_opts"
2467 __gitcomp "$init_opts"
2471 --merge --strategy= --verbose --dry-run
2472 --fetch-all --no-rebase --commit-url
2473 --revision --interactive $cmt_opts $fc_opts
2477 __gitcomp "--stdin $cmt_opts $fc_opts"
2479 create-ignore,--*|propget,--*|proplist,--*|show-ignore,--*|\
2480 show-externals,--*|mkdirs,--*)
2481 __gitcomp "--revision="
2485 --limit= --revision= --verbose --incremental
2486 --oneline --show-commit --non-recursive
2487 --authors-file= --color
2492 --merge --verbose --strategy= --local
2493 --fetch-all --dry-run $fc_opts
2497 __gitcomp "--message= --file= --revision= $cmt_opts"
2503 __gitcomp "--dry-run --message --tag"
2506 __gitcomp "--dry-run --message"
2509 __gitcomp "--git-format"
2513 --config-dir= --ignore-paths= --minimize
2514 --no-auth-cache --username=
2518 __gitcomp "--revision= --parent"
2529 while [ $c -lt $cword ]; do
2533 __gitcomp_nl "$(__git_tags)"
2548 __gitcomp_nl "$(__git_tags)"
2552 __gitcomp_nl "$(__git_refs)"
2559 --list --delete --verify --annotate --message --file
2560 --sign --cleanup --local-user --force --column --sort
2561 --contains --points-at
2574 local i c=1 command __git_dir
2576 while [ $c -lt $cword ]; do
2579 --git-dir=*) __git_dir="${i#--git-dir=}" ;;
2580 --git-dir) ((c++)) ; __git_dir="${words[c]}" ;;
2581 --bare) __git_dir="." ;;
2582 --help) command="help"; break ;;
2583 -c|--work-tree|--namespace) ((c++)) ;;
2585 *) command="$i"; break ;;
2590 if [ -z "$command" ]; then
2605 --no-replace-objects
2609 *) __git_compute_porcelain_commands
2610 __gitcomp "$__git_porcelain_commands $(__git_aliases)" ;;
2615 local completion_func="_git_${command//-/_}"
2616 declare -f $completion_func >/dev/null && $completion_func && return
2618 local expansion=$(__git_aliased_command "$command")
2619 if [ -n "$expansion" ]; then
2621 completion_func="_git_${expansion//-/_}"
2622 declare -f $completion_func >/dev/null && $completion_func
2628 __git_has_doubledash && return
2630 local g="$(__gitdir)"
2632 if [ -f "$g/MERGE_HEAD" ]; then
2638 $__git_log_common_options
2639 $__git_log_gitk_options
2645 __git_complete_revlist
2648 if [[ -n ${ZSH_VERSION-} ]]; then
2649 echo "WARNING: this script is deprecated, please see git-completion.zsh" 1>&2
2651 autoload -U +X compinit && compinit
2657 local cur_="${3-$cur}"
2663 local c IFS=$' \t\n'
2671 array[${#array[@]}+1]="$c"
2674 compadd -Q -S '' -p "${2-}" -a -- array && _ret=0
2685 compadd -Q -S "${4- }" -p "${2-}" -- ${=1} && _ret=0
2694 compadd -Q -p "${2-}" -f -- ${=1} && _ret=0
2699 local _ret=1 cur cword prev
2700 cur=${words[CURRENT]}
2701 prev=${words[CURRENT-1]}
2703 emulate ksh -c __${service}_main
2704 let _ret && _default && _ret=0
2708 compdef _git git gitk
2714 local cur words cword prev
2715 _get_comp_words_by_ref -n =: cur words cword prev
2719 # Setup completion for certain functions defined above by setting common
2720 # variables and workarounds.
2721 # This is NOT a public function; use at your own risk.
2724 local wrapper="__git_wrap${2}"
2725 eval "$wrapper () { __git_func_wrap $2 ; }"
2726 complete -o bashdefault -o default -o nospace -F $wrapper $1 2>/dev/null \
2727 || complete -o default -o nospace -F $wrapper $1
2730 # wrapper for backwards compatibility
2733 __git_wrap__git_main
2736 # wrapper for backwards compatibility
2739 __git_wrap__gitk_main
2742 __git_complete git __git_main
2743 __git_complete gitk __gitk_main
2745 # The following are necessary only for Cygwin, and only are needed
2746 # when the user has tab-completed the executable name and consequently
2747 # included the '.exe' suffix.
2749 if [ Cygwin = "$(uname -o 2>/dev/null)" ]; then
2750 __git_complete git.exe __git_main