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. 88if[-z"${1-}"];then 89if[-n"${__git_dir-}"];then 90echo"$__git_dir" 91elif[-n"${GIT_DIR-}"];then 92test -d"${GIT_DIR-}"||return1 93echo"$GIT_DIR" 94elif[-d .git ];then 95echo .git 96else 97 git rev-parse --git-dir2>/dev/null 98fi 99elif[-d"$1/.git"];then 100echo"$1/.git" 101else 102echo"$1" 103fi 104} 105 106# stores the divergence from upstream in $p 107# used by GIT_PS1_SHOWUPSTREAM 108__git_ps1_show_upstream () 109{ 110local key value 111local svn_remote svn_url_pattern count n 112local upstream=git legacy="" verbose="" 113 114 svn_remote=() 115# get some config options from git-config 116local output="$(git config -z --get-regexp '^(svn-remote\..*\.url|bash\.showupstream)$' 2>/dev/null | tr '\0\n' '\n')" 117whileread -r key value;do 118case"$key"in 119 bash.showupstream) 120 GIT_PS1_SHOWUPSTREAM="$value" 121if[[-z"${GIT_PS1_SHOWUPSTREAM}"]];then 122 p="" 123return 124fi 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;; 131esac 132done<<<"$output" 133 134# parse configuration values 135for option in${GIT_PS1_SHOWUPSTREAM};do 136case"$option"in 137 git|svn) upstream="$option";; 138 verbose) verbose=1;; 139 legacy) legacy=1;; 140esac 141done 142 143# Find our upstream 144case"$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) 149local svn_upstream=($(git log --first-parent -1 \ 150--grep="^git-svn-id: \(${svn_url_pattern#??}\)"2>/dev/null)) 151if[[0-ne${#svn_upstream[@]}]];then 152 svn_upstream=${svn_upstream[ ${#svn_upstream[@]} - 2 ]} 153 svn_upstream=${svn_upstream%@*} 154local n_stop="${#svn_remote[@]}" 155for((n=1; n <= n_stop; n++));do 156 svn_upstream=${svn_upstream#${svn_remote[$n]}} 157done 158 159if[[-z"$svn_upstream"]];then 160# default branch name for checkouts with no layout: 161 upstream=${GIT_SVN_ID:-git-svn} 162else 163 upstream=${svn_upstream#/} 164fi 165elif[["svn+git"="$upstream"]];then 166 upstream="@{upstream}" 167fi 168;; 169esac 170 171# Find how many commits we are ahead/behind our upstream 172if[[-z"$legacy"]];then 173 count="$(git rev-list --count --left-right \ 174 "$upstream"...HEAD 2>/dev/null)" 175else 176# produce equivalent output to --count for older versions of git 177local commits 178if commits="$(git rev-list --left-right "$upstream"...HEAD 2>/dev/null)" 179then 180local commit behind=0 ahead=0 181for commit in$commits 182do 183case"$commit"in 184"<"*) ((behind++)) ;; 185*) ((ahead++)) ;; 186esac 187done 188 count="$behind$ahead" 189else 190 count="" 191fi 192fi 193 194# calculate the result 195if[[-z"$verbose"]];then 196case"$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="<>";; 207esac 208else 209case"$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% *}";; 220esac 221fi 222 223} 224 225 226# __git_ps1 accepts 0 or 1 arguments (i.e., format string) 227# when called from PS1 using command substitution 228# in this mode it prints text to add to bash PS1 prompt (includes branch name) 229# 230# __git_ps1 requires 2 or 3 arguments when called from PROMPT_COMMAND (pc) 231# in that case it _sets_ PS1. The arguments are parts of a PS1 string. 232# when two arguments are given, the first is prepended and the second appended 233# to the state string when assigned to PS1. 234# The optional third parameter will be used as printf format string to further 235# customize the output of the git-status string. 236# In this mode you can request colored hints using GIT_PS1_SHOWCOLORHINTS=true 237__git_ps1 () 238{ 239local pcmode=no 240local detached=no 241local ps1pc_start='\u@\h:\w ' 242local ps1pc_end='\$ ' 243local printf_format=' (%s)' 244 245case"$#"in 2462|3) pcmode=yes 247 ps1pc_start="$1" 248 ps1pc_end="$2" 249 printf_format="${3:-$printf_format}" 250;; 2510|1) printf_format="${1:-$printf_format}" 252;; 253*)return 254;; 255esac 256 257local g="$(__gitdir)" 258if[-z"$g"];then 259if[$pcmode=yes];then 260#In PC mode PS1 always needs to be set 261 PS1="$ps1pc_start$ps1pc_end" 262fi 263else 264local r="" 265local b="" 266if[-f"$g/rebase-merge/interactive"];then 267 r="|REBASE-i" 268 b="$(cat "$g/rebase-merge/head-name")" 269elif[-d"$g/rebase-merge"];then 270 r="|REBASE-m" 271 b="$(cat "$g/rebase-merge/head-name")" 272else 273if[-d"$g/rebase-apply"];then 274if[-f"$g/rebase-apply/rebasing"];then 275 r="|REBASE" 276elif[-f"$g/rebase-apply/applying"];then 277 r="|AM" 278else 279 r="|AM/REBASE" 280fi 281elif[-f"$g/MERGE_HEAD"];then 282 r="|MERGING" 283elif[-f"$g/CHERRY_PICK_HEAD"];then 284 r="|CHERRY-PICKING" 285elif[-f"$g/REVERT_HEAD"];then 286 r="|REVERTING" 287elif[-f"$g/BISECT_LOG"];then 288 r="|BISECTING" 289fi 290 291 b="$(git symbolic-ref HEAD 2>/dev/null)"|| { 292 detached=yes 293 b="$( 294 case "${GIT_PS1_DESCRIBE_STYLE-}" in 295 (contains) 296 git describe --contains HEAD ;; 297 (branch) 298 git describe --contains --all HEAD ;; 299 (describe) 300 git describe HEAD ;; 301 (* | default) 302 git describe --tags --exact-match HEAD ;; 303 esac 2>/dev/null)"|| 304 305 b="$(cut -c1-7 "$g/HEAD" 2>/dev/null)..."|| 306 b="unknown" 307 b="($b)" 308} 309fi 310 311local w="" 312local i="" 313local s="" 314local u="" 315local c="" 316local p="" 317 318if["true"="$(git rev-parse --is-inside-git-dir 2>/dev/null)"];then 319if["true"="$(git rev-parse --is-bare-repository 2>/dev/null)"];then 320 c="BARE:" 321else 322 b="GIT_DIR!" 323fi 324elif["true"="$(git rev-parse --is-inside-work-tree 2>/dev/null)"];then 325if[-n"${GIT_PS1_SHOWDIRTYSTATE-}"] && 326["$(git config --bool bash.showDirtyState)"!="false"] 327then 328 git diff--no-ext-diff --quiet --exit-code|| w="*" 329if git rev-parse --quiet --verify HEAD >/dev/null;then 330 git diff-index --cached --quiet HEAD --|| i="+" 331else 332 i="#" 333fi 334fi 335if[-n"${GIT_PS1_SHOWSTASHSTATE-}"];then 336 git rev-parse --verify refs/stash >/dev/null 2>&1&& s="$" 337fi 338 339if[-n"${GIT_PS1_SHOWUNTRACKEDFILES-}"] && 340["$(git config --bool bash.showUntrackedFiles)"!="false"] && 341[-n"$(git ls-files --others --exclude-standard)"] 342then 343 u="%${ZSH_VERSION+%}" 344fi 345 346if[-n"${GIT_PS1_SHOWUPSTREAM-}"];then 347 __git_ps1_show_upstream 348fi 349fi 350 351local f="$w$i$s$u" 352if[$pcmode=yes];then 353local gitstring= 354if[-n"${GIT_PS1_SHOWCOLORHINTS-}"];then 355local c_red='\e[31m' 356local c_green='\e[32m' 357local c_lblue='\e[1;34m' 358local c_clear='\e[0m' 359local bad_color=$c_red 360local ok_color=$c_green 361local branch_color="$c_clear" 362local flags_color="$c_lblue" 363local branchstring="$c${b##refs/heads/}" 364 365if[$detached= no ];then 366 branch_color="$ok_color" 367else 368 branch_color="$bad_color" 369fi 370 371# Setting gitstring directly with \[ and \] around colors 372# is necessary to prevent wrapping issues! 373 gitstring="\[$branch_color\]$branchstring\[$c_clear\]" 374 375if[-n"$w$i$s$u$r$p"];then 376 gitstring="$gitstring" 377fi 378if["$w"="*"];then 379 gitstring="$gitstring\[$bad_color\]$w" 380fi 381if[-n"$i"];then 382 gitstring="$gitstring\[$ok_color\]$i" 383fi 384if[-n"$s"];then 385 gitstring="$gitstring\[$flags_color\]$s" 386fi 387if[-n"$u"];then 388 gitstring="$gitstring\[$bad_color\]$u" 389fi 390 gitstring="$gitstring\[$c_clear\]$r$p" 391else 392 gitstring="$c${b##refs/heads/}${f:+ $f}$r$p" 393fi 394 gitstring=$(printf -- "$printf_format" "$gitstring") 395 PS1="$ps1pc_start$gitstring$ps1pc_end" 396else 397# NO color option unless in PROMPT_COMMAND mode 398printf --"$printf_format""$c${b##refs/heads/}${f:+ $f}$r$p" 399fi 400fi 401}