Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

programs.starship.enable

Whether to enable starship.

Type: boolean

Default:

false

Example:

true

Declared by:

programs.starship.enableBashIntegration

Whether to enable Bash integration.

Type: boolean

Default:

Example:

false

Declared by:

programs.starship.enableFishIntegration

Whether to enable Fish integration.

Type: boolean

Default:

Example:

false

Declared by:

programs.starship.enableInteractive

Only enable starship when the shell is interactive. This option is only valid for the Fish shell.

Some plugins require this to be set to false to function correctly.

Type: boolean

Default:

true

Declared by:

programs.starship.enableIonIntegration

Whether to enable Ion integration.

Type: boolean

Default:

Example:

false

Declared by:

programs.starship.enableNushellIntegration

Whether to enable Nushell integration.

Type: boolean

Default:

Example:

false

Declared by:

programs.starship.enableTransience

The TransientPrompt feature of Starship replaces previous prompts with a custom string. This is only a valid option for the Fish shell.

For documentation on how to change the default replacement string and for more information visit https://starship.rs/advanced-config/#transientprompt-and-transientrightprompt-in-cmd

Type: boolean

Default:

false

Declared by:

programs.starship.enableZshIntegration

Whether to enable Zsh integration.

Type: boolean

Default:

Example:

false

Declared by:

programs.starship.package

The starship package to use.

Type: package

Default:

pkgs.starship

Declared by:

programs.starship.configPath

Relative path to the user’s home directory where the Starship config should be stored.

Type: string

Default:

${config.xdg.configHome}/starship.toml

Declared by:

programs.starship.extraPackages

Extra packages available to starship.

Type: list of package

Default:

[ ]

Example:

[ pkgs.jj-starship ]

Declared by:

programs.starship.presets

Preset files to be merged with settings in order.

See https://starship.rs/presets/ for the full list of available presets.

Type: list of string

Default:

[ ]

Example:

[
  "nerd-font-symbols"
]

Declared by:

programs.starship.settings

Configuration written to $XDG_CONFIG_HOME/starship.toml.

See https://starship.rs/config/ for the full list of options.

Type: TOML value

Default:

{ }

Example:

{
  add_newline = false;
  format = lib.concatStrings [
    "$line_break"
    "$package"
    "$line_break"
    "$character"
  ];
  scan_timeout = 10;
  character = {
    success_symbol = "➜";
    error_symbol = "➜";
  };
}

Declared by: