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
on 1
Starting configuration
[fossil_branch]
disabled = false
format = "on [$symbol$branch]($style) "
symbol = " "
style = "bold purple"Open in the builderThe configuration is compressed into the URL fragment and stays in your browser.
Key options
- formatstring
- The format for the module. Use '$branch' to refer to the current branch name.
- symbolstring
- The symbol used before the branch name of the check-out in your current directory.
- stylestring
- The style for the module.
- truncation_lengthnumber
- Truncates a Fossil branch name to N graphemes
- truncation_symbolstring
- The symbol used to indicate a branch name was truncated. You can use '' for no symbol.
- disabledboolean
- Disables the fossil_branch module.
Format variables
- $branch
- The active Fossil branch
- $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.