fish-shell/doc_src/fish_git_prompt.txt

\section fish_git_prompt fish_git_prompt - output git information for use in a prompt

\subsection fish_git_prompt-description Description

The fish_git_prompt function can be used to display information about the current git repository, if any.

For obvious reasons, it requires having git installed.

There are numerous configuration options, either as fish variables or git config variables. If a git config variable is supported, it will be used if set, and the fish variable will only be used if it isn't.

- $__fish_git_prompt_showdirtystate or the git config option "bash.showDirtyState" can be set to show if the repository is "dirty", i.e. has uncommitted changes.

- $__fish_git_prompt_showuntrackedfiles or the git config option "bash.showUntrackedFiles" can be set to show if the repository has untracked files (that aren't ignored).

- $__fish_git_prompt_show_informative_status or the git config option "bash.showInformativeStatus" can be set to enable the "informative" display, which will show a large amount of information - the number of untracked files, dirty files, unpushed/unpulled commits, etc... In large repositories, this can take a lot of time, so it is recommended to disable it there.

- $__fish_git_prompt_showupstream can be set to a number of values to determine how changes between HEAD and upstream are shown:

     verbose        show number of commits ahead/behind (+/-) upstream
     name           if verbose, then also show the upstream abbrev name
     informative    similar to verbose, but shows nothing when equal (fish only)
     git            always compare HEAD to @{upstream}
     svn            always compare HEAD to your SVN upstream
     none           disables (fish only, useful with show_informative_status)

- $__fish_git_prompt_showstashstate can be set to display the state of the stash.

- $__fish_git_prompt_shorten_branch_len can be set to the number of characters that the branch name will be shortened to.

- $__fish_git_prompt_describe_style can be set to a number of styles that describe the current HEAD:

     contains
     branch
     describe
     default

- $__fish_git_prompt_showcolorhints can be set to enable coloring for certain things.

A number of variables to set characters and color used to indicate things.

- $__fish_git_prompt_char_cleanstate
- $__fish_git_prompt_char_dirtystate
- $__fish_git_prompt_char_invalidstate
- $__fish_git_prompt_char_stagedstate
- $__fish_git_prompt_char_stashstate
- $__fish_git_prompt_char_stateseparator
- $__fish_git_prompt_char_untrackedfiles
- $__fish_git_prompt_char_upstream_ahead
- $__fish_git_prompt_char_upstream_behind
- $__fish_git_prompt_char_upstream_diverged
- $__fish_git_prompt_char_upstream_equal
- $__fish_git_prompt_char_upstream_prefix
- $__fish_git_prompt_color
- $__fish_git_prompt_color_prefix
- $__fish_git_prompt_color_suffix
- $__fish_git_prompt_color_bare
- $__fish_git_prompt_color_merging
- $__fish_git_prompt_color_cleanstate
- $__fish_git_prompt_color_invalidstate
- $__fish_git_prompt_color_upstream

Colors used with showcolorhints:

- $__fish_git_prompt_color_flags
- $__fish_git_prompt_color_branch
- $__fish_git_prompt_color_dirtystate
- $__fish_git_prompt_color_stagedstate
- $__fish_git_prompt_color_flags
- $__fish_git_prompt_color_branch
- $__fish_git_prompt_color_dirtystate
- $__fish_git_prompt_color_stagedstate
- $__fish_git_prompt_color_branch_detached

Colors used with their respective flags enabled:
- $__fish_git_prompt_color_stashstate
- $__fish_git_prompt_color_untrackedfiles

Note that all colors can also have a corresponding "_done" color. E.g. $__fish_git_prompt_color_upstream_done, used right _after_ the upstream.

See also fish_vcs_prompt, which will call all supported vcs-prompt functions, including git, hg and svn.

\subsection fish_git_prompt-example Example

A simple prompt that displays git info:

\fish
function fish_prompt
    ...
    set -g __fish_git_prompt_showupstream auto
    printf '%s %s$' $PWD (fish_git_prompt)
end
\endfish