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)

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!

That's great, thank you!
Just one issue: I have to run the source ~/.zshrc (in my case source ~/.zprofile) command each time I open a new terminal tab or window. Is there a way to run this automatically?

That's great, thank you! Just one issue: I have to run the source ~/.zshrc (in my case source ~/.zprofile) command each time I open a new terminal tab or window. Is there a way to run this automatically?

The ~/. zprofile file is only evaluated when you login to your mac user account. The . zshrc (environment for interactive shells) should be used for parameters like $PROMPT, aliases, functions, options, history variables and bind keymappings you would like to have in both login and interactive shells.

What's preventing you from using the .zshrc file?

That's great, thank you! Just one issue: I have to run the source ~/.zshrc (in my case source ~/.zprofile) command each time I open a new terminal tab or window. Is there a way to run this automatically?

The ~/. zprofile file is only evaluated when you login to your mac user account. The . zshrc (environment for interactive shells) should be used for parameters like $PROMPT, aliases, functions, options, history variables and bind keymappings you would like to have in both login and interactive shells.

What's preventing you from using the .zshrc file?

Thanks for the reply.
When I installed nvm via Homebrew, I got these 3 items created
.zprofile

.zsh_history

.zsh__sessions (folder)
I thought .zshrc would be one of them (It's been a while since last time I've done this for a new machine!), but since it wasn't there, I've done some research and found out that .zshrc and .zprofile should be the same: I guess they are not!

I'll try create a .zshrc manually then.

That is awesome

Nice! Worked for me. Thank you!

Thank you. I used your version for sometimes until I think I need some adjustment for git status so I created new gist.

Other can use as well or just copy git_status function to your zshrc file and change your exist prompt.
https://gist.github.com/ethaizone/232664a147258fb6a5b91ba2bf790f37

This is awesome, thanks.

thank you

Nice, clean and fast. Thanks!

actual git command that doesn't require extra parsing git rev-parse --abbrev-ref HEAD

Thx