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.
The original idea came from this blog post. It was extended with new functionality at olivierverdier/zsh-git-prompt.
Later the development continued at starcraftman/zsh-git-prompt. See the its wiki for a list of added futures.
Changes/new features:
- Reorganize repository structure
- Add an interface between the script that analyzes the repository and the script that formats the prompt. This makes it easier to exchange the two scripts. See Development
- Added a shell-only implementation. This avoids the startup cost of Python or Haskell.
- Added git-summary
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
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 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 are n staged files |
| ✖n | there are n unmerged files |
| ✚n | there are n changed but unstaged files |
| …n | there are n untracked files |
| ⚑n | there are n stashes on the repo |
| 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 |
| Status | Meaning |
|---|---|
| master|✔ | On a branch (master), clean |
| :3adh57m|✔ | Checked out a hash |
| dev|MERGING|✖1 | Doing a merge onto dev, 1 conflict |
| :h2x78q0|REBASE 1/3|✖2 | Doing a rebase, on first of 3 commits, 2 conflicts |
| :bc49c7c|BISECT 97; 6 steps|✔ | Bisecting 97 commits, roughly 6 steps left (only with GIT_PROMPT_EXECUTABLE=shell) |
When the branch name starts with a colon :, it means it’s actually a hash, not a branch.
It should be pretty clear, unless you name your branches like hashes :-)
-
Clone this repository somewhere on your hard drive.
-
Source the file
zshrc.shfrom your~/.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- Run
stack setupto install the Haskell compiler, if it is not already there - Run
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.zshrc
-
Define the variable
ZSH_THEME_GIT_PROMPT_CACHE=1in order to enable caching. -
Define the variable
ZSH_GIT_PROMPT_SHOW_UPSTREAM=1in order to see the remote branch you are tracking. -
Define the variable
ZSH_GIT_PROMPT_SHOW_UPSTREAM=2to show the remote as above but omit the remote branch when its name is equal to the local branch.
Demo:
-
By default, python version invokes
python. To force a specific python interpreter:ZSH_GIT_PROMPT_PYBIN=/usr/bin/python2.7. -
You may redefine the function
git_super_status(after thesourcestatement) to adapt it to your needs (to change the order in which the information is displayed). -
To modify the symbols/colors of the theme, simply redefine the variables at bottom of the the
zshrc.shafter sourcing. This could be in your~/.zshrcor sourced elsewhere. These are the defaults:
ZSH_THEME_GIT_PROMPT_PREFIX="["
ZSH_THEME_GIT_PROMPT_SUFFIX="]"
ZSH_THEME_GIT_PROMPT_HASH_PREFIX=":"
ZSH_THEME_GIT_PROMPT_SEPARATOR="|"
ZSH_THEME_GIT_PROMPT_BRANCH="%{$fg_bold[magenta]%}"
ZSH_THEME_GIT_PROMPT_STAGED="%{$fg[red]%}%{●%G%}"
ZSH_THEME_GIT_PROMPT_CONFLICTS="%{$fg[red]%}%{✖%G%}"
ZSH_THEME_GIT_PROMPT_CHANGED="%{$fg[blue]%}%{✚%G%}"
ZSH_THEME_GIT_PROMPT_BEHIND="%{↓%2G%}"
ZSH_THEME_GIT_PROMPT_BEHIND_AHEAD_SEPARATOR=""
ZSH_THEME_GIT_PROMPT_AHEAD="%{↑%2G%}"
ZSH_THEME_GIT_PROMPT_STASHED="%{$fg_bold[blue]%}%{⚑%G%}"
ZSH_THEME_GIT_PROMPT_UNTRACKED="%{$fg[cyan]%}%{…%G%}"
ZSH_THEME_GIT_PROMPT_CLEAN="%{$fg_bold[green]%}%{✔%G%}"
ZSH_THEME_GIT_PROMPT_LOCAL=" L"
# The remote branch will be shown between these two
ZSH_THEME_GIT_PROMPT_UPSTREAM_FRONT=" {%{$fg_bold[blue]%}"
ZSH_THEME_GIT_PROMPT_UPSTREAM_END="%{${reset_color}%}}"Enjoy!
The analyzing script need to produce an output like the following:
REPO_IS_REPOSITORY 1
REPO_BRANCH master
REPO_AHEAD 1
REPO_BEHIND 0
REPO_STAGED 0
REPO_CONFLICTS 0
REPO_CHANGED 1
REPO_UNTRACKED 0
Here is a table of all attributes:
| Attribute | Description |
|---|---|
| REPO_IS_REPOSITORY | Needs to be defined so that a prompt is produced. |
| REPO_BRANCH | The name of the branch or the hash of the HEAD. |
| REPO_AHEAD | How many commits the HEAD is behind the upstream ... |
| REPO_BEHIND | ... and ahead of the upstream. |
| REPO_STAGED | How many files are staged, |
| REPO_CHANGED | changed, |
| REPO_CONFLICTS | in conflict, |
| REPO_UNTRACKED | and untracked. |
| REPO_STASHED | How many stashes. |
| REPO_LOCAL_ONLY | The branch has no upstream. |
| REPO_UPSTREAM | The name of the remote repository. |
| REPO_MERGING | Whether we are merging. |
| REPO_REBASE | Information about rebasing. |