1# bash/zsh git prompt support 2# 3# Copyright (C) 2006,2007 Shawn O. Pearce <spearce@spearce.org> 4# Distributed under the GNU General Public License, version 2.0. 5# 6# This script allows you to see the current branch in your prompt. 7# 8# To enable: 9# 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: PS1='[%n@%m %c$(__git_ps1 " (%s)")]\$ ' 17# the optional argument will be used as format string. 18# 3b) Alternatively, if you are using bash, __git_ps1 can be 19# used for PROMPT_COMMAND with two parameters, <pre> and 20# <post>, which are strings you would put in $PS1 before 21# and after the status string generated by the git-prompt 22# machinery. e.g. 23# 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 26# your prompt. 27# Optionally, you can supply a third argument with a printf 28# format string to finetune the output of the branch status 29# 30# The argument to __git_ps1 will be displayed only if you are currently 31# in a git repository. The %s token will be the name of the current 32# branch. 33# 34# In addition, if you set GIT_PS1_SHOWDIRTYSTATE to a nonempty value, 35# unstaged (*) and staged (+) changes will be shown next to the branch 36# name. You can configure this per-repository with the 37# bash.showDirtyState variable, which defaults to true once 38# GIT_PS1_SHOWDIRTYSTATE is enabled. 39# 40# You can also see if currently something is stashed, by setting 41# GIT_PS1_SHOWSTASHSTATE to a nonempty value. If something is stashed, 42# then a '$' will be shown next to the branch name. 43# 44# If you would like to see if there're untracked files, then you can set 45# GIT_PS1_SHOWUNTRACKEDFILES to a nonempty value. If there're untracked 46# files, then a '%' will be shown next to the branch name. You can 47# configure this per-repository with the bash.showUntrackedFiles 48# variable, which defaults to true once GIT_PS1_SHOWUNTRACKEDFILES is 49# enabled. 50# 51# If you would like to see the difference between HEAD and its upstream, 52# set GIT_PS1_SHOWUPSTREAM="auto". A "<" indicates you are behind, ">" 53# indicates you are ahead, "<>" indicates you have diverged and "=" 54# indicates that there is no difference. You can further control 55# behaviour by setting GIT_PS1_SHOWUPSTREAM to a space-separated list 56# of values: 57# 58# verbose show number of commits ahead/behind (+/-) upstream 59# legacy don't use the '--count' option available in recent 60# versions of git-rev-list 61# git always compare HEAD to @{upstream} 62# svn always compare HEAD to your SVN upstream 63# 64# By default, __git_ps1 will compare HEAD to your SVN upstream if it can 65# find one, or @{upstream} otherwise. Once you have set 66# GIT_PS1_SHOWUPSTREAM, you can override it on a per-repository basis by 67# setting the bash.showUpstream config variable. 68# 69# If you would like to see more information about the identity of 70# commits checked out as a detached HEAD, set GIT_PS1_DESCRIBE_STYLE 71# to one of these values: 72# 73# contains relative to newer annotated tag (v1.6.3.2~35) 74# branch relative to newer tag or branch (master~4) 75# describe relative to older annotated tag (v1.6.3.1-13-gdd42c2f) 76# default exactly matching tag 77# 78# If you would like a colored hint about the current dirty state, set 79# GIT_PS1_SHOWCOLORHINTS to a nonempty value. The colors are based on 80# the colored output of "git status -sb". 81 82# __gitdir accepts 0 or 1 arguments (i.e., location) 83# returns location of .git repo 84__gitdir () 85{ 86 # Note: this function is duplicated in git-completion.bash 87 # When updating it, make sure you update the other one to match. 88 if [ -z "${1-}" ]; then 89 if [ -n "${__git_dir-}" ]; then 90 echo "$__git_dir" 91 elif [ -n "${GIT_DIR-}" ]; then 92 test -d "${GIT_DIR-}" || return 1 93 echo "$GIT_DIR" 94 elif [ -d .git ]; then 95 echo .git 96 else 97 git rev-parse --git-dir 2>/dev/null 98 fi 99 elif [ -d "$1/.git" ]; then 100 echo "$1/.git" 101 else 102 echo "$1" 103 fi 104} 105 106# stores the divergence from upstream in $p 107# used by GIT_PS1_SHOWUPSTREAM 108__git_ps1_show_upstream () 109{ 110 local key value 111 local svn_remote svn_url_pattern count n 112 local upstream=git legacy="" verbose="" 113 114 svn_remote=() 115 # get some config options from git-config 116 local output="$(git config -z --get-regexp '^(svn-remote\..*\.url|bash\.showupstream)$' 2>/dev/null | tr '\0\n' '\n ')" 117 while read -r key value; do 118 case "$key" in 119 bash.showupstream) 120 GIT_PS1_SHOWUPSTREAM="$value" 121 if [[ -z "${GIT_PS1_SHOWUPSTREAM}" ]]; then 122 p="" 123 return 124 fi 125 ;; 126 svn-remote.*.url) 127 svn_remote[ $((${#svn_remote[@]} + 1)) ]="$value" 128 svn_url_pattern+="\\|$value" 129 upstream=svn+git # default upstream is SVN if available, else git 130 ;; 131 esac 132 done <<< "$output" 133 134 # parse configuration values 135 for option in ${GIT_PS1_SHOWUPSTREAM}; do 136 case "$option" in 137 git|svn) upstream="$option" ;; 138 verbose) verbose=1 ;; 139 legacy) legacy=1 ;; 140 esac 141 done 142 143 # Find our upstream 144 case "$upstream" in 145 git) upstream="@{upstream}" ;; 146 svn*) 147 # get the upstream from the "git-svn-id: ..." in a commit message 148 # (git-svn uses essentially the same procedure internally) 149 local svn_upstream=($(git log --first-parent -1 \ 150 --grep="^git-svn-id: \(${svn_url_pattern#??}\)" 2>/dev/null)) 151 if [[ 0 -ne ${#svn_upstream[@]} ]]; then 152 svn_upstream=${svn_upstream[ ${#svn_upstream[@]} - 2 ]} 153 svn_upstream=${svn_upstream%@*} 154 local n_stop="${#svn_remote[@]}" 155 for ((n=1; n <= n_stop; n++)); do 156 svn_upstream=${svn_upstream#${svn_remote[$n]}} 157 done 158 159 if [[ -z "$svn_upstream" ]]; then 160 # default branch name for checkouts with no layout: 161 upstream=${GIT_SVN_ID:-git-svn} 162 else 163 upstream=${svn_upstream#/} 164 fi 165 elif [[ "svn+git" = "$upstream" ]]; then 166 upstream="@{upstream}" 167 fi 168 ;; 169 esac 170 171 # Find how many commits we are ahead/behind our upstream 172 if [[ -z "$legacy" ]]; then 173 count="$(git rev-list --count --left-right \ 174 "$upstream"...HEAD 2>/dev/null)" 175 else 176 # produce equivalent output to --count for older versions of git 177 local commits 178 if commits="$(git rev-list --left-right "$upstream"...HEAD 2>/dev/null)" 179 then 180 local commit behind=0 ahead=0 181 for commit in $commits 182 do 183 case "$commit" in 184 "<"*) ((behind++)) ;; 185 *) ((ahead++)) ;; 186 esac 187 done 188 count="$behind $ahead" 189 else 190 count="" 191 fi 192 fi 193 194 # calculate the result 195 if [[ -z "$verbose" ]]; then 196 case "$count" in 197 "") # no upstream 198 p="" ;; 199 "0 0") # equal to upstream 200 p="=" ;; 201 "0 "*) # ahead of upstream 202 p=">" ;; 203 *" 0") # behind upstream 204 p="<" ;; 205 *) # diverged from upstream 206 p="<>" ;; 207 esac 208 else 209 case "$count" in 210 "") # no upstream 211 p="" ;; 212 "0 0") # equal to upstream 213 p=" u=" ;; 214 "0 "*) # ahead of upstream 215 p=" u+${count#0 }" ;; 216 *" 0") # behind upstream 217 p=" u-${count% 0}" ;; 218 *) # diverged from upstream 219 p=" u+${count#* }-${count% *}" ;; 220 esac 221 fi 222 223} 224 225# Helper function that is meant to be called from __git_ps1. It 226# builds up a gitstring injecting color codes into the appropriate 227# places. 228__git_ps1_colorize_gitstring () 229{ 230 local c_red='\e[31m' 231 local c_green='\e[32m' 232 local c_lblue='\e[1;34m' 233 local c_clear='\e[0m' 234 local bad_color=$c_red 235 local ok_color=$c_green 236 local branch_color="$c_clear" 237 local flags_color="$c_lblue" 238 local branchstring="$c${b##refs/heads/}" 239 240 if [ $detached = no ]; then 241 branch_color="$ok_color" 242 else 243 branch_color="$bad_color" 244 fi 245 246 # Setting gitstring directly with \[ and \] around colors 247 # is necessary to prevent wrapping issues! 248 gitstring="\[$branch_color\]$branchstring\[$c_clear\]" 249 250 if [ -n "$w$i$s$u$r$p" ]; then 251 gitstring="$gitstring$z" 252 fi 253 if [ "$w" = "*" ]; then 254 gitstring="$gitstring\[$bad_color\]$w" 255 fi 256 if [ -n "$i" ]; then 257 gitstring="$gitstring\[$ok_color\]$i" 258 fi 259 if [ -n "$s" ]; then 260 gitstring="$gitstring\[$flags_color\]$s" 261 fi 262 if [ -n "$u" ]; then 263 gitstring="$gitstring\[$bad_color\]$u" 264 fi 265 gitstring="$gitstring\[$c_clear\]$r$p" 266} 267 268# __git_ps1 accepts 0 or 1 arguments (i.e., format string) 269# when called from PS1 using command substitution 270# in this mode it prints text to add to bash PS1 prompt (includes branch name) 271# 272# __git_ps1 requires 2 or 3 arguments when called from PROMPT_COMMAND (pc) 273# in that case it _sets_ PS1. The arguments are parts of a PS1 string. 274# when two arguments are given, the first is prepended and the second appended 275# to the state string when assigned to PS1. 276# The optional third parameter will be used as printf format string to further 277# customize the output of the git-status string. 278# In this mode you can request colored hints using GIT_PS1_SHOWCOLORHINTS=true 279__git_ps1 () 280{ 281 local pcmode=no 282 local detached=no 283 local ps1pc_start='\u@\h:\w ' 284 local ps1pc_end='\$ ' 285 local printf_format=' (%s)' 286 287 case "$#" in 288 2|3) pcmode=yes 289 ps1pc_start="$1" 290 ps1pc_end="$2" 291 printf_format="${3:-$printf_format}" 292 ;; 293 0|1) printf_format="${1:-$printf_format}" 294 ;; 295 *) return 296 ;; 297 esac 298 299 local g="$(__gitdir)" 300 if [ -z "$g" ]; then 301 if [ $pcmode = yes ]; then 302 #In PC mode PS1 always needs to be set 303 PS1="$ps1pc_start$ps1pc_end" 304 fi 305 else 306 local r="" 307 local b="" 308 local step="" 309 local total="" 310 if [ -d "$g/rebase-merge" ]; then 311 b="$(cat "$g/rebase-merge/head-name")" 312 step=$(cat "$g/rebase-merge/msgnum") 313 total=$(cat "$g/rebase-merge/end") 314 if [ -f "$g/rebase-merge/interactive" ]; then 315 r="|REBASE-i" 316 else 317 r="|REBASE-m" 318 fi 319 else 320 if [ -d "$g/rebase-apply" ]; then 321 step=$(cat "$g/rebase-apply/next") 322 total=$(cat "$g/rebase-apply/last") 323 if [ -f "$g/rebase-apply/rebasing" ]; then 324 r="|REBASE" 325 elif [ -f "$g/rebase-apply/applying" ]; then 326 r="|AM" 327 else 328 r="|AM/REBASE" 329 fi 330 elif [ -f "$g/MERGE_HEAD" ]; then 331 r="|MERGING" 332 elif [ -f "$g/CHERRY_PICK_HEAD" ]; then 333 r="|CHERRY-PICKING" 334 elif [ -f "$g/REVERT_HEAD" ]; then 335 r="|REVERTING" 336 elif [ -f "$g/BISECT_LOG" ]; then 337 r="|BISECTING" 338 fi 339 340 b="$(git symbolic-ref HEAD 2>/dev/null)" || { 341 detached=yes 342 b="$( 343 case "${GIT_PS1_DESCRIBE_STYLE-}" in 344 (contains) 345 git describe --contains HEAD ;; 346 (branch) 347 git describe --contains --all HEAD ;; 348 (describe) 349 git describe HEAD ;; 350 (* | default) 351 git describe --tags --exact-match HEAD ;; 352 esac 2>/dev/null)" || 353 354 b="$(cut -c1-7 "$g/HEAD" 2>/dev/null)..." || 355 b="unknown" 356 b="($b)" 357 } 358 fi 359 360 if [ -n "$step" ] && [ -n "$total" ]; then 361 r="$r $step/$total" 362 fi 363 364 local w="" 365 local i="" 366 local s="" 367 local u="" 368 local c="" 369 local p="" 370 371 if [ "true" = "$(git rev-parse --is-inside-git-dir 2>/dev/null)" ]; then 372 if [ "true" = "$(git rev-parse --is-bare-repository 2>/dev/null)" ]; then 373 c="BARE:" 374 else 375 b="GIT_DIR!" 376 fi 377 elif [ "true" = "$(git rev-parse --is-inside-work-tree 2>/dev/null)" ]; then 378 if [ -n "${GIT_PS1_SHOWDIRTYSTATE-}" ] && 379 [ "$(git config --bool bash.showDirtyState)" != "false" ] 380 then 381 git diff --no-ext-diff --quiet --exit-code || w="*" 382 if git rev-parse --quiet --verify HEAD >/dev/null; then 383 git diff-index --cached --quiet HEAD -- || i="+" 384 else 385 i="#" 386 fi 387 fi 388 if [ -n "${GIT_PS1_SHOWSTASHSTATE-}" ]; then 389 git rev-parse --verify refs/stash >/dev/null 2>&1 && s="$" 390 fi 391 392 if [ -n "${GIT_PS1_SHOWUNTRACKEDFILES-}" ] && 393 [ "$(git config --bool bash.showUntrackedFiles)" != "false" ] && 394 [ -n "$(git ls-files --others --exclude-standard)" ] 395 then 396 u="%${ZSH_VERSION+%}" 397 fi 398 399 if [ -n "${GIT_PS1_SHOWUPSTREAM-}" ]; then 400 __git_ps1_show_upstream 401 fi 402 fi 403 404 local z="${GIT_PS1_STATESEPARATOR-" "}" 405 local f="$w$i$s$u" 406 if [ $pcmode = yes ]; then 407 local gitstring= 408 if [ -n "${GIT_PS1_SHOWCOLORHINTS-}" ]; then 409 __git_ps1_colorize_gitstring 410 else 411 gitstring="$c${b##refs/heads/}${f:+$z$f}$r$p" 412 fi 413 gitstring=$(printf -- "$printf_format" "$gitstring") 414 PS1="$ps1pc_start$gitstring$ps1pc_end" 415 else 416 # NO color option unless in PROMPT_COMMAND mode 417 printf -- "$printf_format" "$c${b##refs/heads/}${f:+$z$f}$r$p" 418 fi 419 fi 420}