This prompt is a port of the "Informative git prompt for zsh" which you can find here
A bash
prompt that displays information about the current git repository.
In particular the branch name, difference with remote branch, number of files staged, changed, etc.
(an original idea from this blog post).
The prompt may look like the following:
(master↑3|✚1)
: on branchmaster
, ahead of remote by 3 commits, 1 file changed but not staged(status|●2)
: on branchstatus
, 2 files staged(master|✚7…)
: on branchmaster
, 7 files changed, some files untracked(master|✖2✚3)
: on branchmaster
, 2 conflicts, 3 files changed(experimental↓2↑3|✔)
: on branchexperimental
; your branch has diverged by 3 commits, remote by 2 commits; the repository is otherwise clean(:70c2952|✔)
: not on any branch; parent commit has hash70c2952
; the repository is otherwise clean
By default, the general appearance of the prompt is::
(<branch> <branch tracking>|<local status>)
The symbols are as follows:
- Local Status Symbols
✔
: repository clean●n
: there aren
staged files✖n
: there aren
unmerged files✚n
: there aren
changed but unstaged files…n
: there aren
untracked files
- Branch Tracking Symbols
↑n
: ahead of remote byn
commits↓n
: behind remote byn
commits↓m↑n
: branches diverged, other bym
commits, yours byn
commits
- Branch Symbol:
When the branch name starts with a colon:
, it means it's actually a hash, not a branch (although it should be pretty clear, unless you name your branches like hashes :-)
- Clone this repository to your homedir
e.g.
git clone https://github.com/magicmonty/bash-git-prompt.git .bash-git-prompt
- Source the file
gitprompt.sh
from your~/.bashrc
config file - Go in a git repository and test it!
- You can use
GIT_PROMPT_START
andGIT_PROMPT_END
to tweak your prompt - If you want to tweak the colors,
currently you have to tweak it in the
gitprompt.sh
- You can define
prompt_callback
function to tweak your prompt dynamicly
function prompt_callback {
if [ `jobs | wc -l` -ne 0 ]; then
echo -n " jobs:\j"
fi
}
Enjoy!