You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
92 lines
3.5 KiB
92 lines
3.5 KiB
# Informative git prompt for bash and fish
|
|
|
|
This prompt is a port of the "Informative git prompt for zsh" which you can
|
|
find [here](https://github.com/olivierverdier/zsh-git-prompt)
|
|
|
|
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][]).
|
|
|
|
`gitstatus.sh` and `git-prompt-help.sh` added by [AKS](http://github.com/aks).
|
|
|
|
## 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
|
|
* ``(master|⚑2)``: on branch ``master``, 2 stash entries
|
|
* ``(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
|
|
- ``⚑n``: there are ``n`` stash entries
|
|
- 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:<br />
|
|
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
|
|
|
|
1. Clone this repository to your home directory.
|
|
|
|
git clone https://github.com/magicmonty/bash-git-prompt.git .bash-git-prompt
|
|
|
|
2. Source the file `gitprompt.sh` from `~/.bashrc`
|
|
|
|
3. `cd` to a git repository and test it!
|
|
|
|
## Configuration
|
|
|
|
1. You can define `GIT_PROMPT_START` and `GIT_PROMPT_END` to tweak your prompt.
|
|
|
|
2. The default colors are defined within `prompt-colors.sh`, which is sourced
|
|
by `gitprompt.sh`. The colors used for various git status are defined in
|
|
`git-prompt-colors.sh`. Both of these files may be overridden by copying
|
|
them to $HOME with a `.` prefix. They can also be placed in `$HOME/lib`
|
|
without the leading `.`. The defaults are the original files in the
|
|
`~/.bash-git-prompt` directory.
|
|
|
|
3. The current git repo information is obtained by the script `gitstatus.sh` or
|
|
`gitstatus.py`. Both scripts do the same thing, but the bash script is a
|
|
tad more quick, and is used by default. If you prefer the python script
|
|
(possibly because you have enhanced it), simply delete or change the name of
|
|
`gitstatus.sh`.
|
|
|
|
4. You can define `prompt_callback` function to tweak your prompt dynamically.
|
|
|
|
```sh
|
|
function prompt_callback {
|
|
if [ `jobs | wc -l` -ne 0 ]; then
|
|
echo -n " jobs:\j"
|
|
fi
|
|
}
|
|
```
|
|
|
|
5. You can get help on the git prompt with the function ``git_prompt_help``.
|
|
Examples are available with ``git_prompt_examples``.
|
|
|
|
**Enjoy!**
|
|
|
|
[blog post]: http://sebastiancelis.com/2009/nov/16/zsh-prompt-git-users/
|
|
|