Denny Schäfer 1409feed8f Fix indent and Strip traling spaces		12 years ago
.gitignore	apply git prompt only on directories belonging to a git repository	13 years ago
README.md	Updated Installation instructions	12 years ago
gitprompt.fish	Refactor	13 years ago
gitprompt.png	Refix image	13 years ago
gitprompt.sh	Fix indent and Strip traling spaces	12 years ago
gitstatus.py	Added support for tags	13 years ago

README.md

Informative git prompt for bash and fish

This prompt is a port of the "Informative git prompt for zsh" which you can find here

A bash 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).

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

Prompt Structure

By default, the general appearance of the prompt is::

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

The symbols are as follows:

Local Status Symbols
- ✔: 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
Branch Tracking 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
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 :-)

Install

Clone this repository to your homedir e.g. git clone https://github.com/magicmonty/bash-git-prompt.git .bash-git-prompt
configure your prompt and source the file gitprompt.sh from your ~/.bashrc config file

you can use GIT_PROMPT_START and GIT_PROMPT_END to tweak your prompt
If you want to tweak the colors, currently you have to tweak it in the gitprompt.sh

Go in a git repository and test it!

Enjoy!