Create a gist now

Instantly share code, notes, and snippets.

What would you like to do?
Set color bash prompt according to git/svn branch, and return status of last command.
#!/bin/bash
#
# DESCRIPTION:
#
# Set the bash prompt according to:
# * the branch/status of the current git repository
# * the branch of the current subversion repository
# * the return value of the previous command
#
# USAGE:
#
# 1. Save this file as ~/.git_svn_bash_prompt
# 2. Add the following line to the end of your ~/.profile or ~/.bash_profile:
# . ~/.git_svn_bash_prompt
#
# AUTHOR:
#
# Scott Woods <scott@westarete.com>
# West Arete Computing
#
# Based on work by halbtuerke and lakiolen.
#
# http://gist.github.com/31967
# The various escape codes that we can use to color our prompt.
RED="\[\033[0;31m\]"
YELLOW="\[\033[0;33m\]"
GREEN="\[\033[0;32m\]"
BLUE="\[\033[0;34m\]"
LIGHT_RED="\[\033[1;31m\]"
LIGHT_GREEN="\[\033[1;32m\]"
WHITE="\[\033[1;37m\]"
LIGHT_GRAY="\[\033[0;37m\]"
COLOR_NONE="\[\e[0m\]"
# Detect whether the current directory is a git repository.
function is_git_repository {
git branch > /dev/null 2>&1
}
# Detect whether the current directory is a subversion repository.
function is_svn_repository {
test -d .svn
}
# Determine the branch/state information for this git repository.
function set_git_branch {
# Capture the output of the "git status" command.
git_status="$(git status 2> /dev/null)"
# Set color based on clean/staged/dirty.
if [[ ${git_status} =~ "working directory clean" ]]; then
state="${GREEN}"
elif [[ ${git_status} =~ "Changes to be committed" ]]; then
state="${YELLOW}"
else
state="${RED}"
fi
# Set arrow icon based on status against remote.
remote_pattern="# Your branch is (.*) of"
if [[ ${git_status} =~ ${remote_pattern} ]]; then
if [[ ${BASH_REMATCH[1]} == "ahead" ]]; then
remote=""
else
remote=""
fi
else
remote=""
fi
diverge_pattern="# Your branch and (.*) have diverged"
if [[ ${git_status} =~ ${diverge_pattern} ]]; then
remote=""
fi
# Get the name of the branch.
branch_pattern="^# On branch ([^${IFS}]*)"
if [[ ${git_status} =~ ${branch_pattern} ]]; then
branch=${BASH_REMATCH[1]}
fi
# Set the final branch string.
BRANCH="${state}(${branch})${remote}${COLOR_NONE} "
}
# Determine the branch information for this subversion repository. No support
# for svn status, since that needs to hit the remote repository.
function set_svn_branch {
# Capture the output of the "git status" command.
svn_info="$(svn info | egrep '^URL: ' 2> /dev/null)"
# Get the name of the branch.
branch_pattern="^URL: .*/(branches|tags)/([^/]+)"
trunk_pattern="^URL: .*/trunk(/.*)?$"
if [[ ${svn_info} =~ $branch_pattern ]]; then
branch=${BASH_REMATCH[2]}
elif [[ ${svn_info} =~ $trunk_pattern ]]; then
branch='trunk'
fi
# Set the final branch string.
BRANCH="(${branch}) "
}
# Return the prompt symbol to use, colorized based on the return value of the
# previous command.
function set_prompt_symbol () {
if test $1 -eq 0 ; then
PROMPT_SYMBOL="\$"
else
PROMPT_SYMBOL="${RED}\$${COLOR_NONE}"
fi
}
# Set the full bash prompt.
function set_bash_prompt () {
# Set the PROMPT_SYMBOL variable. We do this first so we don't lose the
# return value of the last command.
set_prompt_symbol $?
# Set the BRANCH variable.
if is_git_repository ; then
set_git_branch
elif is_svn_repository ; then
set_svn_branch
else
BRANCH=''
fi
# Set the bash prompt variable.
PS1="\u@\h \w ${BRANCH}${PROMPT_SYMBOL} "
}
# Tell bash to execute this function just before displaying its prompt.
PROMPT_COMMAND=set_bash_prompt
@cybernetlab

This comment has been minimized.

Show comment Hide comment
@cybernetlab

cybernetlab Mar 31, 2014

Good stuff. One remark is to place LANG=en in line #50 for more compatibility like this:

git_status="$(LANG=en git status 2> /dev/null)"

Because, if user have local version of git (for me it's russian), it returns localized output that doesn't recognized by subsecquent conditions

Good stuff. One remark is to place LANG=en in line #50 for more compatibility like this:

git_status="$(LANG=en git status 2> /dev/null)"

Because, if user have local version of git (for me it's russian), it returns localized output that doesn't recognized by subsecquent conditions

@ogryzek

This comment has been minimized.

Show comment Hide comment
@ogryzek

ogryzek May 6, 2014

This is a nice share, thanks!

I had to change line 84 to use (git rev-parse --abbrev-ref HEAD) to get the branch name to display, using git version 1.9.1:

BRANCH="${state}$(git rev-parse --abbrev-ref HEAD)${remote}${COLOR_NONE} "

ogryzek commented May 6, 2014

This is a nice share, thanks!

I had to change line 84 to use (git rev-parse --abbrev-ref HEAD) to get the branch name to display, using git version 1.9.1:

BRANCH="${state}$(git rev-parse --abbrev-ref HEAD)${remote}${COLOR_NONE} "
@dpwrussell

This comment has been minimized.

Show comment Hide comment
@dpwrussell

dpwrussell Jun 23, 2014

Just a heads up, Git 2.0 breaks this. Easily fixed while maintaining backwards compatability by removing the '# ' from the regex.

Just a heads up, Git 2.0 breaks this. Easily fixed while maintaining backwards compatability by removing the '# ' from the regex.

@asterix24

This comment has been minimized.

Show comment Hide comment
@asterix24

asterix24 Sep 30, 2014

I seen on systems that have localized output message, this line could fail return empty string:

branch_pattern="^(# )?On branch ([^${IFS}]*)"

so possible fix for this issue could be:

branch_pattern="^(# )?[a-zA-Z]+ branch ([^${IFS}]*)"

I seen on systems that have localized output message, this line could fail return empty string:

branch_pattern="^(# )?On branch ([^${IFS}]*)"

so possible fix for this issue could be:

branch_pattern="^(# )?[a-zA-Z]+ branch ([^${IFS}]*)"

@gabrielpugliese-luizalabs

This comment has been minimized.

Show comment Hide comment
@gabrielpugliese-luizalabs

gabrielpugliese-luizalabs Oct 6, 2014

Well I tried many things that you guys said, but the easier one is to change the line 80:
branch=${BASH_REMATCH[1]}
to
branch=${BASH_REMATCH[2]}

Well I tried many things that you guys said, but the easier one is to change the line 80:
branch=${BASH_REMATCH[1]}
to
branch=${BASH_REMATCH[2]}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment