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 cmd i is_hash
=y dir
="$(__gitdir "$1")"
67 if [ -d "$dir" ]; then
68 for i
in $
(git
--git-dir="$dir" \
69 for-each-ref
--format='%(refname)' \
71 echo "${i#refs/heads/}"
75 for i
in $
(git-ls-remote
"$1" 2>/dev
/null
); do
79 n
,refs
/heads
/*) is_hash
=y
; echo "${i#refs/heads/}" ;;
80 n
,*) is_hash
=y
; echo "$i" ;;
87 local cmd i is_hash
=y dir
="$(__gitdir "$1")"
88 if [ -d "$dir" ]; then
89 if [ -e "$dir/HEAD" ]; then echo HEAD
; fi
90 for i
in $
(git
--git-dir="$dir" \
91 for-each-ref
--format='%(refname)' \
92 refs
/tags refs
/heads refs
/remotes
); do
94 refs
/tags
/*) echo "${i#refs/tags/}" ;;
95 refs
/heads
/*) echo "${i#refs/heads/}" ;;
96 refs
/remotes
/*) echo "${i#refs/remotes/}" ;;
102 for i
in $
(git-ls-remote
"$dir" 2>/dev
/null
); do
103 case "$is_hash,$i" in
106 n
,refs
/tags
/*) is_hash
=y
; echo "${i#refs/tags/}" ;;
107 n
,refs
/heads
/*) is_hash
=y
; echo "${i#refs/heads/}" ;;
108 n
,refs
/remotes
/*) is_hash
=y
; echo "${i#refs/remotes/}" ;;
109 n
,*) is_hash
=y
; echo "$i" ;;
117 for i
in $
(__git_refs
"$1"); do
122 __git_refs_remotes
()
124 local cmd i is_hash
=y
125 for i
in $
(git-ls-remote
"$1" 2>/dev
/null
); do
126 case "$is_hash,$i" in
129 echo "$i:refs/remotes/$1/${i#refs/heads/}"
133 n
,refs
/tags
/*) is_hash
=y
;;
141 local i ngoff IFS
=$
'\n' d
="$(__gitdir)"
142 shopt -q nullglob || ngoff
=1
144 for i
in "$d/remotes"/*; do
145 echo ${i#$d/remotes/}
147 [ "$ngoff" ] && shopt -u nullglob
148 for i
in $
(git
--git-dir="$d" config
--list); do
158 __git_merge_strategies
()
160 if [ -n "$__git_merge_strategylist" ]; then
161 echo "$__git_merge_strategylist"
164 sed -n "/^all_strategies='/{
165 s/^all_strategies='//
169 }" "$(git --exec-path)/git-merge"
171 __git_merge_strategylist
=
172 __git_merge_strategylist
="$(__git_merge_strategies 2>/dev/null)"
174 __git_complete_file
()
176 local pfx
ls ref cur
="${COMP_WORDS[COMP_CWORD]}"
192 COMPREPLY
=($
(compgen
-P "$pfx" \
193 -W "$(git --git-dir="$
(__gitdir
)" ls-tree "$ls" \
194 | sed '/^100... blob /s,^.* ,,
203 COMPREPLY
=($
(compgen
-W "$(__git_refs)" -- "$cur"))
208 __git_complete_revlist
()
210 local pfx cur
="${COMP_WORDS[COMP_CWORD]}"
215 COMPREPLY
=($
(compgen
-P "$pfx" -W "$(__git_refs)" -- "$cur"))
220 COMPREPLY
=($
(compgen
-P "$pfx" -W "$(__git_refs)" -- "$cur"))
223 COMPREPLY
=($
(compgen
-W "$(__git_refs)" -- "$cur"))
230 if [ -n "$__git_commandlist" ]; then
231 echo "$__git_commandlist"
235 for i
in $
(git
help -a|
egrep '^ ')
238 cat-file
) : plumbing
;;
239 check-ref-format
) : plumbing
;;
240 commit-tree
) : plumbing
;;
241 convert-objects
) : plumbing
;;
242 cvsserver
) : daemon
;;
244 fetch-pack
) : plumbing
;;
245 hash-object
) : plumbing
;;
246 http-
*) : transport
;;
247 index-pack
) : plumbing
;;
248 local-fetch
) : plumbing
;;
249 mailinfo
) : plumbing
;;
250 mailsplit
) : plumbing
;;
251 merge-
*) : plumbing
;;
254 pack-objects
) : plumbing
;;
255 pack-redundant
) : plumbing
;;
256 pack-refs
) : plumbing
;;
257 parse-remote
) : plumbing
;;
258 patch-id
) : plumbing
;;
259 peek-remote
) : plumbing
;;
260 read-tree
) : plumbing
;;
261 receive-pack
) : plumbing
;;
264 rev-list
) : plumbing
;;
265 rev-parse
) : plumbing
;;
266 runstatus
) : plumbing
;;
267 sh-setup
) : internal
;;
269 send-pack
) : plumbing
;;
270 show-index
) : plumbing
;;
272 stripspace
) : plumbing
;;
273 symbolic-ref
) : plumbing
;;
274 unpack-file
) : plumbing
;;
275 unpack-objects
) : plumbing
;;
276 update-ref
) : plumbing
;;
277 update-server-info
) : daemon
;;
278 upload-archive
) : plumbing
;;
279 upload-pack
) : plumbing
;;
280 write-tree
) : plumbing
;;
286 __git_commandlist
="$(__git_commands 2>/dev/null)"
291 for i
in $
(git
--git-dir="$(__gitdir)" config
--list); do
301 __git_aliased_command
()
303 local word cmdline
=$
(git
--git-dir="$(__gitdir)" \
304 config
--get "alias.$1")
305 for word
in $cmdline; do
306 if [ "${word##-*}" ]; then
313 __git_whitespacelist
="nowarn warn error error-all strip"
317 local cur
="${COMP_WORDS[COMP_CWORD]}"
318 if [ -d .dotest
]; then
319 COMPREPLY
=($
(compgen
-W "
326 COMPREPLY
=($
(compgen
-W "$__git_whitespacelist" \
327 -- "${cur##--whitespace=}"))
331 COMPREPLY
=($
(compgen
-W "
332 --signoff --utf8 --binary --3way --interactive
342 local cur
="${COMP_WORDS[COMP_CWORD]}"
345 COMPREPLY
=($
(compgen
-W "$__git_whitespacelist" \
346 -- "${cur##--whitespace=}"))
350 COMPREPLY
=($
(compgen
-W "
351 --stat --numstat --summary --check --index
352 --cached --index-info --reverse --reject --unidiff-zero
353 --apply --no-add --exclude=
354 --whitespace= --inaccurate-eof --verbose
363 local cur
="${COMP_WORDS[COMP_CWORD]}"
364 COMPREPLY
=($
(compgen
-W "$(__git_refs)" -- "$cur"))
369 local cur
="${COMP_WORDS[COMP_CWORD]}"
370 COMPREPLY
=($
(compgen
-W "$(__git_refs)" -- "$cur"))
375 local cur
="${COMP_WORDS[COMP_CWORD]}"
378 COMPREPLY
=($
(compgen
-W "
383 COMPREPLY
=($
(compgen
-W "$(__git_refs)" -- "$cur"))
390 local cur
="${COMP_WORDS[COMP_CWORD]}"
393 COMPREPLY
=($
(compgen
-W "
394 --all --author= --signoff --verify --no-verify
395 --edit --amend --include --only
409 local cur
="${COMP_WORDS[COMP_CWORD]}"
410 COMPREPLY
=($
(compgen
-W "$(__git_refs)" -- "$cur"))
415 local cur
="${COMP_WORDS[COMP_CWORD]}"
417 case "${COMP_WORDS[0]},$COMP_CWORD" in
419 COMPREPLY
=($
(compgen
-W "$(__git_remotes)" -- "$cur"))
422 COMPREPLY
=($
(compgen
-W "$(__git_remotes)" -- "$cur"))
428 COMPREPLY
=($
(compgen
-W "$(__git_refs)" -- "$cur"))
432 case "${COMP_WORDS[0]}" in
433 git-fetch
) remote
="${COMP_WORDS[1]}" ;;
434 git
) remote
="${COMP_WORDS[2]}" ;;
436 COMPREPLY
=($
(compgen
-W "$(__git_refs2 "$remote")" -- "$cur"))
445 local cur
="${COMP_WORDS[COMP_CWORD]}"
448 COMPREPLY
=($
(compgen
-W "
449 --stdout --attach --thread
451 --numbered --start-number
455 --full-index --binary
460 __git_complete_revlist
465 local cur
="${COMP_WORDS[COMP_CWORD]}"
466 COMPREPLY
=($
(compgen
-W "$(__git_remotes)" -- "$cur"))
476 local cur
="${COMP_WORDS[COMP_CWORD]}"
479 COMPREPLY
=($
(compgen
-W "
480 oneline short medium full fuller email raw
481 " -- "${cur##--pretty=}"))
485 COMPREPLY
=($
(compgen
-W "
486 --max-count= --max-age= --since= --after=
487 --min-age= --before= --until=
488 --root --not --topo-order --date-order
490 --abbrev-commit --abbrev=
492 --author= --committer= --grep=
494 --pretty= --name-status --name-only
499 __git_complete_revlist
504 local cur
="${COMP_WORDS[COMP_CWORD]}"
505 case "${COMP_WORDS[COMP_CWORD-1]}" in
507 COMPREPLY
=($
(compgen
-W "$(__git_merge_strategies)" -- "$cur"))
512 COMPREPLY
=($
(compgen
-W "$(__git_merge_strategies)" \
513 -- "${cur##--strategy=}"))
517 COMPREPLY
=($
(compgen
-W "
518 --no-commit --no-summary --squash --strategy
522 COMPREPLY
=($
(compgen
-W "$(__git_refs)" -- "$cur"))
527 local cur
="${COMP_WORDS[COMP_CWORD]}"
528 COMPREPLY
=($
(compgen
-W "$(__git_refs)" -- "$cur"))
533 local cur
="${COMP_WORDS[COMP_CWORD]}"
534 COMPREPLY
=($
(compgen
-W "--tags --all --stdin" -- "$cur"))
539 local cur
="${COMP_WORDS[COMP_CWORD]}"
541 case "${COMP_WORDS[0]},$COMP_CWORD" in
543 COMPREPLY
=($
(compgen
-W "$(__git_remotes)" -- "$cur"))
546 COMPREPLY
=($
(compgen
-W "$(__git_remotes)" -- "$cur"))
550 case "${COMP_WORDS[0]}" in
551 git-pull
) remote
="${COMP_WORDS[1]}" ;;
552 git
) remote
="${COMP_WORDS[2]}" ;;
554 COMPREPLY
=($
(compgen
-W "$(__git_refs "$remote")" -- "$cur"))
561 local cur
="${COMP_WORDS[COMP_CWORD]}"
563 case "${COMP_WORDS[0]},$COMP_CWORD" in
565 COMPREPLY
=($
(compgen
-W "$(__git_remotes)" -- "$cur"))
568 COMPREPLY
=($
(compgen
-W "$(__git_remotes)" -- "$cur"))
574 case "${COMP_WORDS[0]}" in
575 git-push
) remote
="${COMP_WORDS[1]}" ;;
576 git
) remote
="${COMP_WORDS[2]}" ;;
579 COMPREPLY
=($
(compgen
-W "$(__git_refs "$remote")" -- "$cur"))
582 COMPREPLY
=($
(compgen
-W "$(__git_refs2)" -- "$cur"))
591 local cur
="${COMP_WORDS[COMP_CWORD]}"
592 if [ -d .dotest
]; then
593 COMPREPLY
=($
(compgen
-W "
594 --continue --skip --abort
598 case "${COMP_WORDS[COMP_CWORD-1]}" in
600 COMPREPLY
=($
(compgen
-W "$(__git_merge_strategies)" -- "$cur"))
605 COMPREPLY
=($
(compgen
-W "$(__git_merge_strategies)" \
606 -- "${cur##--strategy=}"))
610 COMPREPLY
=($
(compgen
-W "
611 --onto --merge --strategy
615 COMPREPLY
=($
(compgen
-W "$(__git_refs)" -- "$cur"))
620 local cur
="${COMP_WORDS[COMP_CWORD]}"
621 local prv
="${COMP_WORDS[COMP_CWORD-1]}"
624 COMPREPLY
=($
(compgen
-W "$(__git_remotes)" -- "$cur"))
628 COMPREPLY
=($
(compgen
-W "$(__git_refs)" -- "$cur"))
632 local remote
="${prv#remote.}"
633 remote
="${remote%.fetch}"
634 COMPREPLY
=($
(compgen
-W "$(__git_refs_remotes "$remote")" \
639 local remote
="${prv#remote.}"
640 remote
="${remote%.push}"
641 COMPREPLY
=($
(compgen
-W "$(git --git-dir="$
(__gitdir
)" \
642 for-each-ref --format='%(refname):%(refname)' \
643 refs/heads)" -- "$cur"))
653 COMPREPLY
=($
(compgen
-W "
654 --global --list --replace-all
655 --get --get-all --get-regexp
661 local pfx
="${cur%.*}."
663 COMPREPLY
=($
(compgen
-P "$pfx" -W "remote merge" -- "$cur"))
667 local pfx
="${cur%.*}."
669 COMPREPLY
=($
(compgen
-P "$pfx" -S . \
670 -W "$(__git_heads)" -- "$cur"))
674 local pfx
="${cur%.*}."
676 COMPREPLY
=($
(compgen
-P "$pfx" -W "url fetch push" -- "$cur"))
680 local pfx
="${cur%.*}."
682 COMPREPLY
=($
(compgen
-P "$pfx" -S . \
683 -W "$(__git_remotes)" -- "$cur"))
687 COMPREPLY
=($
(compgen
-W "
692 core.preferSymlinkRefs
693 core.logAllRefUpdates
694 core.repositoryFormatVersion
695 core.sharedRepository
696 core.warnAmbiguousRefs
700 i18n.logOutputEncoding
719 http.lowSpeedLimit http.lowSpeedTime
722 repack.useDeltaBaseOffset
723 pull.octopus pull.twohead
726 receive.denyNonFastForwards
737 local cur
="${COMP_WORDS[COMP_CWORD]}"
738 local opt
="--mixed --hard --soft"
739 COMPREPLY
=($
(compgen
-W "$opt $(__git_refs)" -- "$cur"))
744 local cur
="${COMP_WORDS[COMP_CWORD]}"
747 COMPREPLY
=($
(compgen
-W "
748 oneline short medium full fuller email raw
749 " -- "${cur##--pretty=}"))
753 COMPREPLY
=($
(compgen
-W "--pretty=" -- "$cur"))
762 local i c
=1 command __git_dir
764 while [ $c -lt $COMP_CWORD ]; do
767 --git-dir=*) __git_dir
="${i#--git-dir=}" ;;
768 --bare) __git_dir
="." ;;
769 --version|
--help|
-p|
--paginate) ;;
770 *) command="$i"; break ;;
775 if [ $c -eq $COMP_CWORD -a -z "$command" ]; then
776 COMPREPLY
=($
(compgen
-W "
777 --git-dir= --version --exec-path
780 " -- "${COMP_WORDS[COMP_CWORD]}"))
784 local expansion
=$
(__git_aliased_command
"$command")
785 [ "$expansion" ] && command="$expansion"
790 branch
) _git_branch
;;
791 checkout
) _git_checkout
;;
792 cherry-pick
) _git_cherry_pick
;;
793 commit
) _git_commit
;;
794 config
) _git_config
;;
796 diff-tree
) _git_diff_tree
;;
798 format-patch
) _git_format_patch
;;
800 ls-remote
) _git_ls_remote
;;
801 ls-tree
) _git_ls_tree
;;
803 merge-base
) _git_merge_base
;;
804 name-rev
) _git_name_rev
;;
807 rebase
) _git_rebase
;;
808 repo-config
) _git_config
;;
811 show-branch
) _git_log
;;
812 whatchanged
) _git_log
;;
819 local cur
="${COMP_WORDS[COMP_CWORD]}"
820 COMPREPLY
=($
(compgen
-W "--all $(__git_refs)" -- "$cur"))
823 complete
-o default
-o nospace
-F _git git
824 complete
-o default
-F _gitk gitk
825 complete
-o default
-F _git_am git-am
826 complete
-o default
-F _git_apply git-apply
827 complete
-o default
-F _git_branch git-branch
828 complete
-o default
-F _git_checkout git-checkout
829 complete
-o default
-F _git_cherry_pick git-cherry-pick
830 complete
-o default
-F _git_commit git-commit
831 complete
-o default
-o nospace
-F _git_diff git-diff
832 complete
-o default
-F _git_diff_tree git-diff-tree
833 complete
-o default
-o nospace
-F _git_fetch git-fetch
834 complete
-o default
-o nospace
-F _git_format_patch git-format-patch
835 complete
-o default
-o nospace
-F _git_log git-log
836 complete
-o default
-F _git_ls_remote git-ls-remote
837 complete
-o default
-o nospace
-F _git_ls_tree git-ls-tree
838 complete
-o default
-F _git_merge git-merge
839 complete
-o default
-F _git_merge_base git-merge-base
840 complete
-o default
-F _git_name_rev git-name-rev
841 complete
-o default
-o nospace
-F _git_pull git-pull
842 complete
-o default
-o nospace
-F _git_push git-push
843 complete
-o default
-F _git_rebase git-rebase
844 complete
-o default
-F _git_config git-config
845 complete
-o default
-F _git_reset git-reset
846 complete
-o default
-o nospace
-F _git_show git-show
847 complete
-o default
-o nospace
-F _git_log git-show-branch
848 complete
-o default
-o nospace
-F _git_log git-whatchanged
850 # The following are necessary only for Cygwin, and only are needed
851 # when the user has tab-completed the executable name and consequently
852 # included the '.exe' suffix.
854 if [ Cygwin
= "$(uname -o 2>/dev/null)" ]; then
855 complete
-o default
-F _git_apply git-apply.exe
856 complete
-o default
-o nospace
-F _git git.exe
857 complete
-o default
-F _git_branch git-branch.exe
858 complete
-o default
-o nospace
-F _git_diff git-diff.exe
859 complete
-o default
-o nospace
-F _git_diff_tree git-diff-tree.exe
860 complete
-o default
-o nospace
-F _git_format_patch git-format-patch.exe
861 complete
-o default
-o nospace
-F _git_log git-log.exe
862 complete
-o default
-o nospace
-F _git_ls_tree git-ls-tree.exe
863 complete
-o default
-F _git_merge_base git-merge-base.exe
864 complete
-o default
-F _git_name_rev git-name-rev.exe
865 complete
-o default
-o nospace
-F _git_push git-push.exe
866 complete
-o default
-F _git_config git-config
867 complete
-o default
-o nospace
-F _git_show git-show.exe
868 complete
-o default
-o nospace
-F _git_log git-show-branch.exe
869 complete
-o default
-o nospace
-F _git_log git-whatchanged.exe