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
via 💠 default
Starting configuration
[terraform]
format = "via [$symbol$workspace]($style) "
symbol = "💠 "
style = "bold 105"The configuration is compressed into the URL fragment and stays in your browser.
Key options
- formatstring
- The format string for the module.
- version_formatstring
- The version format. Available vars are raw, major, minor, & patch
- symbolstring
- A format string shown before the terraform workspace.
- stylestring
- The style for the module.
- disabledboolean
- Disables the terraform module.
- detect_extensionsarray
- Which extensions should trigger this module.
- detect_filesarray
- Which filenames should trigger this module.
- detect_foldersarray
- Which folders should trigger this module.
- commandsarray
- How to detect what the Terraform version is.
Format variables
- $style
- Mirrors the value of option style
- $symbol
- Mirrors the value of option symbol
- $version
- The version of terraform
- $workspace
- The current Terraform workspace
Common adjustments
- Tune the detection options if this module appears in the wrong projects or misses the right ones.
- 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.