1 # bash/zsh git prompt support
3 # Copyright (C) 2006,2007 Shawn O. Pearce <spearce@spearce.org>
4 # Distributed under the GNU General Public License, version 2.0.
6 # This script allows you to see repository status in your prompt.
10 # 1) Copy this file to somewhere (e.g. ~/.git-prompt.sh).
11 # 2) Add the following line to your .bashrc/.zshrc:
12 # source ~/.git-prompt.sh
13 # 3a) Change your PS1 to call __git_ps1 as
14 # command-substitution:
15 # Bash: PS1='[\u@\h \W$(__git_ps1 " (%s)")]\$ '
16 # ZSH: setopt PROMPT_SUBST ; PS1='[%n@%m %c$(__git_ps1 " (%s)")]\$ '
17 # the optional argument will be used as format string.
18 # 3b) Alternatively, for a slightly faster prompt, __git_ps1 can
19 # be used for PROMPT_COMMAND in Bash or for precmd() in Zsh
20 # with two parameters, <pre> and <post>, which are strings
21 # you would put in $PS1 before and after the status string
22 # generated by the git-prompt machinery. e.g.
23 # Bash: PROMPT_COMMAND='__git_ps1 "\u@\h:\w" "\\\$ "'
24 # will show username, at-sign, host, colon, cwd, then
25 # various status string, followed by dollar and SP, as
27 # ZSH: precmd () { __git_ps1 "%n" ":%~$ " "|%s" }
28 # will show username, pipe, then various status string,
29 # followed by colon, cwd, dollar and SP, as your prompt.
30 # Optionally, you can supply a third argument with a printf
31 # format string to finetune the output of the branch status
33 # The repository status will be displayed only if you are currently in a
34 # git repository. The %s token is the placeholder for the shown status.
36 # The prompt status always includes the current branch name.
38 # In addition, if you set GIT_PS1_SHOWDIRTYSTATE to a nonempty value,
39 # unstaged (*) and staged (+) changes will be shown next to the branch
40 # name. You can configure this per-repository with the
41 # bash.showDirtyState variable, which defaults to true once
42 # GIT_PS1_SHOWDIRTYSTATE is enabled.
44 # You can also see if currently something is stashed, by setting
45 # GIT_PS1_SHOWSTASHSTATE to a nonempty value. If something is stashed,
46 # then a '$' will be shown next to the branch name.
48 # If you would like to see if there're untracked files, then you can set
49 # GIT_PS1_SHOWUNTRACKEDFILES to a nonempty value. If there're untracked
50 # files, then a '%' will be shown next to the branch name. You can
51 # configure this per-repository with the bash.showUntrackedFiles
52 # variable, which defaults to true once GIT_PS1_SHOWUNTRACKEDFILES is
55 # If you would like to see the difference between HEAD and its upstream,
56 # set GIT_PS1_SHOWUPSTREAM="auto". A "<" indicates you are behind, ">"
57 # indicates you are ahead, "<>" indicates you have diverged and "="
58 # indicates that there is no difference. You can further control
59 # behaviour by setting GIT_PS1_SHOWUPSTREAM to a space-separated list
62 # verbose show number of commits ahead/behind (+/-) upstream
63 # name if verbose, then also show the upstream abbrev name
64 # legacy don't use the '--count' option available in recent
65 # versions of git-rev-list
66 # git always compare HEAD to @{upstream}
67 # svn always compare HEAD to your SVN upstream
69 # By default, __git_ps1 will compare HEAD to your SVN upstream if it can
70 # find one, or @{upstream} otherwise. Once you have set
71 # GIT_PS1_SHOWUPSTREAM, you can override it on a per-repository basis by
72 # setting the bash.showUpstream config variable.
74 # You can change the separator between the branch name and the above
75 # state symbols by setting GIT_PS1_STATESEPARATOR. The default separator
78 # When there is an in-progress operation such as a merge, rebase,
79 # revert, cherry-pick, or bisect, the prompt will include information
80 # related to the operation, often in the form "|<OPERATION-NAME>".
82 # When the repository has a sparse-checkout, a notification of the form
83 # "|SPARSE" will be included in the prompt. This can be shortened to a
84 # single '?' character by setting GIT_PS1_COMPRESSSPARSESTATE, or omitted
85 # by setting GIT_PS1_OMITSPARSESTATE.
87 # If you would like to see a notification on the prompt when there are
88 # unresolved conflicts, set GIT_PS1_SHOWCONFLICTSTATE to "yes". The
89 # prompt will include "|CONFLICT".
91 # If you would like to see more information about the identity of
92 # commits checked out as a detached HEAD, set GIT_PS1_DESCRIBE_STYLE
93 # to one of these values:
95 # contains relative to newer annotated tag (v1.6.3.2~35)
96 # branch relative to newer tag or branch (master~4)
97 # describe relative to older annotated tag (v1.6.3.1-13-gdd42c2f)
98 # tag relative to any older tag (v1.6.3.1-13-gdd42c2f)
99 # default exactly matching tag
101 # If you would like a colored hint about the current dirty state, set
102 # GIT_PS1_SHOWCOLORHINTS to a nonempty value. The colors are based on
103 # the colored output of "git status -sb" and are available only when
104 # using __git_ps1 for PROMPT_COMMAND or precmd in Bash,
105 # but always available in Zsh.
107 # If you would like __git_ps1 to do nothing in the case when the current
108 # directory is set up to be ignored by git, then set
109 # GIT_PS1_HIDE_IF_PWD_IGNORED to a nonempty value. Override this on the
110 # repository level by setting bash.hideIfPwdIgnored to "false".
112 # check whether printf supports -v
113 __git_printf_supports_v
=
114 printf -v __git_printf_supports_v
-- '%s' yes >/dev
/null
2>&1
116 # stores the divergence from upstream in $p
117 # used by GIT_PS1_SHOWUPSTREAM
118 __git_ps1_show_upstream
()
121 local svn_remote svn_url_pattern count n
122 local upstream_type
=git legacy
="" verbose
="" name
=""
125 # get some config options from git-config
126 local output
="$(git config -z --get-regexp '^(svn-remote\..*\.url|bash\.showupstream)$' 2>/dev/null | tr '\0\n' '\n ')"
127 while read -r key value
; do
130 GIT_PS1_SHOWUPSTREAM
="$value"
131 if [[ -z "${GIT_PS1_SHOWUPSTREAM}" ]]; then
137 svn_remote
[$
((${#svn_remote[@]} + 1))]="$value"
138 svn_url_pattern
="$svn_url_pattern\\|$value"
139 upstream_type
=svn
+git
# default upstream type is SVN if available, else git
144 # parse configuration values
146 for option
in ${GIT_PS1_SHOWUPSTREAM}; do
148 git|svn
) upstream_type
="$option" ;;
149 verbose
) verbose
=1 ;;
155 # Find our upstream type
156 case "$upstream_type" in
157 git
) upstream_type
="@{upstream}" ;;
159 # get the upstream from the "git-svn-id: ..." in a commit message
160 # (git-svn uses essentially the same procedure internally)
161 local -a svn_upstream
162 svn_upstream
=($
(git log
--first-parent -1 \
163 --grep="^git-svn-id: \(${svn_url_pattern#??}\)" 2>/dev
/null
))
164 if [[ 0 -ne ${#svn_upstream[@]} ]]; then
165 svn_upstream
=${svn_upstream[${#svn_upstream[@]} - 2]}
166 svn_upstream
=${svn_upstream%@*}
167 local n_stop
="${#svn_remote[@]}"
168 for ((n
=1; n
<= n_stop
; n
++)); do
169 svn_upstream
=${svn_upstream#${svn_remote[$n]}}
172 if [[ -z "$svn_upstream" ]]; then
173 # default branch name for checkouts with no layout:
174 upstream_type
=${GIT_SVN_ID:-git-svn}
176 upstream_type
=${svn_upstream#/}
178 elif [[ "svn+git" = "$upstream_type" ]]; then
179 upstream_type
="@{upstream}"
184 # Find how many commits we are ahead/behind our upstream
185 if [[ -z "$legacy" ]]; then
186 count
="$(git rev-list --count --left-right \
187 "$upstream_type"...HEAD 2>/dev/null)"
189 # produce equivalent output to --count for older versions of git
191 if commits
="$(git rev-list --left-right "$upstream_type"...HEAD 2>/dev/null)"
193 local commit behind
=0 ahead
=0
194 for commit
in $commits
197 "<"*) ((behind
++)) ;;
201 count
="$behind $ahead"
207 # calculate the result
208 if [[ -z "$verbose" ]]; then
212 "0 0") # equal to upstream
214 "0 "*) # ahead of upstream
216 *" 0") # behind upstream
218 *) # diverged from upstream
221 else # verbose, set upstream instead of p
225 "0 0") # equal to upstream
227 "0 "*) # ahead of upstream
228 upstream
="|u+${count#0 }" ;;
229 *" 0") # behind upstream
230 upstream
="|u-${count% 0}" ;;
231 *) # diverged from upstream
232 upstream
="|u+${count#* }-${count% *}" ;;
234 if [[ -n "$count" && -n "$name" ]]; then
235 __git_ps1_upstream_name
=$
(git rev-parse \
236 --abbrev-ref "$upstream_type" 2>/dev
/null
)
237 if [ $pcmode = yes ] && [ $ps1_expanded = yes ]; then
238 upstream
="$upstream \${__git_ps1_upstream_name}"
240 upstream
="$upstream ${__git_ps1_upstream_name}"
241 # not needed anymore; keep user's
243 unset __git_ps1_upstream_name
250 # Helper function that is meant to be called from __git_ps1. It
251 # injects color codes into the appropriate gitstring variables used
252 # to build a gitstring. Colored variables are responsible for clearing
254 __git_ps1_colorize_gitstring
()
256 if [[ -n ${ZSH_VERSION-} ]]; then
257 local c_red
='%F{red}'
258 local c_green
='%F{green}'
259 local c_lblue
='%F{blue}'
262 # Using \[ and \] around colors is necessary to prevent
263 # issues with command line editing/browsing/completion!
264 local c_red
='\[\e[31m\]'
265 local c_green
='\[\e[32m\]'
266 local c_lblue
='\[\e[1;34m\]'
267 local c_clear
='\[\e[0m\]'
269 local bad_color
=$c_red
270 local ok_color
=$c_green
271 local flags_color
="$c_lblue"
273 local branch_color
=""
274 if [ $detached = no
]; then
275 branch_color
="$ok_color"
277 branch_color
="$bad_color"
280 c
="$branch_color$c$c_clear"
282 b
="$branch_color$b$c_clear"
285 w
="$bad_color$w$c_clear"
288 i
="$ok_color$i$c_clear"
291 s
="$flags_color$s$c_clear"
294 u
="$bad_color$u$c_clear"
298 # Helper function to read the first line of a file into a variable.
299 # __git_eread requires 2 arguments, the file path and the name of the
300 # variable, in that order.
303 test -r "$1" && IFS
=$
'\r\n' read "$2" <"$1"
306 # see if a cherry-pick or revert is in progress, if the user has committed a
307 # conflict resolution with 'git commit' in the middle of a sequence of picks or
308 # reverts then CHERRY_PICK_HEAD/REVERT_HEAD will not exist so we have to read
310 __git_sequencer_status
()
313 if test -f "$g/CHERRY_PICK_HEAD"
317 elif test -f "$g/REVERT_HEAD"
321 elif __git_eread
"$g/sequencer/todo" todo
337 # __git_ps1 accepts 0 or 1 arguments (i.e., format string)
338 # when called from PS1 using command substitution
339 # in this mode it prints text to add to bash PS1 prompt (includes branch name)
341 # __git_ps1 requires 2 or 3 arguments when called from PROMPT_COMMAND (pc)
342 # in that case it _sets_ PS1. The arguments are parts of a PS1 string.
343 # when two arguments are given, the first is prepended and the second appended
344 # to the state string when assigned to PS1.
345 # The optional third parameter will be used as printf format string to further
346 # customize the output of the git-status string.
347 # In this mode you can request colored hints using GIT_PS1_SHOWCOLORHINTS=true
350 # preserve exit status
354 local ps1pc_start
='\u@\h:\w '
355 local ps1pc_end
='\$ '
356 local printf_format
=' (%s)'
362 printf_format
="${3:-$printf_format}"
363 # set PS1 to a plain prompt so that we can
364 # simply return early if the prompt should not
366 PS1
="$ps1pc_start$ps1pc_end"
368 0|
1) printf_format
="${1:-$printf_format}"
374 # ps1_expanded: This variable is set to 'yes' if the shell
375 # subjects the value of PS1 to parameter expansion:
377 # * bash does unless the promptvars option is disabled
378 # * zsh does not unless the PROMPT_SUBST option is set
379 # * POSIX shells always do
381 # If the shell would expand the contents of PS1 when drawing
382 # the prompt, a raw ref name must not be included in PS1.
383 # This protects the user from arbitrary code execution via
384 # specially crafted ref names. For example, a ref named
385 # 'refs/heads/$(IFS=_;cmd=sudo_rm_-rf_/;$cmd)' might cause the
386 # shell to execute 'sudo rm -rf /' when the prompt is drawn.
388 # Instead, the ref name should be placed in a separate global
389 # variable (in the __git_ps1_* namespace to avoid colliding
390 # with the user's environment) and that variable should be
391 # referenced from PS1. For example:
393 # __git_ps1_foo=$(do_something_to_get_ref_name)
394 # PS1="...stuff...\${__git_ps1_foo}...stuff..."
396 # If the shell does not expand the contents of PS1, the raw
397 # ref name must be included in PS1.
399 # The value of this variable is only relevant when in pcmode.
401 # Assume that the shell follows the POSIX specification and
402 # expands PS1 unless determined otherwise. (This is more
403 # likely to be correct if the user has a non-bash, non-zsh
404 # shell and safer than the alternative if the assumption is
407 local ps1_expanded
=yes
408 [ -z "${ZSH_VERSION-}" ] ||
[[ -o PROMPT_SUBST
]] || ps1_expanded
=no
409 [ -z "${BASH_VERSION-}" ] ||
shopt -q promptvars || ps1_expanded
=no
411 local repo_info rev_parse_exit_code
412 repo_info
="$(git rev-parse --git-dir --is-inside-git-dir \
413 --is-bare-repository --is-inside-work-tree \
414 --short HEAD 2>/dev/null)"
415 rev_parse_exit_code
="$?"
417 if [ -z "$repo_info" ]; then
422 if [ "$rev_parse_exit_code" = "0" ]; then
423 short_sha
="${repo_info##*$'\n'}"
424 repo_info
="${repo_info%$'\n'*}"
426 local inside_worktree
="${repo_info##*$'\n'}"
427 repo_info
="${repo_info%$'\n'*}"
428 local bare_repo
="${repo_info##*$'\n'}"
429 repo_info
="${repo_info%$'\n'*}"
430 local inside_gitdir
="${repo_info##*$'\n'}"
431 local g
="${repo_info%$'\n'*}"
433 if [ "true" = "$inside_worktree" ] &&
434 [ -n "${GIT_PS1_HIDE_IF_PWD_IGNORED-}" ] &&
435 [ "$(git config --bool bash.hideIfPwdIgnored)" != "false" ] &&
436 git check-ignore
-q .
442 if [ -z "${GIT_PS1_COMPRESSSPARSESTATE-}" ] &&
443 [ -z "${GIT_PS1_OMITSPARSESTATE-}" ] &&
444 [ "$(git config --bool core.sparseCheckout)" = "true" ]; then
452 if [ -d "$g/rebase-merge" ]; then
453 __git_eread
"$g/rebase-merge/head-name" b
454 __git_eread
"$g/rebase-merge/msgnum" step
455 __git_eread
"$g/rebase-merge/end" total
458 if [ -d "$g/rebase-apply" ]; then
459 __git_eread
"$g/rebase-apply/next" step
460 __git_eread
"$g/rebase-apply/last" total
461 if [ -f "$g/rebase-apply/rebasing" ]; then
462 __git_eread
"$g/rebase-apply/head-name" b
464 elif [ -f "$g/rebase-apply/applying" ]; then
469 elif [ -f "$g/MERGE_HEAD" ]; then
471 elif __git_sequencer_status
; then
473 elif [ -f "$g/BISECT_LOG" ]; then
479 elif [ -h "$g/HEAD" ]; then
480 # symlink symbolic ref
481 b
="$(git symbolic-ref HEAD 2>/dev/null)"
484 if ! __git_eread
"$g/HEAD" head; then
487 # is it a symbolic ref?
489 if [ "$head" = "$b" ]; then
492 case "${GIT_PS1_DESCRIBE_STYLE-}" in
494 git describe --contains HEAD ;;
496 git describe --contains --all HEAD ;;
498 git describe --tags HEAD ;;
502 git describe --tags --exact-match HEAD ;;
503 esac 2>/dev/null)" ||
511 if [ -n "$step" ] && [ -n "$total" ]; then
515 local conflict
="" # state indicator for unresolved conflicts
516 if [[ "${GIT_PS1_SHOWCONFLICTSTATE}" == "yes" ]] &&
517 [[ $
(git ls-files
--unmerged 2>/dev
/null
) ]]; then
527 local p
="" # short version of upstream state indicator
528 local upstream
="" # verbose version of upstream state indicator
530 if [ "true" = "$inside_gitdir" ]; then
531 if [ "true" = "$bare_repo" ]; then
536 elif [ "true" = "$inside_worktree" ]; then
537 if [ -n "${GIT_PS1_SHOWDIRTYSTATE-}" ] &&
538 [ "$(git config --bool bash.showDirtyState)" != "false" ]
540 git
diff --no-ext-diff --quiet || w
="*"
541 git
diff --no-ext-diff --cached --quiet || i
="+"
542 if [ -z "$short_sha" ] && [ -z "$i" ]; then
546 if [ -n "${GIT_PS1_SHOWSTASHSTATE-}" ] &&
547 git rev-parse
--verify --quiet refs
/stash
>/dev
/null
552 if [ -n "${GIT_PS1_SHOWUNTRACKEDFILES-}" ] &&
553 [ "$(git config --bool bash.showUntrackedFiles)" != "false" ] &&
554 git ls-files
--others --exclude-standard --directory --no-empty-directory --error-unmatch -- ':/*' >/dev
/null
2>/dev
/null
556 u
="%${ZSH_VERSION+%}"
559 if [ -n "${GIT_PS1_COMPRESSSPARSESTATE-}" ] &&
560 [ "$(git config --bool core.sparseCheckout)" = "true" ]; then
564 if [ -n "${GIT_PS1_SHOWUPSTREAM-}" ]; then
565 __git_ps1_show_upstream
569 local z
="${GIT_PS1_STATESEPARATOR-" "}"
572 if [ $pcmode = yes ] && [ $ps1_expanded = yes ]; then
573 __git_ps1_branch_name
=$b
574 b
="\${__git_ps1_branch_name}"
577 # NO color option unless in PROMPT_COMMAND mode or it's Zsh
578 if [ -n "${GIT_PS1_SHOWCOLORHINTS-}" ]; then
579 if [ $pcmode = yes ] ||
[ -n "${ZSH_VERSION-}" ]; then
580 __git_ps1_colorize_gitstring
584 local f
="$h$w$i$s$u$p"
585 local gitstring
="$c$b${f:+$z$f}${sparse}$r${upstream}${conflict}"
587 if [ $pcmode = yes ]; then
588 if [ "${__git_printf_supports_v-}" != yes ]; then
589 gitstring
=$
(printf -- "$printf_format" "$gitstring")
591 printf -v gitstring
-- "$printf_format" "$gitstring"
593 PS1
="$ps1pc_start$gitstring$ps1pc_end"
595 printf -- "$printf_format" "$gitstring"