Add Git Branch Name to Terminal Prompt (MacOS zsh)

terminal-prompt-git-branch-zsh.md

Add Git Branch Name to Terminal Prompt (zsh)

Updated for MacOS with zsh

• Catalina
• Big Sur
• Monterey
• Ventura
• Sonoma

Install

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

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

COLOR_DEF=$'%f'
COLOR_USR=$'%F{243}'
COLOR_DIR=$'%F{197}'
COLOR_GIT=$'%F{39}'
setopt PROMPT_SUBST
export PROMPT='${COLOR_USR}%n ${COLOR_DIR}%~ ${COLOR_GIT}$(parse_git_branch)${COLOR_DEF} $ '

Reload and apply adjustments

To reload and apply adjustments to the formatting use source ~/.zshrc in the zsh shell.

Credits

• Thank you benP2ER for the useful additions in his comment
• Original gist by Jose Quintana: Add Git Branch Name to Terminal Prompt (Linux/Mac)

Thanks :)

finally!! thanks

Thank you!!!

this is awesome :)

Nice! Thank you!

thanks

Thanks

Thank you!

Thank you

It's perfect, thank you :)

Gracias

Funciona, gracias..

Works wonderfully. Thank you!!

helpful, thanks bro

Looks Clean !!!

Thanks!! 👍

Thank you!

Thank you!

Thank you!

Thanks

This is exactly what I was looking for... thank you!

Simple and exactly what I was looking for... thanks!! 💯

but it adds unneccesary space when I opening the non git folder, could we do something about that?

the syntax to get the branch also could be simpler we could do this now

git branch --show-current

It works great, thanks!

I have a two line prompt:

• line 1: current directory [git branch]
• line 2: HH:MM:SS $

function parse_git_branch() {
    git branch 2> /dev/null | sed -n -e 's/^\* \(.*\)/[\1]/p'
}
COLOR_DEF=$'%f'
COLOR_DATE=$'%F{243}'
COLOR_DIR=$'%F{197}'
COLOR_GIT=$'%F{39}'
setopt PROMPT_SUBST
PROMPT_CWD='${COLOR_DIR}%~ ${COLOR_GIT}$(parse_git_branch)${COLOR_DEF}'
export NEWLINE=$'\n'
export PROMPT="${NEWLINE}${PROMPT_CWD}${NEWLINE}${COLOR_DATE}%D{%H:%M:%S}${COLOR_DEF} $ "

I don't need USER, so I changed COLOR_USER to COLOR_DATE.

Here is what it looks like, with the directory name in red, the branch in blue, and the date in faded gray:

~/go/src/github.com/jftuga/dtdiff [dev]
17:35:28 $ 

What I like about having the time:

• If I meant to time something, but forgot to, I have a built-in timer of sorts
• I can easily scroll back to see how long ago I ran a command

thanks!

Amazing, thanks !

Thank you.

This is great thanks!

Is there a way to make it change as i move directories/branches?
Scenario 1
I am on branch main the prompt shows my branch as main i switch to branch feature-X the prompt still shows I am on branch main

Scenario 2
Lets say I have 2 repositories repository A and repository B If I am on branch main in repository A and then run cd ../repository B and I am on feature-branch-X in that repository, then the prompt still shows I am on main which is not true. Is there a way to change this?

IDK if this is an issue that just I'm having or if its something I'm doing wrong etc.

Looks great. Thanks!