amcfague/zsh-git-prompt

Informative git prompt for zsh

Informative 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.

(an original idea from this blog entry).

Examples

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
• (experimental↓2↑3): on branch experimental; your branch has diverged by 3 commits, remote by 2 commits
• (:70c2952): not on any branch; parent commit has sha1 70c2952

Here is how it could look like when you are ahead by 2 commits, and have 3 staged files, 1 changed but unstaged file, and some untracked files, on branch dev:

Symbols

The symbols are as follows:

• Status Symbols

  ⚡:	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 Symbols

  ↑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 sha1, not a branch (although it should be pretty clear, unless you name your branches like sha1 :-)

Install

1. Create the directory ~/.zsh/git-prompt if it does not exist (this location is customizable).

2. Move the file gitstatus.py into ~/.zsh/git-prompt/.

3. Source the file zshrc.sh from your ~/.zshrc config file, and, optionally, configure your prompt. So, somewhere in ~/.zshrc, you should have:

   source path/to/zshrc.sh
   # configure the following, or leave it commented out:
   # PROMPT='%B%m%~%b$(prompt_git_info) %# '
   

4. You may also redefine the function prompt_git_info (after the source statement) to adapt it to your needs (change the colour, or the order of each piece of information). Take a look in the file zshrc.sh to see what this function may look like.

5. Go in a git repository and test it!

Enjoy!