2 # bash completion support for core Git.
4 # Copyright (C) 2006,2007 Shawn Pearce
5 # Conceptually based on gitcompletion (http://gitweb.hawaga.org.uk/).
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
15 # To use these routines:
17 # 1) Copy this file to somewhere (e.g. ~/.git-completion.sh).
18 # 2) Added the following line to your .bashrc:
19 # source ~/.git-completion.sh
21 # 3) You may want to make sure the git executable is available
22 # in your PATH before this script is sourced, as some caching
23 # is performed while the script loads. If git isn't found
24 # at source time then all lookups will be done on demand,
25 # which may be slightly slower.
27 # 4) Consider changing your PS1 to also show the current branch:
28 # PS1='[\u@\h \W$(__git_ps1 " (%s)")]\$ '
30 # The argument to __git_ps1 will be displayed only if you
31 # are currently in a git repository. The %s token will be
32 # the name of the current branch.
38 if [ -n "$__git_dir" ]; then
40 elif [ -d .git
]; then
43 git rev-parse
--git-dir 2>/dev
/null
45 elif [ -d "$1/.git" ]; then
54 local b
="$(git symbolic-ref HEAD 2>/dev/null)"
57 printf "$1" "${b##refs/heads/}"
59 printf " (%s)" "${b##refs/heads/}"
66 local all c s
=$
'\n' IFS
=' '$
'\t'$
'\n'
67 local cur
="${COMP_WORDS[COMP_CWORD]}"
73 --*=*) all
="$all$c$4$s" ;;
74 *.
) all
="$all$c$4$s" ;;
75 *) all
="$all$c$4 $s" ;;
79 COMPREPLY
=($
(compgen
-P "$2" -W "$all" -- "$cur"))
85 local cmd i is_hash
=y dir
="$(__gitdir "$1")"
86 if [ -d "$dir" ]; then
87 for i
in $
(git
--git-dir="$dir" \
88 for-each-ref
--format='%(refname)' \
90 echo "${i#refs/heads/}"
94 for i
in $
(git-ls-remote
"$1" 2>/dev
/null
); do
98 n
,refs
/heads
/*) is_hash
=y
; echo "${i#refs/heads/}" ;;
99 n
,*) is_hash
=y
; echo "$i" ;;
106 local cmd i is_hash
=y dir
="$(__gitdir "$1")"
107 if [ -d "$dir" ]; then
108 if [ -e "$dir/HEAD" ]; then echo HEAD
; fi
109 for i
in $
(git
--git-dir="$dir" \
110 for-each-ref
--format='%(refname)' \
111 refs
/tags refs
/heads refs
/remotes
); do
113 refs
/tags
/*) echo "${i#refs/tags/}" ;;
114 refs
/heads
/*) echo "${i#refs/heads/}" ;;
115 refs
/remotes
/*) echo "${i#refs/remotes/}" ;;
121 for i
in $
(git-ls-remote
"$dir" 2>/dev
/null
); do
122 case "$is_hash,$i" in
125 n
,refs
/tags
/*) is_hash
=y
; echo "${i#refs/tags/}" ;;
126 n
,refs
/heads
/*) is_hash
=y
; echo "${i#refs/heads/}" ;;
127 n
,refs
/remotes
/*) is_hash
=y
; echo "${i#refs/remotes/}" ;;
128 n
,*) is_hash
=y
; echo "$i" ;;
136 for i
in $
(__git_refs
"$1"); do
141 __git_refs_remotes
()
143 local cmd i is_hash
=y
144 for i
in $
(git-ls-remote
"$1" 2>/dev
/null
); do
145 case "$is_hash,$i" in
148 echo "$i:refs/remotes/$1/${i#refs/heads/}"
152 n
,refs
/tags
/*) is_hash
=y
;;
160 local i ngoff IFS
=$
'\n' d
="$(__gitdir)"
161 shopt -q nullglob || ngoff
=1
163 for i
in "$d/remotes"/*; do
164 echo ${i#$d/remotes/}
166 [ "$ngoff" ] && shopt -u nullglob
167 for i
in $
(git
--git-dir="$d" config
--list); do
177 __git_merge_strategies
()
179 if [ -n "$__git_merge_strategylist" ]; then
180 echo "$__git_merge_strategylist"
183 sed -n "/^all_strategies='/{
184 s/^all_strategies='//
188 }" "$(git --exec-path)/git-merge"
190 __git_merge_strategylist
=
191 __git_merge_strategylist
="$(__git_merge_strategies 2>/dev/null)"
193 __git_complete_file
()
195 local pfx
ls ref cur
="${COMP_WORDS[COMP_CWORD]}"
211 COMPREPLY
=($
(compgen
-P "$pfx" \
212 -W "$(git --git-dir="$
(__gitdir
)" ls-tree "$ls" \
213 | sed '/^100... blob /s,^.* ,,
222 __gitcomp
"$(__git_refs)"
227 __git_complete_revlist
()
229 local pfx cur
="${COMP_WORDS[COMP_CWORD]}"
234 __gitcomp
"$(__git_refs)" "$pfx" "$cur"
239 __gitcomp
"$(__git_refs)" "$pfx" "$cur"
245 __gitcomp
"$(__git_refs)"
252 if [ -n "$__git_commandlist" ]; then
253 echo "$__git_commandlist"
257 for i
in $
(git
help -a|
egrep '^ ')
260 add--interactive
) : plumbing
;;
261 applymbox
) : ask gittus
;;
262 applypatch
) : ask gittus
;;
263 archimport
) : import
;;
264 cat-file
) : plumbing
;;
265 check-ref-format
) : plumbing
;;
266 commit-tree
) : plumbing
;;
267 convert-objects
) : plumbing
;;
268 cvsexportcommit
) : export;;
269 cvsimport
) : import
;;
270 cvsserver
) : daemon
;;
272 fsck-objects
) : plumbing
;;
273 fetch-pack
) : plumbing
;;
274 fmt-merge-msg
) : plumbing
;;
275 hash-object
) : plumbing
;;
276 http-
*) : transport
;;
277 index-pack
) : plumbing
;;
278 init-db
) : deprecated
;;
279 local-fetch
) : plumbing
;;
280 mailinfo
) : plumbing
;;
281 mailsplit
) : plumbing
;;
282 merge-
*) : plumbing
;;
285 pack-objects
) : plumbing
;;
286 pack-redundant
) : plumbing
;;
287 pack-refs
) : plumbing
;;
288 parse-remote
) : plumbing
;;
289 patch-id
) : plumbing
;;
290 peek-remote
) : plumbing
;;
292 prune-packed
) : plumbing
;;
293 quiltimport
) : import
;;
294 read-tree
) : plumbing
;;
295 receive-pack
) : plumbing
;;
297 repo-config
) : plumbing
;;
299 rev-list
) : plumbing
;;
300 rev-parse
) : plumbing
;;
301 runstatus
) : plumbing
;;
302 sh-setup
) : internal
;;
304 send-pack
) : plumbing
;;
305 show-index
) : plumbing
;;
307 stripspace
) : plumbing
;;
308 svn
) : import
export;;
309 svnimport
) : import
;;
310 symbolic-ref
) : plumbing
;;
311 tar-tree
) : deprecated
;;
312 unpack-file
) : plumbing
;;
313 unpack-objects
) : plumbing
;;
314 update-index
) : plumbing
;;
315 update-ref
) : plumbing
;;
316 update-server-info
) : daemon
;;
317 upload-archive
) : plumbing
;;
318 upload-pack
) : plumbing
;;
319 write-tree
) : plumbing
;;
320 verify-tag
) : plumbing
;;
326 __git_commandlist
="$(__git_commands 2>/dev/null)"
331 for i
in $
(git
--git-dir="$(__gitdir)" config
--list); do
341 __git_aliased_command
()
343 local word cmdline
=$
(git
--git-dir="$(__gitdir)" \
344 config
--get "alias.$1")
345 for word
in $cmdline; do
346 if [ "${word##-*}" ]; then
353 __git_whitespacelist
="nowarn warn error error-all strip"
357 local cur
="${COMP_WORDS[COMP_CWORD]}"
358 if [ -d .dotest
]; then
359 __gitcomp
"--skip --resolved"
364 __gitcomp
"$__git_whitespacelist" "" "${cur##--whitespace=}"
369 --signoff --utf8 --binary --3way --interactive
379 local cur
="${COMP_WORDS[COMP_CWORD]}"
382 __gitcomp
"$__git_whitespacelist" "" "${cur##--whitespace=}"
387 --stat --numstat --summary --check --index
388 --cached --index-info --reverse --reject --unidiff-zero
389 --apply --no-add --exclude=
390 --whitespace= --inaccurate-eof --verbose
399 local cur
="${COMP_WORDS[COMP_CWORD]}"
402 __gitcomp
"--interactive"
410 __gitcomp
"$(__git_refs)"
415 __gitcomp
"$(__git_refs)"
420 __gitcomp
"$(__git_refs)"
425 local cur
="${COMP_WORDS[COMP_CWORD]}"
428 __gitcomp
"--edit --no-commit"
431 __gitcomp
"$(__git_refs)"
438 local cur
="${COMP_WORDS[COMP_CWORD]}"
442 --all --author= --signoff --verify --no-verify
443 --edit --amend --include --only
457 __gitcomp
"$(__git_refs)"
462 local cur
="${COMP_WORDS[COMP_CWORD]}"
464 case "${COMP_WORDS[0]},$COMP_CWORD" in
466 __gitcomp
"$(__git_remotes)"
469 __gitcomp
"$(__git_remotes)"
474 __gitcomp
"$(__git_refs)" "" "${cur#*:}"
478 case "${COMP_WORDS[0]}" in
479 git-fetch
) remote
="${COMP_WORDS[1]}" ;;
480 git
) remote
="${COMP_WORDS[2]}" ;;
482 __gitcomp
"$(__git_refs2 "$remote")"
491 local cur
="${COMP_WORDS[COMP_CWORD]}"
495 --stdout --attach --thread
497 --numbered --start-number
501 --full-index --binary
507 __git_complete_revlist
512 __gitcomp
"$(__git_remotes)"
522 local cur
="${COMP_WORDS[COMP_CWORD]}"
526 oneline short medium full fuller email raw
527 " "" "${cur##--pretty=}"
532 --max-count= --max-age= --since= --after=
533 --min-age= --before= --until=
534 --root --not --topo-order --date-order
536 --abbrev-commit --abbrev=
538 --author= --committer= --grep=
540 --pretty= --name-status --name-only
546 __git_complete_revlist
551 local cur
="${COMP_WORDS[COMP_CWORD]}"
552 case "${COMP_WORDS[COMP_CWORD-1]}" in
554 __gitcomp
"$(__git_merge_strategies)"
559 __gitcomp
"$(__git_merge_strategies)" "" "${cur##--strategy=}"
564 --no-commit --no-summary --squash --strategy
568 __gitcomp
"$(__git_refs)"
573 __gitcomp
"$(__git_refs)"
578 __gitcomp
"--tags --all --stdin"
583 local cur
="${COMP_WORDS[COMP_CWORD]}"
585 case "${COMP_WORDS[0]},$COMP_CWORD" in
587 __gitcomp
"$(__git_remotes)"
590 __gitcomp
"$(__git_remotes)"
594 case "${COMP_WORDS[0]}" in
595 git-pull
) remote
="${COMP_WORDS[1]}" ;;
596 git
) remote
="${COMP_WORDS[2]}" ;;
598 __gitcomp
"$(__git_refs "$remote")"
605 local cur
="${COMP_WORDS[COMP_CWORD]}"
607 case "${COMP_WORDS[0]},$COMP_CWORD" in
609 __gitcomp
"$(__git_remotes)"
612 __gitcomp
"$(__git_remotes)"
618 case "${COMP_WORDS[0]}" in
619 git-push
) remote
="${COMP_WORDS[1]}" ;;
620 git
) remote
="${COMP_WORDS[2]}" ;;
622 __gitcomp
"$(__git_refs "$remote")" "" "${cur#*:}"
625 __gitcomp
"$(__git_refs2)"
634 local cur
="${COMP_WORDS[COMP_CWORD]}"
635 if [ -d .dotest
]; then
636 __gitcomp
"--continue --skip --abort"
639 case "${COMP_WORDS[COMP_CWORD-1]}" in
641 __gitcomp
"$(__git_merge_strategies)"
646 __gitcomp
"$(__git_merge_strategies)" "" "${cur##--strategy=}"
650 __gitcomp
"--onto --merge --strategy"
653 __gitcomp
"$(__git_refs)"
658 local cur
="${COMP_WORDS[COMP_CWORD]}"
659 local prv
="${COMP_WORDS[COMP_CWORD-1]}"
662 __gitcomp
"$(__git_remotes)"
666 __gitcomp
"$(__git_refs)"
670 local remote
="${prv#remote.}"
671 remote
="${remote%.fetch}"
672 __gitcomp
"$(__git_refs_remotes "$remote")"
676 local remote
="${prv#remote.}"
677 remote
="${remote%.push}"
678 __gitcomp
"$(git --git-dir="$
(__gitdir
)" \
679 for-each-ref --format='%(refname):%(refname)' \
683 pull.twohead|pull.octopus
)
684 __gitcomp
"$(__git_merge_strategies)"
687 color.branch|color.
diff|color.status
)
688 __gitcomp
"always never auto"
693 black red green yellow blue magenta cyan white
694 bold dim ul blink reverse
706 --global --list --replace-all
707 --get --get-all --get-regexp
713 local pfx
="${cur%.*}."
715 __gitcomp
"remote merge" "$pfx" "$cur"
719 local pfx
="${cur%.*}."
721 __gitcomp
"$(__git_heads)" "$pfx" "$cur" "."
725 local pfx
="${cur%.*}."
727 __gitcomp
"url fetch push" "$pfx" "$cur"
731 local pfx
="${cur%.*}."
733 __gitcomp
"$(__git_remotes)" "$pfx" "$cur" "."
742 core.preferSymlinkRefs
743 core.logAllRefUpdates
744 core.repositoryFormatVersion
745 core.sharedRepository
746 core.warnAmbiguousRefs
749 core.packedGitWindowSize
763 color.diff.whitespace
769 color.status.untracked
777 gc.reflogexpireunreachable
790 i18n.logOutputEncoding
797 repack.useDeltaBaseOffset
803 receive.denyNonFastForwards
814 local cur
="${COMP_WORDS[COMP_CWORD]}"
817 __gitcomp
"--mixed --hard --soft"
821 __gitcomp
"$(__git_refs)"
826 local cur
="${COMP_WORDS[COMP_CWORD]}"
830 oneline short medium full fuller email raw
831 " "" "${cur##--pretty=}"
835 __gitcomp
"--pretty="
844 local i c
=1 command __git_dir
846 while [ $c -lt $COMP_CWORD ]; do
849 --git-dir=*) __git_dir
="${i#--git-dir=}" ;;
850 --bare) __git_dir
="." ;;
851 --version|
--help|
-p|
--paginate) ;;
852 *) command="$i"; break ;;
857 if [ $c -eq $COMP_CWORD -a -z "$command" ]; then
858 case "${COMP_WORDS[COMP_CWORD]}" in
859 --*=*) COMPREPLY
=() ;;
860 --*) __gitcomp
"--git-dir= --bare --version --exec-path" ;;
861 *) __gitcomp
"$(__git_commands) $(__git_aliases)" ;;
866 local expansion
=$
(__git_aliased_command
"$command")
867 [ "$expansion" ] && command="$expansion"
873 branch
) _git_branch
;;
874 checkout
) _git_checkout
;;
875 cherry
) _git_cherry
;;
876 cherry-pick
) _git_cherry_pick
;;
877 commit
) _git_commit
;;
878 config
) _git_config
;;
880 diff-tree
) _git_diff_tree
;;
882 format-patch
) _git_format_patch
;;
884 ls-remote
) _git_ls_remote
;;
885 ls-tree
) _git_ls_tree
;;
887 merge-base
) _git_merge_base
;;
888 name-rev
) _git_name_rev
;;
891 rebase
) _git_rebase
;;
894 show-branch
) _git_log
;;
895 whatchanged
) _git_log
;;
902 local cur
="${COMP_WORDS[COMP_CWORD]}"
905 __gitcomp
"--not --all"
909 __git_complete_revlist
912 complete
-o default
-o nospace
-F _git git
913 complete
-o default
-o nospace
-F _gitk gitk
914 complete
-o default
-o nospace
-F _git_am git-am
915 complete
-o default
-o nospace
-F _git_apply git-apply
916 complete
-o default
-o nospace
-F _git_branch git-branch
917 complete
-o default
-o nospace
-F _git_checkout git-checkout
918 complete
-o default
-o nospace
-F _git_cherry git-cherry
919 complete
-o default
-o nospace
-F _git_cherry_pick git-cherry-pick
920 complete
-o default
-o nospace
-F _git_commit git-commit
921 complete
-o default
-o nospace
-F _git_diff git-diff
922 complete
-o default
-o nospace
-F _git_diff_tree git-diff-tree
923 complete
-o default
-o nospace
-F _git_fetch git-fetch
924 complete
-o default
-o nospace
-F _git_format_patch git-format-patch
925 complete
-o default
-o nospace
-F _git_log git-log
926 complete
-o default
-o nospace
-F _git_ls_remote git-ls-remote
927 complete
-o default
-o nospace
-F _git_ls_tree git-ls-tree
928 complete
-o default
-o nospace
-F _git_merge git-merge
929 complete
-o default
-o nospace
-F _git_merge_base git-merge-base
930 complete
-o default
-o nospace
-F _git_name_rev git-name-rev
931 complete
-o default
-o nospace
-F _git_pull git-pull
932 complete
-o default
-o nospace
-F _git_push git-push
933 complete
-o default
-o nospace
-F _git_rebase git-rebase
934 complete
-o default
-o nospace
-F _git_config git-config
935 complete
-o default
-o nospace
-F _git_reset git-reset
936 complete
-o default
-o nospace
-F _git_show git-show
937 complete
-o default
-o nospace
-F _git_log git-show-branch
938 complete
-o default
-o nospace
-F _git_log git-whatchanged
940 # The following are necessary only for Cygwin, and only are needed
941 # when the user has tab-completed the executable name and consequently
942 # included the '.exe' suffix.
944 if [ Cygwin
= "$(uname -o 2>/dev/null)" ]; then
945 complete
-o default
-o nospace
-F _git_add git-add.exe
946 complete
-o default
-o nospace
-F _git_apply git-apply.exe
947 complete
-o default
-o nospace
-F _git git.exe
948 complete
-o default
-o nospace
-F _git_branch git-branch.exe
949 complete
-o default
-o nospace
-F _git_cherry git-cherry.exe
950 complete
-o default
-o nospace
-F _git_diff git-diff.exe
951 complete
-o default
-o nospace
-F _git_diff_tree git-diff-tree.exe
952 complete
-o default
-o nospace
-F _git_format_patch git-format-patch.exe
953 complete
-o default
-o nospace
-F _git_log git-log.exe
954 complete
-o default
-o nospace
-F _git_ls_tree git-ls-tree.exe
955 complete
-o default
-o nospace
-F _git_merge_base git-merge-base.exe
956 complete
-o default
-o nospace
-F _git_name_rev git-name-rev.exe
957 complete
-o default
-o nospace
-F _git_push git-push.exe
958 complete
-o default
-o nospace
-F _git_config git-config
959 complete
-o default
-o nospace
-F _git_show git-show.exe
960 complete
-o default
-o nospace
-F _git_log git-show-branch.exe
961 complete
-o default
-o nospace
-F _git_log git-whatchanged.exe