4 | # Distributed under the GNU General Public License, version 2.0.
5 | #
6 | # This script allows you to see repository status 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: 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, and , 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
26 | # your prompt.
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
32 | #
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.
35 | #
36 | # The prompt status always includes the current branch name.
37 | #
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.
43 | #
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.
47 | #
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
53 | # enabled.
54 | #
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
60 | # of values:
61 | #
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
68 | #
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.
73 | #
74 | # If you would like to see more information about the identity of
75 | # commits checked out as a detached HEAD, set GIT_PS1_DESCRIBE_STYLE
76 | # to one of these values:
77 | #
78 | # contains relative to newer annotated tag (v1.6.3.2~35)
79 | # branch relative to newer tag or branch (master~4)
80 | # describe relative to older annotated tag (v1.6.3.1-13-gdd42c2f)
81 | # default exactly matching tag
82 | #
83 | # If you would like a colored hint about the current dirty state, set
84 | # GIT_PS1_SHOWCOLORHINTS to a nonempty value. The colors are based on
85 | # the colored output of "git status -sb" and are available only when
86 | # using __git_ps1 for PROMPT_COMMAND or precmd.
87 |
88 | # check whether printf supports -v
89 | __git_printf_supports_v=
90 | printf -v __git_printf_supports_v -- '%s' yes >/dev/null 2>&1
91 |
92 | # stores the divergence from upstream in $p
93 | # used by GIT_PS1_SHOWUPSTREAM
94 | __git_ps1_show_upstream ()
95 | {
96 | local key value
97 | local svn_remote svn_url_pattern count n
98 | local upstream=git legacy="" verbose="" name=""
99 |
100 | svn_remote=()
101 | # get some config options from git-config
102 | local output="$(git config -z --get-regexp '^(svn-remote\..*\.url|bash\.showupstream)$' 2>/dev/null | tr '\0\n' '\n ')"
103 | while read -r key value; do
104 | case "$key" in
105 | bash.showupstream)
106 | GIT_PS1_SHOWUPSTREAM="$value"
107 | if [[ -z "${GIT_PS1_SHOWUPSTREAM}" ]]; then
108 | p=""
109 | return
110 | fi
111 | ;;
112 | svn-remote.*.url)
113 | svn_remote[$((${#svn_remote[@]} + 1))]="$value"
114 | svn_url_pattern="$svn_url_pattern\\|$value"
115 | upstream=svn+git # default upstream is SVN if available, else git
116 | ;;
117 | esac
118 | done <<< "$output"
119 |
120 | # parse configuration values
121 | for option in ${GIT_PS1_SHOWUPSTREAM}; do
122 | case "$option" in
123 | git|svn) upstream="$option" ;;
124 | verbose) verbose=1 ;;
125 | legacy) legacy=1 ;;
126 | name) name=1 ;;
127 | esac
128 | done
129 |
130 | # Find our upstream
131 | case "$upstream" in
132 | git) upstream="@{upstream}" ;;
133 | svn*)
134 | # get the upstream from the "git-svn-id: ..." in a commit message
135 | # (git-svn uses essentially the same procedure internally)
136 | local -a svn_upstream
137 | svn_upstream=($(git log --first-parent -1 \
138 | --grep="^git-svn-id: \(${svn_url_pattern#??}\)" 2>/dev/null))
139 | if [[ 0 -ne ${#svn_upstream[@]} ]]; then
140 | svn_upstream=${svn_upstream[${#svn_upstream[@]} - 2]}
141 | svn_upstream=${svn_upstream%@*}
142 | local n_stop="${#svn_remote[@]}"
143 | for ((n=1; n <= n_stop; n++)); do
144 | svn_upstream=${svn_upstream#${svn_remote[$n]}}
145 | done
146 |
147 | if [[ -z "$svn_upstream" ]]; then
148 | # default branch name for checkouts with no layout:
149 | upstream=${GIT_SVN_ID:-git-svn}
150 | else
151 | upstream=${svn_upstream#/}
152 | fi
153 | elif [[ "svn+git" = "$upstream" ]]; then
154 | upstream="@{upstream}"
155 | fi
156 | ;;
157 | esac
158 |
159 | # Find how many commits we are ahead/behind our upstream
160 | if [[ -z "$legacy" ]]; then
161 | count="$(git rev-list --count --left-right \
162 | "$upstream"...HEAD 2>/dev/null)"
163 | else
164 | # produce equivalent output to --count for older versions of git
165 | local commits
166 | if commits="$(git rev-list --left-right "$upstream"...HEAD 2>/dev/null)"
167 | then
168 | local commit behind=0 ahead=0
169 | for commit in $commits
170 | do
171 | case "$commit" in
172 | "<"*) ((behind++)) ;;
173 | *) ((ahead++)) ;;
174 | esac
175 | done
176 | count="$behind $ahead"
177 | else
178 | count=""
179 | fi
180 | fi
181 |
182 | # calculate the result
183 | if [[ -z "$verbose" ]]; then
184 | case "$count" in
185 | "") # no upstream
186 | p="" ;;
187 | "0 0") # equal to upstream
188 | p="=" ;;
189 | "0 "*) # ahead of upstream
190 | p=">" ;;
191 | *" 0") # behind upstream
192 | p="<" ;;
193 | *) # diverged from upstream
194 | p="<>" ;;
195 | esac
196 | else
197 | case "$count" in
198 | "") # no upstream
199 | p="" ;;
200 | "0 0") # equal to upstream
201 | p=" u=" ;;
202 | "0 "*) # ahead of upstream
203 | p=" u+${count#0 }" ;;
204 | *" 0") # behind upstream
205 | p=" u-${count% 0}" ;;
206 | *) # diverged from upstream
207 | p=" u+${count#* }-${count% *}" ;;
208 | esac
209 | if [[ -n "$count" && -n "$name" ]]; then
210 | __git_ps1_upstream_name=$(git rev-parse \
211 | --abbrev-ref "$upstream" 2>/dev/null)
212 | if [ $pcmode = yes ]; then
213 | # see the comments around the
214 | # __git_ps1_branch_name variable below
215 | p="$p \${__git_ps1_upstream_name}"
216 | else
217 | p="$p ${__git_ps1_upstream_name}"
218 | # not needed anymore; keep user's
219 | # environment clean
220 | unset __git_ps1_upstream_name
221 | fi
222 | fi
223 | fi
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 | {
232 | if [[ -n ${ZSH_VERSION-} ]]; then
233 | local c_red='%F{red}'
234 | local c_green='%F{green}'
235 | local c_lblue='%F{blue}'
236 | local c_clear='%f'
237 | else
238 | # Using \[ and \] around colors is necessary to prevent
239 | # issues with command line editing/browsing/completion!
240 | local c_red='\[\e[31m\]'
241 | local c_green='\[\e[32m\]'
242 | local c_lblue='\[\e[1;34m\]'
243 | local c_clear='\[\e[0m\]'
244 | fi
245 | local bad_color=$c_red
246 | local ok_color=$c_green
247 | local flags_color="$c_lblue"
248 |
249 | local branch_color=""
250 | if [ $detached = no ]; then
251 | branch_color="$ok_color"
252 | else
253 | branch_color="$bad_color"
254 | fi
255 | c="$branch_color$c"
256 |
257 | z="$c_clear$z"
258 | if [ "$w" = "*" ]; then
259 | w="$bad_color$w"
260 | fi
261 | if [ -n "$i" ]; then
262 | i="$ok_color$i"
263 | fi
264 | if [ -n "$s" ]; then
265 | s="$flags_color$s"
266 | fi
267 | if [ -n "$u" ]; then
268 | u="$bad_color$u"
269 | fi
270 | r="$c_clear$r"
271 | }
272 |
273 | __git_eread ()
274 | {
275 | f="$1"
276 | shift
277 | test -r "$f" && read "$@" <"$f"
278 | }
279 |
280 | # __git_ps1 accepts 0 or 1 arguments (i.e., format string)
281 | # when called from PS1 using command substitution
282 | # in this mode it prints text to add to bash PS1 prompt (includes branch name)
283 | #
284 | # __git_ps1 requires 2 or 3 arguments when called from PROMPT_COMMAND (pc)
285 | # in that case it _sets_ PS1. The arguments are parts of a PS1 string.
286 | # when two arguments are given, the first is prepended and the second appended
287 | # to the state string when assigned to PS1.
288 | # The optional third parameter will be used as printf format string to further
289 | # customize the output of the git-status string.
290 | # In this mode you can request colored hints using GIT_PS1_SHOWCOLORHINTS=true
291 | __git_ps1 ()
292 | {
293 | local pcmode=no
294 | local detached=no
295 | local ps1pc_start='\u@\h:\w '
296 | local ps1pc_end='\$ '
297 | local printf_format=' (%s)'
298 |
299 | case "$#" in
300 | 2|3) pcmode=yes
301 | ps1pc_start="$1"
302 | ps1pc_end="$2"
303 | printf_format="${3:-$printf_format}"
304 | ;;
305 | 0|1) printf_format="${1:-$printf_format}"
306 | ;;
307 | *) return
308 | ;;
309 | esac
310 |
311 | local repo_info rev_parse_exit_code
312 | repo_info="$(git rev-parse --git-dir --is-inside-git-dir \
313 | --is-bare-repository --is-inside-work-tree \
314 | --short HEAD 2>/dev/null)"
315 | rev_parse_exit_code="$?"
316 |
317 | if [ -z "$repo_info" ]; then
318 | if [ $pcmode = yes ]; then
319 | #In PC mode PS1 always needs to be set
320 | PS1="$ps1pc_start$ps1pc_end"
321 | fi
322 | return
323 | fi
324 |
325 | local short_sha
326 | if [ "$rev_parse_exit_code" = "0" ]; then
327 | short_sha="${repo_info##*$'\n'}"
328 | repo_info="${repo_info%$'\n'*}"
329 | fi
330 | local inside_worktree="${repo_info##*$'\n'}"
331 | repo_info="${repo_info%$'\n'*}"
332 | local bare_repo="${repo_info##*$'\n'}"
333 | repo_info="${repo_info%$'\n'*}"
334 | local inside_gitdir="${repo_info##*$'\n'}"
335 | local g="${repo_info%$'\n'*}"
336 |
337 | local r=""
338 | local b=""
339 | local step=""
340 | local total=""
341 | if [ -d "$g/rebase-merge" ]; then
342 | __git_eread "$g/rebase-merge/head-name" b
343 | __git_eread "$g/rebase-merge/msgnum" step
344 | __git_eread "$g/rebase-merge/end" total
345 | if [ -f "$g/rebase-merge/interactive" ]; then
346 | r="|REBASE-i"
347 | else
348 | r="|REBASE-m"
349 | fi
350 | else
351 | if [ -d "$g/rebase-apply" ]; then
352 | __git_eread "$g/rebase-apply/next" step
353 | __git_eread "$g/rebase-apply/last" total
354 | if [ -f "$g/rebase-apply/rebasing" ]; then
355 | __git_eread "$g/rebase-apply/head-name" b
356 | r="|REBASE"
357 | elif [ -f "$g/rebase-apply/applying" ]; then
358 | r="|AM"
359 | else
360 | r="|AM/REBASE"
361 | fi
362 | elif [ -f "$g/MERGE_HEAD" ]; then
363 | r="|MERGING"
364 | elif [ -f "$g/CHERRY_PICK_HEAD" ]; then
365 | r="|CHERRY-PICKING"
366 | elif [ -f "$g/REVERT_HEAD" ]; then
367 | r="|REVERTING"
368 | elif [ -f "$g/BISECT_LOG" ]; then
369 | r="|BISECTING"
370 | fi
371 |
372 | if [ -n "$b" ]; then
373 | :
374 | elif [ -h "$g/HEAD" ]; then
375 | # symlink symbolic ref
376 | b="$(git symbolic-ref HEAD 2>/dev/null)"
377 | else
378 | local head=""
379 | if ! __git_eread "$g/HEAD" head; then
380 | if [ $pcmode = yes ]; then
381 | PS1="$ps1pc_start$ps1pc_end"
382 | fi
383 | return
384 | fi
385 | # is it a symbolic ref?
386 | b="${head#ref: }"
387 | if [ "$head" = "$b" ]; then
388 | detached=yes
389 | b="$(
390 | case "${GIT_PS1_DESCRIBE_STYLE-}" in
391 | (contains)
392 | git describe --contains HEAD ;;
393 | (branch)
394 | git describe --contains --all HEAD ;;
395 | (describe)
396 | git describe HEAD ;;
397 | (* | default)
398 | git describe --tags --exact-match HEAD ;;
399 | esac 2>/dev/null)" ||
400 |
401 | b="$short_sha..."
402 | b="($b)"
403 | fi
404 | fi
405 | fi
406 |
407 | if [ -n "$step" ] && [ -n "$total" ]; then
408 | r="$r $step/$total"
409 | fi
410 |
411 | local w=""
412 | local i=""
413 | local s=""
414 | local u=""
415 | local c=""
416 | local p=""
417 |
418 | if [ "true" = "$inside_gitdir" ]; then
419 | if [ "true" = "$bare_repo" ]; then
420 | c="BARE:"
421 | else
422 | b="GIT_DIR!"
423 | fi
424 | elif [ "true" = "$inside_worktree" ]; then
425 | if [ -n "${GIT_PS1_SHOWDIRTYSTATE-}" ] &&
426 | [ "$(git config --bool bash.showDirtyState)" != "false" ]
427 | then
428 | git diff --no-ext-diff --quiet --exit-code || w="*"
429 | if [ -n "$short_sha" ]; then
430 | git diff-index --cached --quiet HEAD -- || i="+"
431 | else
432 | i="#"
433 | fi
434 | fi
435 | if [ -n "${GIT_PS1_SHOWSTASHSTATE-}" ] &&
436 | [ -r "$g/refs/stash" ]; then
437 | s="$"
438 | fi
439 |
440 | if [ -n "${GIT_PS1_SHOWUNTRACKEDFILES-}" ] &&
441 | [ "$(git config --bool bash.showUntrackedFiles)" != "false" ] &&
442 | git ls-files --others --exclude-standard --error-unmatch -- '*' >/dev/null 2>/dev/null
443 | then
444 | u="%${ZSH_VERSION+%}"
445 | fi
446 |
447 | if [ -n "${GIT_PS1_SHOWUPSTREAM-}" ]; then
448 | __git_ps1_show_upstream
449 | fi
450 | fi
451 |
452 | local z="${GIT_PS1_STATESEPARATOR-" "}"
453 |
454 | # NO color option unless in PROMPT_COMMAND mode
455 | if [ $pcmode = yes ] && [ -n "${GIT_PS1_SHOWCOLORHINTS-}" ]; then
456 | __git_ps1_colorize_gitstring
457 | fi
458 |
459 | b=${b##refs/heads/}
460 | if [ $pcmode = yes ]; then
461 | # In pcmode (and only pcmode) the contents of
462 | # $gitstring are subject to expansion by the shell.
463 | # Avoid putting the raw ref name in the prompt to
464 | # protect the user from arbitrary code execution via
465 | # specially crafted ref names (e.g., a ref named
466 | # '$(IFS=_;cmd=sudo_rm_-rf_/;$cmd)' would execute
467 | # 'sudo rm -rf /' when the prompt is drawn). Instead,
468 | # put the ref name in a new global variable (in the
469 | # __git_ps1_* namespace to avoid colliding with the
470 | # user's environment) and reference that variable from
471 | # PS1.
472 | __git_ps1_branch_name=$b
473 | # note that the $ is escaped -- the variable will be
474 | # expanded later (when it's time to draw the prompt)
475 | b="\${__git_ps1_branch_name}"
476 | fi
477 |
478 | local f="$w$i$s$u"
479 | local gitstring="$c$b${f:+$z$f}$r$p"
480 |
481 | if [ $pcmode = yes ]; then
482 | if [ "${__git_printf_supports_v-}" != yes ]; then
483 | gitstring=$(printf -- "$printf_format" "$gitstring")
484 | else
485 | printf -v gitstring -- "$printf_format" "$gitstring"
486 | fi
487 | PS1="$ps1pc_start$gitstring$ps1pc_end"
488 | else
489 | printf -- "$printf_format" "$gitstring"
490 | fi
491 | }
492 |
--------------------------------------------------------------------------------