ylib/ohmyzsh
1
0
Fork 0
mirror of https://github.com/ohmyzsh/ohmyzsh.git synced 2024-11-30 14:24:16 +08:00
Code Projects Releases Wiki Activity
7dddfe0a39
ohmyzsh/plugins/git-prompt
History
Jacob Tomaw 1ba0af650a Use safer append to hook function arrays (#8406) 
Use add-zsh-hook to add functions to hooks. That way they won't be added again
when doing `source ~/.zshrc` multiple times.

Co-authored-by: Marc Cornellà <marc.cornella@live.com>
2019-11-19 18:47:12 +01:00
..
git-prompt.plugin.zsh Use safer append to hook function arrays (#8406) 2019-11-19 18:47:12 +01:00
gitstatus.py git-prompt: fix LANG override for git status call 2019-04-10 20:30:30 +02:00
README.md git-prompt: add README (#7554) 2019-04-09 21:21:26 +02:00

README.md

git-prompt plugin

A zsh prompt that displays information about the current git repository. In particular:
the branch name, difference with remote branch, number of files staged or changed, etc.

To use it, add git-prompt to the plugins array in your zshrc file:

plugins=(... git-prompt)

See the original repository.

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

Symbol Meaning
✔ repository clean
●n there are n staged files
✖n there are n unmerged files
✚n there are n 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

Customisation

  • Set the variable ZSH_THEME_GIT_PROMPT_CACHE to any value in order to enable caching.
  • You may also change a number of variables (whose name start with ZSH_THEME_GIT_PROMPT_)
    to change the appearance of the prompt. Take a look at the bottom of the plugin file`
    to see what variables are available.

Enjoy!