Starship Prompt Builder

Nix shell module

Shows the nix-shell environment

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 ❄️  impure (shell) 

Starting configuration

[nix_shell]
format = "via [$symbol$state( \\($name\\))]($style) "
symbol = "❄️  "
style = "bold blue"
Open in the builder

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

Key options

formatstring
The format for the module.
symbolstring
A format string representing the symbol of nix-shell.
stylestring
The style for the module.
impure_msgstring
A format string shown when the shell is impure.
pure_msgstring
A format string shown when the shell is pure.
unknown_msgstring
A format string shown when it is unknown if the shell is pure/impure.
disabledboolean
Disables the nix_shell module.
heuristicboolean
Attempts to detect new nix shell-style shells with a heuristic.

Format variables

$level
The depth level of the nix-shell (Only when using Lix)
$name
The name of the nix-shell
$state
The state of the nix-shell
$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.