Starship Prompt Builder

Mercurial state module

Shows the Mercurial operation in progress, such as merging or rebasing

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
(MERGING) 

Starting configuration

[hg_state]
disabled = false
format = "\\([$state]($style)\\) "
style = "bold yellow"
Open in the builder

The configuration is compressed into the URL fragment and stays in your browser.

Key options

mergestring
A format string displayed when a merge is in progress.
rebasestring
A format string displayed when a rebase is in progress.
updatestring
A format string displayed when a update is in progress.
bisectstring
A format string displayed when a bisect is in progress.
shelvestring
A format string displayed when a shelve is in progress.
graftstring
A format string displayed when a graft is in progress.
transplantstring
A format string displayed when a transplant is in progress.
histeditstring
A format string displayed when a histedit is in progress.
stylestring
The style for the module.
formatstring
The format for the module.
disabledboolean
Disables the hg_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.