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