starship/docs/de-DE/config

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 wird über diese TOML-Datei durchgeführt:

# Inserts a blank line between shell prompts
add_newline = true

# Replace the "❯" symbol in the prompt with "➜"
[character]                            # The name of the module we are configuring is "character"
success_symbol = "[➜](bold green)"     # The "success_symbol" segment is being set to "➜" with the color "bold green"

# Disable the package module, hiding it from the prompt completely
[package]
disabled = true

You can change default configuration file location with STARSHIP_CONFIG environment variable:

export STARSHIP_CONFIG=~/.starship/config.toml

Equivalently in PowerShell (Windows) would be adding this line to your $PROFILE:

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

Logging

By default starship logs warnings and errors into a file named ~/.cache/starship/session_${STARSHIP_SESSION_KEY}.log, where the session key is corresponding to a instance of your terminal. This, however can be changed using the STARSHIP_CACHE environment variable:

export STARSHIP_CACHE=~/.starship/cache

Equivalently in PowerShell (Windows) would be adding this line to your $PROFILE:

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

Terminologie

Module: Eine Komponente in der Konsole, die auf kontextualisierte Informationen des OS basiert. For example, the "nodejs" module shows the version of Node.js that is currently installed on your computer, if your current directory is a Node.js project.

Variable: Smaller sub-components that contain information provided by the module. For example, the "version" variable in the "nodejs" module contains the current version of Node.js.

By convention, most modules have a prefix of default terminal color (e.g. via in "nodejs") and an empty space as a suffix.

Format Strings

Format strings are the format that a module prints all its variables with. Most modules have an entry called format that configures the display format of the module. You can use texts, variables and text groups in a format string.

Variable

A variable contains a $ symbol followed by the name of the variable. The name of a variable only contains letters, numbers and _.

For example:

• $version is a format string with a variable named version.
• $git_branch$git_commit is a format string with two variables named git_branch and git_commit.
• $git_branch $git_commit has the two variables separated with a space.

Text Group

A text group is made up of two different parts.

The first part, which is enclosed in a [], is a format string. You can add texts, variables, or even nested text groups in it.

In the second part, which is enclosed in a (), is a style string. This can be used style the first part.

For example:

• [on](red bold) will print a string on with bold text colored red.
• [⌘ $version](bold green) will print a symbol ⌘ followed by the content of variable version, with bold text colored green.
• [a [b](red) c](green) will print a b c with b red, and a and c green.

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 mit Beschreibungen was sie bewirken. Details zur vollen Syntax findest du im Erweiterten Konfigurationshandbuch.

• "fg:green bg:blue" setzt grünen Text auf blauen Hintergrund
• "bg:blue fg:bright-green" setzt hell-grünen Text auf blauen Hintergrund
• "bold fg:27" setzt dicke Schrift auf ANSI Farbe 27
• "underline bg:#bf5700" setzt unterstrichenen Text auf einen orangenen Hintergrund
• "bold italic fg:purple" setzt dicke lila Kursivschrift
• "" 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.

For example:

• (@$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\] ).

Escapable characters

The following symbols have special usage in a format string. If you want to print the following symbols, you have to escape them with a backslash (\).

• $
• \
• [
• ]
• (
• )

Note that toml has its own escape syntax. It is recommended to use a literal string ('') in your config. If you want to use a basic string (""), pay attention to escape the backslash \.

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.
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

# Use custom format
format = """
[┌───────────────────>](bold green)
[│](bold green)$directory$rust$package
[└─>](bold green) """

# Wait 10 milliseconds for starship to check files under the current directory.
scan_timeout = 10

# Disable the blank line at the start of the prompt
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\
$kubernetes\
$directory\
$vcsh\
$git_branch\
$git_commit\
$git_state\
$git_metrics\
$git_status\
$hg_branch\
$docker_context\
$package\
$cmake\
$dart\
$deno\
$dotnet\
$elixir\
$elm\
$erlang\
$golang\
$helm\
$java\
$julia\
$kotlin\
$nim\
$nodejs\
$ocaml\
$perl\
$php\
$purescript\
$python\
$red\
$ruby\
$rust\
$scala\
$swift\
$terraform\
$vlang\
$vagrant\
$zig\
$nix_shell\
$conda\
$memory_usage\
$aws\
$gcloud\
$openstack\
$env_var\
$crystal\
$custom\
$cmd_duration\
$line_break\
$lua\
$jobs\
$battery\
$time\
$status\
$shell\
$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)'	The format for the module.
symbol	"☁️ "	Symbol das vor dem aktuellen AWS-Profil angezeigt wird.
region_aliases		Table of region aliases to display in addition to the AWS name.
style	"bold yellow"	Stil für dieses Modul.
expiration_symbol	X	The symbol displayed when the temporary credentials have expired.
disabled	false	Deaktiviert das aws-Modul.

Variables

Variable	Beispiel	Beschreibung
region	ap-northeast-1	The current AWS region
profile	astronauts	The current AWS profile
duration	2h27m20s	The temporary credentials validity duration
symbol		Mirrors the value of option symbol
style*		Mirrors the value of option style

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

Examples

Display everything

# ~/.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"

Display region

# ~/.config/starship.toml

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

Display profile

# ~/.config/starship.toml

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

Akkustand

Das battery Modul zeigt, wie hoch der Akku des Geräts geladen ist und den aktuellen Ladestatus. Das Modul ist nur sichtbar, wenn der Akku des Geräts unter 10% geladen ist.

Optionen

Option	Standartwert	Beschreibung
full_symbol	" "	Das Symbol das angezeigt wird wenn der Akku voll geladen ist.
charging_symbol	" "	Das Symbol das angezeigt wird wenn der Akku aufgeladen wird.
discharging_symbol	" "	Das Symbol, das angezeigt wird, wenn die Batterie entladen wird.
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) "	The format for the module.
display	link	Stellt den Grenzwert ein ab dem der Ladezustand (das battery-Modul) angezeigt wird.
disabled	false	Wenn der Wert auf true steht, wird das Akkustand-Modul deaktiviert.

Beispiel

# ~/.config/starship.toml

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

Anzeige des Akkustandes

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). Wenn display nicht angegeben ist. 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

Die display-Option beinhaltet ein Array mit den folgenden Werten.

Option	Standardwert	Beschreibung
threshold	10	Der Schwellenwert zur Anzeige dieser Option.
style	bold red	Der Stil, der zur Anzeige dieser Option verwendet wird.
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

Das character Modul zeigt ein Zeichen ( meistens einen Pfeil "❯") vor der Texteingabe an.

Das Zeichen zeigt an ob der letzte Befehl erfolgreich war, oder einen Fehler erzeugt hat. 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	Deaktiviert das character-Modul.

Variables

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

Examples

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)"	The format for the module.
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		Mirrors the value of option symbol
style*		Mirrors the value of option style

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

Befehlsdauer

Das cmd_duration Modul zeigt an wie lange der letzte Befehl ausgeführt wurde. Das Modul wird nur angezeigt wenn der letzte Befehl länger als zwei Sekunden ausgeführt wurde. Mit der min_time Option kann die Zeit eingestellt werden ab der <0>cmd_duration</0> angezeigt wird.

::: warning Nicht die DEBUG-trap in der Bash hooken

Ist bash die Konsole der Wahl, dann nicht die DEBUG-trap nach der Ausführung von eval $(starship init $0) hooken, andernfalls wird dieses Modul unweigerlich untergehen.

:::

Bash Nutzer, die eine "preexec" ähnliche Funktion benötigen, können rcaloras bash_preexec Framework verwenden. Definieren Sie einfach die Arrays preexec_functions und precmd_functions bevor sie eval $(starship init $0) ausführen, und fahren Sie dann wie gewohnt fort.

Optionen

Option	Standardwert	Beschreibung
min_time	2_000	Schwellwert für kleinste anzuzeigende Laufzeit (in Millisekunden).
show_milliseconds	false	Zeige Millisekunden zusätzlich zu Sekunden.
format	"took [$duration]($style) "	The format for the module.
style	"bold yellow"	Stil für dieses Modul.
disabled	false	Deaktiviert das cmd_duration-Modul.
show_notifications	false	Show desktop notifications when command completes.
min_time_to_notify	45_000	Shortest duration for notification (in milliseconds).

::: Tipp

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*		Mirrors the value of 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

Das conda-Modul zeigt dessen aktuelle Umgebung an, sofern $CONDA_DEFAULT_ENV gesetzt ist.

::: Tipp

Hinweis: Dies unterdrückt nicht conda's eigenen Prompt-Modifikator, sie können jedoch conda mit conda config --set changeps1 False konfigurieren, um die Ausgabe von conda selbst auszuschalten.

:::

Optionen

Option	Standardwert	Beschreibung
truncation_length	1	Die Anzahl der Verzeichnisse, auf die der Verzeichnisspfad abgeschnitten werden soll, wenn die Umgebung über conda erstellt wurde -p [path]. 0 bedeutet keine Kürzung. Beachte auch die Beschreibung für das directory Modul.
symbol	"🅒 "	Symbol das vor dem Umgebungsnamen angezeigt wird.
style	"bold green"	Stil für dieses Modul.
format	"via [$symbol$environment]($style) "	The format for the module.
ignore_base	true	Ignores base environment when activated.
disabled	false	Deaktiviert das conda-Modul.

Variables

Variable	Beispiel	Beschreibung
environment	astronauts	The current conda environment
symbol		Mirrors the value of option symbol
style*		Mirrors the value of 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:

• Das aktuelle Verzeichnis enthält eine shard.yml-Datei
• 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)"	The format for the module.
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		Mirrors the value of option symbol
style*		Mirrors the value of 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
• Das aktuelle Verzeichnis enthält pubspec.yaml, pubspec.yml oder pubspec.lock

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	"🎯 "	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		Mirrors the value of option symbol
style*		Mirrors the value of 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)"	The format for the module.
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		Mirrors the value of option symbol
style*		Mirrors the value of option style

Beispiel

# ~/.config/starship.toml

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

Verzeichnis

Das directory -Modul zeigt den Pfad zu Ihrem aktuellen Verzeichnis an, abgeschnitten auf drei übergeordnete Ordner. 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	Die Anzahl der übergeordneten Ordner, die angezeigt werden.
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) "	The format for the module.
style	"bold cyan"	Stil für dieses Modul.
disabled	false	Deaktiviert das directory-Modul.
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: "…/"
home_symbol	"~"	The symbol indicating home directory.

Dieses Modul hat einige erweiterte Konfigurationsoptionen, welche die Darstellung von Verzeichnissen steuern.

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"	Mirrors the value of 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_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) "	The format for the module.
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		Mirrors the value of option symbol
style*		Mirrors the value of 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)"	The format for the module.
version_format	"v${raw}"	The version format. Available vars are raw, major, minor, & patch
symbol	".NET "	Symbol das vor der dotnet-Version angezeigt wird.
heuristic	true	Schnelle Versionserkennung nutzen um Starship bedienbar zu halten.
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	Deaktiviert das dotnet-Modul.

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		Mirrors the value of option symbol
style*		Mirrors the value of 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:

• Das aktuelle Verzeichnis enthält eine mix.exs-Datei.

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		Mirrors the value of option symbol
style*		Mirrors the value of 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:

• Das aktuelle Verzeichnis enthält eine elm.json-Datei
• Das aktuelle Verzeichnis enthält eine elm-package.json-Datei
• 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)"	The format for the module.
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		Mirrors the value of option symbol
style*		Mirrors the value of 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 variable. 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

Optionen

Option	Standardwert	Beschreibung
symbol		Das Symbol, das vor der Anzeige der Variable verwendet wird.
variable		Die anzuzeigende Umgebungsvariable.
default		Der Standardwert, der angezeigt wird, wenn die ausgewählte Variable nicht definiert ist.
format	"with [$env_value]($style) "	The format for the module.
disabled	false	Deaktiviert das env_var-Modul.

Variables

Variable	Beispiel	Beschreibung
env_value	Windows NT (if variable would be $OS)	The environment value of option variable
symbol		Mirrors the value of option symbol
style*	black bold dimmed	Mirrors the value of 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"

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:

• Das aktuelle Verzeichnis enthält eine rebar.config-Datei.
• Das aktuelle Verzeichnis enthält eine erlang.mk-Datei.

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 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		Mirrors the value of option symbol
style*		Mirrors the value of 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) "

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) '	The format for the module.
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		Mirrors the value of option symbol
style*		Mirrors the value of option style

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

Examples

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

Das git_branch-Modul zeigt den aktiven Git-Branch des Repositories im aktuellen Verzeichnis an.

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) "	The format for the module. 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	Deaktiviert das git_branch-Modul.

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		Mirrors the value of option symbol
style*		Mirrors the value of 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\\)]($style) [\\($tag\\)]($style)"	The format for the module.
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*		Mirrors the value of 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-Zustand

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)\) '	The format for the module.
disabled	false	Deaktiviert das git_state-Modul.

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*		Mirrors the value of 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.

::: Tipp

Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration disabled auf false um es zu aktivieren.

:::

Optionen

Option	Standardwert	Beschreibung
added_style	"bold green"	The style for the added count.
deleted_style	"bold red"	The style for the deleted count.
format	'[+$added]($added_style) [-$deleted]($deleted_style) '	The format for the module.
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
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	Deaktiviert das git_status-Modul.

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 or behind 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*	Mirrors the value of 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 = "😵"
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}"

Golang

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

• Das aktuelle Verzeichnis enthält eine go.mod-Datei
• Das aktuelle Verzeichnis enthält eine go.sum-Datei
• Das aktuelle Verzeichnis enthält eine glide.yaml-Datei
• Das aktuelle Verzeichnis enthält eine Gopkg.yml-Datei
• Das aktuelle Verzeichnis enthält eine Gopkg.lock-Datei
• The current directory contains a .go-version file
• Das aktuelle Verzeichnis enthält ein Godeps-Verzeichnis
• Das aktuelle Verzeichnis enthält eine Datei mit der .go-Erweiterung

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	"🐹 "	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	Deaktiviert das golang-Modul.

Variables

Variable	Beispiel	Beschreibung
version	v1.12.1	The version of go
symbol		Mirrors the value of option symbol
style*		Mirrors the value of 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:

• Das aktuelle Verzeichnis enthält eine helmfile.yaml-Datei
• The current directory contains a Chart.yaml file

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
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		Mirrors the value of option symbol
style*		Mirrors the value of 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

Das hostname-Modul zeigt den Hostnamen des Systems an.

Optionen

Option	Standardwert	Beschreibung
ssh_only	true	Zeigt den Hostnamen nur, wenn via SSH-Sitzung verbunden.
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 "	The format for the module.
style	"bold dimmed green"	Stil für dieses Modul.
disabled	false	Deaktiviert das hostname-Modul.

Variables

Variable	Beispiel	Beschreibung
symbol		Mirrors the value of option symbol
style*		Mirrors the value of 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)"	The format for the module.
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	Deaktiviert das Java-Modul.

Variables

Variable	Beispiel	Beschreibung
version	v14	The version of java
symbol		Mirrors the value of option symbol
style*		Mirrors the value of 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 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.

::: Warnung

This module is not supported on tcsh and nu.

:::

Optionen

Option	Standardwert	Beschreibung
threshold	1	Zeigt die Anzahl der Jobs wenn der angegebene Schwellenwert überschritten wurde.
format	"[$symbol$number]($style) "	The format for the module.
symbol	"✦"	A format string representing the number of jobs.
style	"bold blue"	Stil für dieses Modul.
disabled	false	Deaktiviert das jobs-Modul.

Variables

Variable	Beispiel	Beschreibung
number	1	The number of jobs
symbol		Mirrors the value of option symbol
style*		Mirrors the value of option style

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

Beispiel

# ~/.config/starship.toml

[jobs]
symbol = "+ "
threshold = 4

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)"	The format for the module.
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		Mirrors the value of option symbol
style*		Mirrors the value of 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)"	The format for the module.
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		Mirrors the value of option symbol
style*		Mirrors the value of 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.

::: Tipp

Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration disabled auf false um es zu aktivieren.

:::

Optionen

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

Variables

Variable	Beispiel	Beschreibung
context	starship-cluster	The current kubernetes context
namespace	starship-namespace	If set, the current kubernetes namespace
symbol		Mirrors the value of option symbol
style*		Mirrors the value of 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"

Zeilenumbruch

Das line_break-Modul unterteilt den Prompt in zwei Zeilen.

Optionen

Option	Standardwert	Beschreibung
disabled	false	Deaktiviert das line_break-Modul, wodurch der Prompt einzeilig wird.

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)"	The format for the module.
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		Mirrors the value of option symbol
style*		Mirrors the value of 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) "

Speicherauslastung

Das memory_usage Modul zeigt den aktuellen Systemspeicher und die swap-Nutzung an.

Standardmäßig wird die swap-Nutzung angezeigt, wenn der gesamte System-swap nicht Null ist.

::: Tipp

Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration disabled auf false um es zu aktivieren.

:::

Optionen

Option	Standardwert	Beschreibung
threshold	75	Speicherauslastung ausblenden, wenn sie unter diesem Prozentsatz ist.
format	"via $symbol [${ram}( | ${swap})]($style) "	The format for the module.
symbol	"🐏"	Symbol das vor der Speicherauslastung angezeigt wird.
style	"bold dimmed white"	Stil für dieses Modul.
disabled	true	Deaktiviert das memory_usage-Modul.

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	🐏	Mirrors the value of option symbol
style*		Mirrors the value of 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) "	The format for the module.
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		Mirrors the value of option symbol
style*		Mirrors the value of 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:

• Das aktuelle Verzeichnis enthält eine nim.cfg-Datei
• 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		Mirrors the value of option symbol
style*		Mirrors the value of 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. Das Modul wird angezeigt, wenn es sich in einer nix-Shell-Umgebung befindet.

Optionen

Option	Standardwert	Beschreibung
format	'via [$symbol$state( \($name\))]($style) '	The format for the module.
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	Deaktiviert das nix_shell-Modul.

Variables

Variable	Beispiel	Beschreibung
state	pure	The state of the nix-shell
name	lorri	The name of the nix-shell
symbol		Mirrors the value of option symbol
style*		Mirrors the value of 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:

• Das aktuelle Verzeichnis enthält eine package.json-Datei
• The current directory contains a .node-version file
• The current directory contains a .nvmrc file
• Das aktuelle Verzeichnis enthält ein node_modules-Verzeichnis
• 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)"	The format for the module.
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	Deaktiviert das nodejs-Modul.
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		Mirrors the value of option symbol
style*		Mirrors the value of 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		Mirrors the value of option symbol
style*		Mirrors the value of 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) "	The format for the module.
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		Mirrors the value of option symbol
style*		Mirrors the value of 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 = "☁️ "

Paketversion

Das Package Modul wird angezeigt, wenn das aktuelle Verzeichnis das Repository für ein Paket ist, und zeigt dessen aktuelle Version an. The module currently supports npm, nimble, cargo, poetry, composer, gradle, julia, mix and helm 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
• 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
• vlang - The vlang package version is extracted from the v.mod present

⚠️ 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) "	The format for the module.
symbol	"📦 "	Symbol das vor der Paketversion angezeigt wird.
style	"bold 208"	Stil für dieses Modul.
display_private	false	Enable displaying version for packages marked as private.
disabled	false	Deaktiviert das package-Modul.

Variables

Variable	Beispiel	Beschreibung
version	v1.0.0	The version of your package
symbol		Mirrors the value of option symbol
style*		Mirrors the value of 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		Mirrors the value of option symbol
style*		Mirrors the value of 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:

• Das aktuelle Verzeichnis enthält eine composer.json-Datei
• The current directory contains a .php-version file
• The current directory contains a .php 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	"🐘 "	Symbol das vor der PHP-Version angezeigt wird.
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	Deaktiviert das php-Modul.

Variables

Variable	Beispiel	Beschreibung
version	v7.3.8	The version of php
symbol		Mirrors the value of option symbol
style*		Mirrors the value of 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) "

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:

• Das aktuelle Verzeichnis enthält eine spago.dhall-Datei
• The current directory contains a file with the .purs 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 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		Mirrors the value of option symbol
style*		Mirrors the value of 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:

• Das aktuelle Verzeichnis enthält eine .python-version-Datei
• Das aktuelle Verzeichnis enthält eine Pipfile-Datei
• The current directory contains a __init__.py file
• Das aktuelle Verzeichnis enthält eine pyproject.toml-Datei
• Das aktuelle Verzeichnis enthält eine requirements.txt-Datei
• Das aktuelle Verzeichnis enthält eine setup.py-Datei
• Das aktuelle Verzeichnis enthält eine tox.ini-Datei
• Das aktuelle Verzeichnis enthält eine Datei mit der .py-Erweiterung.
• Ein virtualenv ist momentan aktiv

Optionen

Option	Standardwert	Beschreibung
format	'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'	The format for the module.
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	Verwende pyenv um die Python-Versionzu beziehen.
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	Deaktiviert das python-Modul.

::: Tipp

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	"🐍 "	Mirrors the value of option symbol
style	"yellow bold"	Mirrors the value of 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)"	The format for the module.
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		Mirrors the value of option symbol
style	"blue bold"	Mirrors the value of 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. Das Modul wird nur dann angezeigt, wenn eine der folgenden Bedingungen zutrifft:

• The current directory contains a file with .red or .reds 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	"🔺 "	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		Mirrors the value of option symbol
style*		Mirrors the value of 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. Das Modul wird nur dann angezeigt, wenn eine der folgenden Bedingungen zutrifft:

• Das aktuelle Verzeichnis enthält eine Gemfile-Datei
• The current directory contains a .ruby-version file
• Das aktuelle Verzeichnis enthält eine .rb-Datei

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	"💎 "	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.
style	"bold red"	Stil für dieses Modul.
disabled	false	Deaktiviert das ruby-Modul.

Variables

Variable	Beispiel	Beschreibung
version	v2.5.1	The version of ruby
symbol		Mirrors the value of option symbol
style*		Mirrors the value of 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. Das Modul wird nur dann angezeigt, wenn eine der folgenden Bedingungen zutrifft:

• Das aktuelle Verzeichnis enthält eine Cargo.toml-Datei
• Das aktuelle Verzeichnis enthält eine Datei mit der .rs-Erweiterung

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	"🦀 "	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	Deaktiviert das rust-Modul.

Variables

Variable	Beispiel	Beschreibung
version	v1.43.0-nightly	The version of rustc
symbol		Mirrors the value of option symbol
style*		Mirrors the value of 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)"	The format for the module.
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		Mirrors the value of option symbol
style*		Mirrors the value of 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.

::: Tipp

Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration disabled auf false um es zu aktivieren.

:::

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.
unknown_indicator		The default value to be displayed when the shell is unknown.
format	$indicator	The format for the module.
disabled	true	Disables the shell module.

Variables

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

Examples

# ~/.config/starship.toml

[shell]
fish_indicator = ""
powershell_indicator = "_"
unknown_indicator = "mystery shell"
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) "	The format for the module.
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		Mirrors the value of option symbol
style*		Mirrors the value of 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) '	The format for the module.
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		Mirrors the value of option symbol
style*		Mirrors the value of 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.

::: Tipp

Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration disabled auf false um es zu aktivieren.

:::

::: 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
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
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
symbol		Mirrors the value of option symbol
style*		Mirrors the value of 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

Swift

By default the swift module shows the currently installed version of Swift. Das Modul wird nur dann angezeigt, wenn eine der folgenden Bedingungen zutrifft:

• 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)"	The format for the module.
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		Mirrors the value of option symbol
style*		Mirrors the value of 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.

::: Tipp

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:

• Das aktuelle Verzeichnis enthält eine .terraform-Datei
• Current directory contains a file with the .tf or .hcl 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", "hcl"]	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	Deaktiviert das terraform Modul.

Variables

Variable	Beispiel	Beschreibung
version	v0.12.24	The version of terraform
workspace	default	The current Terraform workspace
symbol		Mirrors the value of option symbol
style*		Mirrors the value of 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

Das time Modul zeigt die aktuelle lokale Zeit an. Der format Wert wird von der crate chrono benutzt um die Zeit zu formatieren. Schau dir die chrono strftime Dokumentation an, um die möglichen Optionen zu sehen.

::: Tipp

Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration disabled auf false um es zu aktivieren.

:::

Optionen

Option	Standardwert	Beschreibung
format	"at [$time]($style) "	The format string for the module.
use_12hr	false	Aktiviert die Formatierung der Uhrzeit im 12-Stunden-Format.
time_format	Siehe unten	Das Format zum Anzeigen der Uhrzeit in chrono-Formatierung.
style	"bold yellow"	Stil für dieses Modul.
utc_time_offset	"local"	Legt das UTC-Offset fest, das verwendet werden soll. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets.
disabled	true	Deaktiviert das time-Modul.
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". Ansonsten ist der Standardwert hierfür "%T". Manually setting time_format will override the use_12hr setting.

Variables

Variable	Beispiel	Beschreibung
uhrzeit	13:08:10	The current time.
style*		Mirrors the value of 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"

Benutzername

Das Modul username zeigt den Benutzernamen des aktiven Benutzers. Das Modul wird nur dann angezeigt, wenn eine der folgenden Bedingungen zutrifft:

• Der aktuelle Benutzer ist root
• Der aktuelle Benutzer ist nicht derjenige, der derzeit angemeldet ist
• Der Benutzer ist über eine SSH-Sitzung verbunden
• Die Variale show_always ist auf true gesetzt

::: Tipp

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"	Stil beim root-Benutzer.
style_user	"bold yellow"	Stil bei allen anderen Benutzern.
format	"[$user]($style) in "	The format for the module.
show_always	false	username-Modul immer anzeigen.
disabled	false	Deaktiviert das username-Modul.

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)"	The format for the module.
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		Mirrors the value of option symbol
style*		Mirrors the value of 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) "

VLang

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)"	The format for the module.
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		Mirrors the value of option symbol
style*		Mirrors the value of option style

Beispiel

# ~/.config/starship.toml
[v]
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) "	The format for the module.
disabled	false	Disables the vcsh module.

Variables

Variable	Beispiel	Beschreibung
repo	dotfiles if in a VCSH repo named dotfiles	The active repository name
symbol		Mirrors the value of option symbol
style*	black bold dimmed	Mirrors the value of 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. Das Modul wird nur dann angezeigt, wenn eine der folgenden Bedingungen zutrifft:

• The current directory contains a .zig file

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 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		Mirrors the value of option symbol
style*		Mirrors the value of 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.

::: Tipp

Multiple custom modules can be defined by using a ..

:::

::: Tipp

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.

:::

::: Tipp

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

:::

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
beschreibung	"<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)"	The format for the module.
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	Mirrors the value of option symbol
style*	Mirrors the value of 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
when = """ test "$HOME" == "$PWD" """
format = " transcending [$output]($style)"

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