VCPROMPT(1)

NAME

    vcprompt - Version control information in your prompt

SYNOPSIS

    vcprompt [ OPTIONS ]
    vcprompt --format FORMAT
    vcprompt --format-SYSTEM FORMAT
    vcprompt --path PATH
    vcprompt --unknown UNKNOWN
    vcprompt --systems
    vcprompt --version
    vcprompt --help

DESCRIPTION

    vcprompt is a small utility for displaying version control information in your shell's prompt.

INSTALL

    $ curl -sL https://github.com/djl/vcprompt/raw/master/bin/vcprompt > ~/bin/vcprompt
    $ chmod 755 ~/bin/vcprompt

OPTIONS

    -f, --format=FORMAT
          The format string to use when displaying information.

          If not provided this will fall  back  onto  the  VCPROMPT_FORMAT
          environment  variable  or  the  hard-coded  string inside of the
          vprompt binary.

    --format-SYSTEM=FORMAT
          The format string to be used for a specific version control sys-
          tem.  If  a  system's formatting is not explicitly specified, it
          will automatically fall back onto  the  value  of  the  --format
          flag.

    -p, --path=PATH
          The  path to for vcprompt to start looking for a version control
          repository.

          Defaults to '.'.

    -u, --unknown=UNKNOWN
          The value to use when vcprompt is unable to determine the appro-
          priate output for a formatting option.

          If not provided will fall back onto the VCPROMPT_UNKNOWN envi-
          ronment variable or the hard-coded string inside of the vcprompt
          binary.

    -d, --max-depth=DEPTH
          The maximum number of directories  vcprompt will traverse in
          order to find a version control system.

          A non-positive number indicates an infinite depth.

          Defaults to 0 (no limit).

    -s, --systems=SYSTEMS
          Prints all known version control systems.

ENVIRONMENT

    VCPROMPT_FORMAT
        The format string which vcprompt will use when displaying any
        information.

    VCPROMPT_FORMAT_SYSTEM
        Each version control system's formatting can be specified via
        it's own environment variable.

    VCPROMPT_UNKNOWN
        The value to be used when vcprompt is unable to determine the
        output for a formatting option.

    VCPROMPT_DEPTH
        The maximum number of directories vcprompt should traverse
        when looking for a usable version control system.

SEE ALSO

    https://github.com/djl/vcprompt