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 Prod
Starting configuration
[azure]
disabled = false
format = "on [$symbol($subscription)]($style) "
symbol = " "
style = "blue bold"The configuration is compressed into the URL fragment and stays in your browser.
Key options
- formatstring
- The format for the Azure module to render.
- symbolstring
- The symbol used in the format.
- stylestring
- The style used in the format.
- disabledboolean
- Disables the azure module.
- subscription_aliasesobject
- Table of subscription name aliases to display in addition to Azure subscription name.
Format variables
- $subscription
- The name of the default Azure subscription
- $username
- The username on the default subscription
- $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.