stow/oh-my-zsh/.oh-my-zsh/plugins/git-prompt/README.md

   1 # git-prompt plugin
   2
   3 A `zsh` prompt that displays information about the current git repository. In particular:
   4 the branch name, difference with remote branch, number of files staged or changed, etc.
   5
   6 To use it, add `git-prompt` to the plugins array in your zshrc file:
   7
   8 ```zsh
   9 plugins=(... git-prompt)
  10 ```
  11
  12 See the [original repository](https://github.com/olivierverdier/zsh-git-prompt).
  13
  14 ## Requirements
  15
  16 This plugin uses `python3`, so your host needs to have it installed.
  17
  18 ## Examples
  19
  20 The prompt may look like the following:
  21
  22 - `(master↑3|✚1)`: on branch `master`, ahead of remote by 3 commits, 1 file changed but not staged
  23 - `(status|●2)`: on branch `status`, 2 files staged
  24 - `(master|✚7…)`: on branch `master`, 7 files changed, some files untracked
  25 - `(master|✖2✚3)`: on branch `master`, 2 conflicts, 3 files changed
  26 - `(experimental↓2↑3|✔)`: on branch `experimental`; your branch has diverged by 3 commits, remote by 2 commits; the repository is otherwise clean
  27 - `(:70c2952|✔)`: not on any branch; parent commit has hash `70c2952`; the repository is otherwise clean
  28 - `(master|⚑2)`: on branch `master`, there are 2 stashed changes
  29
  30 ## Prompt Structure
  31
  32 By default, the general appearance of the prompt is:
  33
  34 ```text
  35 (<branch><branch tracking>|<local status>)
  36 ```
  37
  38 The symbols are as follows:
  39
  40 ### Local Status Symbols
  41
  42 | Symbol | Meaning                        |
  43 |--------|--------------------------------|
  44 | ✔      | repository clean               |
  45 | ●n     | there are `n` staged files     |
  46 | ✖n     | there are `n` unmerged files   |
  47 | ✚n     | there are `n` unstaged files   |
  48 | ⚑n     | there are `n` stashed changes  |
  49 | …      | there are some untracked files |
  50
  51 ### Branch Tracking Symbols
  52
  53 | Symbol | Meaning                                                       |
  54 |--------|---------------------------------------------------------------|
  55 | ↑n     | ahead of remote by `n` commits                                |
  56 | ↓n     | behind remote by `n` commits                                  |
  57 | ↓m↑n   | branches diverged: other by `m` commits, yours by `n` commits |
  58
  59 ## Customisation
  60
  61 - Set the variable `ZSH_THEME_GIT_PROMPT_CACHE` to any value in order to enable caching.
  62 - You may also change a number of variables (whose name start with `ZSH_THEME_GIT_PROMPT_`)
  63   to change the appearance of the prompt. Take a look at the bottom of the [plugin file](git-prompt.plugin.zsh)`
  64   to see what variables are available.
  65
  66 **Enjoy!**