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
/bin/zsh
Starting configuration
[env_var.SHELL]
variable = "SHELL"
format = "[$env_value]($style)"The configuration is compressed into the URL fragment and stays in your browser.
Key options
- symbolstring
- The symbol used before displaying the variable value.
- stylestring
- The style for the module.
- variablestring
- The environment variable to be displayed.
- defaultstring
- The default value to be displayed when the selected variable is not defined.
- formatstring
- The format for the module.
- disabledboolean
- Disables the env_var module.
- descriptionstring
- The description of the module that is shown when running starship explain.
Format variables
- $env_value
- The environment value of option variable
- $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.