When it appears
This module is disabled by default. Enable it, then it renders when Starship detects the matching context.
Preview
Rendered from the starting configuration in a representative simulated environment.
starship — preview
as 🧙
Starting configuration
[sudo]
disabled = false
format = "[as $symbol]($style)"
symbol = "🧙 "
style = "bold blue"The configuration is compressed into the URL fragment and stays in your browser.
Key options
- formatstring
- The format of the module
- symbolstring
- The symbol displayed when credentials are cached
- stylestring
- The style for the module.
- allow_windowsboolean
- Since windows has no default sudo, default is disabled.
- disabledboolean
- Disables the sudo module.
Format variables
- $style
- Mirrors the value of option style
- $symbol
- Mirrors the value of option symbol
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.