Skip to content

Instantly share code, notes, and snippets.

@vemarav
Forked from eliotsykes/git-aware-bash-prompt.md
Created January 2, 2021 07:00
Show Gist options
  • Save vemarav/113a0236b1a419cdd66b50cbcdd3d17e to your computer and use it in GitHub Desktop.
Save vemarav/113a0236b1a419cdd66b50cbcdd3d17e to your computer and use it in GitHub Desktop.
Git Aware Bash Prompt

In Terminal

mkdir ~/.bash

Copy the raw git-prompt.sh file from git contrib in to the ~/.bash directory: https://github.com/git/git/blob/master/contrib/completion/git-prompt.sh

Inside ~/.bashrc or ~/.bash_profile (choose the file where you normally put any bash customizations/setup), add the lines:

source ~/.bash/git-prompt.sh # Show git branch name at command prompt
export GIT_PS1_SHOWCOLORHINTS=true # Option for git-prompt.sh to show branch name in color

# Terminal Prompt:
# Include git branch, use PROMPT_COMMAND (not PS1) to get color output (see git-prompt.sh for more)
export PROMPT_COMMAND='__git_ps1 "\w" "\n\\\$ "' # Git branch (relies on git-prompt.sh)

As long as you're inside a git repo, your Bash prompt should now show the current git branch in color signifying if its got uncommitted changes.

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