Add Git Branch Name to Terminal Prompt (Linux/Mac)

terminal-git-branch-name.md

Add Git Branch Name to Terminal Prompt (Linux/Mac)

Open ~/.bash_profile in your favorite editor and add the following content to the bottom.

# Git branch in prompt.

parse_git_branch() {
  git branch 2> /dev/null | sed -e '/^[^*]/d' -e 's/* \(.*\)/ (\1)/'
}

export PS1="\u@\h \W\[\033[32m\]\$(parse_git_branch)\[\033[00m\] $ "

By MARTIN FITZPATRICK at http://martinfitzpatrick.name/article/add-git-branch-name-to-terminal-prompt-mac/

Bonus for Fish shell users

If you are Fish shell user and you want speed up your Git workflow, try it out https://github.com/joseluisq/gitnow.

Thank you!

thanks!!! +1

parse_git_branch() {
  git branch 2> /dev/null | sed -e '/^[^*]/d' -e 's/* \(.*\)/ (\1)/'
# git branch 2>/dev/null | /usr/bin/grep '^*' | colrm 1 2)"
}

PS1_date="\[\033[38;5;237m\]\d\[$(tput sgr0)\]\[\033[38;5;15m\]"
PS1_time="\[$(tput sgr0)\]\[\033[38;5;236m\]\t\[$(tput sgr0)\]\[\033[38;5;15m\]"
PS1_wdir="\[$(tput sgr0)\]\[\033[38;5;24m\]\W"
PS1_gitbranch="\e[38;5;204m\]\$(parse_git_branch)"
PS1_gt="\[$(tput bold)\]\[$(tput sgr0)\]\[\e[38;5;214m\]>"
PS1_other="\[$(tput sgr0)\]\[$(tput sgr0)\]\[\e[38;5;15m\]"

export PS1="${PS1_date} ${PS1_time} ${PS1_wdir}${PS1_gitbranch}${PS1_gt}${PS1_other} \[$(tput sgr0)\]"

@testradav thanks for the script. now it looks so much better !
I don't quite understand the code, Im wondering though, how do I change the color of PS1_gitbranch to yellow for example ?

@joseluisq Thanks for this snippet. Worked!

https://gist.github.com/abdes-zakari/3eb232acd89ee697bf5d76d9862543d7

@hospino11 great!

I already got working git branch in PROMPT before upgrading to Monterey , after upgrading it suddenly gone

apparently I only need to pick parse_git_branch method and replace the old PROMPT

thank you :)

https://gist.github.com/abdes-zakari/3eb232acd89ee697bf5d76d9862543d7

Thanks! This worked for me. 🙏🏾

This does not work anymore on Mac Catilina 10.15.6 :(
Update : Kudos to is0xjh25 ... it is now working in Mac catilina ..
add in your ~/.zshrc file

function parse_git_branch() {
    git branch 2> /dev/null | sed -n -e 's/^\* \(.*\)/[\1]/p'
}

setopt PROMPT_SUBST
export PROMPT='%F{grey}%n%f %F{cyan}%~%f %F{green}$(parse_git_branch)%f %F{normal}$%f '

This worked for me! Catalina 10.15.7
Thanks @DhruboB

thanks a lot!! you saved me

Lovely, this was way easy to change colours :)

Thanks @DhruboB

https://gist.github.com/abdes-zakari/3eb232acd89ee697bf5d76d9862543d7

Thanks for sharing! this also worked for me.

+1

i wanna reference my https://gist.github.com/IDK9911/ec425bd83d3d2839c9884650a0dd1e8b
work as well.
If u wanna use an RPROMPT and uses zsh shell.

Thank you!

I experienced this one is the best:

export PS1='$(__git_ps1 " (%s)")'"$PS1"

Thanks this works.
But I noticed the branch name on the terminal does not automatically change when I change branch from Github Desktop.

Do I need an additional settings?

thanks

function parse_git_branch() {
git branch 2> /dev/null | sed -n -e 's/^* (.*)/[\1]/p'
}

COLOR_DEF=$'\e[0m'
COLOR_USR=$'\e[38;5;243m'
COLOR_DIR=$'\e[38;5;197m'
COLOR_GIT=$'\e[38;5;39m'
setopt PROMPT_SUBST
export PROMPT='${COLOR_USR}%n ${COLOR_DIR}%~ ${COLOR_GIT}$(parse_git_branch)${COLOR_DEF} $ '

Thanks... this worked for me on my mac for both iTerm and Terminal 👍👍

https://gist.github.com/abdes-zakari/3eb232acd89ee697bf5d76d9862543d7

This worked for me too. I'm using macOS 13.2.1. Thank you. 😃

https://gist.github.com/abdes-zakari/3eb232acd89ee697bf5d76d9862543d7

This worked for me too. I'm using macOS 13.2.1. Thank you. 😃

thanks!

I get an error : Badly Placed 's() while using this parse_git_function () in my Konsole terminal , can anyone please help me fix it ?

function parse_git_branch() {
git branch 2> /dev/null | sed -n -e 's/^* (.*)/[\1]/p'
}

setopt PROMPT_SUBST
export PROMPT='%F{grey}%n%f %F{cyan}%~%f %F{green}$(parse_git_branch)%f %F{normal}$%f '

This is right for me on MACOs 14.5

Nice. Excellent !

This does not work anymore on Mac Catilina 10.15.6 :(
Update : Kudos to is0xjh25 ... it is now working in Mac catilina ..
add in your ~/.zshrc file

function parse_git_branch() {
    git branch 2> /dev/null | sed -n -e 's/^\* \(.*\)/[\1]/p'
}

setopt PROMPT_SUBST
export PROMPT='%F{grey}%n%f %F{cyan}%~%f %F{green}$(parse_git_branch)%f %F{normal}$%f '

This worked for me! Catalina 10.15.7
Thanks @DhruboB

thanks a lot!! you saved me

Lovely, this was way easy to change colours :)

Hey man i am a complete beginner, i noticed my machines name disappeared, is there a way to bring it back? and i want to use hex code for the colors how do i do that? i tried replacing the color names but it didnt work.