Skip to content

Instantly share code, notes, and snippets.

@reinvanoyen
Last active June 14, 2024 21:43
Show Gist options
  • Save reinvanoyen/05bcfe95ca9cb5041a4eafd29309ff29 to your computer and use it in GitHub Desktop.
Save reinvanoyen/05bcfe95ca9cb5041a4eafd29309ff29 to your computer and use it in GitHub Desktop.
Add Git Branch Name to Terminal Prompt (MacOS zsh)

Add Git Branch Name to Terminal Prompt (zsh)

Updated for MacOS with zsh

  • Catalina
  • Big Sur
  • Monterey
  • Ventura
  • Sonoma

screenshot

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

@RodrigoIbarraSanchez
Copy link

Thanks!

@jsohndata
Copy link

Thanks!!!

@reinvanoyen
Copy link
Author

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.

@DigitalSolomon
Copy link

Great stuff.

@trontrytel
Copy link

Thank you!

@silviomedice
Copy link

Thanks :)

@amalsalimz
Copy link

finally!! thanks

@chunshao90
Copy link

Thank you!!!

@jake-betplusev
Copy link

this is awesome :)

@Dayglor
Copy link

Dayglor commented May 23, 2023

Nice! Thank you!

@saintmalik
Copy link

thanks

@giedriusksd
Copy link

Thanks

@cmiller96
Copy link

Thank you!

@nicholaide
Copy link

Thank you

@daCFniel
Copy link

It's perfect, thank you :)

@symplytheo
Copy link

Gracias

@Ramizdo
Copy link

Ramizdo commented Oct 6, 2023

Funciona, gracias..

@vnguyen13
Copy link

Works wonderfully. Thank you!!

@devih-21
Copy link

helpful, thanks bro

@vasu2912
Copy link

Looks Clean !!!

@csarrvas
Copy link

Thanks!! 👍

@pychap
Copy link

pychap commented Dec 21, 2023

Thank you!

@z-coder-hub
Copy link

Thank you!

@emcfarlane
Copy link

Thank you!

@gideonokyere
Copy link

Thanks

@TrevorPawlewicz
Copy link

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

@beitomartinez
Copy link

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

@laptopmutia
Copy link

laptopmutia commented Mar 26, 2024

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

@luisf-av1
Copy link

It works great, thanks!

@jftuga
Copy link

jftuga commented Jun 14, 2024

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

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