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