Debug School

Cover image for Colored Bash Prompt
Suyash Sambhare
Suyash Sambhare

Posted on

Colored Bash Prompt

-------- Modern Colored Bash Prompt --------

Colors (ANSI escape sequences, with Bash [ ] wrapping for correct line editing)

Regular

BLACK="[\e[30m]"; RED="[\e[31m]"; GREEN="[\e[32m]"; YELLOW="[\e[33m]"
BLUE="[\e[34m]"; MAGENTA="[\e[35m]"; CYAN="[\e[36m]"; WHITE="[\e[37m]"

Styles

BOLD="[\e[1m]"; DIM="[\e[2m]"; RESET="[\e[0m]"

Show last exit code if non-zero

__last_exit_segment() {
local ec=$?
if [[ $ec -ne 0 ]]; then
echo -e "${RED}✖${ec}${RESET} "
fi
}

Git branch + dirty/clean + ahead/behind markers

__git_segment() {
command -v git >/dev/null 2>&1 || return
local branch dirty ahead behind
branch=$(git rev-parse --abbrev-ref HEAD 2>/dev/null) || return
# Detect changes
if ! git diff --quiet 2>/dev/null || ! git diff --cached --quiet 2>/dev/null; then
dirty="*"
else
dirty=""
fi
# Ahead/behind against upstream
if git rev-parse --abbrev-ref @{u} >/dev/null 2>&1; then
local counts
counts=$(git rev-list --left-right --count HEAD...@{u} 2>/dev/null)
ahead=$(echo "$counts" | awk '{print $1}')
behind=$(echo "$counts" | awk '{print $2}')
fi
local ab=""
[[ -n "$ahead" && "$ahead" -gt 0 ]] && ab+="↑$ahead"
[[ -n "$behind" && "$behind" -gt 0 ]] && ab+="↓$behind"

if [[ -n "$ab" ]]; then
echo -e "${MAGENTA} ${branch}${dirty} ${YELLOW}${ab}${RESET}"
else
echo -e "${MAGENTA} ${branch}${dirty}${RESET}"
fi
}

Jobs segment (background jobs)

__jobs_segment() {
local jcount
jcount=$(jobs -p | wc -l | tr -d ' ')
if [[ "$jcount" -gt 0 ]]; then
echo -e "${CYAN}⚙ ${jcount}${RESET} "
fi
}

Build PS1

build_ps1() {
local exit_seg git_seg jobs_seg
exit_seg=$(
last_exit_segment)
git_seg=$(git_segment)
jobs_seg=$(
jobs_segment)
PS1="${exit_seg}${DIM}\u@\h${RESET} ${BOLD}${BLUE}\w${RESET}"
if [[ -n "$git_seg" ]]; then
PS1+=" ${git_seg}"
fi
if [[ -n "$jobs_seg" ]]; then
PS1+=" ${jobs_seg}"
fi
PS1+="\n${GREEN}➜${RESET} "
}

Ensure the prompt rebuilds each time

PROMPT_COMMAND="__build_ps1"


# -------- Modern Colored Bash Prompt --------
# Colors (ANSI escape sequences, with Bash \[ \] wrapping for correct line editing)
# Regular
BLACK="\[\e[30m\]"; RED="\[\e[31m\]"; GREEN="\[\e[32m\]"; YELLOW="\[\e[33m\]"
BLUE="\[\e[34m\]"; MAGENTA="\[\e[35m\]"; CYAN="\[\e[36m\]"; WHITE="\[\e[37m\]"
# Styles
BOLD="\[\e[1m\]"; DIM="\[\e[2m\]"; RESET="\[\e[0m\]"

# Show last exit code if non-zero
__last_exit_segment() {
  local ec=$?
  if [[ $ec -ne 0 ]]; then
    echo -e "${RED}${ec}${RESET} "
  fi
}

# Git branch + dirty/clean + ahead/behind markers
__git_segment() {
  command -v git >/dev/null 2>&1 || return
  local branch dirty ahead behind
  branch=$(git rev-parse --abbrev-ref HEAD 2>/dev/null) || return
  # Detect changes
  if ! git diff --quiet 2>/dev/null || ! git diff --cached --quiet 2>/dev/null; then
    dirty="*"
  else
    dirty=""
  fi
  # Ahead/behind against upstream
  if git rev-parse --abbrev-ref @{u} >/dev/null 2>&1; then
    local counts
    counts=$(git rev-list --left-right --count HEAD...@{u} 2>/dev/null)
    ahead=$(echo "$counts" | awk '{print $1}')
    behind=$(echo "$counts" | awk '{print $2}')
  fi
  local ab=""
  [[ -n "$ahead" && "$ahead" -gt 0 ]] && ab+="↑$ahead"
  [[ -n "$behind" && "$behind" -gt 0 ]] && ab+="↓$behind"

  if [[ -n "$ab" ]]; then
    echo -e "${MAGENTA}${branch}${dirty} ${YELLOW}${ab}${RESET}"
  else
    echo -e "${MAGENTA}${branch}${dirty}${RESET}"
  fi
}

# Jobs segment (background jobs)
__jobs_segment() {
  local jcount
  jcount=$(jobs -p | wc -l | tr -d ' ')
  if [[ "$jcount" -gt 0 ]]; then
    echo -e "${CYAN}${jcount}${RESET} "
  fi
}

# Build PS1
__build_ps1() {
  local exit_seg git_seg jobs_seg
  exit_seg=$(__last_exit_segment)
  git_seg=$(__git_segment)
  jobs_seg=$(__jobs_segment)
  PS1="${exit_seg}${DIM}\u@\h${RESET} ${BOLD}${BLUE}\w${RESET}"
  if [[ -n "$git_seg" ]]; then
    PS1+=" ${git_seg}"
  fi
  if [[ -n "$jobs_seg" ]]; then
    PS1+=" ${jobs_seg}"
  fi
  PS1+="\n${GREEN}${RESET} "
}

# Ensure the prompt rebuilds each time
PROMPT_COMMAND="__build_ps1"
#

Enter fullscreen mode Exit fullscreen mode

Bash

~/.bashrc: executed by bash(1) for non-login shells.

see /usr/share/doc/bash/examples/startup-files (in the package bash-doc)

for examples

If not running interactively, don't do anything

case $- in
i) ;;
*) return;;
esac

don't put duplicate lines or lines starting with space in the history.

See bash(1) for more options

HISTCONTROL=ignoreboth

append to the history file, don't overwrite it

shopt -s histappend

for setting history length see HISTSIZE and HISTFILESIZE in bash(1)

HISTSIZE=1000
HISTFILESIZE=2000

check the window size after each command and, if necessary,

update the values of LINES and COLUMNS.

shopt -s checkwinsize

If set, the pattern "**" used in a pathname expansion context will

match all files and zero or more directories and subdirectories.

shopt -s globstar

make less more friendly for non-text input files, see lesspipe(1)

[ -x /usr/bin/lesspipe ] && eval "$(SHELL=/bin/sh lesspipe)"

set variable identifying the chroot you work in (used in the prompt below)

if [ -z "${debian_chroot:-}" ] && [ -r /etc/debian_chroot ]; then
debian_chroot=$(cat /etc/debian_chroot)
fi

set a fancy prompt (non-color, unless we know we "want" color)

case "$TERM" in
xterm-color|*-256color) color_prompt=yes;;
esac

uncomment for a colored prompt, if the terminal has the capability; turned

off by default to not distract the user: the focus in a terminal window

should be on the output of commands, not on the prompt

force_color_prompt=yes

if [ -n "$force_color_prompt" ]; then
if [ -x /usr/bin/tput ] && tput setaf 1 >&/dev/null; then
# We have color support; assume it's compliant with Ecma-48
# (ISO/IEC-6429). (Lack of such support is extremely rare, and such
# a case would tend to support setf rather than setaf.)
color_prompt=yes
else
color_prompt=
fi
fi

if [ "$color_prompt" = yes ]; then
PS1='${debian_chroot:+($debian_chroot)}[\033[01;32m]\u@\h[\033[00m]:[\033[01;34m]\w[\033[00m]\$ '
else
PS1='${debian_chroot:+($debian_chroot)}\u@\h:\w\$ '
fi
unset color_prompt force_color_prompt

If this is an xterm set the title to user@host:dir

case "$TERM" in
xterm*|rxvt*)
PS1="[\e]0;${debian_chroot:+($debian_chroot)}\u@\h: \w\a]$PS1"
;;
*)
;;
esac

enable color support of ls and also add handy aliases

if [ -x /usr/bin/dircolors ]; then
test -r ~/.dircolors && eval "$(dircolors -b ~/.dircolors)" || eval "$(dircolors -b)"
alias ls='ls --color=auto'
#alias dir='dir --color=auto'
#alias vdir='vdir --color=auto'

alias grep='grep --color=auto'
alias fgrep='fgrep --color=auto'
alias egrep='egrep --color=auto'
Enter fullscreen mode Exit fullscreen mode

fi

colored GCC warnings and errors

export GCC_COLORS='error=01;31:warning=01;35:note=01;36:caret=01;32:locus=01:quote=01'

some more ls aliases

alias ll='ls -alF'
alias la='ls -A'
alias l='ls -CF'

Add an "alert" alias for long running commands. Use like so:

sleep 10; alert

alias alert='notify-send --urgency=low -i "$([ $? = 0 ] && echo terminal || echo error)" "$(history|tail -n1|sed -e '\''s/^\s*[0-9]+\s*//;s/[;&|]\s*alert$//'\'')"'

Alias definitions.

You may want to put all your additions into a separate file like

~/.bash_aliases, instead of adding them here directly.

See /usr/share/doc/bash-doc/examples in the bash-doc package.

if [ -f ~/.bash_aliases ]; then
. ~/.bash_aliases
fi

enable programmable completion features (you don't need to enable

this, if it's already enabled in /etc/bash.bashrc and /etc/profile

sources /etc/bash.bashrc).

if ! shopt -oq posix; then
if [ -f /usr/share/bash-completion/bash_completion ]; then
. /usr/share/bash-completion/bash_completion
elif [ -f /etc/bash_completion ]; then
. /etc/bash_completion
fi
fi
[ -r /home/ubuntu/.config/byobu/prompt ] && . /home/ubuntu/.config/byobu/prompt #byobu-prompt#

# ~/.bashrc: executed by bash(1) for non-login shells.
# see /usr/share/doc/bash/examples/startup-files (in the package bash-doc)
# for examples

# If not running interactively, don't do anything
case $- in
    *i*) ;;
      *) return;;
esac

# don't put duplicate lines or lines starting with space in the history.
# See bash(1) for more options
HISTCONTROL=ignoreboth

# append to the history file, don't overwrite it
shopt -s histappend

# for setting history length see HISTSIZE and HISTFILESIZE in bash(1)
HISTSIZE=1000
HISTFILESIZE=2000

# check the window size after each command and, if necessary,
# update the values of LINES and COLUMNS.
shopt -s checkwinsize

# If set, the pattern "**" used in a pathname expansion context will
# match all files and zero or more directories and subdirectories.
#shopt -s globstar

# make less more friendly for non-text input files, see lesspipe(1)
[ -x /usr/bin/lesspipe ] && eval "$(SHELL=/bin/sh lesspipe)"

# set variable identifying the chroot you work in (used in the prompt below)
if [ -z "${debian_chroot:-}" ] && [ -r /etc/debian_chroot ]; then
    debian_chroot=$(cat /etc/debian_chroot)
fi

# set a fancy prompt (non-color, unless we know we "want" color)
case "$TERM" in
    xterm-color|*-256color) color_prompt=yes;;
esac

# uncomment for a colored prompt, if the terminal has the capability; turned
# off by default to not distract the user: the focus in a terminal window
# should be on the output of commands, not on the prompt
#force_color_prompt=yes

if [ -n "$force_color_prompt" ]; then
    if [ -x /usr/bin/tput ] && tput setaf 1 >&/dev/null; then
        # We have color support; assume it's compliant with Ecma-48
        # (ISO/IEC-6429). (Lack of such support is extremely rare, and such
        # a case would tend to support setf rather than setaf.)
        color_prompt=yes
    else
        color_prompt=
    fi
fi

if [ "$color_prompt" = yes ]; then
    PS1='${debian_chroot:+($debian_chroot)}\[\033[01;32m\]\u@\h\[\033[00m\]:\[\033[01;34m\]\w\[\033[00m\]\$ '
else
    PS1='${debian_chroot:+($debian_chroot)}\u@\h:\w\$ '
fi
unset color_prompt force_color_prompt

# If this is an xterm set the title to user@host:dir
case "$TERM" in
xterm*|rxvt*)
    PS1="\[\e]0;${debian_chroot:+($debian_chroot)}\u@\h: \w\a\]$PS1"
    ;;
*)
    ;;
esac

# enable color support of ls and also add handy aliases
if [ -x /usr/bin/dircolors ]; then
    test -r ~/.dircolors && eval "$(dircolors -b ~/.dircolors)" || eval "$(dircolors -b)"
    alias ls='ls --color=auto'
    #alias dir='dir --color=auto'
    #alias vdir='vdir --color=auto'

    alias grep='grep --color=auto'
    alias fgrep='fgrep --color=auto'
    alias egrep='egrep --color=auto'
fi

# colored GCC warnings and errors
#export GCC_COLORS='error=01;31:warning=01;35:note=01;36:caret=01;32:locus=01:quote=01'

# some more ls aliases
alias ll='ls -alF'
alias la='ls -A'
alias l='ls -CF'

# Add an "alert" alias for long running commands.  Use like so:
#   sleep 10; alert
alias alert='notify-send --urgency=low -i "$([ $? = 0 ] && echo terminal || echo error)" "$(history|tail -n1|sed -e '\''s/^\s*[0-9]\+\s*//;s/[;&|]\s*alert$//'\'')"'

# Alias definitions.
# You may want to put all your additions into a separate file like
# ~/.bash_aliases, instead of adding them here directly.
# See /usr/share/doc/bash-doc/examples in the bash-doc package.

if [ -f ~/.bash_aliases ]; then
    . ~/.bash_aliases
fi

# enable programmable completion features (you don't need to enable
# this, if it's already enabled in /etc/bash.bashrc and /etc/profile
# sources /etc/bash.bashrc).
if ! shopt -oq posix; then
  if [ -f /usr/share/bash-completion/bash_completion ]; then
    . /usr/share/bash-completion/bash_completion
  elif [ -f /etc/bash_completion ]; then
    . /etc/bash_completion
  fi
fi
[ -r /home/ubuntu/.config/byobu/prompt ] && . /home/ubuntu/.config/byobu/prompt   #byobu-prompt#
Enter fullscreen mode Exit fullscreen mode

Top comments (0)