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
is 📦 v1.2.3
Starting configuration
[package]
format = "is [$symbol$version]($style) "
symbol = "📦 "
style = "208 bold"The configuration is compressed into the URL fragment and stays in your browser.
Key options
- formatstring
- The format for the module.
- symbolstring
- The symbol used before displaying the version the package.
- stylestring
- The style for the module.
- display_privateboolean
- Enable displaying version for packages marked as private.
- disabledboolean
- Disables the package module.
- version_formatstring
- The version format. Available vars are raw, major, minor, & patch
Format variables
- $style
- Mirrors the value of option style
- $symbol
- Mirrors the value of option symbol
- $version
- The version of your package
Common adjustments
- Edit format to reorder its variables or make surrounding text conditional.
- Adjust its style options to fit the palette used by the rest of the prompt.