FISH_VCS_PROMPT(1)

NAME
fish_vcs_prompt - output version control system information for use in a prompt

SYNOPSIS
fish_vcs_prompt

    function fish_prompt
         printf '%s' $PWD (fish_vcs_prompt) ' $ '
    end

DESCRIPTION

The fish_vcs_prompt function displays information about the current version control system (VCS) repository, if any.

It calls out to VCS-specific functions. The currently supported systems are:

•   fish_git_prompt <>

•   fish_hg_prompt <>

•   fish_svn_prompt <>

    If a VCS isn't installed, the respective function does nothing.

    The Subversion prompt is disabled by default, because it's slow on large repositories. To enable it, modify fish_vcs_prompt to uncomment it. See funced <>.

    For more information, see the documentation for each of the functions above.

EXAMPLE

A simple prompt that displays all known VCS info:

    function fish_prompt
        ...
        set -g __fish_git_prompt_showupstream auto
        printf '%s %s$' $PWD (fish_vcs_prompt)
    end

Copyright
2023, fish-shell developers