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 for the script.
I ran into some issues on my system (macOS Monterey 12.0.1; zsh 5.8). When I autocomplete paths or use the arrow key to scroll through previous commands the formatting gets screwed up. Turns out the issues occur because of the ANSI color codes.

Solution:

The zsh shell has its own Prompt Expensions with visual effects. For colors you use %F and %f to escape the foreground color. (This also allows the usage of color aliases like %F{blue}This text is blue!%f)

Adjusted script:

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} $ '

Other Things:

To avoid non ascii characters causing this issue try wrapping them in a 'glitch' sequence which assumes everything inside is only one character long, like this: %{👌%G%}.

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

If you have a long working directory, you can shorten the path by only displaying the last n elements of the path. To display the last 2 elements replace %~ with %2~.

I also didn't want 2 spaces displayed, when the current working directory is not a repository so I adjusted the spacings:

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}%2~ ${COLOR_GIT}$(parse_git_branch)${COLOR_DEF}$ '

You could also shorten the script by removing the COLOR_... variables and using the extensions directly:

export PROMPT='%F{243}%n%f %F{197}%2~%f %F{39}$(parse_git_branch)%f$ '

Hope this maybe helps anyone with the same issues.

Works fine to me. Thanks a lot!

Thanks for the script. I ran into some issues on my system (macOS Monterey 12.0.1; zsh 5.8). When I autocomplete paths or use the arrow key to scroll through previous commands the formatting gets screwed up. Turns out the issues occur because of the ANSI color codes.

Solution:

The zsh shell has its own Prompt Extensions with visual effects. For colors you use %F and %f to escape the foreground color. (This also allows the usage of color aliases like %F{blue}This text is blue!%f)

Adjusted script:

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} $ '

Other Things:

To avoid non ascii characters causing this issue try wrapping them in a 'glitch' sequence which assumes everything inside is only one character long, like this: %{👌%G%}.

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

If you have a long working directory, you can shorten the path by only displaying the last n elements of the path. To display the last 2 elements replace %~ with %2~.

I also didn't want 2 spaces displayed, when the current working directory is not a repository so I adjusted the spacings:

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}%2~ ${COLOR_GIT}$(parse_git_branch)${COLOR_DEF}$ '

You could also shorten the script by removing the COLOR_... variables and using the extensions directly:

export PROMPT='%F{243}%n%f %F{197}%2~%f %F{39}$(parse_git_branch)%f$ '

Hope this maybe helps anyone with the same issues.

This was super helpful, ty

Lovely!, thank you.

Thanks for the script. I ran into some issues on my system (macOS Monterey 12.0.1; zsh 5.8). When I autocomplete paths or use the arrow key to scroll through previous commands the formatting gets screwed up. Turns out the issues occur because of the ANSI color codes.

Solution:

The zsh shell has its own Prompt Expensions with visual effects. For colors you use %F and %f to escape the foreground color. (This also allows the usage of color aliases like %F{blue}This text is blue!%f)

Adjusted script:

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} $ '

Other Things:

To avoid non ascii characters causing this issue try wrapping them in a 'glitch' sequence which assumes everything inside is only one character long, like this: %{👌%G%}.

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

If you have a long working directory, you can shorten the path by only displaying the last n elements of the path. To display the last 2 elements replace %~ with %2~.

I also didn't want 2 spaces displayed, when the current working directory is not a repository so I adjusted the spacings:

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}%2~ ${COLOR_GIT}$(parse_git_branch)${COLOR_DEF}$ '

You could also shorten the script by removing the COLOR_... variables and using the extensions directly:

export PROMPT='%F{243}%n%f %F{197}%2~%f %F{39}$(parse_git_branch)%f$ '

Hope this maybe helps anyone with the same issues.

Thank you!!

Thanks!

thanks

Thank you!

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

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

Thanks you

Thanks!

Thanks!!!

Thanks for the script. I ran into some issues on my system (macOS Monterey 12.0.1; zsh 5.8). When I autocomplete paths or use the arrow key to scroll through previous commands the formatting gets screwed up. Turns out the issues occur because of the ANSI color codes.

Solution:

The zsh shell has its own Prompt Expensions with visual effects. For colors you use %F and %f to escape the foreground color. (This also allows the usage of color aliases like %F{blue}This text is blue!%f)

Adjusted script:

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} $ '

Other Things:

To avoid non ascii characters causing this issue try wrapping them in a 'glitch' sequence which assumes everything inside is only one character long, like this: %{👌%G%}.

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

If you have a long working directory, you can shorten the path by only displaying the last n elements of the path. To display the last 2 elements replace %~ with %2~.

I also didn't want 2 spaces displayed, when the current working directory is not a repository so I adjusted the spacings:

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}%2~ ${COLOR_GIT}$(parse_git_branch)${COLOR_DEF}$ '

You could also shorten the script by removing the COLOR_... variables and using the extensions directly:

export PROMPT='%F{243}%n%f %F{197}%2~%f %F{39}$(parse_git_branch)%f$ '

Hope this maybe helps anyone with the same issues.

Thank you for your deep-dive comment. I updated the gist with your solution and linked your comment.

Great stuff.

Thank you!

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 !!!