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
zsh
Starting configuration
[shell]
disabled = false
format = "[$indicator]($style) "
style = "white bold"The configuration is compressed into the URL fragment and stays in your browser.
Key options
- formatstring
- The format for the module.
- bash_indicatorstring
- A format string used to represent bash.
- fish_indicatorstring
- A format string used to represent fish.
- zsh_indicatorstring
- A format string used to represent zsh.
- powershell_indicatorstring
- A format string used to represent powershell.
- pwsh_indicatorstring
- A format string used to represent pwsh. The default value mirrors the value of powershell_indicator.
- ion_indicatorstring
- A format string used to represent ion.
- elvish_indicatorstring
- A format string used to represent elvish.
- tcsh_indicatorstring
- A format string used to represent tcsh.
- nu_indicatorstring
- A format string used to represent nu.
- xonsh_indicatorstring
- A format string used to represent xonsh.
- cmd_indicatorstring
- A format string used to represent cmd.
- unknown_indicatorstring
- The default value to be displayed when the shell is unknown.
- stylestring
- The style for the module.
- disabledboolean
- Disables the shell module.
Format variables
- $indicator
- Mirrors the value of indicator for currently used shell.
- $style
- Mirrors the value of option style.
- $bash_indicator
- A format string used to represent bash.
- $fish_indicator
- A format string used to represent fish.
- $zsh_indicator
- A format string used to represent zsh.
- $powershell_indicator
- A format string used to represent powershell.
- $ion_indicator
- A format string used to represent ion.
- $elvish_indicator
- A format string used to represent elvish.
- $tcsh_indicator
- A format string used to represent tcsh.
- $xonsh_indicator
- A format string used to represent xonsh.
- $cmd_indicator
- A format string used to represent cmd.
- $pwsh_indicator
- A format string used to represent pwsh. Mirrors powershell_indicator unless it is set.
- $unknown_indicator
- The default value to be displayed when the shell is unknown.
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.