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
✦3
Starting configuration
[jobs]
format = "[$symbol$number]($style) "
symbol = "✦"
style = "bold blue"Open in the builderThe configuration is compressed into the URL fragment and stays in your browser.
Key options
- thresholdnumber
- Show number of jobs if exceeded.
- symbol_thresholdnumber
- Show symbol if the job count is at least symbol_threshold.
- number_thresholdnumber
- Show the number of jobs if the job count is at least number_threshold.
- formatstring
- The format for the module.
- symbolstring
- The string used to represent the symbol variable.
- stylestring
- The style for the module.
- disabledboolean
- Disables the jobs module.
Format variables
- $number
- The number of jobs
- $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.