Informative git prompt for zsh
zsh 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 branch
master, ahead of remote by 3 commits, 1 file changed but not staged
(status|●2): on branch
status, 2 files staged
(master|✚7…): on branch
master, 7 files changed, some files untracked
(master|✖2✚3): on branch
master, 2 conflicts, 3 files changed
(experimental↓2↑3|✔): on branch
experimental; your branch has diverged by 3 commits, remote by 2 commits; the repository is otherwise clean
(:70c2952|✔): not on any branch; parent commit has hash
70c2952; the repository is otherwise clean
Here is how it could look like when you are ahead by 4 commits, behind by 5 commits, and have 1 staged files, 1 changed but unstaged file, and some untracked files, on branch
By default, the general appearance of the prompt is:
(<branch><branch tracking>|<local status>)
The symbols are as follows:
Local Status Symbols
|…||there are some untracked files|
Branch Tracking Symbols
|↑n||ahead of remote by
|↓n||behind remote by
|↓m↑n||branches diverged, other by
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 somewhere on your hard drive.
Source the file
~/.zshrcconfig file, and configure your prompt. So, somewhere in
~/.zshrc, you should have:
source path/to/zshrc.sh # an example prompt PROMPT='%B%m%~%b$(git_super_status) %# '
Go in a git repository and test it!
There is now a Haskell implementation as well, which can be four to six times faster than the Python one. The reason is not that Haskell is faster in itself (although it is), but that this implementation calls
git only once. To install, do the following:
- Make sure Haskell's stack is installed on your system
cdto this folder
stack setupto install the Haskell compiler, if it is not already there
stack build && stack install(don't worry, the executable is only “installed” in this folder, not on your system)
- Define the variable
GIT_PROMPT_EXECUTABLE="haskell"somewhere in your
- You may redefine the function
sourcestatement) to adapt it to your needs (to change the order in which the information is displayed).
- Define the variable
ZSH_THEME_GIT_PROMPT_CACHEin order to enable caching.
- You may also change a number of variables (which name start with
ZSH_THEME_GIT_PROMPT_) to change the appearance of the prompt. Take a look in the file
zshrc.shto see how the function
git_super_statusis defined, and what variables are available.