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 local cur="${COMP_WORDS[COMP_CWORD]}"
423 __gitcomp "--edit --no-commit"
426 __gitcomp "$(__git_refs)"
433 local cur="${COMP_WORDS[COMP_CWORD]}"
437 --all --author= --signoff --verify --no-verify
438 --edit --amend --include --only
452 __gitcomp "$(__git_refs)"
457 local cur="${COMP_WORDS[COMP_CWORD]}"
459 case "${COMP_WORDS[0]},$COMP_CWORD" in
461 __gitcomp "$(__git_remotes)"
464 __gitcomp "$(__git_remotes)"
469 __gitcomp "$(__git_refs)" "" "${cur#*:}"
473 case "${COMP_WORDS[0]}" in
474 git-fetch) remote="${COMP_WORDS[1]}" ;;
475 git) remote="${COMP_WORDS[2]}" ;;
477 __gitcomp "$(__git_refs2 "$remote")"
486 local cur="${COMP_WORDS[COMP_CWORD]}"
490 --stdout --attach --thread
492 --numbered --start-number
496 --full-index --binary
501 __git_complete_revlist
506 __gitcomp "$(__git_remotes)"
516 local cur="${COMP_WORDS[COMP_CWORD]}"
520 oneline short medium full fuller email raw
521 " "" "${cur##--pretty=}"
526 --max-count= --max-age= --since= --after=
527 --min-age= --before= --until=
528 --root --not --topo-order --date-order
530 --abbrev-commit --abbrev=
532 --author= --committer= --grep=
534 --pretty= --name-status --name-only
539 __git_complete_revlist
544 local cur="${COMP_WORDS[COMP_CWORD]}"
545 case "${COMP_WORDS[COMP_CWORD-1]}" in
547 __gitcomp "$(__git_merge_strategies)"
552 __gitcomp "$(__git_merge_strategies)" "" "${cur##--strategy=}"
557 --no-commit --no-summary --squash --strategy
561 __gitcomp "$(__git_refs)"
566 __gitcomp "$(__git_refs)"
571 __gitcomp "--tags --all --stdin"
576 local cur="${COMP_WORDS[COMP_CWORD]}"
578 case "${COMP_WORDS[0]},$COMP_CWORD" in
580 __gitcomp "$(__git_remotes)"
583 __gitcomp "$(__git_remotes)"
587 case "${COMP_WORDS[0]}" in
588 git-pull) remote="${COMP_WORDS[1]}" ;;
589 git) remote="${COMP_WORDS[2]}" ;;
591 __gitcomp "$(__git_refs "$remote")"
598 local cur="${COMP_WORDS[COMP_CWORD]}"
600 case "${COMP_WORDS[0]},$COMP_CWORD" in
602 __gitcomp "$(__git_remotes)"
605 __gitcomp "$(__git_remotes)"
611 case "${COMP_WORDS[0]}" in
612 git-push) remote="${COMP_WORDS[1]}" ;;
613 git) remote="${COMP_WORDS[2]}" ;;
615 __gitcomp "$(__git_refs "$remote")" "" "${cur#*:}"
618 __gitcomp "$(__git_refs2)"
627 local cur="${COMP_WORDS[COMP_CWORD]}"
628 if [ -d .dotest ]; then
629 __gitcomp "--continue --skip --abort"
632 case "${COMP_WORDS[COMP_CWORD-1]}" in
634 __gitcomp "$(__git_merge_strategies)"
639 __gitcomp "$(__git_merge_strategies)" "" "${cur##--strategy=}"
643 __gitcomp "--onto --merge --strategy"
646 __gitcomp "$(__git_refs)"
651 local cur="${COMP_WORDS[COMP_CWORD]}"
652 local prv="${COMP_WORDS[COMP_CWORD-1]}"
655 __gitcomp "$(__git_remotes)"
659 __gitcomp "$(__git_refs)"
663 local remote="${prv#remote.}"
664 remote="${remote%.fetch}"
665 __gitcomp "$(__git_refs_remotes "$remote")"
669 local remote="${prv#remote.}"
670 remote="${remote%.push}"
671 __gitcomp "$(git --git-dir="$(__gitdir)" \
672 for-each-ref --format='%(refname):%(refname)' \
676 pull.twohead|pull.octopus)
677 __gitcomp "$(__git_merge_strategies)"
680 color.branch|color.diff|color.status)
681 __gitcomp "always never auto"
686 black red green yellow blue magenta cyan white
687 bold dim ul blink reverse
699 --global --list --replace-all
700 --get --get-all --get-regexp
706 local pfx="${cur%.*}."
708 __gitcomp "remote merge" "$pfx" "$cur"
712 local pfx="${cur%.*}."
714 __gitcomp "$(__git_heads)" "$pfx" "$cur" "."
718 local pfx="${cur%.*}."
720 __gitcomp "url fetch push" "$pfx" "$cur"
724 local pfx="${cur%.*}."
726 __gitcomp "$(__git_remotes)" "$pfx" "$cur" "."
735 core.preferSymlinkRefs
736 core.logAllRefUpdates
737 core.repositoryFormatVersion
738 core.sharedRepository
739 core.warnAmbiguousRefs
742 core.packedGitWindowSize
756 color.diff.whitespace
762 color.status.untracked
770 gc.reflogexpireunreachable
783 i18n.logOutputEncoding
790 repack.useDeltaBaseOffset
796 receive.denyNonFastForwards
807 local cur="${COMP_WORDS[COMP_CWORD]}"
810 __gitcomp "--mixed --hard --soft"
814 __gitcomp "$(__git_refs)"
819 local cur="${COMP_WORDS[COMP_CWORD]}"
823 oneline short medium full fuller email raw
824 " "" "${cur##--pretty=}"
828 __gitcomp "--pretty="
837 local i c=1 command __git_dir
839 while [ $c -lt $COMP_CWORD ]; do
842 --git-dir=*) __git_dir="${i#--git-dir=}" ;;
843 --bare) __git_dir="." ;;
844 --version|--help|-p|--paginate) ;;
845 *) command="$i"; break ;;
850 if [ $c -eq $COMP_CWORD -a -z "$command" ]; then
851 case "${COMP_WORDS[COMP_CWORD]}" in
852 --*=*) COMPREPLY=() ;;
853 --*) __gitcomp "--git-dir= --bare --version --exec-path" ;;
854 *) __gitcomp "$(__git_commands) $(__git_aliases)" ;;
859 local expansion=$(__git_aliased_command "$command")
860 [ "$expansion" ] && command="$expansion"
866 branch) _git_branch ;;
867 checkout) _git_checkout ;;
868 cherry-pick) _git_cherry_pick ;;
869 commit) _git_commit ;;
870 config) _git_config ;;
872 diff-tree) _git_diff_tree ;;
874 format-patch) _git_format_patch ;;
876 ls-remote) _git_ls_remote ;;
877 ls-tree) _git_ls_tree ;;
879 merge-base) _git_merge_base ;;
880 name-rev) _git_name_rev ;;
883 rebase) _git_rebase ;;
886 show-branch) _git_log ;;
887 whatchanged) _git_log ;;
894 local cur="${COMP_WORDS[COMP_CWORD]}"
897 __gitcomp "--not --all"
901 __gitcomp "$(__git_refs)"
904 complete -o default -o nospace -F _git git
905 complete -o default -o nospace -F _gitk gitk
906 complete -o default -o nospace -F _git_am git-am
907 complete -o default -o nospace -F _git_apply git-apply
908 complete -o default -o nospace -F _git_branch git-branch
909 complete -o default -o nospace -F _git_checkout git-checkout
910 complete -o default -o nospace -F _git_cherry_pick git-cherry-pick
911 complete -o default -o nospace -F _git_commit git-commit
912 complete -o default -o nospace -F _git_diff git-diff
913 complete -o default -o nospace -F _git_diff_tree git-diff-tree
914 complete -o default -o nospace -F _git_fetch git-fetch
915 complete -o default -o nospace -F _git_format_patch git-format-patch
916 complete -o default -o nospace -F _git_log git-log
917 complete -o default -o nospace -F _git_ls_remote git-ls-remote
918 complete -o default -o nospace -F _git_ls_tree git-ls-tree
919 complete -o default -o nospace -F _git_merge git-merge
920 complete -o default -o nospace -F _git_merge_base git-merge-base
921 complete -o default -o nospace -F _git_name_rev git-name-rev
922 complete -o default -o nospace -F _git_pull git-pull
923 complete -o default -o nospace -F _git_push git-push
924 complete -o default -o nospace -F _git_rebase git-rebase
925 complete -o default -o nospace -F _git_config git-config
926 complete -o default -o nospace -F _git_reset git-reset
927 complete -o default -o nospace -F _git_show git-show
928 complete -o default -o nospace -F _git_log git-show-branch
929 complete -o default -o nospace -F _git_log git-whatchanged
931 # The following are necessary only for Cygwin, and only are needed
932 # when the user has tab-completed the executable name and consequently
933 # included the '.exe' suffix.
935 if [ Cygwin = "$(uname -o 2>/dev/null)" ]; then
936 complete -o default -o nospace -F _git_add git-add.exe
937 complete -o default -o nospace -F _git_apply git-apply.exe
938 complete -o default -o nospace -F _git git.exe
939 complete -o default -o nospace -F _git_branch git-branch.exe
940 complete -o default -o nospace -F _git_diff git-diff.exe
941 complete -o default -o nospace -F _git_diff_tree git-diff-tree.exe
942 complete -o default -o nospace -F _git_format_patch git-format-patch.exe
943 complete -o default -o nospace -F _git_log git-log.exe
944 complete -o default -o nospace -F _git_ls_tree git-ls-tree.exe
945 complete -o default -o nospace -F _git_merge_base git-merge-base.exe
946 complete -o default -o nospace -F _git_name_rev git-name-rev.exe
947 complete -o default -o nospace -F _git_push git-push.exe
948 complete -o default -o nospace -F _git_config git-config
949 complete -o default -o nospace -F _git_show git-show.exe
950 complete -o default -o nospace -F _git_log git-show-branch.exe
951 complete -o default -o nospace -F _git_log git-whatchanged.exe