git prompt for zsh

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.

Features

Emoji-Enhanced Visuals: Lively and clear representation using emojis.
Refined Codebase: Improved for better performance and readability.
Flexible Installation: Compatible with standard methods and Antidote package manager.
Customizable Appearance: Easily switch between traditional and emoji styles.

Examples

The prompt may look like the following:

Traditional Style

(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

Emoji Style

(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 dev:

Prompt Structure

By default, the general appearance of the prompt is:

(<branch><branch tracking>|<local status>)

The symbols are as follows:

Local Status Symbols

Symbol	Meaning
✔	repository clean
●n	there are `n` staged files
✖n	there are `n` unmerged files
✚n	there are `n` changed but unstaged files
…	there are some untracked files

Branch Tracking Symbols

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

Emoji Local Status Symbols

Emoji	Meaning
✅	Repository clean
📦n	`n` staged files
⚔️n	`n` unmerged files
✍️n	`n` changed but unstaged files
📭	Some untracked files

Emoji Branch Tracking Symbols

Emoji	Meaning
⬆️n	Ahead of remote by `n` commits
⬇️n	Behind remote by `n` commits
⬆️m⬇️n	Branches diverged: yours by `m` commits, other by `n` 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 :-)

No git folders

We now autohide the prompt when no .git is found inside the current folder.

Install

Manual

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!

Antidote

Install with Antidote: antidote install Rynaro/zsh-git-prompt.
Source zshrc.sh in your ~/.zshrc.

Add Rynaro/zsh-git-prompt to your .zsh_plugins.txt
Source ~/.zshrc

Haskell (optional)

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
cd to this folder
Run stack setup to 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

Customisation

You can switch back to the traditional style adding the USE_TRADITIONAL_GIT_PROMPT_THEME='true' on your zhrc.sh
You may redefine the function git_super_status (after the source statement) to adapt it to your needs (to change the order in which the information is displayed).
Define the variable ZSH_THEME_GIT_PROMPT_CACHE in 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.sh to see how the function git_super_status is defined, and what variables are available.

Enjoy!

Rynaro / zsh-git-prompt