starship/docs/de-DE/config/README.md

180 KiB
Raw Blame History

Konfiguration

Um mit der Konfiguration von Starship zu beginnen, musst du die folgende Datei erstellen: ~/.config/starship.toml.

mkdir -p ~/.config && touch ~/.config/starship.toml

Die gesamte Konfiguration von Starship erfolgt in dieser TOML-Datei:

# Füge eine Leerzeile zwischen den Eingabeaufforderungen ein
add_newline = true

# Ersetze das "" Symbol der Eingabeaufforderung mit "➜"
[character]                            # Der Name des Moduls, welches wir konfigurieren ist "character"
success_symbol = "[➜](bold green)"     # Das "succes_symbol" Segment wird zu "➜" eingestellt und ist "bold green" (fettgedrucktes grün) gefärbt

# Deaktiviere das "package" Modul, damit es aus der Eingabeaufforderung komplett verschwindet
[package]
disabled = true

Du kannst die voreingestellte Konfigurations-Datei mit der STARSHIP_CONFIG Umgebungsvariable verändern:

export STARSHIP_CONFIG=~/.starship/config.toml

Äquivalent zur PowerShell (Windows) würdest du diese Zeile zu $PROFILE hinzufügen:

$ENV:STARSHIP_CONFIG = "$HOME\.starship\config.toml"

Protokollierung

Standardmäßig protokolliert Starship Warnungen und Fehler in einer Datei names ~/.cache/starship/session_${STARSHIP_SESSION_KEY}.log, wobei der session key zu der Instanz deines Terminals korrespondiert. Das kann jedoch durch die Nutzung der STARSHIP_CACHE Umgebungsvariable verändert werden:

export STARSHIP_CACHE=~/.starship/cache

Äquivalent zur PowerShell (Windows) würdest du diese Zeile zu $PROFILE hinzufügen:

$ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp"

Terminologie

Modul: Eine Komponente in der Eingabeaufforderung, welche Informationen basierend auf Kontextinformationen deines Betriebssystems angibt. Beispielsweise zeigt das "nodejs" Module die Version von Node.js, welches derzeitig auf deinem Computer installiert ist, an, falls dein derzeitiger Ordner ein Node.js Projekt ist.

Variable: Eine kleinere Unterkomponente, welche Information des Moduls enthält. Zum Beispiel enthält die Variable "version" im Modul "nodejs" die aktuelle Version von Node.js.

Die meisten Module haben einen Präfix der standardmäßigen terminal-Farbe (z.B. via in "nodejs") und ein Leerzeichen als Suffix.

Formatierte Strings

Formatierte Strings sind das Format, mit dem ein Modul all seine Variablen ausgibt. Die meisten Module haben den Eintrag format, welcher das anzeige-Format des Moduls konfiguriert. Du kannst Texte, Variablen und Textgruppen in einem formatierten string benutzen.

Variable

Eine Variable besteht aus dem $ Symbol und dem Namen der Variable. The name of a variable can only contain letters, numbers and _.

Hier sind ein paar Beispiele:

  • $version ist ein formatierter string mit dem Namen version.
  • $git_branch$git_commit ist ein formatierter string mit zwei Variablen, nämlich git_branch und git_commit.
  • $git_branch $git_commit hat die zwei Variablen mit einem Leerzeichen getrennt.

Textgruppe

Eine Textgruppe besteht aus zwei verschiedenen Teilen.

Der erste Teil, welcher innerhalb eckiger Klammern [] ist, ist ein formatierter string. Du kannst ihm Texte, Variablen oder sogar verschachtelte Textgruppen hinzufügen.

Der zweite Teil ist innerhalb normaler Klammern () und ist einstyle string. Dies kann verwendet werden, um den ersten Teil zu gestalten.

Hier sind ein paar Beispiele:

  • [on](red bold) wird einen string on mit fettgedrucktem roten Text ausgeben.
  • [⌘ $version](bold green) wird ein Symbol gefolgt von dem Inhalt der Variable version mit fettgedrucktem grünen Text ausgeben.
  • [a [b](red) c](green) wird a b c ausgeben, wobei b rot ist und a und c grün sind.

Style-Strings

Die meisten Module in Starship lassen dich den Darstellungsstil verändern. Dies passiert meistens an einem bestimmten Eintrag (gewöhnlich style genannt), der einen String mit den Einstellungen darstellt. Es folgen ein paar Beispiele für solche Strings zusammen der mit Beschreibungen, was sie bewirken. Details zur vollen Syntax findest du im Erweiterten Konfigurationshandbuch.

  • "fg:green bg:blue" setzt grünen Text auf einem blauen Hintergrund
  • "bg:blue fg:bright-green" setzt hell-grünen Text auf einen blauen Hintergrund
  • "bold fg:27" setzt färbt fettgedruckten Text in die ANSI Farbe 27
  • "underline bg:#bf5700" setzt unterstrichenen Text auf einen orangenen Hintergrund
  • "bold italic fg:purple" setzt lilane fett-kursive Schrift
  • "" deaktiviert explizit jeden Stil

Wie genau sich diese Konfiguration auswirkt liegt an deinem Terminal-Emulator. Einige Emulatoren zum Beispiel werden die Farben erhellen statt Text dick zu machen, und ein paar Farbthemen benutzen dieselben Werte für normale und helle Farben. Für kursiven Text muss dein Terminal Kursivschrift unterstützen.

Conditional Format Strings

A conditional format string wrapped in ( and ) will not render if all variables inside are empty.

Hier sind ein paar Beispiele:

  • (@$region) will show nothing if the variable region is None or empty string, otherwise @ followed by the value of region.
  • (some text) will always show nothing since there are no variables wrapped in the braces.
  • When $all is a shortcut for \[$a$b\], ($all) will show nothing only if $a and $b are both None. This works the same as (\[$a$b\] ).

Special characters

The following symbols have special usage in a format string and must be escaped: $ \ [ ] ( ).

Note that TOML has both basic strings and literal strings. It is recommended to use a literal string (surrounded by single quotes) in your config. If you want to use a basic string (surrounded by double quotes), you must escape the backslash itself (i.e. use \\).

For example, when you want to print a $ symbol on a new line, the following configs for format are equivalent:

# with basic string
format = "\n\\$"

# with multiline basic string
format = """

\\$"""

# with literal string
format = '''

\$'''

Prompt

Dies ist eine Liste mit Prompt-weiten Konfigurationsoptionen.

Optionen

Option Standardwert Beschreibung
format link Configure the format of the prompt.
right_format "" See Enable Right Prompt
scan_timeout 30 Timeout für das Scannen von Dateien (in Millisekunden).
command_timeout 500 Timeout for commands executed by starship (in milliseconds).
add_newline true Inserts blank line between shell prompts.

Beispiel

# ~/.config/starship.toml

# Verwende benutzerdefiniertes Format
format = """
[┌───────────────────>](bold green)
[│](bold green)$directory$rust$package
[└─>](bold green) """

# Warte 10 Millisekunden damit Starship die Dateien im aktuellen Ordner überprüfen kann.
scan_timeout = 10

# Deaktiviere die Leerzeile am Anfang der Eingabeaufforderung
add_newline = false

Default Prompt Format

The default format is used to define the format of the prompt, if empty or no format is provided. Die Standardwerte sind folgende:

format = "$all"

# Which is equivalent to
format = """
$username\
$hostname\
$shlvl\
$singularity\
$kubernetes\
$directory\
$vcsh\
$git_branch\
$git_commit\
$git_state\
$git_metrics\
$git_status\
$hg_branch\
$docker_context\
$package\
$cmake\
$cobol\
$dart\
$deno\
$dotnet\
$elixir\
$elm\
$erlang\
$golang\
$helm\
$java\
$julia\
$kotlin\
$lua\
$nim\
$nodejs\
$ocaml\
$perl\
$php\
$pulumi\
$purescript\
$python\
$rlang\
$red\
$ruby\
$rust\
$scala\
$swift\
$terraform\
$vlang\
$vagrant\
$zig\
$nix_shell\
$conda\
$memory_usage\
$aws\
$gcloud\
$openstack\
$azure\
$env_var\
$crystal\
$custom\
$sudo\
$cmd_duration\
$line_break\
$jobs\
$battery\
$time\
$status\
$shell\
$character"""

If you just want to extend the default format, you can use $all; modules you explicitly add to the format will not be duplicated. Eg.

# Move the directory to the second line
format="$all$directory$character"

AWS

Das aws-Modul zeigt das aktuelle AWS-Profil an. Dies basiert auf den Umgebungsvariablen: AWS_REGION, AWS_DEFAULT_REGION, AWS_PROFILE und der ~/.aws/config Datei. This module also shows an expiration timer when using temporary credentials.

When using aws-vault the profile is read from the AWS_VAULT env var and the credentials expiration date is read from the AWS_SESSION_EXPIRATION env var.

When using awsu the profile is read from the AWSU_PROFILE env var.

When using AWSume the profile is read from the AWSUME_PROFILE env var and the credentials expiration date is read from the AWSUME_EXPIRATION env var.

Optionen

Option Standardwert Beschreibung
format 'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)' Das Format für das Modul.
symbol "☁️ " Symbol das vor dem aktuellen AWS-Profil angezeigt wird.
region_aliases Tabelle der Regionaliasen, die zusätzlich zum AWS-Namen angezeigt werden sollen.
style "bold yellow" Stil für dieses Modul.
expiration_symbol X Das Symbol, das angezeigt wird, wenn die temporären Anmeldeinformationen abgelaufen sind.
disabled false Deaktiviert das aws-Modul.

Variables

Variable Beispiel Beschreibung
region ap-northeast-1 Die aktuelle AWS-Region
profile astronauts Das aktuelle AWS Profil
duration 2h27m20s Gültigkeitsdauer der temporären Anmeldeinformationen
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiele

Alles anzeigen

# ~/.config/starship.toml

[aws]
format = 'on [$symbol($profile )(\($region\) )]($style)'
style = "bold blue"
symbol = "🅰 "
[aws.region_aliases]
ap-southeast-2 = "au"
us-east-1 = "va"

Region anzeigen

# ~/.config/starship.toml

[aws]
format = "on [$symbol$region]($style) "
style = "bold blue"
symbol = "🅰 "
[aws.region_aliases]
ap-southeast-2 = "au"
us-east-1 = "va"

Profil anzeigen

# ~/.config/starship.toml

[aws]
format = "on [$symbol$profile]($style) "
style = "bold blue"
symbol = "🅰 "

Azure

The azure module shows the current Azure Subscription. This is based on showing the name of the default subscription, as defined in the ~/.azure/azureProfile.json file.

Optionen

Variable Standartwert Beschreibung
format "on [$symbol($subscription)]($style) " The format for the Azure module to render.
symbol "ﴃ " The symbol used in the format.
style "blue bold" The style used in the format.
disabled true Disables the azure module.

Beispiel

# ~/.config/starship.toml

[azure]
disabled = false
format = "on [$symbol($subscription)]($style) "
symbol = "ﴃ "
style = "blue bold"

Battery

The battery module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%.

Optionen

Option Standardwert Beschreibung
full_symbol " " The symbol shown when the battery is full.
charging_symbol " " The symbol shown when the battery is charging.
discharging_symbol " " The symbol shown when the battery is discharging.
unknown_symbol " " The symbol shown when the battery state is unknown.
empty_symbol " " The symbol shown when the battery state is empty.
format "[$symbol$percentage]($style) " Das Format für das Modul.
display link Display threshold and style for the module.
disabled false Disables the battery module.

Beispiel

# ~/.config/starship.toml

[battery]
full_symbol = "🔋 "
charging_symbol = "⚡️ "
discharging_symbol = "💀 "

Battery Display

The display configuration option is used to define when the battery indicator should be shown (threshold), which symbol would be used (symbol), and what it would like (style). If no display is provided. Die Standardwerte sind folgende:

[[battery.display]]
threshold = 10
style = "bold red"

The default value for the charging_symbol and discharging_symbol option is respectively the value of battery's charging_symbol and discharging_symbol option.

Optionen

The display option is an array of the following table.

Option Standardwert Beschreibung
threshold 10 The upper bound for the display option.
style bold red The style used if the display option is in use.
charging_symbol - Optional symbol displayed if display option is in use, defaults to battery's charging_symbol option.
discharging_symbol - Optional symbol displayed if display option is in use, defaults to battery's discharging_symbol option.

Beispiel

[[battery.display]]  # "bold red" style and discharging_symbol when capacity is between 0% and 10%
threshold = 10
style = "bold red"

[[battery.display]]  # "bold yellow" style and 💦 symbol when capacity is between 10% and 30%
threshold = 30
style = "bold yellow"
discharging_symbol = "💦"

# when capacity is over 30%, the battery indicator will not be displayed

Zeichen

The character module shows a character (usually an arrow) beside where the text is entered in your terminal.

The character will tell you whether the last command was successful or not. It can do this in two ways:

  • changing color (red/green)
  • changing shape (/)

By default it only changes color. If you also want to change its shape take a look at this example.

::: Warnung

error_symbol is not supported on elvish and nu shell.

:::

::: Warnung

vicmd_symbol is only supported in fish and zsh.

:::

Optionen

Option Standardwert Beschreibung
format "$symbol " The format string used before the text input.
success_symbol "[](bold green)" The format string used before the text input if the previous command succeeded.
error_symbol "[](bold red)" The format string used before the text input if the previous command failed.
vicmd_symbol "[](bold green)" The format string used before the text input if the shell is in vim normal mode.
disabled false Disables the character module.

Variables

Variable Beispiel Beschreibung
symbol A mirror of either success_symbol, error_symbol or vicmd_symbol

Beispiele

With custom error shape

# ~/.config/starship.toml

[character]
success_symbol = "[➜](bold green) "
error_symbol = "[✗](bold red) "

Without custom error shape

# ~/.config/starship.toml

[character]
success_symbol = "[➜](bold green) "
error_symbol = "[➜](bold red) "

With custom vim shape

# ~/.config/starship.toml

[character]
vicmd_symbol = "[V](bold green) "

CMake

The cmake module shows the currently installed version of CMake. By default the module will be activated if any of the following conditions are met:

  • The current directory contains a CMakeLists.txt file
  • The current directory contains a CMakeCache.txt file

Optionen

Option Standardwert Beschreibung
format "via [$symbol($version )]($style)" Das Format für das Modul.
version_format "v${raw}" The version format. Available vars are raw, major, minor, & patch
symbol "△ " The symbol used before the version of cmake.
detect_extensions [] Which extensions should trigger this module
detect_files ["CMakeLists.txt", "CMakeCache.txt"] Which filenames should trigger this module
detect_folders [] Which folders should trigger this module
style "bold blue" Stil für dieses Modul.
disabled false Disables the cmake module.

Variables

Variable Beispiel Beschreibung
version v3.17.3 The version of cmake
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

COBOL / GNUCOBOL

The cobol module shows the currently installed version of COBOL. By default, the module will be shown if any of the following conditions are met:

  • The current directory contains any files ending in .cob or .COB
  • The current directory contains any files ending in .cbl or .CBL

Optionen

Option Standardwert Beschreibung
symbol "⚙️ " The symbol used before displaying the version of COBOL.
format "via [$symbol($version )]($style)" Das Format für das Modul.
version_format "v${raw}" The version format. Available vars are raw, major, minor, & patch
style "bold blue" Stil für dieses Modul.
detect_extensions ["cbl", "cob", "CBL", "COB"] Which extensions should trigger this module.
detect_files [] Which filenames should trigger this module.
detect_folders [] Which folders should trigger this module.
disabled false Disables the cobol module.

Variables

Variable Beispiel Beschreibung
version v3.1.2.0 The version of cobol
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Befehlsdauer

The cmd_duration module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the min_time config value, if it exists.

::: warning Do not hook the DEBUG trap in Bash

If you are running Starship in bash, do not hook the DEBUG trap after running eval $(starship init $0), or this module will break.

:::

Bash users who need preexec-like functionality can use rcaloras's bash_preexec framework. Simply define the arrays preexec_functions and precmd_functions before running eval $(starship init $0), and then proceed as normal.

Optionen

Option Standardwert Beschreibung
min_time 2_000 Shortest duration to show time for (in milliseconds).
show_milliseconds false Show milliseconds in addition to seconds for the duration.
format "took [$duration]($style) " Das Format für das Modul.
style "bold yellow" Stil für dieses Modul.
disabled false Disables the cmd_duration module.
show_notifications false Show desktop notifications when command completes.
min_time_to_notify 45_000 Shortest duration for notification (in milliseconds).

::: tip

Showing desktop notifications requires starship to be built with rust-notify support. You check if your starship supports notifications by running STARSHIP_LOG=debug starship module cmd_duration -d 60000 when show_notifications is set to true.

:::

Variables

Variable Beispiel Beschreibung
duration 16m40s The time it took to execute the command
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiel

# ~/.config/starship.toml

[cmd_duration]
min_time = 500
format = "underwent [$duration](bold yellow)"

Conda

The conda module shows the current Conda environment, if $CONDA_DEFAULT_ENV is set.

::: tip

This does not suppress conda's own prompt modifier, you may want to run conda config --set changeps1 False.

:::

Optionen

Option Standardwert Beschreibung
truncation_length 1 The number of directories the environment path should be truncated to, if the environment was created via conda create -p [path]. 0 means no truncation. Also see the directory module.
symbol "🅒 " The symbol used before the environment name.
style "bold green" Stil für dieses Modul.
format "via [$symbol$environment]($style) " Das Format für das Modul.
ignore_base true Ignores base environment when activated.
disabled false Disables the conda module.

Variables

Variable Beispiel Beschreibung
environment astronauts The current conda environment
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiel

# ~/.config/starship.toml

[conda]
format = "[$symbol$environment](dimmed green) "

Crystal

The crystal module shows the currently installed version of Crystal. By default the module will be shown if any of the following conditions are met:

  • The current directory contains a shard.yml file
  • The current directory contains a .cr file

Optionen

Option Standardwert Beschreibung
symbol "🔮 " The symbol used before displaying the version of crystal.
format "via [$symbol($version )]($style)" Das Format für das Modul.
version_format "v${raw}" The version format. Available vars are raw, major, minor, & patch
style "bold red" Stil für dieses Modul.
detect_extensions ["cr"] Which extensions should trigger this module.
detect_files ["shard.yml"] Which filenames should trigger this module.
detect_folders [] Which folders should trigger this module.
disabled false Disables the crystal module.

Variables

Variable Beispiel Beschreibung
version v0.32.1 The version of crystal
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiel

# ~/.config/starship.toml

[crystal]
format = "via [✨ $version](bold blue) "

Dart

The dart module shows the currently installed version of Dart. By default the module will be shown if any of the following conditions are met:

  • The current directory contains a file with .dart extension
  • The current directory contains a .dart_tool directory
  • The current directory contains a pubspec.yaml, pubspec.yml or pubspec.lock file

Optionen

Option Standardwert Beschreibung
format "via [$symbol($version )]($style)" Das Format für das Modul.
version_format "v${raw}" The version format. Available vars are raw, major, minor, & patch
symbol "🎯 " A format string representing the symbol of Dart
detect_extensions ["dart"] Which extensions should trigger this module.
detect_files ["pubspec.yaml", "pubspec.yml", "pubspec.lock"] Which filenames should trigger this module.
detect_folders [".dart_tool"] Which folders should trigger this module.
style "bold blue" Stil für dieses Modul.
disabled false Disables the dart module.

Variables

Variable Beispiel Beschreibung
version v2.8.4 The version of dart
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiel

# ~/.config/starship.toml

[dart]
format = "via [🔰 $version](bold red) "

Deno

The deno module shows you your currently installed version of Deno. By default the module will be shown if any of the following conditions are met:

  • The current directory contains a mod.ts, mod.js, deps.ts or deps.js file

Optionen

Option Standardwert Beschreibung
format "via [$symbol($version )]($style)" Das Format für das Modul.
version_format "v${raw}" The version format. Available vars are raw, major, minor, & patch
symbol "🦕 " A format string representing the symbol of Deno
detect_extensions [] Which extensions should trigger this module.
detect_files ["mod.ts", "mod.js", "deps.ts", "deps.js"] Which filenames should trigger this module.
detect_folders [] Which folders should trigger this module.
style "green bold" Stil für dieses Modul.
disabled false Disables the deno module.

Variables

Variable Beispiel Beschreibung
version v1.8.3 The version of deno
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

Beispiel

# ~/.config/starship.toml

[deno]
format = "via [🦕 $version](green bold) "

Verzeichnis

The directory module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in.

When using the fish style pwd option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option.

For example, given ~/Dev/Nix/nixpkgs/pkgs where nixpkgs is the repo root, and the option set to 1. You will now see ~/D/N/nixpkgs/pkgs, whereas before it would have been nixpkgs/pkgs.

Optionen

Option Standardwert Beschreibung
truncation_length 3 The number of parent folders that the current directory should be truncated to.
truncate_to_repo true Whether or not to truncate to the root of the git repo that you're currently in.
format "[$path]($style)[$read_only]($read_only_style) " Das Format für das Modul.
style "bold cyan" Stil für dieses Modul.
disabled false Disables the directory module.
read_only "🔒" The symbol indicating current directory is read only.
read_only_style "red" The style for the read only symbol.
truncation_symbol "" The symbol to prefix to truncated paths. eg: "…/"
repo_root_style None The style for the root of the git repo when truncate_to_repo option is set to false.
home_symbol "~" The symbol indicating home directory.
This module has a few advanced configuration options that control how the directory is displayed.
Advanced Option Standardwert Beschreibung
substitutions A table of substitutions to be made to the path.
fish_style_pwd_dir_length 0 The number of characters to use when applying fish shell pwd path logic.
use_logical_path true If true render the logical path sourced from the shell via PWD or --logical-path. If false instead render the physical filesystem path with symlinks resolved.

substitutions allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD.

[directory.substitutions]
"/Volumes/network/path" = "/net"
"src/com/long/java/path" = "mypath"

fish_style_pwd_dir_length interacts with the standard truncation options in a way that can be surprising at first: if it's non-zero, the components of the path that would normally be truncated are instead displayed with that many characters. For example, the path /built/this/city/on/rock/and/roll, which would normally be displayed as as rock/and/roll, would be displayed as /b/t/c/o/rock/and/roll with fish_style_pwd_dir_length = 1--the path components that would normally be removed are displayed with a single character. For fish_style_pwd_dir_length = 2, it would be /bu/th/ci/on/rock/and/roll.

Variables

Variable Beispiel Beschreibung
path "D:/Projects" The current directory path
style* "black bold dimmed" Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiel

# ~/.config/starship.toml

[directory]
truncation_length = 8
truncation_symbol = "…/"

Docker Context

The docker_context module shows the currently active Docker context if it's not set to default or if the DOCKER_MACHINE_NAME, DOCKER_HOST or DOCKER_CONTEXT environment variables are set (as they are meant to override the context in use).

Optionen

Option Standardwert Beschreibung
format "via [$symbol$context]($style) " Das Format für das Modul.
symbol "🐳 " The symbol used before displaying the Docker context.
only_with_files true Only show when there's a match
detect_extensions [] Which extensions should trigger this module (needs only_with_files to be true).
detect_files ["docker-compose.yml", "docker-compose.yaml", "Dockerfile"] Which filenames should trigger this module (needs only_with_files to be true).
detect_folders [] Which folders should trigger this module (needs only_with_files to be true).
style "blue bold" Stil für dieses Modul.
disabled false Disables the docker_context module.

Variables

Variable Beispiel Beschreibung
context test_context The current docker context
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiel

# ~/.config/starship.toml

[docker_context]
format = "via [🐋 $context](blue bold)"

Dotnet

The dotnet module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK.

By default this module will only be shown in your prompt when one or more of the following files are present in the current directory:

  • global.json
  • project.json
  • Directory.Build.props
  • Directory.Build.targets
  • Packages.props
  • *.csproj
  • *.fsproj
  • *.xproj

You'll also need the .NET Core SDK installed in order to use it correctly.

Internally, this module uses its own mechanism for version detection. Typically it is twice as fast as running dotnet --version, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting heuristic = false in the module options.

The module will also show the Target Framework Moniker (https://docs.microsoft.com/en-us/dotnet/standard/frameworks#supported-target-framework-versions) when there is a csproj file in the current directory.

Optionen

Option Standardwert Beschreibung
format "via [$symbol($version )(🎯 $tfm )]($style)" Das Format für das Modul.
version_format "v${raw}" The version format. Available vars are raw, major, minor, & patch
symbol ".NET " The symbol used before displaying the version of dotnet.
heuristic true Use faster version detection to keep starship snappy.
detect_extensions ["csproj", "fsproj", "xproj"] Which extensions should trigger this module.
detect_files ["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"] Which filenames should trigger this module.
detect_folders [] Which folders should trigger this modules.
style "bold blue" Stil für dieses Modul.
disabled false Disables the dotnet module.

Variables

Variable Beispiel Beschreibung
version v3.1.201 The version of dotnet sdk
tfm netstandard2.0 The Target Framework Moniker that the current project is targeting
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiel

# ~/.config/starship.toml

[dotnet]
symbol = "🥅 "
style = "green"
heuristic = false

Elixir

The elixir module shows the currently installed version of Elixir and Erlang/OTP. By default the module will be shown if any of the following conditions are met:

  • The current directory contains a mix.exs file.

Optionen

Option Standardwert Beschreibung
format 'via [$symbol($version \(OTP $otp_version\) )]($style)' The format for the module elixir.
version_format "v${raw}" The version format. Available vars are raw, major, minor, & patch
symbol "💧 " The symbol used before displaying the version of Elixir/Erlang.
detect_extensions [] Which extensions should trigger this module.
detect_files ["mix.exs"] Which filenames should trigger this module.
detect_folders [] Which folders should trigger this modules.
style "bold purple" Stil für dieses Modul.
disabled false Disables the elixir module.

Variables

Variable Beispiel Beschreibung
version v1.10 The version of elixir
otp_version The otp version of elixir
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiel

# ~/.config/starship.toml

[elixir]
symbol = "🔮 "

Elm

The elm module shows the currently installed version of Elm. By default the module will be shown if any of the following conditions are met:

  • The current directory contains a elm.json file
  • The current directory contains a elm-package.json file
  • The current directory contains a .elm-version file
  • The current directory contains a elm-stuff folder
  • The current directory contains a *.elm files

Optionen

Option Standardwert Beschreibung
format "via [$symbol($version )]($style)" Das Format für das Modul.
version_format "v${raw}" The version format. Available vars are raw, major, minor, & patch
symbol "🌳 " A format string representing the symbol of Elm.
detect_extensions ["elm"] Which extensions should trigger this module.
detect_files ["elm.json", "elm-package.json", ".elm-version"] Which filenames should trigger this module.
detect_folders ["elm-stuff"] Which folders should trigger this modules.
style "cyan bold" Stil für dieses Modul.
disabled false Disables the elm module.

Variables

Variable Beispiel Beschreibung
version v0.19.1 The version of elm
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiel

# ~/.config/starship.toml

[elm]
format = "via [ $version](cyan bold) "

Umgebungsvariablen

The env_var module displays the current value of a selected environment variables. The module will be shown only if any of the following conditions are met:

  • The variable configuration option matches an existing environment variable
  • The variable configuration option is not defined, but the default configuration option is

::: tip Multiple environmental variables can be displayed by using a .. (see example) If the variable configuration option is not set, the module will display value of variable under the name of text after the . character.

Example: following configuration will display value of USER environment variable

# ~/.config/starship.toml

[env_var.USER]
default = "unknown user"

:::

Optionen

Option Standardwert Beschreibung
symbol "" The symbol used before displaying the variable value.
variable The environment variable to be displayed.
default The default value to be displayed when the selected variable is not defined.
format "with [$env_value]($style) " Das Format für das Modul.
disabled false Disables the env_var module.

Variables

Variable Beispiel Beschreibung
env_value Windows NT (if variable would be $OS) The environment value of option variable
symbol Spiegelt den Wert der Option symbol
style* black bold dimmed Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiel

# ~/.config/starship.toml

[env_var]
variable = "SHELL"
default = "unknown shell"

Displaying multiple environmental variables:

# ~/.config/starship.toml

[env_var.SHELL]
variable = "SHELL"
default = "unknown shell"
[env_var.USER]
default = "unknown user"

Erlang

The erlang module shows the currently installed version of Erlang/OTP. By default the module will be shown if any of the following conditions are met:

  • The current directory contains a rebar.config file.
  • The current directory contains a erlang.mk file.

Optionen

Option Standardwert Beschreibung
format "via [$symbol($version )]($style)" Das Format für das Modul.
version_format "v${raw}" The version format. Available vars are raw, major, minor, & patch
symbol " " The symbol used before displaying the version of erlang.
style "bold red" Stil für dieses Modul.
detect_extensions [] Which extensions should trigger this module.
detect_files ["rebar.config", "elang.mk"] Which filenames should trigger this module.
detect_folders [] Which folders should trigger this modules.
disabled false Disables the erlang module.

Variables

Variable Beispiel Beschreibung
version v22.1.3 The version of erlang
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiel

# ~/.config/starship.toml

[erlang]
format = "via [e $version](bold red) "

Fill

The fill module fills any extra space on the line with a symbol. If multiple fill modules are present in a line they will split the space evenly between them. This is useful for aligning other modules.

Optionen

Option Standardwert Beschreibung
symbol "." The symbol used to fill the line.
style "bold black" Stil für dieses Modul.
disabled false Disables the fill module

Beispiel

# ~/.config/starship.toml
format="AA $fill BB $fill CC"

[fill]
symbol = "-"
style = "bold green"

Produces a prompt that looks like:

AA -------------------------------------------- BB -------------------------------------------- CC

Google Cloud (gcloud)

The gcloud module shows the current configuration for gcloud CLI. This is based on the ~/.config/gcloud/active_config file and the ~/.config/gcloud/configurations/config_{CONFIG NAME} file and the CLOUDSDK_CONFIG env var.

Optionen

Option Standardwert Beschreibung
format 'on [$symbol$account(@$domain)(\($region\))]($style) ' Das Format für das Modul.
symbol "☁️ " The symbol used before displaying the current GCP profile.
region_aliases Table of region aliases to display in addition to the GCP name.
style "bold blue" Stil für dieses Modul.
disabled false Disables the gcloud module.

Variables

Variable Beispiel Beschreibung
region us-central1 The current GCP region
account foo The current GCP profile
domain example.com The current GCP profile domain
project The current GCP project
active default The active config name written in ~/.config/gcloud/active_config
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiele

Display account and project

# ~/.config/starship.toml

[gcloud]
format = 'on [$symbol$account(@$domain)(\($project\))]($style) '

Display active config name only

# ~/.config/starship.toml

[gcloud]
format = "[$symbol$active]($style) "
style = "bold yellow"

Display account and aliased region

# ~/.config/starship.toml

[gcloud]
symbol = "️🇬️ "
[gcloud.region_aliases]
us-central1 = "uc1"
asia-northeast1 = "an1"

Git Branch

The git_branch module shows the active branch of the repo in your current directory.

Optionen

Option Standardwert Beschreibung
always_show_remote false Shows the remote tracking branch name, even if it is equal to the local branch name.
format "on [$symbol$branch]($style) " Das Format für das Modul. Use "$branch" to refer to the current branch name.
symbol " " A format string representing the symbol of git branch.
style "bold purple" Stil für dieses Modul.
truncation_length 2^63 - 1 Truncates a git branch to N graphemes.
truncation_symbol "…" The symbol used to indicate a branch name was truncated. You can use "" for no symbol.
only_attached false Only show the branch name when not in a detached HEAD state.
disabled false Disables the git_branch module.

Variables

Variable Beispiel Beschreibung
branch master The current branch name, falls back to HEAD if there's no current branch (e.g. git detached HEAD).
remote_name origin The remote name.
remote_branch master The name of the branch tracked on remote_name.
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiel

# ~/.config/starship.toml

[git_branch]
symbol = "🌱 "
truncation_length = 4
truncation_symbol = ""

Git Commit

The git_commit module shows the current commit hash and also the tag (if any) of the repo in your current directory.

Optionen

Option Standardwert Beschreibung
commit_hash_length 7 The length of the displayed git commit hash.
format "[\\($hash$tag\\)]($style) " Das Format für das Modul.
style "bold green" Stil für dieses Modul.
only_detached true Only show git commit hash when in detached HEAD state
tag_disabled true Disables showing tag info in git_commit module.
tag_symbol " 🏷 " Tag symbol prefixing the info shown
disabled false Disables the git_commit module.

Variables

Variable Beispiel Beschreibung
hash b703eb3 The current git commit hash
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiel

# ~/.config/starship.toml

[git_commit]
commit_hash_length = 4
tag_symbol = "🔖 "

Git State

The git_state module will show in directories which are part of a git repository, and where there is an operation in progress, such as: REBASING, BISECTING, etc. If there is progress information (e.g., REBASING 3/10), that information will be shown too.

Optionen

Option Standardwert Beschreibung
rebase "REBASING" A format string displayed when a rebase is in progress.
merge "MERGING" A format string displayed when a merge is in progress.
revert "REVERTING" A format string displayed when a revert is in progress.
cherry_pick "CHERRY-PICKING" A format string displayed when a cherry-pick is in progress.
bisect "BISECTING" A format string displayed when a bisect is in progress.
am "AM" A format string displayed when an apply-mailbox (git am) is in progress.
am_or_rebase "AM/REBASE" A format string displayed when an ambiguous apply-mailbox or rebase is in progress.
style "bold yellow" Stil für dieses Modul.
format '\([$state( $progress_current/$progress_total)]($style)\) ' Das Format für das Modul.
disabled false Disables the git_state module.

Variables

Variable Beispiel Beschreibung
state REBASING The current state of the repo
progress_current 1 The current operation progress
progress_total 2 The total operation progress
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiel

# ~/.config/starship.toml

[git_state]
format = '[\($state( $progress_current of $progress_total)\)]($style) '
cherry_pick = "[🍒 PICKING](bold red)"

Git Metrics

The git_metrics module will show the number of added and deleted lines in the current git repository.

::: tip

This module is disabled by default. To enable it, set disabled to false in your configuration file.

:::

Optionen

Option Standardwert Beschreibung
added_style "bold green" The style for the added count.
deleted_style "bold red" The style for the deleted count.
only_nonzero_diffs true Render status only for changed items.
format '([+$added]($added_style) )([-$deleted]($deleted_style) )' Das Format für das Modul.
disabled true Disables the git_metrics module.

Variables

Variable Beispiel Beschreibung
added 1 The current number of added lines
deleted 2 The current number of deleted lines
added_style* Mirrors the value of option added_style
deleted_style* Mirrors the value of option deleted_style

*: This variable can only be used as a part of a style string

Beispiel

# ~/.config/starship.toml

[git_metrics]
added_style = "bold blue"
format = '[+$added]($added_style)/[-$deleted]($deleted_style) '

Git-Status

The git_status module shows symbols representing the state of the repo in your current directory.

Optionen

Option Standardwert Beschreibung
format '([\[$all_status$ahead_behind\]]($style) )' The default format for git_status
conflicted "=" This branch has merge conflicts.
ahead "⇡" The format of ahead
behind "⇣" The format of behind
diverged "⇕" The format of diverged
up_to_date "" The format of up_to_date
untracked "?" The format of untracked
stashed "$" The format of stashed
modified "!" The format of modified
staged "+" The format of staged
renamed "»" The format of renamed
deleted "✘" The format of deleted
style "bold red" Stil für dieses Modul.
disabled false Disables the git_status module.

Variables

The following variables can be used in format:

Variable Beschreibung
all_status Shortcut for$conflicted$stashed$deleted$renamed$modified$staged$untracked
ahead_behind Displays diverged, ahead, behind or up_to_date format string based on the current status of the repo.
conflicted Displays conflicted when this branch has merge conflicts.
untracked Displays untracked when there are untracked files in the working directory.
stashed Displays stashed when a stash exists for the local repository.
modified Displays modified when there are file modifications in the working directory.
staged Displays staged when a new file has been added to the staging area.
renamed Displays renamed when a renamed file has been added to the staging area.
deleted Displays deleted when a file's deletion has been added to the staging area.
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

The following variables can be used in diverged:

Variable Beschreibung
ahead_count Number of commits ahead of the tracking branch
behind_count Number of commits behind the tracking branch

The following variables can be used in conflicted, ahead, behind, untracked, stashed, modified, staged, renamed and deleted:

Variable Beschreibung
count Show the number of files

Beispiel

# ~/.config/starship.toml

[git_status]
conflicted = "🏳"
ahead = "🏎💨"
behind = "😰"
diverged = "😵"
up_to_date = "✓"
untracked = "🤷‍"
stashed = "📦"
modified = "📝"
staged = '[++\($count\)](green)'
renamed = "👅"
deleted = "🗑"

Show ahead/behind count of the branch being tracked

# ~/.config/starship.toml

[git_status]
ahead = "⇡${count}"
diverged = "⇕⇡${ahead_count}⇣${behind_count}"
behind = "⇣${count}"

Go

The golang module shows the currently installed version of Go. By default the module will be shown if any of the following conditions are met:

  • The current directory contains a go.mod file
  • The current directory contains a go.sum file
  • The current directory contains a glide.yaml file
  • The current directory contains a Gopkg.yml file
  • The current directory contains a Gopkg.lock file
  • The current directory contains a .go-version file
  • The current directory contains a Godeps directory
  • The current directory contains a file with the .go extension

Optionen

Option Standardwert Beschreibung
format "via [$symbol($version )]($style)" Das Format für das Modul.
version_format "v${raw}" The version format. Available vars are raw, major, minor, & patch
symbol "🐹 " A format string representing the symbol of Go.
detect_extensions ["go"] Which extensions should trigger this module.
detect_files ["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"] Which filenames should trigger this module.
detect_folders ["Godeps"] Which folders should trigger this module.
style "bold cyan" Stil für dieses Modul.
disabled false Disables the golang module.

Variables

Variable Beispiel Beschreibung
version v1.12.1 The version of go
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiel

# ~/.config/starship.toml

[golang]
format = "via [🏎💨 $version](bold cyan) "

Helm

The helm module shows the currently installed version of Helm. By default the module will be shown if any of the following conditions are met:

  • The current directory contains a helmfile.yaml file
  • The current directory contains a Chart.yaml file

Optionen

Option Standardwert Beschreibung
format "via [$symbol($version )]($style)" Das Format für das Modul.
version_format "v${raw}" The version format. Available vars are raw, major, minor, & patch
detect_extensions [] Which extensions should trigger this module.
detect_files ["helmfile.yaml", "Chart.yaml"] Which filenames should trigger this module.
detect_folders [] Which folders should trigger this modules.
symbol "⎈ " A format string representing the symbol of Helm.
style "bold white" Stil für dieses Modul.
disabled false Disables the helm module.

Variables

Variable Beispiel Beschreibung
version v3.1.1 The version of helm
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiel

# ~/.config/starship.toml

[helm]
format = "via [⎈ $version](bold white) "

Hostname

The hostname module shows the system hostname.

Optionen

Option Standardwert Beschreibung
ssh_only true Only show hostname when connected to an SSH session.
trim_at "." String that the hostname is cut off at, after the first match. "." will stop after the first dot. "" will disable any truncation
format "[$hostname]($style) in " Das Format für das Modul.
style "bold dimmed green" Stil für dieses Modul.
disabled false Disables the hostname module.

Variables

Variable Beispiel Beschreibung
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiel

# ~/.config/starship.toml

[hostname]
ssh_only = false
format =  "on [$hostname](bold red) "
trim_at = ".companyname.com"
disabled = false

Java

The java module shows the currently installed version of Java. By default the module will be shown if any of the following conditions are met:

  • The current directory contains a pom.xml, build.gradle.kts, build.sbt, .java-version, .deps.edn, project.clj, or build.boot file
  • The current directory contains a file with the .java, .class, .gradle, .jar, .clj, or .cljc extension

Optionen

Option Standardwert Beschreibung
format "via [${symbol}(${version} )]($style)" Das Format für das Modul.
version_format "v${raw}" The version format. Available vars are raw, major, minor, & patch
detect_extensions ["java", "class", "gradle", "jar", "cljs", "cljc"] Which extensions should trigger this module.
detect_files ["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"] Which filenames should trigger this module.
detect_folders [] Which folders should trigger this modules.
symbol "☕ " A format string representing the symbol of Java
style "red dimmed" Stil für dieses Modul.
disabled false Disables the java module.

Variables

Variable Beispiel Beschreibung
version v14 The version of java
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiel

# ~/.config/starship.toml

[java]
symbol = "🌟 "

Jobs

The jobs module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there are at least 2 jobs, or more than the number_threshold config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the symbol_threshold config value, if it exists. You can set both values to 0 in order to always show the symbol and number of jobs, even if there are 0 jobs running.

The default functionality is:

  • 0 jobs -> Nothing is shown.
  • 1 job -> symbol is shown.
  • 2 jobs or more -> symbol + number are shown.

::: Warnung

This module is not supported on tcsh and nu.

:::

::: Warnung

The threshold option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the threshold config value, if it exists. If threshold is set to 0, then the module will also show when there are 0 jobs running.

:::

Optionen

Option Standardwert Beschreibung
threshold* 1 Show number of jobs if exceeded.
symbol_threshold 1 Show symbol if the job count is at least symbol_threshold.
number_threshold 2 Show the number of jobs if the job count is at least number_threshold.
format "[$symbol$number]($style) " Das Format für das Modul.
symbol "✦" The string used to represent the symbol variable.
style "bold blue" Stil für dieses Modul.
disabled false Disables the jobs module.
*: This option is deprecated, please use the

number_threshold and symbol_threshold options instead.

Variables

Variable Beispiel Beschreibung
number 1 The number of jobs
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiel

# ~/.config/starship.toml

[jobs]
symbol = "+ "
number_threshold = 4
symbol_threshold = 0

Julia

The julia module shows the currently installed version of Julia. By default the module will be shown if any of the following conditions are met:

  • The current directory contains a Project.toml file
  • The current directory contains a Manifest.toml file
  • The current directory contains a file with the .jl extension

Optionen

Option Standardwert Beschreibung
format "via [$symbol($version )]($style)" Das Format für das Modul.
version_format "v${raw}" The version format. Available vars are raw, major, minor, & patch
detect_extensions ["jl"] Which extensions should trigger this module.
detect_files ["Project.toml", "Manifest.toml"] Which filenames should trigger this module.
detect_folders [] Which folders should trigger this modules.
symbol "ஃ " A format string representing the symbol of Julia.
style "bold purple" Stil für dieses Modul.
disabled false Disables the julia module.

Variables

Variable Beispiel Beschreibung
version v1.4.0 The version of julia
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiel

# ~/.config/starship.toml

[julia]
symbol = "∴ "

Kotlin

The kotlin module shows the currently installed version of Kotlin. By default the module will be shown if any of the following conditions are met:

  • The current directory contains a .kt or a .kts file

Optionen

Option Standardwert Beschreibung
format "via [$symbol($version )]($style)" Das Format für das Modul.
version_format "v${raw}" The version format. Available vars are raw, major, minor, & patch
detect_extensions ["kt", "kts"] Which extensions should trigger this module.
detect_files [] Which filenames should trigger this module.
detect_folders [] Which folders should trigger this modules.
symbol "🅺 " A format string representing the symbol of Kotlin.
style "bold blue" Stil für dieses Modul.
kotlin_binary "kotlin" Configures the kotlin binary that Starship executes when getting the version.
disabled false Disables the kotlin module.

Variables

Variable Beispiel Beschreibung
version v1.4.21 The version of kotlin
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiel

# ~/.config/starship.toml

[kotlin]
symbol = "🅺 "
# ~/.config/starship.toml

[kotlin]
# Uses the Kotlin Compiler binary to get the installed version
kotlin_binary = "kotlinc"

Kubernetes

Displays the current Kubernetes context name and, if set, the namespace from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via kubectl config set-context starship-cluster --namespace astronaut. If the $KUBECONFIG env var is set the module will use that if not it will use the ~/.kube/config.

::: tip

This module is disabled by default. To enable it, set disabled to false in your configuration file.

:::

Optionen

Option Standardwert Beschreibung
symbol "☸ " A format string representing the symbol displayed before the Cluster.
format '[$symbol$context( \($namespace\))]($style) in ' Das Format für das Modul.
style "cyan bold" Stil für dieses Modul.
context_aliases Table of context aliases to display.
disabled true Disables the kubernetes module.

Variables

Variable Beispiel Beschreibung
context starship-cluster The current kubernetes context
namespace starship-namespace If set, the current kubernetes namespace
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiel

# ~/.config/starship.toml

[kubernetes]
format = 'on [⛵ $context \($namespace\)](dimmed green) '
disabled = false
[kubernetes.context_aliases]
"dev.local.cluster.k8s" = "dev"
".*/openshift-cluster/.*" = "openshift"
"gke_.*_(?P<cluster>[\\w-]+)" = "gke-$cluster"

Regex Matching

Additional to simple aliasing, context_aliases also supports extended matching and renaming using regular expressions.

The regular expression must match on the entire kube context, capture groups can be referenced using $name and $N in the replacement. This is more explained in the regex crate documentation.

Long and automatically generated cluster names can be identified and shortened using regular expressions:

[kubernetes.context_aliases]
# OpenShift contexts carry the namespace and user in the kube context: `namespace/name/user`:
".*/openshift-cluster/.*" = "openshift"
# Or better, to rename every OpenShift cluster at once:
".*/(?P<cluster>[\\w-]+)/.*" = "$cluster"

# Contexts from GKE, AWS and other cloud providers usually carry additional information, like the region/zone.
# The following entry matches on the GKE format (`gke_projectname_zone_cluster-name`)
# and renames every matching kube context into a more readable format (`gke-cluster-name`):
"gke_.*_(?P<cluster>[\\w-]+)" = "gke-$cluster"

Line Break

The line_break module separates the prompt into two lines.

Optionen

Option Standardwert Beschreibung
disabled false Disables the line_break module, making the prompt a single line.

Beispiel

# ~/.config/starship.toml

[line_break]
disabled = true

Lua

The lua module shows the currently installed version of Lua. By default the module will be shown if any of the following conditions are met:

  • The current directory contains a .lua-version file
  • The current directory contains a lua directory
  • The current directory contains a file with the .lua extension

Optionen

Option Standardwert Beschreibung
format "via [$symbol($version )]($style)" Das Format für das Modul.
version_format "v${raw}" The version format. Available vars are raw, major, minor, & patch
symbol "🌙 " A format string representing the symbol of Lua.
detect_extensions ["lua"] Which extensions should trigger this module.
detect_files [".lua-version"] Which filenames should trigger this module.
detect_folders ["lua"] Which folders should trigger this module.
style "bold blue" Stil für dieses Modul.
lua_binary "lua" Configures the lua binary that Starship executes when getting the version.
disabled false Disables the lua module.

Variables

Variable Beispiel Beschreibung
version v5.4.0 The version of lua
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiel

# ~/.config/starship.toml

[lua]
format = "via [🌕 $version](bold blue) "

Memory Usage

The memory_usage module shows current system memory and swap usage.

By default the swap usage is displayed if the total system swap is non-zero.

::: tip

This module is disabled by default. To enable it, set disabled to false in your configuration file.

:::

Optionen

Option Standardwert Beschreibung
threshold 75 Hide the memory usage unless it exceeds this percentage.
format "via $symbol [${ram}( | ${swap})]($style) " Das Format für das Modul.
symbol "🐏" The symbol used before displaying the memory usage.
style "bold dimmed white" Stil für dieses Modul.
disabled true Disables the memory_usage module.

Variables

Variable Beispiel Beschreibung
ram 31GiB/65GiB The usage/total RAM of the current system memory.
ram_pct 48% The percentage of the current system memory.
swap** 1GiB/4GiB The swap memory size of the current system swap memory file.
swap_pct** 77% The swap memory percentage of the current system swap memory file.
symbol 🐏 Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string **: The SWAP file information is only displayed if detected on the current system

Beispiel

# ~/.config/starship.toml

[memory_usage]
disabled = false
threshold = -1
symbol = " "
style = "bold dimmed green"

Mercurial Branch

The hg_branch module shows the active branch of the repo in your current directory.

Optionen

Option Standardwert Beschreibung
symbol " " The symbol used before the hg bookmark or branch name of the repo in your current directory.
style "bold purple" Stil für dieses Modul.
format "on [$symbol$branch]($style) " Das Format für das Modul.
truncation_length 2^63 - 1 Truncates the hg branch name to N graphemes
truncation_symbol "…" The symbol used to indicate a branch name was truncated.
disabled true Disables the hg_branch module.

Variables

Variable Beispiel Beschreibung
branch master The active mercurial branch
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiel

# ~/.config/starship.toml

[hg_branch]
format = "on [🌱 $branch](bold purple)"
truncation_length = 4
truncation_symbol = ""

Nim

The nim module shows the currently installed version of Nim. By default the module will be shown if any of the following conditions are met:

  • The current directory contains a nim.cfg file
  • The current directory contains a file with the .nim extension
  • The current directory contains a file with the .nims extension
  • The current directory contains a file with the .nimble extension

Optionen

Option Standardwert Beschreibung
format "via [$symbol($version )]($style)" The format for the module
version_format "v${raw}" The version format. Available vars are raw, major, minor, & patch
symbol "👑 " The symbol used before displaying the version of Nim.
detect_extensions ["nim", "nims", "nimble"] Which extensions should trigger this module.
detect_files ["nim.cfg"] Which filenames should trigger this module.
detect_folders [] Which folders should trigger this module.
style "bold yellow" Stil für dieses Modul.
disabled false Disables the nim module.

Variables

Variable Beispiel Beschreibung
version v1.2.0 The version of nimc
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiel

# ~/.config/starship.toml

[nim]
style = "yellow"
symbol = "🎣 "

Nix-shell

The nix_shell module shows the nix-shell environment. The module will be shown when inside a nix-shell environment.

Optionen

Option Standardwert Beschreibung
format 'via [$symbol$state( \($name\))]($style) ' Das Format für das Modul.
symbol "❄️ " A format string representing the symbol of nix-shell.
style "bold blue" Stil für dieses Modul.
impure_msg "impure" A format string shown when the shell is impure.
pure_msg "pure" A format string shown when the shell is pure.
disabled false Disables the nix_shell module.

Variables

Variable Beispiel Beschreibung
state pure The state of the nix-shell
name lorri The name of the nix-shell
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiel

# ~/.config/starship.toml

[nix_shell]
disabled = true
impure_msg = "[impure shell](bold red)"
pure_msg = "[pure shell](bold green)"
format = 'via [☃️ $state( \($name\))](bold blue) '

Node.js

The nodejs module shows the currently installed version of Node.js. By default the module will be shown if any of the following conditions are met:

  • The current directory contains a package.json file
  • The current directory contains a .node-version file
  • The current directory contains a .nvmrc file
  • The current directory contains a node_modules directory
  • The current directory contains a file with the .js, .mjs or .cjs extension
  • The current directory contains a file with the .ts extension

Optionen

Option Standardwert Beschreibung
format "via [$symbol($version )]($style)" Das Format für das Modul.
version_format "v${raw}" The version format. Available vars are raw, major, minor, & patch
symbol " " A format string representing the symbol of Node.js.
detect_extensions ["js", "mjs", "cjs", "ts"] Which extensions should trigger this module.
detect_files ["package.json", ".node-version"] Which filenames should trigger this module.
detect_folders ["node_modules"] Which folders should trigger this module.
style "bold green" Stil für dieses Modul.
disabled false Disables the nodejs module.
not_capable_style bold red The style for the module when an engines property in package.json does not match the Node.js version.

Variables

Variable Beispiel Beschreibung
version v13.12.0 The version of node
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiel

# ~/.config/starship.toml

[nodejs]
format = "via [🤖 $version](bold green) "

OCaml

The ocaml module shows the currently installed version of OCaml. By default the module will be shown if any of the following conditions are met:

  • The current directory contains a file with .opam extension or _opam directory
  • The current directory contains a esy.lock directory
  • The current directory contains a dune or dune-project file
  • The current directory contains a jbuild or jbuild-ignore file
  • The current directory contains a .merlin file
  • The current directory contains a file with .ml, .mli, .re or .rei extension

Optionen

Option Standardwert Beschreibung
format "via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)" The format string for the module.
version_format "v${raw}" The version format. Available vars are raw, major, minor, & patch
symbol "🐫 " The symbol used before displaying the version of OCaml.
global_switch_indicator "" The format string used to represent global OPAM switch.
local_switch_indicator "*" The format string used to represent local OPAM switch.
detect_extensions ["opam", "ml", "mli", "re", "rei"] Which extensions should trigger this module.
detect_files ["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"] Which filenames should trigger this module.
detect_folders ["_opam", "esy.lock"] Which folders should trigger this module.
style "bold yellow" Stil für dieses Modul.
disabled false Disables the ocaml module.

Variables

Variable Beispiel Beschreibung
version v4.10.0 The version of ocaml
switch_name my-project The active OPAM switch
switch_indicator Mirrors the value of indicator for currently active OPAM switch
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiel

# ~/.config/starship.toml

[ocaml]
format = "via [🐪 $version]($style) "

OpenStack

The openstack module shows the current OpenStack cloud and project. The module only active when the OS_CLOUD env var is set, in which case it will read clouds.yaml file from any of the default locations. to fetch the current project in use.

Optionen

Option Standardwert Beschreibung
format "on [$symbol$cloud(\\($project\\))]($style) " Das Format für das Modul.
symbol "☁️ " The symbol used before displaying the current OpenStack cloud.
style "bold yellow" Stil für dieses Modul.
disabled false Disables the openstack module.

Variables

Variable Beispiel Beschreibung
cloud corp The current OpenStack cloud
project dev The current OpenStack project
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiel

# ~/.config/starship.toml

[openstack]
format = "on [$symbol$cloud(\\($project\\))]($style) "
style = "bold yellow"
symbol = "☁️ "

Package Version

The package module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports npm, nimble, cargo, poetry, composer, gradle, julia, mix, helm and shards packages.

  • npm The npm package version is extracted from the package.json present in the current directory
  • Cargo The cargo package version is extracted from the Cargo.toml present in the current directory
  • Nimble - The nimble package version is extracted from the *.nimble file present in the current directory with the nimble dump command
  • Poetry The poetry package version is extracted from the pyproject.toml present in the current directory
  • Python - The python package version is extracted from the setup.cfg present in the current directory
  • Composer The composer package version is extracted from the composer.json present in the current directory
  • Gradle The gradle package version is extracted from the build.gradle present
  • Julia - The package version is extracted from the Project.toml present
  • Mix - The mix package version is extracted from the mix.exs present
  • Helm - The helm chart version is extracted from the Chart.yaml present
  • Maven - The maven package version is extracted from the pom.xml present
  • Meson - The meson package version is extracted from the meson.build present
  • Shards - The shards package version is extracted from the shard.yml present
  • V - The vlang package version is extracted from the v.mod present
  • SBT - The sbt package version is extracted from the build.sbt present in the current directory

⚠️ Die angezeigte Version ist die des Pakets, dessen Quellcode im Verzeichnis liegt, nicht die des Paketmanagers.

Optionen

Option Standardwert Beschreibung
format "is [$symbol$version]($style) " Das Format für das Modul.
symbol "📦 " The symbol used before displaying the version the package.
version_format "v${raw}" The version format. Available vars are raw, major, minor, & patch
style "bold 208" Stil für dieses Modul.
display_private false Enable displaying version for packages marked as private.
disabled false Disables the package module.

Variables

Variable Beispiel Beschreibung
version v1.0.0 The version of your package
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiel

# ~/.config/starship.toml

[package]
format = "via [🎁 $version](208 bold) "

Perl

The perl module shows the currently installed version of Perl. By default the module will be shown if any of the following conditions are met:

  • The current directory contains a Makefile.PL or Build.PL file
  • The current directory contains a cpanfile or cpanfile.snapshot file
  • The current directory contains a META.json file or META.yml file
  • The current directory contains a .perl-version file
  • The current directory contains a .pl, .pm or .pod

Optionen

Option Standardwert Beschreibung
format "via [$symbol($version )]($style)" The format string for the module.
version_format "v${raw}" The version format. Available vars are raw, major, minor, & patch
symbol "🐪 " The symbol used before displaying the version of Perl
detect_extensions ["pl", "pm", "pod"] Which extensions should trigger this module.
detect_files ["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"] Which filenames should trigger this module.
detect_folders [] Which folders should trigger this module.
style "bold 149" Stil für dieses Modul.
disabled false Disables the perl module.

Variables

Variable Beispiel Beschreibung
version v5.26.1 The version of perl
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

Beispiel

# ~/.config/starship.toml

[perl]
format = "via [🦪 $version]($style) "

PHP

The php module shows the currently installed version of PHP. By default the module will be shown if any of the following conditions are met:

  • The current directory contains a composer.json file
  • The current directory contains a .php-version file
  • The current directory contains a .php extension

Optionen

Option Standardwert Beschreibung
format "via [$symbol($version )]($style)" Das Format für das Modul.
version_format "v${raw}" The version format. Available vars are raw, major, minor, & patch
symbol "🐘 " The symbol used before displaying the version of PHP.
detect_extensions ["php"] Which extensions should trigger this module.
detect_files ["composer.json", ".php-version"] Which filenames should trigger this module.
detect_folders [] Which folders should trigger this module.
style "147 bold" Stil für dieses Modul.
disabled false Disables the php module.

Variables

Variable Beispiel Beschreibung
version v7.3.8 The version of php
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiel

# ~/.config/starship.toml

[php]
format = "via [🔹 $version](147 bold) "

Pulumi

The pulumi module shows the currently selected Pulumi Stack and version.

::: tip

By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, follow the example shown below.

:::

By default the module will be shown if any of the following conditions are met:

  • The current directory contains either Pulumi.yaml or Pulumi.yml
  • A parent directory contains either Pulumi.yaml or Pulumi.yml

Optionen

Option Standardwert Beschreibung
format "via [$symbol$stack]($style) " The format string for the module.
version_format "v${raw}" The version format. Available vars are raw, major, minor, & patch
symbol " " A format string shown before the Pulumi stack.
style "bold 5" Stil für dieses Modul.
disabled false Disables the pulumi module.

Variables

Variable Beispiel Beschreibung
version v0.12.24 The version of pulumi
stack dev The current Pulumi stack
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiel

With Pulumi Version

# ~/.config/starship.toml

[pulumi]
format = "[🛥 ($version )$stack]($style) "

Without Pulumi version

# ~/.config/starship.toml
[pulumi]
symbol = "🛥 "
format = "[$symbol$stack]($style) "

PureScript

The purescript module shows the currently installed version of PureScript version. By default the module will be shown if any of the following conditions are met:

  • The current directory contains a spago.dhall file
  • The current directory contains a file with the .purs extension

Optionen

Option Standardwert Beschreibung
format "via [$symbol($version )]($style)" Das Format für das Modul.
version_format "v${raw}" The version format. Available vars are raw, major, minor, & patch
symbol "<=> " The symbol used before displaying the version of PureScript.
detect_extensions ["purs"] Which extensions should trigger this module.
detect_files ["spago.dhall"] Which filenames should trigger this module.
detect_folders [] Which folders should trigger this module.
style "bold white" Stil für dieses Modul.
disabled false Disables the purescript module.

Variables

Variable Beispiel Beschreibung
version 0.13.5 The version of purescript
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiel

# ~/.config/starship.toml

[purescript]
format = "via [$symbol$version](bold white)"

Python

The python module shows the currently installed version of Python and the current Python virtual environment if one is activated.

If pyenv_version_name is set to true, it will display the pyenv version name. Otherwise, it will display the version number from python --version.

By default the module will be shown if any of the following conditions are met:

  • The current directory contains a .python-version file
  • The current directory contains a Pipfile file
  • The current directory contains a __init__.py file
  • The current directory contains a pyproject.toml file
  • The current directory contains a requirements.txt file
  • The current directory contains a setup.py file
  • The current directory contains a tox.ini file
  • The current directory contains a file with the .py extension.
  • A virtual environment is currently activated

Optionen

Option Standardwert Beschreibung
format 'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)' Das Format für das Modul.
version_format "v${raw}" The version format. Available vars are raw, major, minor, & patch
symbol "🐍 " A format string representing the symbol of Python
style "yellow bold" Stil für dieses Modul.
pyenv_version_name false Use pyenv to get Python version
pyenv_prefix pyenv Prefix before pyenv version display, only used if pyenv is used
python_binary ["python", "python3", "python2"] Configures the python binaries that Starship should executes when getting the version.
detect_extensions ["py"] Which extensions should trigger this module
detect_files [".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"] Which filenames should trigger this module
detect_folders [] Which folders should trigger this module
disabled false Disables the python module.

::: tip

The python_binary variable accepts either a string or a list of strings. Starship will try executing each binary until it gets a result. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used.

The default values and order for python_binary was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a python, no matter if it points to python3 or python2). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink /usr/bin/python to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to "python3" will hide any Python version 2, see example below.

:::

Variables

Variable Beispiel Beschreibung
version "v3.8.1" The version of python
symbol "🐍 " Spiegelt den Wert der Option symbol
style "yellow bold" Spiegelt den Wert der Option style
pyenv_prefix "pyenv " Mirrors the value of option pyenv_prefix
virtualenv "venv" The current virtualenv name

Beispiel

# ~/.config/starship.toml

[python]
symbol = "👾 "
pyenv_version_name = true
# ~/.config/starship.toml

[python]
# Only use the `python3` binary to get the version.
python_binary = "python3"
# ~/.config/starship.toml

[python]
# Don't trigger for files with the py extension
detect_extensions = []
# ~/.config/starship.toml

[python]
# Display the version of python from inside a local venv.
#
# Note this will only work when the venv is inside the project and it will only
# work in the directory that contains the venv dir but maybe this is ok?
python_binary = ["./venv/bin/python", "python", "python3", "python2"]

R

The rlang module shows the currently installed version of R. The module will be shown if any of the following conditions are met:

  • The current directory contains a file with the .R extension.
  • The current directory contains a file with the .Rd extension.
  • The current directory contains a file with the .Rmd extension.
  • The current directory contains a file with the .Rproj extension.
  • The current directory contains a file with the .Rsx extension.
  • The current directory contains a .Rprofile file
  • The current directory contains a .Rproj.user folder

Optionen

Option Standardwert Beschreibung
format "via [$symbol($version )]($style)" Das Format für das Modul.
version_format "v${raw}" The version format. Available vars are raw, major, minor, & patch
symbol "📐" A format string representing the symbol of R.
style "blue bold" Stil für dieses Modul.
detect_extensions ["R", "Rd", "Rmd", "Rproj", "Rsx"] Which extensions should trigger this module
detect_files [".Rprofile"] Which filenames should trigger this module
detect_folders [".Rproj.user"] Which folders should trigger this module
disabled false Disables the r module.

Variables

Variable Beispiel Beschreibung
version v4.0.5 The version of R
symbol Spiegelt den Wert der Option symbol
style "blue bold" Spiegelt den Wert der Option style

Beispiel

# ~/.config/starship.toml

[rlang]
format = "with [📐 $version](blue bold) "

Red

By default the red module shows the currently installed version of Red. The module will be shown if any of the following conditions are met:

  • The current directory contains a file with .red or .reds extension

Optionen

Option Standardwert Beschreibung
format "via [$symbol($version )]($style)" Das Format für das Modul.
version_format "v${raw}" The version format. Available vars are raw, major, minor, & patch
symbol "🔺 " A format string representing the symbol of Red.
detect_extensions ["red"] Which extensions should trigger this module.
detect_files [] Which filenames should trigger this module.
detect_folders [] Which folders should trigger this module.
style "red bold" Stil für dieses Modul.
disabled false Disables the red module.

Variables

Variable Beispiel Beschreibung
version v2.5.1 The version of red
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiel

# ~/.config/starship.toml

[red]
symbol = "🔴 "

Ruby

By default the ruby module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met:

  • The current directory contains a Gemfile file
  • The current directory contains a .ruby-version file
  • The current directory contains a .rb file
  • The environment variables RUBY_VERSION or RBENV_VERSION are set

Starship gets the current Ruby version by running ruby -v.

Optionen

Option Standardwert Beschreibung
format "via [$symbol($version )]($style)" Das Format für das Modul.
version_format "v${raw}" The version format. Available vars are raw, major, minor, & patch
symbol "💎 " A format string representing the symbol of Ruby.
detect_extensions ["rb"] Which extensions should trigger this module.
detect_files ["Gemfile", ".ruby-version"] Which filenames should trigger this module.
detect_folders [] Which folders should trigger this module.
detect_variables ["RUBY_VERSION", "RBENV_VERSION"] Which environment variables should trigger this module.
style "bold red" Stil für dieses Modul.
disabled false Disables the ruby module.

Variables

Variable Beispiel Beschreibung
version v2.5.1 The version of ruby
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiel

# ~/.config/starship.toml

[ruby]
symbol = "🔺 "

Rust

By default the rust module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met:

  • The current directory contains a Cargo.toml file
  • The current directory contains a file with the .rs extension

Optionen

Option Standardwert Beschreibung
format "via [$symbol($version )]($style)" Das Format für das Modul.
version_format "v${raw}" The version format. Available vars are raw, major, minor, & patch
symbol "🦀 " A format string representing the symbol of Rust
detect_extensions ["rs"] Which extensions should trigger this module.
detect_files ["Cargo.toml"] Which filenames should trigger this module.
detect_folders [] Which folders should trigger this module.
style "bold red" Stil für dieses Modul.
disabled false Disables the rust module.

Variables

Variable Beispiel Beschreibung
version v1.43.0-nightly The version of rustc
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiel

# ~/.config/starship.toml

[rust]
format = "via [⚙️ $version](red bold)"

Scala

The scala module shows the currently installed version of Scala. By default the module will be shown if any of the following conditions are met:

  • The current directory contains a build.sbt, .scalaenv or .sbtenv file
  • The current directory contains a file with the .scala or .sbt extension
  • The current directory contains a directory named .metals

Optionen

Option Standardwert Beschreibung
format "via [${symbol}(${version} )]($style)" Das Format für das Modul.
version_format "v${raw}" The version format. Available vars are raw, major, minor, & patch
detect_extensions ["sbt", "scala"] Which extensions should trigger this module.
detect_files [".scalaenv", ".sbtenv", "build.sbt"] Which filenames should trigger this module.
detect_folders [".metals"] Which folders should trigger this modules.
symbol "🆂 " A format string representing the symbol of Scala.
style "red dimmed" Stil für dieses Modul.
disabled false Disables the scala module.

Variables

Variable Beispiel Beschreibung
version 2.13.5 The version of scala
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiel

# ~/.config/starship.toml

[scala]
symbol = "🌟 "

Shell

The shell module shows an indicator for currently used shell.

::: tip

This module is disabled by default. To enable it, set disabled to false in your configuration file.

:::

Optionen

Option Standardwert Beschreibung
bash_indicator bsh A format string used to represent bash.
fish_indicator fsh A format string used to represent fish.
zsh_indicator zsh A format string used to represent zsh.
powershell_indicator psh A format string used to represent powershell.
ion_indicator ion A format string used to represent ion.
elvish_indicator esh A format string used to represent elvish.
tcsh_indicator tsh A format string used to represent tcsh.
xonsh_indicator xsh A format string used to represent xonsh.
unknown_indicator The default value to be displayed when the shell is unknown.
format "[$indicator]($style) " Das Format für das Modul.
style "white bold" Stil für dieses Modul.
disabled true Disables the shell module.

Variables

Variable Standardwert Beschreibung
indicator Mirrors the value of indicator for currently used shell.
style* Mirrors the value of option style.

*: This variable can only be used as a part of a style string

Beispiele

# ~/.config/starship.toml

[shell]
fish_indicator = ""
powershell_indicator = "_"
unknown_indicator = "mystery shell"
style = "cyan bold"
disabled = false

SHLVL

The shlvl module shows the current SHLVL ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold.

Optionen

Option Standardwert Beschreibung
threshold 2 Display threshold.
format "[$symbol$shlvl]($style) " Das Format für das Modul.
symbol "↕️ " The symbol used to represent the SHLVL.
repeat false Causes symbol to be repeated by the current SHLVL amount.
style "bold yellow" Stil für dieses Modul.
disabled true Disables the shlvl module.

Variables

Variable Beispiel Beschreibung
shlvl 3 The current value of SHLVL
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiel

# ~/.config/starship.toml

[shlvl]
disabled = false
format = "$shlvl level(s) down"
threshold = 3

Singularity

The singularity module shows the current Singularity image, if inside a container and $SINGULARITY_NAME is set.

Optionen

Option Standardwert Beschreibung
format '[$symbol\[$env\]]($style) ' Das Format für das Modul.
symbol "" A format string displayed before the image name.
style "bold dimmed blue" Stil für dieses Modul.
disabled false Disables the singularity module.

Variables

Variable Beispiel Beschreibung
env centos.img The current Singularity image
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiel

# ~/.config/starship.toml

[singularity]
format = '[📦 \[$env\]]($style) '

Status

The status module displays the exit code of the previous command. The module will be shown only if the exit code is not 0.

::: tip

This module is disabled by default. To enable it, set disabled to false in your configuration file.

:::

::: warning This module is not supported on elvish and nu shell. :::

Optionen

Option Standardwert Beschreibung
format "[$symbol$status]($style) " The format of the module
symbol "✖" The symbol displayed on program error
success_symbol "✔️" The symbol displayed on program success
not_executable_symbol "🚫" The symbol displayed when file isn't executable
not_found_symbol "🔍" The symbol displayed when the command can't be found
sigint_symbol "🧱" The symbol displayed on SIGINT (Ctrl + c)
signal_symbol "⚡" The symbol displayed on any signal
style "bold red" Stil für dieses Modul.
recognize_signal_code true Enable signal mapping from exit code
map_symbol false Enable symbols mapping from exit code
pipestatus false Enable pipestatus reporting
pipestatus_separator ` `
pipestatus_format \\[$pipestatus\\] => [$symbol$common_meaning$signal_name$maybe_int]($style) The format of the module when the command is a pipeline
disabled true Disables the status module.

Variables

Variable Beispiel Beschreibung
status 127 The exit code of the last command
int 127 The exit code of the last command
common_meaning ERROR Meaning of the code if not a signal
signal_number 9 Signal number corresponding to the exit code, only if signalled
signal_name KILL Name of the signal corresponding to the exit code, only if signalled
maybe_int 7 Contains the exit code number when no meaning has been found
pipestatus Rendering of in pipeline programs's exit codes, this is only available in pipestatus_format
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiel


# ~/.config/starship.toml

[status]
style = "bg:blue"
symbol = "🔴"
format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) '
map_symbol = true
disabled = false

Sudo

The sudo module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached.

::: tip

This module is disabled by default. To enable it, set disabled to false in your configuration file.

:::

Optionen

Option Standardwert Beschreibung
format [as $symbol]($style)" The format of the module
symbol "🧙 " The symbol displayed when credentials are cached
style "bold blue" Stil für dieses Modul.
allow_windows false Since windows has no default sudo, default is disabled.
disabled true Disables the sudo module.

Variables

Variable Beispiel Beschreibung
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiel


# ~/.config/starship.toml

[sudo]
style = "bold green"
symbol = "👩‍💻 "
disabled = false
# On windows
# $HOME\.starship\config.toml

[sudo]
allow_windows = true
disabled = false

Swift

By default the swift module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met:

  • The current directory contains a Package.swift file
  • The current directory contains a file with the .swift extension

Optionen

Option Standardwert Beschreibung
format "via [$symbol($version )]($style)" Das Format für das Modul.
version_format "v${raw}" The version format. Available vars are raw, major, minor, & patch
symbol "🐦 " A format string representing the symbol of Swift
detect_extensions ["swift"] Which extensions should trigger this module.
detect_files ["Package.swift"] Which filenames should trigger this module.
detect_folders [] Which folders should trigger this module.
style "bold 202" Stil für dieses Modul.
disabled false Disables the swift module.

Variables

Variable Beispiel Beschreibung
version v5.2.4 The version of swift
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiel

# ~/.config/starship.toml

[swift]
format = "via [🏎  $version](red bold)"

Terraform

The terraform module shows the currently selected Terraform workspace and version.

::: tip

By default the Terraform version is not shown, since this is slow for current versions of Terraform when a lot of plugins are in use. If you still want to enable it, follow the example shown below.

:::

By default the module will be shown if any of the following conditions are met:

  • The current directory contains a .terraform folder
  • Current directory contains a file with the .tf, .tfplan or .tfstate extensions

Optionen

Option Standardwert Beschreibung
format "via [$symbol$workspace]($style) " The format string for the module.
version_format "v${raw}" The version format. Available vars are raw, major, minor, & patch
symbol "💠" A format string shown before the terraform workspace.
detect_extensions ["tf", "tfplan", "tfstate"] Which extensions should trigger this module.
detect_files [] Which filenames should trigger this module.
detect_folders [".terraform"] Which folders should trigger this module.
style "bold 105" Stil für dieses Modul.
disabled false Disables the terraform module.

Variables

Variable Beispiel Beschreibung
version v0.12.24 The version of terraform
workspace default The current Terraform workspace
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiel

With Terraform Version

# ~/.config/starship.toml

[terraform]
format = "[🏎💨 $version$workspace]($style) "

Without Terraform version

# ~/.config/starship.toml

[terraform]
format = "[🏎💨 $workspace]($style) "

Zeit

The time module shows the current local time. The format configuration value is used by the chrono crate to control how the time is displayed. Take a look at the chrono strftime docs to see what options are available.

::: tip

This module is disabled by default. To enable it, set disabled to false in your configuration file.

:::

Optionen

Option Standardwert Beschreibung
format "at [$time]($style) " The format string for the module.
use_12hr false Enables 12 hour formatting
time_format see below The chrono format string used to format the time.
style "bold yellow" The style for the module time
utc_time_offset "local" Sets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets.
disabled true Disables the time module.
time_range "-" Sets the time range during which the module will be shown. Times must be specified in 24-hours format

If use_12hr is true, then time_format defaults to "%r". Otherwise, it defaults to "%T". Manually setting time_format will override the use_12hr setting.

Variables

Variable Beispiel Beschreibung
time 13:08:10 The current time.
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiel

# ~/.config/starship.toml

[time]
disabled = false
format = '🕙[\[ $time \]]($style) '
time_format = "%T"
utc_time_offset = "-5"
time_range = "10:00:00-14:00:00"

Username

The username module shows active user's username. The module will be shown if any of the following conditions are met:

  • The current user is root
  • The current user isn't the same as the one that is logged in
  • The user is currently connected as an SSH session
  • The variable show_always is set to true

::: tip

SSH connection is detected by checking environment variables SSH_CONNECTION, SSH_CLIENT, and SSH_TTY. If your SSH host does not set up these variables, one workaround is to set one of them with a dummy value.

:::

Optionen

Option Standardwert Beschreibung
style_root "bold red" The style used when the user is root.
style_user "bold yellow" The style used for non-root users.
format "[$user]($style) in " Das Format für das Modul.
show_always false Always shows the username module.
disabled false Disables the username module.

Variables

Variable Beispiel Beschreibung
style "red bold" Mirrors the value of option style_root when root is logged in and style_user otherwise.
user "matchai" The currently logged-in user ID.

Beispiel

# ~/.config/starship.toml

[username]
style_user = "white bold"
style_root = "black bold"
format = "user: [$user]($style) "
disabled = false
show_always = true

Vagrant

The vagrant module shows the currently installed version of Vagrant. By default the module will be shown if any of the following conditions are met:

  • The current directory contains a Vagrantfile file

Optionen

Option Standardwert Beschreibung
format "via [$symbol($version )]($style)" Das Format für das Modul.
version_format "v${raw}" The version format. Available vars are raw, major, minor, & patch
symbol "⍱ " A format string representing the symbol of Vagrant.
detect_extensions [] Which extensions should trigger this module.
detect_files ["Vagrantfile"] Which filenames should trigger this module.
detect_folders [] Which folders should trigger this module.
style "cyan bold" Stil für dieses Modul.
disabled false Disables the vagrant module.

Variables

Variable Beispiel Beschreibung
version Vagrant 2.2.10 The version of Vagrant
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiel

# ~/.config/starship.toml

[vagrant]
format = "via [⍱ $version](bold white) "

V

The vlang module shows you your currently installed version of V. By default the module will be shown if any of the following conditions are met:

  • The current directory contains a file with .v extension
  • The current directory contains a v.mod, vpkg.json or .vpkg-lock.json file

Optionen

Option Standardwert Beschreibung
format "via [$symbol($version )]($style)" Das Format für das Modul.
version_format "v${raw}" The version format. Available vars are raw, major, minor, & patch
symbol "V " A format string representing the symbol of V
detect_extensions ["v"] Which extensions should trigger this module.
detect_files ["v.mod", "vpkg.json", ".vpkg-lock.json" ] Which filenames should trigger this module.
detect_folders [] Which folders should trigger this module.
style "blue bold" Stil für dieses Modul.
disabled false Disables the vlang module.

Variables

Variable Beispiel Beschreibung
version v0.2 The version of v
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

Beispiel

# ~/.config/starship.toml
[vlang]
format = "via [V $version](blue bold) "

VCSH

The vcsh module displays the current active VCSH repository. The module will be shown only if a repository is currently in use.

Optionen

Option Standardwert Beschreibung
symbol The symbol used before displaying the repository name.
style "bold yellow" Stil für dieses Modul.
format "vcsh [$symbol$repo]($style) " Das Format für das Modul.
disabled false Disables the vcsh module.

Variables

Variable Beispiel Beschreibung
repo dotfiles if in a VCSH repo named dotfiles The active repository name
symbol Spiegelt den Wert der Option symbol
style* black bold dimmed Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiel

# ~/.config/starship.toml

[vcsh]
format = "[🆅 $repo](bold blue) "

Zig

By default the the zig module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met:

  • The current directory contains a .zig file

Optionen

Option Standardwert Beschreibung
format "via [$symbol($version )]($style)" Das Format für das Modul.
version_format "v${raw}" The version format. Available vars are raw, major, minor, & patch
symbol "↯ " The symbol used before displaying the version of Zig.
style "bold yellow" Stil für dieses Modul.
disabled false Disables the zig module.
detect_extensions ["zig"] Which extensions should trigger this module.
detect_files [] Which filenames should trigger this module.
detect_folders [] Which folders should trigger this module.

Variables

Variable Beispiel Beschreibung
version v0.6.0 The version of zig
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Beispiel

# ~/.config/starship.toml

[zig]
symbol = "⚡️ "

Custom commands

The custom modules show the output of some arbitrary commands.

These modules will be shown if any of the following conditions are met:

  • The current directory contains a file whose name is in files
  • The current directory contains a directory whose name is in directories
  • The current directory contains a file whose extension is in extensions
  • The when command returns 0
  • The current Operating System (std::env::consts::OS) matchs with os field if defined.

::: tip

Multiple custom modules can be defined by using a ..

:::

::: tip

The order in which custom modules are shown can be individually set by including ${custom.foo} in the top level format (as it includes a dot, you need to use ${...}). By default, the custom module will simply show all custom modules in the order they were defined.

:::

::: tip

Issue #1252 contains examples of custom modules. If you have an interesting example not covered there, feel free to share it there!

:::

::: warning Command output is printed unescaped to the prompt

Whatever output the command generates is printed unmodified in the prompt. This means if the output contains special sequences that are interpreted by your shell they will be expanded when displayed. These special sequences are shell specific, e.g. you can write a command module that writes bash sequences, e.g. \h, but this module will not work in a fish or zsh shell.

Format strings can also contain shell specific prompt sequences, e.g. Bash, Zsh.

:::

Optionen

Option Standardwert Beschreibung
command "" The command whose output should be printed. The command will be passed on stdin to the shell.
when A shell command used as a condition to show the module. The module will be shown if the command returns a 0 status code.
shell See below
description "<custom module>" The description of the module that is shown when running starship explain.
files [] The files that will be searched in the working directory for a match.
directories [] The directories that will be searched in the working directory for a match.
extensions [] The extensions that will be searched in the working directory for a match.
symbol "" The symbol used before displaying the command output.
style "bold green" Stil für dieses Modul.
format "[$symbol($output )]($style)" Das Format für das Modul.
disabled false Disables this custom module.
os Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) See possible values.

Variables

Variable Beschreibung
output The output of shell command in shell
symbol Spiegelt den Wert der Option symbol
style* Spiegelt den Wert der Option style

*: This variable can only be used as a part of a style string

Custom command shell

shell accepts a non-empty list of strings, where:

  • The first string is the path to the shell to use to execute the command.
  • Other following arguments are passed to the shell.

If unset, it will fallback to STARSHIP_SHELL and then to "sh" on Linux, and "cmd /C" on Windows.

The command will be passed in on stdin.

If shell is not given or only contains one element and Starship detects PowerShell will be used, the following arguments will automatically be added: -NoProfile -Command -. This behavior can be avoided by explicitly passing arguments to the shell, e.g.

shell = ["pwsh", "-Command", "-"]

::: warning Make sure your custom shell configuration exits gracefully

If you set a custom command, make sure that the default Shell used by starship will properly execute the command with a graceful exit (via the shell option).

For example, PowerShell requires the -Command parameter to execute a one liner. Omitting this parameter might throw starship into a recursive loop where the shell might try to load a full profile environment with starship itself again and hence re-execute the custom command, getting into a never ending loop.

Parameters similar to -NoProfile in PowerShell are recommended for other shells as well to avoid extra loading time of a custom profile on every starship invocation.

Automatic detection of shells and proper parameters addition are currently implemented, but it's possible that not all shells are covered. Please open an issue with shell details and starship configuration if you hit such scenario.

:::

Beispiel

# ~/.config/starship.toml

[custom.foo]
command = "echo foo"  # shows output of command
files = ["foo"]       # can specify filters but wildcards are not supported
when = """ test "$HOME" == "$PWD" """
format = " transcending [$output]($style)"

[custom.time]
command = "time /T"
extensions = ["pst"]  # filters *.pst files
shell = ["pwsh.exe", "-NoProfile", "-Command", "-"]