When it appears
It renders when Starship detects the matching context and its configured conditions are met.
Preview
Rendered from the starting configuration in a representative simulated environment.
starship — preview
on feat/live-preview (a1b2c3d) (REBASING 2/5) [$!+?⇡]
Starting configuration
[vcs]
disabled = falseThe configuration is compressed into the URL fragment and stays in your browser.
Key options
- orderarray
- The order in which to search VCSes.
- disabledboolean
- Disables the vcs module.
- fossil_modulesstring
- Modules to show when a Fossil repository is found.
- git_modulesstring
- Modules to show when a Git repository is found.
- hg_modulesstring
- Modules to show when a Mercurial repository is found.
- pijul_modulesstring
- Modules to show when a Pijul repository is found.
Format variables
Starship does not document format variables for this module.
Common adjustments
- Use disabled to control whether this module can appear in the prompt.