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
(REBASING 2/5)
Starting configuration
[git_state]
format = "\\([$state( $progress_current/$progress_total)]($style)\\) "
style = "bold yellow"The configuration is compressed into the URL fragment and stays in your browser.
Key options
- rebasestring
- A format string displayed when a rebase is in progress.
- mergestring
- A format string displayed when a merge is in progress.
- revertstring
- A format string displayed when a revert is in progress.
- cherry_pickstring
- A format string displayed when a cherry-pick is in progress.
- bisectstring
- A format string displayed when a bisect is in progress.
- amstring
- A format string displayed when an apply-mailbox (git am) is in progress.
- am_or_rebasestring
- A format string displayed when an ambiguous apply-mailbox or rebase is in progress.
- stylestring
- The style for the module.
- formatstring
- The format for the module.
- disabledboolean
- Disables the git_state module.
Format variables
- $progress_current
- The current operation progress
- $progress_total
- The total operation progress
- $state
- The current state of the repo
- $style
- Mirrors the value of option style
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.