3 # bash/zsh completion support for core Git.
5 # Copyright (C) 2006,2007 Shawn O. Pearce <spearce@spearce.org>
6 # Conceptually based on gitcompletion (http://gitweb.hawaga.org.uk/).
7 # Distributed under the GNU General Public License, version 2.0.
9 # The contained completion routines provide support for completing:
11 # *) local and remote branch names
12 # *) local and remote tag names
13 # *) .git/remotes file names
14 # *) git 'subcommands'
15 # *) tree paths within 'ref:path/to/file' expressions
16 # *) file paths within current working directory and index
17 # *) common --long-options
19 # To use these routines:
21 # 1) Copy this file to somewhere (e.g. ~/.git-completion.sh).
22 # 2) Add the following line to your .bashrc/.zshrc:
23 # source ~/.git-completion.sh
24 # 3) Consider changing your PS1 to also show the current branch,
25 # see git-prompt.sh for details.
27 case "$COMP_WORDBREAKS" in
29 *) COMP_WORDBREAKS
="$COMP_WORDBREAKS:"
32 # __gitdir accepts 0 or 1 arguments (i.e., location)
33 # returns location of .git repo
36 # Note: this function is duplicated in git-prompt.sh
37 # When updating it, make sure you update the other one to match.
38 if [ -z "${1-}" ]; then
39 if [ -n "${__git_dir-}" ]; then
41 elif [ -n "${GIT_DIR-}" ]; then
42 test -d "${GIT_DIR-}" ||
return 1
44 elif [ -d .git
]; then
47 git rev-parse
--git-dir 2>/dev
/null
49 elif [ -d "$1/.git" ]; then
69 # The following function is based on code from:
71 # bash_completion - programmable completion functions for bash 3.2+
73 # Copyright © 2006-2008, Ian Macdonald <ian@caliban.org>
74 # © 2009-2010, Bash Completion Maintainers
75 # <bash-completion-devel@lists.alioth.debian.org>
77 # This program is free software; you can redistribute it and/or modify
78 # it under the terms of the GNU General Public License as published by
79 # the Free Software Foundation; either version 2, or (at your option)
82 # This program is distributed in the hope that it will be useful,
83 # but WITHOUT ANY WARRANTY; without even the implied warranty of
84 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
85 # GNU General Public License for more details.
87 # You should have received a copy of the GNU General Public License
88 # along with this program; if not, write to the Free Software Foundation,
89 # Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
91 # The latest version of this software can be obtained here:
93 # http://bash-completion.alioth.debian.org/
97 # This function can be used to access a tokenized list of words
98 # on the command line:
100 # __git_reassemble_comp_words_by_ref '=:'
101 # if test "${words_[cword_-1]}" = -w
106 # The argument should be a collection of characters from the list of
107 # word completion separators (COMP_WORDBREAKS) to treat as ordinary
110 # This is roughly equivalent to going back in time and setting
111 # COMP_WORDBREAKS to exclude those characters. The intent is to
112 # make option types like --date=<type> and <rev>:<path> easy to
113 # recognize by treating each shell word as a single token.
115 # It is best not to set COMP_WORDBREAKS directly because the value is
116 # shared with other completion scripts. By the time the completion
117 # function gets called, COMP_WORDS has already been populated so local
118 # changes to COMP_WORDBREAKS have no effect.
120 # Output: words_, cword_, cur_.
122 __git_reassemble_comp_words_by_ref
()
124 local exclude i j first
125 # Which word separators to exclude?
126 exclude
="${1//[^$COMP_WORDBREAKS]}"
128 if [ -z "$exclude" ]; then
129 words_
=("${COMP_WORDS[@]}")
132 # List of word completion separators has shrunk;
133 # re-assemble words to complete.
134 for ((i
=0, j
=0; i
< ${#COMP_WORDS[@]}; i
++, j
++)); do
135 # Append each nonempty word consisting of just
136 # word separator characters to the current word.
140 [ -n "${COMP_WORDS[$i]}" ] &&
141 # word consists of excluded word separators
142 [ "${COMP_WORDS[$i]//[^$exclude]}" = "${COMP_WORDS[$i]}" ]
144 # Attach to the previous token,
145 # unless the previous token is the command name.
146 if [ $j -ge 2 ] && [ -n "$first" ]; then
150 words_
[$j]=${words_[j]}${COMP_WORDS[i]}
151 if [ $i = $COMP_CWORD ]; then
154 if (($i < ${#COMP_WORDS[@]} - 1)); then
161 words_
[$j]=${words_[j]}${COMP_WORDS[i]}
162 if [ $i = $COMP_CWORD ]; then
168 if ! type _get_comp_words_by_ref
>/dev
/null
2>&1; then
169 _get_comp_words_by_ref
()
171 local exclude cur_ words_ cword_
172 if [ "$1" = "-n" ]; then
176 __git_reassemble_comp_words_by_ref
"$exclude"
177 cur_
=${words_[cword_]}
178 while [ $# -gt 0 ]; do
184 prev
=${words_[$cword_-1]}
187 words
=("${words_[@]}")
198 # Generates completion reply with compgen, appending a space to possible
199 # completion words, if necessary.
200 # It accepts 1 to 4 arguments:
201 # 1: List of possible completion words.
202 # 2: A prefix to be added to each possible completion word (optional).
203 # 3: Generate possible completion matches for this word (optional).
204 # 4: A suffix to be appended to each possible completion word (optional).
207 local cur_
="${3-$cur}"
215 COMPREPLY
=($
(compgen
-P "${2-}" \
216 -W "$(__gitcomp_1 "${1-}" "${4-}")" \
222 # Generates completion reply with compgen from newline-separated possible
223 # completion words by appending a space to all of them.
224 # It accepts 1 to 4 arguments:
225 # 1: List of possible completion words, separated by a single newline.
226 # 2: A prefix to be added to each possible completion word (optional).
227 # 3: Generate possible completion matches for this word (optional).
228 # 4: A suffix to be appended to each possible completion word instead of
229 # the default space (optional). If specified but empty, nothing is
234 COMPREPLY
=($
(compgen
-P "${2-}" -S "${4- }" -W "$1" -- "${3-$cur}"))
237 # Generates completion reply with compgen from newline-separated possible
238 # completion filenames.
239 # It accepts 1 to 3 arguments:
240 # 1: List of possible completion filenames, separated by a single newline.
241 # 2: A directory prefix to be added to each possible completion filename
243 # 3: Generate possible completion matches for this word (optional).
248 # XXX does not work when the directory prefix contains a tilde,
249 # since tilde expansion is not applied.
250 # This means that COMPREPLY will be empty and Bash default
251 # completion will be used.
252 COMPREPLY
=($
(compgen
-P "${2-}" -W "$1" -- "${3-$cur}"))
254 # Tell Bash that compspec generates filenames.
255 compopt
-o filenames
2>/dev
/null
258 __git_index_file_list_filter_compat
()
262 while read -r path
; do
264 ?
*/*) echo "${path%%/*}/" ;;
270 __git_index_file_list_filter_bash
()
274 while read -r path
; do
277 # XXX if we append a slash to directory names when using
278 # `compopt -o filenames`, Bash will append another slash.
279 # This is pretty stupid, and this the reason why we have to
280 # define a compatible version for this function.
281 echo "${path%%/*}" ;;
288 # Process path list returned by "ls-files" and "diff-index --name-only"
289 # commands, in order to list only file names relative to a specified
290 # directory, and append a slash to directory names.
291 __git_index_file_list_filter
()
293 # Default to Bash >= 4.x
294 __git_index_file_list_filter_bash
297 # Execute git ls-files, returning paths relative to the directory
298 # specified in the first argument, and using the options specified in
299 # the second argument.
300 __git_ls_files_helper
()
303 test -n "${CDPATH+set}" && unset CDPATH
304 # NOTE: $2 is not quoted in order to support multiple options
305 cd "$1" && git ls-files
--exclude-standard $2
310 # Execute git diff-index, returning paths relative to the directory
311 # specified in the first argument, and using the tree object id
312 # specified in the second argument.
313 __git_diff_index_helper
()
316 test -n "${CDPATH+set}" && unset CDPATH
317 cd "$1" && git diff-index
--name-only --relative "$2"
321 # __git_index_files accepts 1 or 2 arguments:
322 # 1: Options to pass to ls-files (required).
323 # Supported options are --cached, --modified, --deleted, --others,
325 # 2: A directory path (optional).
326 # If provided, only files within the specified directory are listed.
327 # Sub directories are never recursed. Path must have a trailing
331 local dir
="$(__gitdir)" root
="${2-.}"
333 if [ -d "$dir" ]; then
334 __git_ls_files_helper
"$root" "$1" | __git_index_file_list_filter |
339 # __git_diff_index_files accepts 1 or 2 arguments:
340 # 1) The id of a tree object.
341 # 2) A directory path (optional).
342 # If provided, only files within the specified directory are listed.
343 # Sub directories are never recursed. Path must have a trailing
345 __git_diff_index_files
()
347 local dir
="$(__gitdir)" root
="${2-.}"
349 if [ -d "$dir" ]; then
350 __git_diff_index_helper
"$root" "$1" | __git_index_file_list_filter |
357 local dir
="$(__gitdir)"
358 if [ -d "$dir" ]; then
359 git
--git-dir="$dir" for-each-ref
--format='%(refname:short)' \
367 local dir
="$(__gitdir)"
368 if [ -d "$dir" ]; then
369 git
--git-dir="$dir" for-each-ref
--format='%(refname:short)' \
375 # __git_refs accepts 0, 1 (to pass to __gitdir), or 2 arguments
376 # presence of 2nd argument means use the guess heuristic employed
377 # by checkout for tracking branches
380 local i
hash dir
="$(__gitdir "${1-}")" track
="${2-}"
382 if [ -d "$dir" ]; then
390 for i
in HEAD FETCH_HEAD ORIG_HEAD MERGE_HEAD
; do
391 if [ -e "$dir/$i" ]; then echo $i; fi
393 format
="refname:short"
394 refs
="refs/tags refs/heads refs/remotes"
397 git
--git-dir="$dir" for-each-ref
--format="%($format)" \
399 if [ -n "$track" ]; then
400 # employ the heuristic used by git checkout
401 # Try to find a remote branch that matches the completion word
402 # but only output if the branch name is unique
404 git
--git-dir="$dir" for-each-ref
--shell --format="ref=%(refname:short)" \
406 while read -r entry
; do
409 if [[ "$ref" == "$cur"* ]]; then
412 done |
sort |
uniq -u
418 git ls-remote
"$dir" "$cur*" 2>/dev
/null | \
419 while read -r hash i
; do
427 git ls-remote
"$dir" HEAD ORIG_HEAD
'refs/tags/*' 'refs/heads/*' 'refs/remotes/*' 2>/dev
/null | \
428 while read -r hash i
; do
431 refs
/*) echo "${i#refs/*/}" ;;
439 # __git_refs2 requires 1 argument (to pass to __git_refs)
443 for i
in $
(__git_refs
"$1"); do
448 # __git_refs_remotes requires 1 argument (to pass to ls-remote)
449 __git_refs_remotes
()
452 git ls-remote
"$1" 'refs/heads/*' 2>/dev
/null | \
453 while read -r hash i
; do
454 echo "$i:refs/remotes/$1/${i#refs/heads/}"
460 local i IFS
=$
'\n' d
="$(__gitdir)"
461 test -d "$d/remotes" && ls -1 "$d/remotes"
462 for i
in $
(git
--git-dir="$d" config
--get-regexp 'remote\..*\.url' 2>/dev
/null
); do
468 __git_list_merge_strategies
()
470 git merge
-s help 2>&1 |
471 sed -n -e '/[Aa]vailable strategies are: /,/^$/{
480 __git_merge_strategies
=
481 # 'git merge -s help' (and thus detection of the merge strategy
482 # list) fails, unfortunately, if run outside of any git working
483 # tree. __git_merge_strategies is set to the empty string in
484 # that case, and the detection will be repeated the next time it
486 __git_compute_merge_strategies
()
488 test -n "$__git_merge_strategies" ||
489 __git_merge_strategies
=$
(__git_list_merge_strategies
)
492 __git_complete_revlist_file
()
494 local pfx
ls ref cur_
="$cur"
514 case "$COMP_WORDBREAKS" in
516 *) pfx
="$ref:$pfx" ;;
519 __gitcomp_nl
"$(git --git-dir="$
(__gitdir
)" ls-tree "$ls" \
520 | sed '/^100... blob /{
536 pfx
="${cur_%...*}..."
538 __gitcomp_nl
"$(__git_refs)" "$pfx" "$cur_"
543 __gitcomp_nl
"$(__git_refs)" "$pfx" "$cur_"
546 __gitcomp_nl
"$(__git_refs)"
552 # __git_complete_index_file requires 1 argument: the options to pass to
554 __git_complete_index_file
()
556 local pfx cur_
="$cur"
564 __gitcomp_file
"$(__git_index_files "$1" "$pfx")" "$pfx" "$cur_"
567 __gitcomp_file
"$(__git_index_files "$1")" "" "$cur_"
572 # __git_complete_diff_index_file requires 1 argument: the id of a tree
574 __git_complete_diff_index_file
()
576 local pfx cur_
="$cur"
584 __gitcomp_file
"$(__git_diff_index_files "$1" "$pfx")" "$pfx" "$cur_"
587 __gitcomp_file
"$(__git_diff_index_files "$1")" "" "$cur_"
592 __git_complete_file
()
594 __git_complete_revlist_file
597 __git_complete_revlist
()
599 __git_complete_revlist_file
602 __git_complete_remote_or_refspec
()
604 local cur_
="$cur" cmd
="${words[1]}"
605 local i c
=2 remote
="" pfx
="" lhs
=1 no_complete_refspec
=0
606 if [ "$cmd" = "remote" ]; then
609 while [ $c -lt $cword ]; do
612 --mirror) [ "$cmd" = "push" ] && no_complete_refspec
=1 ;;
615 push
) no_complete_refspec
=1 ;;
624 *) remote
="$i"; break ;;
628 if [ -z "$remote" ]; then
629 __gitcomp_nl
"$(__git_remotes)"
632 if [ $no_complete_refspec = 1 ]; then
636 [ "$remote" = "." ] && remote
=
639 case "$COMP_WORDBREAKS" in
641 *) pfx
="${cur_%%:*}:" ;;
653 if [ $lhs = 1 ]; then
654 __gitcomp_nl
"$(__git_refs2 "$remote")" "$pfx" "$cur_"
656 __gitcomp_nl
"$(__git_refs)" "$pfx" "$cur_"
660 if [ $lhs = 1 ]; then
661 __gitcomp_nl
"$(__git_refs "$remote")" "$pfx" "$cur_"
663 __gitcomp_nl
"$(__git_refs)" "$pfx" "$cur_"
667 if [ $lhs = 1 ]; then
668 __gitcomp_nl
"$(__git_refs)" "$pfx" "$cur_"
670 __gitcomp_nl
"$(__git_refs "$remote")" "$pfx" "$cur_"
676 __git_complete_strategy
()
678 __git_compute_merge_strategies
681 __gitcomp
"$__git_merge_strategies"
686 __gitcomp
"$__git_merge_strategies" "" "${cur##--strategy=}"
693 __git_list_all_commands
()
696 for i
in $
(git
help -a|
egrep '^ [a-zA-Z0-9]')
699 *--*) : helper pattern
;;
706 __git_compute_all_commands
()
708 test -n "$__git_all_commands" ||
709 __git_all_commands
=$
(__git_list_all_commands
)
712 __git_list_porcelain_commands
()
715 __git_compute_all_commands
716 for i
in $__git_all_commands
719 *--*) : helper pattern
;;
720 applymbox
) : ask gittus
;;
721 applypatch
) : ask gittus
;;
722 archimport
) : import
;;
723 cat-file
) : plumbing
;;
724 check-attr
) : plumbing
;;
725 check-ref-format
) : plumbing
;;
726 checkout-index
) : plumbing
;;
727 commit-tree
) : plumbing
;;
728 count-objects
) : infrequent
;;
729 credential-cache
) : credentials helper
;;
730 credential-store
) : credentials helper
;;
731 cvsexportcommit
) : export;;
732 cvsimport
) : import
;;
733 cvsserver
) : daemon
;;
735 diff-files
) : plumbing
;;
736 diff-index
) : plumbing
;;
737 diff-tree
) : plumbing
;;
738 fast-import
) : import
;;
739 fast-export
) : export;;
740 fsck-objects
) : plumbing
;;
741 fetch-pack
) : plumbing
;;
742 fmt-merge-msg
) : plumbing
;;
743 for-each-ref
) : plumbing
;;
744 hash-object
) : plumbing
;;
745 http-
*) : transport
;;
746 index-pack
) : plumbing
;;
747 init-db
) : deprecated
;;
748 local-fetch
) : plumbing
;;
749 lost-found
) : infrequent
;;
750 ls-files
) : plumbing
;;
751 ls-remote
) : plumbing
;;
752 ls-tree
) : plumbing
;;
753 mailinfo
) : plumbing
;;
754 mailsplit
) : plumbing
;;
755 merge-
*) : plumbing
;;
758 pack-objects
) : plumbing
;;
759 pack-redundant
) : plumbing
;;
760 pack-refs
) : plumbing
;;
761 parse-remote
) : plumbing
;;
762 patch-id
) : plumbing
;;
763 peek-remote
) : plumbing
;;
765 prune-packed
) : plumbing
;;
766 quiltimport
) : import
;;
767 read-tree
) : plumbing
;;
768 receive-pack
) : plumbing
;;
769 remote-
*) : transport
;;
770 repo-config
) : deprecated
;;
772 rev-list
) : plumbing
;;
773 rev-parse
) : plumbing
;;
774 runstatus
) : plumbing
;;
775 sh-setup
) : internal
;;
777 show-ref
) : plumbing
;;
778 send-pack
) : plumbing
;;
779 show-index
) : plumbing
;;
781 stripspace
) : plumbing
;;
782 symbolic-ref
) : plumbing
;;
783 tar-tree
) : deprecated
;;
784 unpack-file
) : plumbing
;;
785 unpack-objects
) : plumbing
;;
786 update-index
) : plumbing
;;
787 update-ref
) : plumbing
;;
788 update-server-info
) : daemon
;;
789 upload-archive
) : plumbing
;;
790 upload-pack
) : plumbing
;;
791 write-tree
) : plumbing
;;
793 verify-pack
) : infrequent
;;
794 verify-tag
) : plumbing
;;
800 __git_porcelain_commands
=
801 __git_compute_porcelain_commands
()
803 __git_compute_all_commands
804 test -n "$__git_porcelain_commands" ||
805 __git_porcelain_commands
=$
(__git_list_porcelain_commands
)
808 __git_pretty_aliases
()
811 for i
in $
(git
--git-dir="$(__gitdir)" config
--get-regexp "pretty\..*" 2>/dev
/null
); do
824 for i
in $
(git
--git-dir="$(__gitdir)" config
--get-regexp "alias\..*" 2>/dev
/null
); do
834 # __git_aliased_command requires 1 argument
835 __git_aliased_command
()
837 local word cmdline
=$
(git
--git-dir="$(__gitdir)" \
838 config
--get "alias.$1")
839 for word
in $cmdline; do
845 \
!*) : shell
command alias ;;
847 *=*) : setting env
;;
856 # __git_find_on_cmdline requires 1 argument
857 __git_find_on_cmdline
()
859 local word subcommand c
=1
860 while [ $c -lt $cword ]; do
862 for subcommand
in $1; do
863 if [ "$subcommand" = "$word" ]; then
872 __git_has_doubledash
()
875 while [ $c -lt $cword ]; do
876 if [ "--" = "${words[c]}" ]; then
884 # Try to count non option arguments passed on the command line for the
885 # specified git command.
886 # When options are used, it is necessary to use the special -- option to
887 # tell the implementation were non option arguments begin.
888 # XXX this can not be improved, since options can appear everywhere, as
892 # __git_count_arguments requires 1 argument: the git command executed.
893 __git_count_arguments
()
897 # Skip "git" (first argument)
898 for ((i
=1; i
< ${#words[@]}; i
++)); do
903 # Good; we can assume that the following are only non
908 # Skip the specified git command and discard git
921 __git_whitespacelist
="nowarn warn error error-all fix"
925 local dir
="$(__gitdir)"
926 if [ -d "$dir"/rebase-apply
]; then
927 __gitcomp
"--skip --continue --resolved --abort"
932 __gitcomp
"$__git_whitespacelist" "" "${cur##--whitespace=}"
937 --3way --committer-date-is-author-date --ignore-date
938 --ignore-whitespace --ignore-space-change
939 --interactive --keep --no-utf8 --signoff --utf8
940 --whitespace= --scissors
951 __gitcomp
"$__git_whitespacelist" "" "${cur##--whitespace=}"
956 --stat --numstat --summary --check --index
957 --cached --index-info --reverse --reject --unidiff-zero
958 --apply --no-add --exclude=
959 --ignore-whitespace --ignore-space-change
960 --whitespace= --inaccurate-eof --verbose
972 --interactive --refresh --patch --update --dry-run
973 --ignore-errors --intent-to-add
978 # XXX should we check for --update and --all options ?
979 __git_complete_index_file
"--others --modified"
986 __gitcomp
"$(git archive --list)" "" "${cur##--format=}"
990 __gitcomp_nl
"$(__git_remotes)" "" "${cur##--remote=}"
995 --format= --list --verbose
996 --prefix= --remote= --exec=
1006 __git_has_doubledash
&& return
1008 local subcommands
="start bad good skip reset visualize replay log run"
1009 local subcommand
="$(__git_find_on_cmdline "$subcommands")"
1010 if [ -z "$subcommand" ]; then
1011 if [ -f "$(__gitdir)"/BISECT_START
]; then
1012 __gitcomp
"$subcommands"
1014 __gitcomp
"replay start"
1019 case "$subcommand" in
1020 bad|good|
reset|skip|start
)
1021 __gitcomp_nl
"$(__git_refs)"
1031 local i c
=1 only_local_ref
="n" has_r
="n"
1033 while [ $c -lt $cword ]; do
1036 -d|
-m) only_local_ref
="y" ;;
1043 --set-upstream-to=*)
1044 __gitcomp
"$(__git_refs)" "" "${cur##--set-upstream-to=}"
1048 --color --no-color --verbose --abbrev= --no-abbrev
1049 --track --no-track --contains --merged --no-merged
1050 --set-upstream-to= --edit-description --list
1055 if [ $only_local_ref = "y" -a $has_r = "n" ]; then
1056 __gitcomp_nl
"$(__git_heads)"
1058 __gitcomp_nl
"$(__git_refs)"
1066 local cmd
="${words[2]}"
1069 __gitcomp
"create list-heads verify unbundle"
1072 # looking for a file
1077 __git_complete_revlist
1086 __git_has_doubledash
&& return
1090 __gitcomp
"diff3 merge" "" "${cur##--conflict=}"
1094 --quiet --ours --theirs --track --no-track --merge
1095 --conflict= --orphan --patch
1099 # check if --track, --no-track, or --no-guess was specified
1100 # if so, disable DWIM mode
1101 local flags
="--track --no-track --no-guess" track
=1
1102 if [ -n "$(__git_find_on_cmdline "$flags")" ]; then
1105 __gitcomp_nl
"$(__git_refs '' $track)"
1112 __gitcomp
"$(__git_refs)"
1119 __gitcomp
"--edit --no-commit"
1122 __gitcomp_nl
"$(__git_refs)"
1131 __gitcomp
"--dry-run --quiet"
1136 # XXX should we check for -x option ?
1137 __git_complete_index_file
"--others"
1170 __gitcomp_nl
"$(__git_refs)" "" "${cur}"
1177 __gitcomp
"default strip verbatim whitespace
1178 " "" "${cur##--cleanup=}"
1181 --reuse-message=*|
--reedit-message=*|\
1182 --fixup=*|
--squash=*)
1183 __gitcomp_nl
"$(__git_refs)" "" "${cur#*=}"
1186 --untracked-files=*)
1187 __gitcomp
"all no normal" "" "${cur##--untracked-files=}"
1192 --all --author= --signoff --verify --no-verify
1194 --amend --include --only --interactive
1195 --dry-run --reuse-message= --reedit-message=
1196 --reset-author --file= --message= --template=
1197 --cleanup= --untracked-files --untracked-files=
1198 --verbose --quiet --fixup= --squash=
1203 if git rev-parse
--verify --quiet HEAD
>/dev
/null
; then
1204 __git_complete_diff_index_file
"HEAD"
1206 # This is the first commit
1207 __git_complete_index_file
"--cached"
1216 --all --tags --contains --abbrev= --candidates=
1217 --exact-match --debug --long --match --always
1221 __gitcomp_nl
"$(__git_refs)"
1224 __git_diff_common_options
="--stat --numstat --shortstat --summary
1225 --patch-with-stat --name-only --name-status --color
1226 --no-color --color-words --no-renames --check
1227 --full-index --binary --abbrev --diff-filter=
1228 --find-copies-harder
1229 --text --ignore-space-at-eol --ignore-space-change
1230 --ignore-all-space --exit-code --quiet --ext-diff
1232 --no-prefix --src-prefix= --dst-prefix=
1233 --inter-hunk-context=
1236 --dirstat --dirstat= --dirstat-by-file
1237 --dirstat-by-file= --cumulative
1242 __git_has_doubledash
&& return
1246 __gitcomp
"--cached --staged --pickaxe-all --pickaxe-regex
1247 --base --ours --theirs --no-index
1248 $__git_diff_common_options
1253 __git_complete_revlist_file
1256 __git_mergetools_common
="diffuse ecmerge emerge kdiff3 meld opendiff
1257 tkdiff vimdiff gvimdiff xxdiff araxis p4merge bc3 codecompare
1262 __git_has_doubledash
&& return
1266 __gitcomp
"$__git_mergetools_common kompare" "" "${cur##--tool=}"
1270 __gitcomp
"--cached --staged --pickaxe-all --pickaxe-regex
1271 --base --ours --theirs
1272 --no-renames --diff-filter= --find-copies-harder
1273 --relative --ignore-submodules
1281 __git_fetch_options
="
1282 --quiet --verbose --append --upload-pack --force --keep --depth=
1283 --tags --no-tags --all --prune --dry-run
1290 __gitcomp
"$__git_fetch_options"
1294 __git_complete_remote_or_refspec
1297 __git_format_patch_options
="
1298 --stdout --attach --no-attach --thread --thread= --output-directory
1299 --numbered --start-number --numbered-files --keep-subject --signoff
1300 --signature --no-signature --in-reply-to= --cc= --full-index --binary
1301 --not --all --cover-letter --no-prefix --src-prefix= --dst-prefix=
1302 --inline --suffix= --ignore-if-in-upstream --subject-prefix=
1305 _git_format_patch
()
1311 " "" "${cur##--thread=}"
1315 __gitcomp
"$__git_format_patch_options"
1319 __git_complete_revlist
1327 --tags --root --unreachable --cache --no-reflogs --full
1328 --strict --verbose --lost-found
1340 __gitcomp
"--prune --aggressive"
1352 __git_match_ctag
() {
1353 awk "/^${1////\\/}/ { print \$1 }" "$2"
1358 __git_has_doubledash
&& return
1364 --text --ignore-case --word-regexp --invert-match
1365 --full-name --line-number
1366 --extended-regexp --basic-regexp --fixed-strings
1368 --files-with-matches --name-only
1369 --files-without-match
1372 --and --or --not --all-match
1378 case "$cword,$prev" in
1380 if test -r tags
; then
1381 __gitcomp_nl
"$(__git_match_ctag "$cur" tags)"
1387 __gitcomp_nl
"$(__git_refs)"
1394 __gitcomp
"--all --info --man --web"
1398 __git_compute_all_commands
1399 __gitcomp
"$__git_all_commands $(__git_aliases)
1400 attributes cli core-tutorial cvs-migration
1401 diffcore gitk glossary hooks ignore modules
1402 namespaces repository-layout tutorial tutorial-2
1412 false true umask group all world everybody
1413 " "" "${cur##--shared=}"
1417 __gitcomp
"--quiet --bare --template= --shared --shared="
1428 __gitcomp
"--cached --deleted --modified --others --ignored
1429 --stage --directory --no-empty-directory --unmerged
1430 --killed --exclude= --exclude-from=
1431 --exclude-per-directory= --exclude-standard
1432 --error-unmatch --with-tree= --full-name
1433 --abbrev --ignored --exclude-per-directory
1439 # XXX ignore options like --modified and always suggest all cached
1441 __git_complete_index_file
"--cached"
1446 __gitcomp_nl
"$(__git_remotes)"
1454 # Options that go well for log, shortlog and gitk
1455 __git_log_common_options
="
1457 --branches --tags --remotes
1458 --first-parent --merges --no-merges
1460 --max-age= --since= --after=
1461 --min-age= --until= --before=
1462 --min-parents= --max-parents=
1463 --no-min-parents --no-max-parents
1465 # Options that go well for log and gitk (not shortlog)
1466 __git_log_gitk_options
="
1467 --dense --sparse --full-history
1468 --simplify-merges --simplify-by-decoration
1469 --left-right --notes --no-notes
1471 # Options that go well for log and shortlog (not gitk)
1472 __git_log_shortlog_options
="
1473 --author= --committer= --grep=
1477 __git_log_pretty_formats
="oneline short medium full fuller email raw format:"
1478 __git_log_date_formats
="relative iso8601 rfc2822 short local default raw"
1482 __git_has_doubledash
&& return
1484 local g
="$(git rev-parse --git-dir 2>/dev/null)"
1486 if [ -f "$g/MERGE_HEAD" ]; then
1490 --pretty=*|
--format=*)
1491 __gitcomp
"$__git_log_pretty_formats $(__git_pretty_aliases)
1496 __gitcomp
"$__git_log_date_formats" "" "${cur##--date=}"
1500 __gitcomp
"long short" "" "${cur##--decorate=}"
1505 $__git_log_common_options
1506 $__git_log_shortlog_options
1507 $__git_log_gitk_options
1508 --root --topo-order --date-order --reverse
1509 --follow --full-diff
1510 --abbrev-commit --abbrev=
1511 --relative-date --date=
1512 --pretty= --format= --oneline
1515 --decorate --decorate=
1517 --parents --children
1519 $__git_diff_common_options
1520 --pickaxe-all --pickaxe-regex
1525 __git_complete_revlist
1528 __git_merge_options
="
1529 --no-commit --no-stat --log --no-log --squash --strategy
1530 --commit --stat --no-squash --ff --no-ff --ff-only --edit --no-edit
1535 __git_complete_strategy
&& return
1539 __gitcomp
"$__git_merge_options"
1542 __gitcomp_nl
"$(__git_refs)"
1549 __gitcomp
"$__git_mergetools_common tortoisemerge" "" "${cur##--tool=}"
1562 __gitcomp_nl
"$(__git_refs)"
1569 __gitcomp
"--dry-run"
1574 if [ $
(__git_count_arguments
"mv") -gt 0 ]; then
1575 # We need to show both cached and untracked files (including
1576 # empty directories) since this may not be the last argument.
1577 __git_complete_index_file
"--cached --others --directory"
1579 __git_complete_index_file
"--cached"
1585 __gitcomp
"--tags --all --stdin"
1590 local subcommands
='add append copy edit list prune remove show'
1591 local subcommand
="$(__git_find_on_cmdline "$subcommands")"
1593 case "$subcommand,$cur" in
1600 __gitcomp_nl
"$(__git_refs)"
1603 __gitcomp
"$subcommands --ref"
1607 add
,--reuse-message=*|append
,--reuse-message=*|\
1608 add
,--reedit-message=*|append
,--reedit-message=*)
1609 __gitcomp_nl
"$(__git_refs)" "" "${cur#*=}"
1612 __gitcomp
'--file= --message= --reedit-message=
1619 __gitcomp
'--dry-run --verbose'
1628 __gitcomp_nl
"$(__git_refs)"
1637 __git_complete_strategy
&& return
1642 --rebase --no-rebase
1643 $__git_merge_options
1644 $__git_fetch_options
1649 __git_complete_remote_or_refspec
1656 __gitcomp_nl
"$(__git_remotes)"
1661 __gitcomp_nl
"$(__git_remotes)" "" "${cur##--repo=}"
1666 --all --mirror --tags --dry-run --force --verbose
1667 --receive-pack= --repo= --set-upstream
1672 __git_complete_remote_or_refspec
1677 local dir
="$(__gitdir)"
1678 if [ -d "$dir"/rebase-apply
] ||
[ -d "$dir"/rebase-merge
]; then
1679 __gitcomp
"--continue --skip --abort"
1682 __git_complete_strategy
&& return
1685 __gitcomp
"$__git_whitespacelist" "" "${cur##--whitespace=}"
1690 --onto --merge --strategy --interactive
1691 --preserve-merges --stat --no-stat
1692 --committer-date-is-author-date --ignore-date
1693 --ignore-whitespace --whitespace=
1699 __gitcomp_nl
"$(__git_refs)"
1704 local subcommands
="show delete expire"
1705 local subcommand
="$(__git_find_on_cmdline "$subcommands")"
1707 if [ -z "$subcommand" ]; then
1708 __gitcomp
"$subcommands"
1710 __gitcomp_nl
"$(__git_refs)"
1714 __git_send_email_confirm_options
="always never auto cc compose"
1715 __git_send_email_suppresscc_options
="author self cc bodycc sob cccmd body all"
1722 $__git_send_email_confirm_options
1723 " "" "${cur##--confirm=}"
1728 $__git_send_email_suppresscc_options
1729 " "" "${cur##--suppress-cc=}"
1733 --smtp-encryption=*)
1734 __gitcomp
"ssl tls" "" "${cur##--smtp-encryption=}"
1740 " "" "${cur##--thread=}"
1744 __gitcomp
"--annotate --bcc --cc --cc-cmd --chain-reply-to
1745 --compose --confirm= --dry-run --envelope-sender
1747 --in-reply-to --no-chain-reply-to --no-signed-off-by-cc
1748 --no-suppress-from --no-thread --quiet
1749 --signed-off-by-cc --smtp-pass --smtp-server
1750 --smtp-server-port --smtp-encryption= --smtp-user
1751 --subject --suppress-cc= --suppress-from --thread --to
1752 --validate --no-validate
1753 $__git_format_patch_options"
1757 __git_complete_revlist
1765 __git_config_get_set_variables
()
1767 local prevword word config_file
= c
=$cword
1768 while [ $c -gt 1 ]; do
1771 --global|
--system|
--file=*)
1776 config_file
="$word $prevword"
1784 git
--git-dir="$(__gitdir)" config
$config_file --list 2>/dev
/null |
1799 __gitcomp_nl
"$(__git_remotes)"
1803 __gitcomp_nl
"$(__git_refs)"
1807 local remote
="${prev#remote.}"
1808 remote
="${remote%.fetch}"
1809 if [ -z "$cur" ]; then
1810 COMPREPLY
=("refs/heads/")
1813 __gitcomp_nl
"$(__git_refs_remotes "$remote")"
1817 local remote
="${prev#remote.}"
1818 remote
="${remote%.push}"
1819 __gitcomp_nl
"$(git --git-dir="$
(__gitdir
)" \
1820 for-each-ref --format='%(refname):%(refname)' \
1824 pull.twohead|pull.octopus
)
1825 __git_compute_merge_strategies
1826 __gitcomp
"$__git_merge_strategies"
1829 color.branch|color.
diff|color.interactive|\
1830 color.showbranch|color.status|color.ui
)
1831 __gitcomp
"always never auto"
1835 __gitcomp
"false true"
1840 normal black red green yellow blue magenta cyan white
1841 bold dim ul blink reverse
1846 __gitcomp
"man info web html"
1850 __gitcomp
"$__git_log_date_formats"
1853 sendemail.aliasesfiletype
)
1854 __gitcomp
"mutt mailrc pine elm gnus"
1858 __gitcomp
"$__git_send_email_confirm_options"
1861 sendemail.suppresscc
)
1862 __gitcomp
"$__git_send_email_suppresscc_options"
1865 --get|
--get-all|
--unset|
--unset-all)
1866 __gitcomp_nl
"$(__git_config_get_set_variables)"
1877 --global --system --file=
1878 --list --replace-all
1879 --get --get-all --get-regexp
1880 --add --unset --unset-all
1881 --remove-section --rename-section
1886 local pfx
="${cur%.*}." cur_
="${cur##*.}"
1887 __gitcomp
"remote merge mergeoptions rebase" "$pfx" "$cur_"
1891 local pfx
="${cur%.*}." cur_
="${cur#*.}"
1892 __gitcomp_nl
"$(__git_heads)" "$pfx" "$cur_" "."
1896 local pfx
="${cur%.*}." cur_
="${cur##*.}"
1898 argprompt cmd confirm needsfile noconsole norescan
1899 prompt revprompt revunmerged title
1904 local pfx
="${cur%.*}." cur_
="${cur##*.}"
1905 __gitcomp
"cmd path" "$pfx" "$cur_"
1909 local pfx
="${cur%.*}." cur_
="${cur##*.}"
1910 __gitcomp
"cmd path" "$pfx" "$cur_"
1914 local pfx
="${cur%.*}." cur_
="${cur##*.}"
1915 __gitcomp
"cmd path trustExitCode" "$pfx" "$cur_"
1919 local pfx
="${cur%.*}." cur_
="${cur#*.}"
1920 __git_compute_all_commands
1921 __gitcomp_nl
"$__git_all_commands" "$pfx" "$cur_"
1925 local pfx
="${cur%.*}." cur_
="${cur##*.}"
1927 url proxy fetch push mirror skipDefaultUpdate
1928 receivepack uploadpack tagopt pushurl
1933 local pfx
="${cur%.*}." cur_
="${cur#*.}"
1934 __gitcomp_nl
"$(__git_remotes)" "$pfx" "$cur_" "."
1938 local pfx
="${cur%.*}." cur_
="${cur##*.}"
1939 __gitcomp
"insteadOf pushInsteadOf" "$pfx" "$cur_"
1945 advice.commitBeforeMerge
1947 advice.implicitIdentity
1948 advice.pushNonFastForward
1949 advice.resolveConflict
1953 apply.ignorewhitespace
1955 branch.autosetupmerge
1956 branch.autosetuprebase
1960 color.branch.current
1965 color.decorate.branch
1966 color.decorate.remoteBranch
1967 color.decorate.stash
1977 color.diff.whitespace
1982 color.grep.linenumber
1985 color.grep.separator
1987 color.interactive.error
1988 color.interactive.header
1989 color.interactive.help
1990 color.interactive.prompt
1995 color.status.changed
1997 color.status.nobranch
1998 color.status.untracked
1999 color.status.updated
2008 core.bigFileThreshold
2011 core.deltaBaseCacheLimit
2016 core.fsyncobjectfiles
2018 core.ignoreCygwinFSTricks
2021 core.logAllRefUpdates
2022 core.loosecompression
2025 core.packedGitWindowSize
2027 core.preferSymlinkRefs
2030 core.repositoryFormatVersion
2032 core.sharedRepository
2036 core.warnAmbiguousRefs
2039 diff.autorefreshindex
2042 diff.ignoreSubmodules
2047 diff.suppressBlankEmpty
2052 fetch.recurseSubmodules
2061 format.subjectprefix
2072 gc.reflogexpireunreachable
2076 gitcvs.commitmsgannotation
2077 gitcvs.dbTableNamePrefix
2088 gui.copyblamethreshold
2092 gui.matchtrackingbranch
2093 gui.newbranchtemplate
2094 gui.pruneduringfetch
2095 gui.spellingdictionary
2110 http.sslCertPasswordProtected
2115 i18n.logOutputEncoding
2121 imap.preformattedHTML
2131 interactive.singlekey
2147 mergetool.keepBackup
2148 mergetool.keepTemporaries
2153 notes.rewrite.rebase
2157 pack.deltaCacheLimit
2173 receive.denyCurrentBranch
2174 receive.denyDeleteCurrent
2176 receive.denyNonFastForwards
2179 receive.updateserverinfo
2181 repack.usedeltabaseoffset
2185 sendemail.aliasesfile
2186 sendemail.aliasfiletype
2190 sendemail.chainreplyto
2192 sendemail.envelopesender
2196 sendemail.signedoffbycc
2197 sendemail.smtpdomain
2198 sendemail.smtpencryption
2200 sendemail.smtpserver
2201 sendemail.smtpserveroption
2202 sendemail.smtpserverport
2204 sendemail.suppresscc
2205 sendemail.suppressfrom
2210 status.relativePaths
2211 status.showUntrackedFiles
2212 status.submodulesummary
2215 transfer.unpackLimit
2227 local subcommands
="add rename remove set-head set-branches set-url show prune update"
2228 local subcommand
="$(__git_find_on_cmdline "$subcommands")"
2229 if [ -z "$subcommand" ]; then
2230 __gitcomp
"$subcommands"
2234 case "$subcommand" in
2235 rename|remove|set-url|show|prune
)
2236 __gitcomp_nl
"$(__git_remotes)"
2238 set-head|set-branches
)
2239 __git_complete_remote_or_refspec
2242 local i c
='' IFS
=$
'\n'
2243 for i
in $
(git
--git-dir="$(__gitdir)" config
--get-regexp "remotes\..*" 2>/dev
/null
); do
2257 __gitcomp_nl
"$(__git_refs)"
2262 __git_has_doubledash
&& return
2266 __gitcomp
"--merge --mixed --hard --soft --patch"
2270 __gitcomp_nl
"$(__git_refs)"
2277 __gitcomp
"--edit --mainline --no-edit --no-commit --signoff"
2281 __gitcomp_nl
"$(__git_refs)"
2288 __gitcomp
"--cached --dry-run --ignore-unmatch --quiet"
2293 __git_complete_index_file
"--cached"
2298 __git_has_doubledash
&& return
2303 $__git_log_common_options
2304 $__git_log_shortlog_options
2305 --numbered --summary
2310 __git_complete_revlist
2315 __git_has_doubledash
&& return
2318 --pretty=*|
--format=*)
2319 __gitcomp
"$__git_log_pretty_formats $(__git_pretty_aliases)
2324 __gitcomp
"--pretty= --format= --abbrev-commit --oneline
2325 $__git_diff_common_options
2338 --all --remotes --topo-order --current --more=
2339 --list --independent --merge-base --no-name
2341 --sha1-name --sparse --topics --reflog
2346 __git_complete_revlist
2351 local save_opts
='--keep-index --no-keep-index --quiet --patch'
2352 local subcommands
='save list show apply clear drop pop create branch'
2353 local subcommand
="$(__git_find_on_cmdline "$subcommands")"
2354 if [ -z "$subcommand" ]; then
2357 __gitcomp
"$save_opts"
2360 if [ -z "$(__git_find_on_cmdline "$save_opts")" ]; then
2361 __gitcomp
"$subcommands"
2368 case "$subcommand,$cur" in
2370 __gitcomp
"$save_opts"
2373 __gitcomp
"--index --quiet"
2375 show
,--*|drop
,--*|branch
,--*)
2378 show
,*|apply
,*|drop
,*|pop
,*|branch
,*)
2379 __gitcomp_nl
"$(git --git-dir="$
(__gitdir
)" stash list \
2380 | sed -n -e 's/:.*//p')"
2391 __git_has_doubledash
&& return
2393 local subcommands
="add status init update summary foreach sync"
2394 if [ -z "$(__git_find_on_cmdline "$subcommands")" ]; then
2397 __gitcomp
"--quiet --cached"
2400 __gitcomp
"$subcommands"
2410 init fetch clone rebase dcommit log find-rev
2411 set-tree commit-diff info create-ignore propget
2412 proplist show-ignore show-externals branch tag blame
2413 migrate mkdirs reset gc
2415 local subcommand
="$(__git_find_on_cmdline "$subcommands")"
2416 if [ -z "$subcommand" ]; then
2417 __gitcomp
"$subcommands"
2419 local remote_opts
="--username= --config-dir= --no-auth-cache"
2421 --follow-parent --authors-file= --repack=
2422 --no-metadata --use-svm-props --use-svnsync-props
2423 --log-window-size= --no-checkout --quiet
2424 --repack-flags --use-log-author --localtime
2425 --ignore-paths= $remote_opts
2428 --template= --shared= --trunk= --tags=
2429 --branches= --stdlayout --minimize-url
2430 --no-metadata --use-svm-props --use-svnsync-props
2431 --rewrite-root= --prefix= --use-log-author
2432 --add-author-from $remote_opts
2435 --edit --rmdir --find-copies-harder --copy-similarity=
2438 case "$subcommand,$cur" in
2440 __gitcomp
"--revision= --fetch-all $fc_opts"
2443 __gitcomp
"--revision= $fc_opts $init_opts"
2446 __gitcomp
"$init_opts"
2450 --merge --strategy= --verbose --dry-run
2451 --fetch-all --no-rebase --commit-url
2452 --revision --interactive $cmt_opts $fc_opts
2456 __gitcomp
"--stdin $cmt_opts $fc_opts"
2458 create-ignore
,--*|propget
,--*|proplist
,--*|show-ignore
,--*|\
2459 show-externals
,--*|mkdirs
,--*)
2460 __gitcomp
"--revision="
2464 --limit= --revision= --verbose --incremental
2465 --oneline --show-commit --non-recursive
2466 --authors-file= --color
2471 --merge --verbose --strategy= --local
2472 --fetch-all --dry-run $fc_opts
2476 __gitcomp
"--message= --file= --revision= $cmt_opts"
2482 __gitcomp
"--dry-run --message --tag"
2485 __gitcomp
"--dry-run --message"
2488 __gitcomp
"--git-format"
2492 --config-dir= --ignore-paths= --minimize
2493 --no-auth-cache --username=
2497 __gitcomp
"--revision= --parent"
2509 while [ $c -lt $cword ]; do
2513 __gitcomp_nl
"$(__git_tags)"
2529 __gitcomp_nl
"$(__git_tags)"
2535 __gitcomp_nl
"$(__git_refs)"
2547 local i c
=1 command __git_dir
2549 while [ $c -lt $cword ]; do
2552 --git-dir=*) __git_dir
="${i#--git-dir=}" ;;
2553 --bare) __git_dir
="." ;;
2554 --help) command="help"; break ;;
2557 *) command="$i"; break ;;
2562 if [ -z "$command" ]; then
2576 --no-replace-objects
2580 *) __git_compute_porcelain_commands
2581 __gitcomp
"$__git_porcelain_commands $(__git_aliases)" ;;
2586 local completion_func
="_git_${command//-/_}"
2587 declare -f $completion_func >/dev
/null
&& $completion_func && return
2589 local expansion
=$
(__git_aliased_command
"$command")
2590 if [ -n "$expansion" ]; then
2591 completion_func
="_git_${expansion//-/_}"
2592 declare -f $completion_func >/dev
/null
&& $completion_func
2598 __git_has_doubledash
&& return
2600 local g
="$(__gitdir)"
2602 if [ -f "$g/MERGE_HEAD" ]; then
2608 $__git_log_common_options
2609 $__git_log_gitk_options
2615 __git_complete_revlist
2618 if [[ -n ${ZSH_VERSION-} ]]; then
2619 echo "WARNING: this script is deprecated, please see git-completion.zsh" 1>&2
2621 autoload
-U +X compinit
&& compinit
2627 local cur_
="${3-$cur}"
2633 local c IFS
=$
' \t\n'
2644 compadd
-Q -S '' -p "${2-}" -a -- array
&& _ret
=0
2655 compadd
-Q -S "${4- }" -p "${2-}" -- ${=1} && _ret=0
2664 compadd -Q -p "${2-}" -f -- ${=1} && _ret=0
2670 local cur cword prev
2671 cur=${words[CURRENT-1]}
2672 prev=${words[CURRENT-2]}
2682 let _ret && _default -S '' && _ret=0
2686 compdef _git git gitk
2688 elif [[ -n ${BASH_VERSION-} ]]; then
2689 if ((${BASH_VERSINFO[0]} < 4)); then
2690 # compopt is not supported
2691 __git_index_file_list_filter ()
2693 __git_index_file_list_filter_compat
2700 local cur words cword prev
2701 _get_comp_words_by_ref -n =: cur words cword prev
2705 # Setup completion for certain functions defined above by setting common
2706 # variables and workarounds.
2707 # This is NOT a public function; use at your own risk.
2710 local wrapper="__git_wrap
${2}"
2711 eval "$wrapper () { __git_func_wrap
$2 ; }"
2712 complete -o bashdefault -o default -o nospace -F $wrapper $1 2>/dev/null \
2713 || complete -o default -o nospace -F $wrapper $1
2716 # wrapper for backwards compatibility
2719 __git_wrap__git_main
2722 # wrapper for backwards compatibility
2725 __git_wrap__gitk_main
2728 __git_complete git __git_main
2729 __git_complete gitk __gitk_main
2731 # The following are necessary only for Cygwin, and only are needed
2732 # when the user has tab-completed the executable name and consequently
2733 # included the '.exe' suffix.
2735 if [ Cygwin = "$
(uname
-o 2>/dev
/null
)" ]; then
2736 __git_complete git.exe __git_main