Current Git branch name in command prompt

Since we started using Git branches as part of our dev workflow at work, it has become essential to always be sure that you’re working with the right branch. You can either always check git branch, or let the current branch name be displayed as part of the command line all the time when you’re inside a Git project. This is very convenient and helps you not to mess the things up.

There are several ways how to output the git branch name to the command line, and I’ll share the one I use and worked fine on all machines where I have tested it. I have originally found it on DeveloperZen.

If you’re working in Linux (I have tested with Ubuntu), just add the following code to .bashrc file in your home directory:

function parse_git_branch () {
  git branch 2> /dev/null | sed -e '/^[^*]/d' -e 's/* \(.*\)/ (\1)/'
}
 
RED="\[\033[0;31m\]"
YELLOW="\[\033[0;33m\]"
GREEN="\[\033[0;32m\]"
NO_COLOR="\[\033[0m\]"
 
PS1="$GREEN\u@\h$NO_COLOR:\w$YELLOW\$(parse_git_branch)$NO_COLOR\$ "

If you’re on Mac, you should put this code to .bash_profile in your home directory. For Windows you probably won’t need this because the “Git for Windows” command line interface handles this functionality by default.

The function parse_git_branch() could be replaced with predefined __git_ps1() normally available in bash, but this one didn’t work well on one of my colleagues computer (it did show the “master” branch name all the time, even if not in a git project). This snippet also adds some colors to your command prompt. How cool is that? 🙂

Leave a Reply

Your email address will not be published. Required fields are marked *