Skip to content

Instantly share code, notes, and snippets.

@romanlevin
Forked from insin/bash_prompt.sh
Last active May 25, 2022 02:35
Show Gist options
  • Save romanlevin/5e9422045bb6a5eb6558cbe371cd8635 to your computer and use it in GitHub Desktop.
Save romanlevin/5e9422045bb6a5eb6558cbe371cd8635 to your computer and use it in GitHub Desktop.
Set color bash prompt according to active pyenv, git branch and return status of last command.
#!/bin/bash
#
# DESCRIPTION:
#
# Set the bash prompt according to:
# * the active virtualenv
# * the branch/status of the current git repository
# * the return value of the previous command
# * the fact you just came from Windows and are used to having newlines in
# your prompts.
#
# USAGE:
#
# 1. Save this file as ~/.bash_prompt
# 2. Add the following line to the end of your ~/.bashrc or ~/.bash_profile:
# . ~/.bash_prompt
#
# LINEAGE:
#
# Based on work by woods
#
# https://gist.github.com/31967
# The various escape codes that we can use to color our prompt.
RED="\[\033[0;31m\]"
YELLOW="\[\033[1;33m\]"
GREEN="\[\033[0;32m\]"
BLUE="\[\033[1;34m\]"
LIGHT_RED="\[\033[1;31m\]"
LIGHT_GREEN="\[\033[1;32m\]"
WHITE="\[\033[1;37m\]"
LIGHT_GRAY="\[\033[0;37m\]"
COLOR_NONE="\[\e[0m\]"
# Detect whether the current directory is a git repository.
function is_git_repository {
git branch > /dev/null 2>&1
}
# Determine the branch/state information for this git repository.
function set_git_branch {
# Capture the output of the "git status" command.
git_status="$(git status 2> /dev/null)"
# Set color based on clean/staged/dirty.
if [[ ${git_status} =~ "working directory clean" ]]; then
state="${GREEN}"
elif [[ ${git_status} =~ "Changes to be committed" ]]; then
state="${YELLOW}"
else
state="${LIGHT_RED}"
fi
# Set arrow icon based on status against remote.
remote_pattern="# Your branch is (ahead|behind)+ "
if [[ ${git_status} =~ ${remote_pattern} ]]; then
if [[ ${BASH_REMATCH[1]} == "ahead" ]]; then
remote="↑"
else
remote="↓"
fi
else
remote=""
fi
diverge_pattern="# Your branch and (.*) have diverged"
if [[ ${git_status} =~ ${diverge_pattern} ]]; then
remote="↕"
fi
# Get the name of the branch.
branch="$(git rev-parse --abbrev-ref HEAD)"
# Set the final branch string.
BRANCH="${state}(${branch})${remote}${COLOR_NONE} "
}
# Return the prompt symbol to use, colorized based on the return value of the
# previous command.
function set_prompt_symbol () {
if test $1 -eq 0 ; then
PROMPT_SYMBOL="\$"
else
PROMPT_SYMBOL="${LIGHT_RED}\$${COLOR_NONE}"
fi
}
# Determine active Python virtualenv details.
function set_virtualenv () {
if [[ `pyenv version-name` == "system" ]] ; then
PYTHON_VIRTUALENV=""
else
PYTHON_VIRTUALENV="${BLUE}[`pyenv version-name`]${COLOR_NONE} "
fi
}
# Set the full bash prompt.
function set_bash_prompt () {
# Set the PROMPT_SYMBOL variable. We do this first so we don't lose the
# return value of the last command.
set_prompt_symbol $?
# Set the PYTHON_VIRTUALENV variable.
set_virtualenv
# Set the BRANCH variable.
if is_git_repository ; then
set_git_branch
else
BRANCH=''
fi
# Set the bash prompt variable.
PS1="
${PYTHON_VIRTUALENV}${GREEN}\u@\h ${YELLOW}\w${COLOR_NONE} ${BRANCH}
${PROMPT_SYMBOL} "
}
# Tell bash to execute this function just before displaying its prompt.
PROMPT_COMMAND=set_bash_prompt
@hsuRush
Copy link

hsuRush commented Oct 29, 2017

Thx !! it work for me.
OS : macOS Sierra 10.12.6

@pandres
Copy link

pandres commented Oct 17, 2018

Beautiful!

@robertour
Copy link

robertour commented Nov 29, 2019

thanks, I also needed to add executions permissions: chmod +x bash_prompt

In case somebody missed the instructions (as i did the first time that landed here):

  1. Save this file as ~/.bash_prompt
  2. Add execution permissions: chmod +x .bash_prompt
  3. Add the following line to the end of your ~/.bashrc or ~/.bash_profile:
. ~/.bash_prompt
  1. Rerun ~/.bashrc or ~/.bash_profile
source  ~/.bashrc

OR

source ~/.bash_profile

@eevmanu
Copy link

eevmanu commented Jun 26, 2021

there is an update from working directory clean to working tree clean on v2.9.1

πŸ‘‰ Working tree vs working directory

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