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
🍎
Starting configuration
[os]
disabled = false
format = "[$symbol]($style)"
style = "bold white"The configuration is compressed into the URL fragment and stays in your browser.
Key options
- formatstring
- The format for the module.
- stylestring
- The style for the module.
- symbolsobject
- A table that maps each operating system to its symbol.
- disabledboolean
- Disables the os module.
Format variables
- $codename
- The current operating system codename, if applicable
- $edition
- The current operating system edition, if applicable
- $name
- The current operating system name
- $style
- Mirrors the value of option style
- $symbol
- The current operating system symbol from advanced option symbols
- $type
- The current operating system type
- $version
- The current operating system version, if applicable
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.