A 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 cleanHere 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 dev
:
By default, the general appearance of the prompt is:
(<branch><branch tracking>|<local status>)
The symbols are as follows:
Symbol Meaning ✔ repository clean ●n there aren
staged files ✖n there are n
unmerged files ✚n there are n
changed but unstaged files … there are some untracked files Symbol Meaning ↑n ahead of remote by n
commits ↓n behind remote by n
commits ↓m↑n branches diverged, other by m
commits, yours by n
commits
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 zshrc.sh
from your ~/.zshrc
config 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:
cd
to this folderstack setup
to install the Haskell compiler, if it is not already therestack build && stack install
(don't worry, the executable is only “installed” in this folder, not on your system)GIT_PROMPT_EXECUTABLE="haskell"
somewhere in your .zshrc
git_super_status
(after the source
statement) to adapt it to your needs (to change the order in which the information is displayed).ZSH_THEME_GIT_PROMPT_CACHE
in order to enable caching.ZSH_THEME_GIT_PROMPT_
) to change the appearance of the prompt. Take a look in the file zshrc.sh
to see how the function git_super_status
is defined, and what variables are available.Enjoy!
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.3