2019-10-21 14:42:08 +00:00
# Konfiguration
2019-10-04 08:57:43 +00:00
2020-10-01 01:23:36 +00:00
Um mit der Konfiguration von Starship zu beginnen, musst du die folgende Datei erstellen: `~/.config/starship.toml` .
2019-10-04 08:57:43 +00:00
2020-02-07 21:47:30 +00:00
```sh
2020-06-19 21:05:45 +00:00
mkdir -p ~/.config & & touch ~/.config/starship.toml
2019-10-04 08:57:43 +00:00
```
2020-10-01 01:23:36 +00:00
Die gesamte Konfiguration von Starship wird über diese [TOML ](https://github.com/toml-lang/toml )-Datei durchgeführt:
2019-10-04 08:57:43 +00:00
```toml
2020-07-23 21:07:10 +00:00
# Don't print a new line at the start of the prompt
2019-10-04 08:57:43 +00:00
add_newline = false
2020-07-23 21:07:10 +00:00
# Replace the "❯
[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"
2019-10-04 08:57:43 +00:00
2020-07-23 21:07:10 +00:00
# Disable the package module, hiding it from the prompt completely
2019-10-04 08:57:43 +00:00
[package]
disabled = true
```
2020-10-01 01:23:36 +00:00
Sie können den Pfad zur `starship.toml` mit der `STARSHIP_CONFIG` Umgebungsvariable ändern:
2020-07-23 21:07:10 +00:00
2020-02-07 21:47:30 +00:00
```sh
2020-01-15 17:23:25 +00:00
export STARSHIP_CONFIG=~/.starship
```
2020-05-23 23:10:58 +00:00
Equivalently in PowerShell (Windows) would be adding this line to your `$PROFILE` :
2020-07-23 21:07:10 +00:00
2020-05-23 23:10:58 +00:00
```ps1
$ENV:STARSHIP_CONFIG = "$HOME\.starship"
```
2020-09-30 20:26:13 +00:00
### 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:
```sh
export STARSHIP_CACHE=~/.starship/cache
```
Equivalently in PowerShell (Windows) would be adding this line to your `$PROFILE` :
```ps1
$ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp"
```
2020-10-01 01:23:36 +00:00
### Terminologie
2019-10-04 08:57:43 +00:00
2020-10-01 01:23:36 +00:00
**Module**: Eine Komponente in der Konsole, die auf kontextualisierte Informationen des OS basiert. Zum Beispiel zeigt das Modul "nodejs" die Version von NodeJS, die derzeit auf Ihrem Computer installiert ist, wenn Ihr aktuelles Verzeichnis ein NodeJS-Projekt ist.
2019-10-04 08:57:43 +00:00
2020-07-23 21:07:10 +00:00
**Variable**: Smaller sub-components that contains information provided by the module. For example, the "version" variable in the "nodejs" module contains the current version of NodeJS.
2019-10-04 08:57:43 +00:00
2020-07-23 21:07:10 +00:00
By convention, most modules have a prefix of default terminal color (e.g. `via` in "nodejs") and an empty space as a suffix.
2019-10-04 08:57:43 +00:00
2020-07-23 21:07:10 +00:00
### 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 ](#format-strings ). 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 ](#style-strings ). This can be used style the first part.
For example:
2019-10-04 08:57:43 +00:00
2020-07-23 21:07:10 +00:00
- `[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
2019-10-04 08:57:43 +00:00
2020-10-01 01:23:36 +00:00
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 ](/advanced-config/ ).
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
- `"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 ](https://i.stack.imgur.com/KTSQa.png ) 27
- `"underline bg:#bf5700"` setzt unterstrichenen Text auf einen orangenen Hintergrund
2019-11-02 11:12:46 +00:00
- `"bold italic fg:purple"` setzt dicke lila Kursivschrift
- `""` deaktiviert explizit jeden Stil
2019-10-04 08:57:43 +00:00
2020-10-01 01:23:36 +00:00
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.
2019-10-04 08:57:43 +00:00
2020-07-23 21:07:10 +00:00
#### 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` , 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 (`\`).
2020-09-30 20:26:13 +00:00
- \$
2020-07-23 21:07:10 +00:00
- \\
- [
- ]
- (
- )
Note that `toml` has [its own escape syntax ](https://github.com/toml-lang/toml#user-content-string ). 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:
```toml
# with basic string
format = "\n\\$"
# with multiline basic string
format = """
\\$"""
# with literal string
format = '''
\$'''
```
2019-10-04 08:57:43 +00:00
## Prompt
2020-10-01 01:23:36 +00:00
Dies ist eine Liste mit Prompt-weiten Konfigurationsoptionen.
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
### Optionen
2019-10-04 08:57:43 +00:00
2020-10-01 01:23:36 +00:00
| Option | Standardwert | Beschreibung |
| -------------- | ------------------------------ | ------------------------------------------------------- |
| `format` | [link ](#default-prompt-format ) | Configure the format of the prompt. |
| `scan_timeout` | `30` | Timeout für das Scannen von Dateien (in Millisekunden). |
| `add_newline` | `true` | Neuer Zeilenumbruch bei Start des Prompts. |
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
### Beispiel
2019-10-04 08:57:43 +00:00
```toml
# ~/.config/starship.toml
2020-07-23 21:07:10 +00:00
# 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.
2019-11-02 11:12:46 +00:00
scan_timeout = 10
2020-09-30 20:26:13 +00:00
# Disable the newline at the start of the prompt
add_newline = false
2019-10-04 08:57:43 +00:00
```
2020-07-23 21:07:10 +00:00
### Default Prompt Format
2019-10-04 08:57:43 +00:00
2020-10-01 01:23:36 +00:00
The default `format` is used to define the format of the prompt, if empty or no `format` is provided. Die Standardwerte sind folgende:
2019-10-04 08:57:43 +00:00
```toml
2020-09-30 20:26:13 +00:00
format = "$all"
2020-07-23 21:07:10 +00:00
# Which is equivalent to
format = """
$username\
$hostname\
2020-09-30 20:26:13 +00:00
$shlvl\
2020-07-23 21:07:10 +00:00
$kubernetes\
$directory\
$git_branch\
$git_commit\
$git_state\
$git_status\
$hg_branch\
$docker_context\
$package\
$cmake\
2020-09-30 20:26:13 +00:00
$dart\
2020-07-23 21:07:10 +00:00
$dotnet\
$elixir\
$elm\
$erlang\
$golang\
$helm\
$java\
$julia\
$nim\
$nodejs\
$ocaml\
2020-09-30 20:26:13 +00:00
$perl\
2020-07-23 21:07:10 +00:00
$php\
$purescript\
$python\
$ruby\
$rust\
2020-09-30 20:26:13 +00:00
$swift\
2020-07-23 21:07:10 +00:00
$terraform\
$zig\
$nix_shell\
$conda\
$memory_usage\
$aws\
2020-09-30 20:26:13 +00:00
$gcloud\
2020-11-29 04:45:59 +00:00
$openstack\
2020-07-23 21:07:10 +00:00
$env_var\
$crystal\
$cmd_duration\
$custom\
$line_break\
2020-11-29 04:45:59 +00:00
$lua\
2020-07-23 21:07:10 +00:00
$jobs\
$battery\
$time\
2020-09-30 20:26:13 +00:00
$status\
2020-07-23 21:07:10 +00:00
$character"""
2019-10-04 08:57:43 +00:00
```
## AWS
2020-10-01 01:23:36 +00:00
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.
2019-10-04 08:57:43 +00:00
2020-04-06 18:48:26 +00:00
When using [aws-vault ](https://github.com/99designs/aws-vault ) the profile is read from the `AWS_VAULT` env var.
2019-10-21 14:42:08 +00:00
### Optionen
2019-10-04 08:57:43 +00:00
2020-10-13 19:09:01 +00:00
| Option | Standardwert | Beschreibung |
| ---------------- | ------------------------------------------------ | --------------------------------------------------------------- |
| `format` | `'on [$symbol$profile(\($region\))]($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. |
| `disabled` | `false` | Deaktiviert das `aws` -Modul. |
2019-10-04 08:57:43 +00:00
2020-07-23 21:07:10 +00:00
### Variables
| Variable | Beispiel | Beschreibung |
| --------- | ---------------- | ------------------------------------ |
| region | `ap-northeast-1` | The current AWS region |
| profile | `astronauts` | The current AWS profile |
| 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
2019-10-04 08:57:43 +00:00
```toml
# ~/.config/starship.toml
[aws]
2020-10-13 19:09:01 +00:00
format = 'on [$symbol$profile(\($region\)) ]($style ) '
2019-10-04 08:57:43 +00:00
style = "bold blue"
symbol = "🅰 "
2019-12-24 21:54:29 +00:00
[aws.region_aliases]
ap-southeast-2 = "au"
us-east-1 = "va"
2019-10-04 08:57:43 +00:00
```
2020-07-23 21:07:10 +00:00
#### Display region
```toml
# ~/.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
```toml
# ~/.config/starship.toml
[aws]
format = "on [$symbol$profile ]($style ) "
style = "bold blue"
symbol = "🅰 "
```
2019-10-21 14:42:08 +00:00
## Akkustand
2019-10-04 08:57:43 +00:00
2020-10-01 01:23:36 +00:00
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.
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
### Optionen
2019-10-04 08:57:43 +00:00
2020-07-23 21:07:10 +00:00
| 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. |
| `format` | `"[$symbol$percentage]($style) "` | The format for the module. |
| `display` | [link ](#battery-display ) | 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. |
2019-10-04 08:57:43 +00:00
< details >
2020-10-01 01:23:36 +00:00
< summary > Das Batterie-Modul unterstützt auch einige untypische Zustände.< / summary >
2019-10-04 08:57:43 +00:00
2019-11-02 11:12:46 +00:00
| Variable | Beschreibung |
2019-10-04 08:57:43 +00:00
| ---------------- | --------------------------------------------------- |
| `unknown_symbol` | The symbol shown when the battery state is unknown. |
| `empty_symbol` | The symbol shown when the battery state is empty. |
Note: Battery indicator will be hidden if the status is `unknown` or `empty` unless you specify the option in the config.
< / details >
2019-10-21 14:42:08 +00:00
### Beispiel
2019-10-04 08:57:43 +00:00
```toml
# ~/.config/starship.toml
[battery]
full_symbol = "🔋"
charging_symbol = "⚡️"
discharging_symbol = "💀"
```
2020-10-01 01:23:36 +00:00
### Anzeige des Akkustandes
2019-10-04 08:57:43 +00:00
2020-10-01 01:23:36 +00:00
Die `display` Konfiguration "threshold" stellt ein ab wann die Akkuanzeige eingeblendet wird. Mit "style" wird das Erscheinungsbild festgelegt. Wenn `display` nicht angegeben ist. Die Standardwerte sind folgende:
2019-10-04 08:57:43 +00:00
```toml
[[battery.display]]
threshold = 10
style = "bold red"
```
2019-10-21 14:42:08 +00:00
#### Optionen
2019-10-04 08:57:43 +00:00
2020-10-01 01:23:36 +00:00
Die `display` -Option beinhaltet ein Array mit den folgenden Werten.
2019-10-04 08:57:43 +00:00
2020-10-13 19:09:01 +00:00
| Option | Beschreibung |
2019-10-21 14:42:08 +00:00
| ----------- | ------------------------------------------------------- |
| `threshold` | Der Schwellenwert zur Anzeige dieser Option. |
| `style` | Der Stil, der zur Anzeige dieser Option verwendet wird. |
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
#### Beispiel
2019-10-04 08:57:43 +00:00
```toml
2020-10-01 01:23:36 +00:00
[[battery.display]] # "bold red" bei Akkustand zwischen 0–
2019-10-04 08:57:43 +00:00
threshold = 10
style = "bold red"
2020-10-01 01:23:36 +00:00
[[battery.display]] # "bold yellow" bei Akkustand zwischen 10–
2019-10-04 08:57:43 +00:00
threshold = 30
style = "bold yellow"
2020-10-01 01:23:36 +00:00
# Bei Akkustand über 30% wird der Akkustand nicht angezeigt
2019-10-04 08:57:43 +00:00
```
2019-10-21 14:42:08 +00:00
## Zeichen
2019-10-04 08:57:43 +00:00
2020-10-01 01:23:36 +00:00
Das `character` Modul zeigt ein Zeichen ( meistens einen Pfeil "❯
2019-10-04 08:57:43 +00:00
2020-10-01 01:23:36 +00:00
Das Zeichen zeigt an ob der letzte Befehl erfolgreich war, oder einen Fehler erzeugt hat. It can do this in two ways:
2020-07-23 21:07:10 +00:00
- changing color (`red`/`green`)
- changing shape (`❯
By default it only changes color. If you also want to change it's shape take a look at [this example ](#with-custom-error-shape ).
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
### Optionen
2019-10-04 08:57:43 +00:00
2020-07-23 21:07:10 +00:00
| Option | Standardwert | Beschreibung |
| ---------------- | ------------------- | -------------------------------------------------------------------------------- |
| `format` | `"$symbol "` | The format string used before the text input. |
| `success_symbol` | `"[❯ | The format string used before the text input if the previous command succeeded. |
| `error_symbol` | `"[❯ | The format string used before the text input if the previous command failed. |
| `vicmd_symbol` | `"[❮ | The format string used before the text input if the shell is in vim normal mode. |
| `disabled` | `false` | Deaktiviert das `character` -Modul. |
2019-10-04 08:57:43 +00:00
2020-07-23 21:07:10 +00:00
### Variables
| Variable | Beispiel | Beschreibung |
| -------- | -------- | --------------------------------------------------------------------- |
| symbol | | A mirror of either `success_symbol` , `error_symbol` or `vicmd_symbol` |
### Examples
#### With custom error shape
2019-10-04 08:57:43 +00:00
```toml
# ~/.config/starship.toml
[character]
2020-07-23 21:07:10 +00:00
success_symbol = "[➜](bold green) "
error_symbol = "[✗](bold red) "
2019-10-04 08:57:43 +00:00
```
2020-07-23 21:07:10 +00:00
#### Without custom error shape
```toml
# ~/.config/starship.toml
[character]
success_symbol = "[➜](bold green) "
error_symbol = "[➜](bold red) "
```
#### With custom vim shape
```toml
# ~/.config/starship.toml
[character]
vicmd_symbol = "[V](bold green) "
```
## CMake
2020-11-29 04:45:59 +00:00
The `cmake` module shows the currently installed version of CMake if any of the following conditions are met:
2020-07-23 21:07:10 +00:00
- The current directory contains a `CMakeLists.txt` file
2020-11-29 04:45:59 +00:00
- The current directory contains a `CMakeCache.txt` file
2020-07-23 21:07:10 +00:00
### Optionen
| Option | Standardwert | Beschreibung |
| ---------- | ---------------------------------- | -------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
2020-11-29 04:45:59 +00:00
| `symbol` | `"喝 "` | The symbol used before the version of cmake. |
2020-07-23 21:07:10 +00:00
| `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
2019-10-21 14:42:08 +00:00
## Befehlsdauer
2019-10-04 08:57:43 +00:00
2020-10-01 01:23:36 +00:00
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 `cmd_duration` angezeigt wird.
2019-10-04 08:57:43 +00:00
2020-10-01 01:23:36 +00:00
::: warning Nicht die DEBUG-trap in der Bash hooken
2019-10-04 08:57:43 +00:00
2020-10-01 01:23:36 +00:00
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.
2019-10-04 08:57:43 +00:00
:::
2020-10-01 01:23:36 +00:00
Bash Nutzer, die eine "preexec" ähnliche Funktion benötigen, können [rcaloras bash_preexec Framework ](https://github.com/rcaloras/bash-preexec ) 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.
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
### Optionen
2019-10-04 08:57:43 +00:00
2020-11-29 04:45:59 +00:00
| 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` .
:::
2020-07-23 21:07:10 +00:00
### 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
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
### Beispiel
2019-10-04 08:57:43 +00:00
```toml
# ~/.config/starship.toml
[cmd_duration]
2019-12-24 21:54:29 +00:00
min_time = 500
2020-07-23 21:07:10 +00:00
format = "underwent [$duration ](bold yellow )"
2019-10-04 08:57:43 +00:00
```
2019-10-11 08:31:19 +00:00
## Conda
2020-11-29 04:45:59 +00:00
The `conda` module shows the current conda environment, if `$CONDA_DEFAULT_ENV` is set.
2019-12-14 23:46:45 +00:00
2020-10-01 01:23:36 +00:00
::: Tipp
2019-12-14 23:46:45 +00:00
2020-11-29 04:45:59 +00:00
This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False` .
2019-12-14 23:46:45 +00:00
:::
2019-10-11 08:31:19 +00:00
2019-10-21 14:42:08 +00:00
### Optionen
2019-10-11 08:31:19 +00:00
2020-07-23 21:07:10 +00:00
| 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` ](#directory ) Modul. |
| `symbol` | `"🅒 "` | Symbol das vor dem Umgebungsnamen angezeigt wird. |
| `style` | `"bold green"` | Stil für dieses Modul. |
| `format` | `"[$symbol$environment]($style) "` | The format for the module. |
2020-09-30 20:26:13 +00:00
| `ignore_base` | `true` | Ignores `base` environment when activated. |
2020-10-01 01:23:36 +00:00
| `disabled` | `false` | Deaktiviert das `conda` -Modul. |
2020-07-23 21:07:10 +00:00
### 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
2019-10-11 08:31:19 +00:00
2019-10-21 14:42:08 +00:00
### Beispiel
2019-10-11 08:31:19 +00:00
```toml
# ~/.config/starship.toml
[conda]
2020-07-23 21:07:10 +00:00
format = "[$symbol$environment](dimmed green) "
2019-10-11 08:31:19 +00:00
```
2020-04-03 16:35:39 +00:00
## Crystal
2020-11-29 04:45:59 +00:00
The `crystal` module shows the currently installed version of Crystal. The module will be shown if any of the following conditions are met:
2020-04-03 16:35:39 +00:00
2020-04-06 18:48:26 +00:00
- Das aktuelle Verzeichnis enthält eine `shard.yml` -Datei
2020-04-03 16:35:39 +00:00
- The current directory contains a `.cr` file
### Optionen
2020-07-23 21:07:10 +00:00
| Option | Standardwert | Beschreibung |
| ---------- | ---------------------------------- | --------------------------------------------------------- |
| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. |
| `style` | `"bold red"` | Stil für dieses Modul. |
| `format` | `"via [$symbol$version]($style) "` | The format for the 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
2020-04-03 16:35:39 +00:00
### Beispiel
```toml
# ~/.config/starship.toml
[crystal]
2020-07-23 21:07:10 +00:00
format = "via [✨ $version ](bold blue ) "
2020-04-03 16:35:39 +00:00
```
2019-10-04 08:57:43 +00:00
2020-09-30 20:26:13 +00:00
## Dart
2020-11-29 04:45:59 +00:00
The `dart` module shows the currently installed version of Dart. The module will be shown if any of the following conditions are met:
2020-04-03 16:35:39 +00:00
2020-09-30 20:26:13 +00:00
- The current directory contains a file with `.dart` extension
- The current directory contains a `.dart_tool` directory
- The current directory contains a `pubspec.yaml` or `pubspec.lock` file
### Optionen
2020-10-13 19:09:01 +00:00
| Option | Standartwert | Beschreibung |
2020-09-30 20:26:13 +00:00
| ---------- | ---------------------------------- | ----------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"🎯 "` | A format string representing the symbol of Dart |
| `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
```toml
# ~/.config/starship.toml
[dart]
format = "via [🔰 $version ](bold red ) "
```
2020-10-01 01:23:36 +00:00
## Verzeichnis
2020-09-30 20:26:13 +00:00
2020-11-29 04:45:59 +00:00
The `directory` module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in.
2019-10-04 08:57:43 +00:00
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` .
2019-10-21 14:42:08 +00:00
### Optionen
2019-10-04 08:57:43 +00:00
2020-10-13 19:09:01 +00:00
| Option | Standardwert | Beschreibung |
2020-10-01 01:23:36 +00:00
| ------------------- | -------------------------------------------------- | -------------------------------------------------------------------------------- |
| `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. |
2020-10-13 19:09:01 +00:00
| `truncation_symbol` | `""` | The symbol to prefix to truncated paths. eg: "…/" |
2019-10-04 08:57:43 +00:00
< details >
2020-11-29 04:45:59 +00:00
< summary > This module has a few advanced configuration options that control how the directory is displayed.< / summary >
2019-10-04 08:57:43 +00:00
2020-07-23 21:07:10 +00:00
| Advanced Option | Standardwert | Beschreibung |
2019-10-21 14:42:08 +00:00
| --------------------------- | ------------ | ---------------------------------------------------------------------------------------- |
docs(i18n): new Crowdin translations (#1262)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (German)
* New translations README.md (French)
* New translations README.md (Japanese)
* New translations README.md (Spanish)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Traditional)
* New translations README.md (Chinese Simplified)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (French)
* New translations README.md (Japanese)
* New translations README.md (German)
* New translations README.md (Spanish)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Simplified)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Chinese Traditional)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Simplified)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (German)
* New translations README.md (Chinese Simplified)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Russian)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
2020-06-11 01:28:04 +00:00
| `substitutions` | | A table of substitutions to be made to the path. |
2019-10-21 14:42:08 +00:00
| `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. |
| `use_logical_path` | `true` | Displays the logical path provided by the shell (`PWD`) instead of the path from the OS. |
2019-10-04 08:57:43 +00:00
docs(i18n): new Crowdin translations (#1262)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (German)
* New translations README.md (French)
* New translations README.md (Japanese)
* New translations README.md (Spanish)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Traditional)
* New translations README.md (Chinese Simplified)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (French)
* New translations README.md (Japanese)
* New translations README.md (German)
* New translations README.md (Spanish)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Simplified)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Chinese Traditional)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Simplified)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (German)
* New translations README.md (Chinese Simplified)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Russian)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
2020-06-11 01:28:04 +00:00
`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.
```toml
[directory.substitutions]
"/Volumes/network/path" = "/net"
"src/com/long/java/path" = "mypath"
```
2020-04-03 16:35:39 +00:00
`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` .
2019-10-04 08:57:43 +00:00
< / details >
2020-07-23 21:07:10 +00:00
### 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
2019-10-21 14:42:08 +00:00
### Beispiel
2019-10-04 08:57:43 +00:00
```toml
# ~/.config/starship.toml
[directory]
truncation_length = 8
2020-10-13 19:09:01 +00:00
truncation_symbol = "…/"
2019-10-04 08:57:43 +00:00
```
2020-04-06 18:48:26 +00:00
## Docker Context
The `docker_context` module shows the currently active [Docker context ](https://docs.docker.com/engine/context/working-with-contexts/ ) if it's not set to `default` .
### Optionen
2020-07-23 21:07:10 +00:00
| Option | Standardwert | Beschreibung |
| ----------------- | ---------------------------------- | --------------------------------------------------------------------------------------- |
| `format` | `"via [$symbol$context]($style) "` | The format for the module. |
| `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. |
| `style` | `"blue bold"` | Stil für dieses Modul. |
| `only_with_files` | `false` | Only show when there's a `docker-compose.yml` or `Dockerfile` in the current directory. |
| `disabled` | `true` | 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
2020-04-06 18:48:26 +00:00
### Beispiel
```toml
# ~/.config/starship.toml
[docker_context]
2020-07-23 21:07:10 +00:00
format = "via [🐋 $context ](blue bold )"
2020-04-06 18:48:26 +00:00
```
2019-10-04 08:57:43 +00:00
## 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.
2020-07-23 21:07:10 +00:00
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`
- `*.sln`
- `*.csproj`
- `*.fsproj`
- `*.xproj`
You'll also need the .NET Core SDK installed in order to use it correctly.
2019-10-04 08:57:43 +00:00
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.
2020-07-23 21:07:10 +00:00
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.
2019-10-21 14:42:08 +00:00
### Optionen
2019-10-04 08:57:43 +00:00
2020-10-01 01:23:36 +00:00
| Option | Standardwert | Beschreibung |
| ----------- | ---------------------------------------- | ------------------------------------------------------------------ |
| `format` | `"v[$symbol$version( 🎯 $tfm)]($style) "` | The format for the module. |
| `symbol` | `"•NET "` | Symbol das vor der dotnet-Version angezeigt wird. |
| `heuristic` | `true` | Schnelle Versionserkennung nutzen um Starship bedienbar zu halten. |
| `style` | `"bold blue"` | Stil für dieses Modul. |
| `disabled` | `false` | Deaktiviert das `dotnet` -Modul. |
2020-07-23 21:07:10 +00:00
### 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
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
### Beispiel
2019-10-04 08:57:43 +00:00
```toml
# ~/.config/starship.toml
[dotnet]
symbol = "🥅 "
style = "green"
heuristic = false
```
2020-04-03 16:35:39 +00:00
## Elixir
2020-11-29 04:45:59 +00:00
The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. The module will be shown if any of the following conditions are met:
2020-04-03 16:35:39 +00:00
2020-10-01 01:23:36 +00:00
- Das aktuelle Verzeichnis enthält eine `mix.exs` -Datei.
2020-04-03 16:35:39 +00:00
### Optionen
2020-10-13 19:09:01 +00:00
| Option | Standardwert | Beschreibung |
| ---------- | --------------------------------------------------------- | --------------------------------------------------------------- |
| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. |
| `style` | `"bold purple"` | Stil für dieses Modul. |
| `format` | `'via [$symbol$version \(OTP $otp_version\)]($style) '` | The format for the module elixir. |
| `disabled` | `false` | Disables the `elixir` module. |
2020-07-23 21:07:10 +00:00
### 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
2020-04-03 16:35:39 +00:00
### Beispiel
```toml
# ~/.config/starship.toml
[elixir]
symbol = "🔮 "
```
2020-02-07 21:47:30 +00:00
## Elm
2020-11-29 04:45:59 +00:00
The `elm` module shows the currently installed version of Elm. The module will be shown if any of the following conditions are met:
2020-02-07 21:47:30 +00:00
2020-10-01 01:23:36 +00:00
- Das aktuelle Verzeichnis enthält eine `elm.json` -Datei
- Das aktuelle Verzeichnis enthält eine `elm-package.json` -Datei
2020-04-06 18:48:26 +00:00
- The current directory contains a `.elm-version` file
2020-02-07 21:47:30 +00:00
- The current directory contains a `elm-stuff` folder
- The current directory contains a `*.elm` files
### Optionen
2020-07-23 21:07:10 +00:00
| Option | Standardwert | Beschreibung |
| ---------- | ---------------------------------- | ----------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"🌳 "` | A format string representing the symbol of Elm. |
| `style` | `"cyan bold"` | Stil für dieses Modul. |
| `disabled` | `false` | Disables the `elm` module. |
2020-02-07 21:47:30 +00:00
2020-07-23 21:07:10 +00:00
### 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
2020-02-07 21:47:30 +00:00
### Beispiel
```toml
# ~/.config/starship.toml
[elm]
2020-07-23 21:07:10 +00:00
format = "via [ $version ](cyan bold ) "
2020-02-07 21:47:30 +00:00
```
2020-10-01 01:23:36 +00:00
## Umgebungsvariablen
2020-05-05 17:07:34 +00:00
2020-05-15 15:55:21 +00:00
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:
2020-05-05 17:07:34 +00:00
2020-05-15 15:55:21 +00:00
- The `variable` configuration option matches an existing environment variable
- The `variable` configuration option is not defined, but the `default` configuration option is
2020-05-05 17:07:34 +00:00
### Optionen
2020-10-01 01:23:36 +00:00
| 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. |
2020-07-23 21:07:10 +00:00
### Variables
| Variable | Beispiel | Beschreibung |
| --------- | ------------------------------------------- | ------------------------------------------ |
2020-09-30 20:26:13 +00:00
| env_value | `Windows NT` (if _variable_ would be `$OS` ) | The environment value of option `variable` |
2020-07-23 21:07:10 +00:00
| 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
2020-05-05 17:07:34 +00:00
### Beispiel
```toml
# ~/.config/starship.toml
2020-05-15 15:55:21 +00:00
[env_var]
variable = "SHELL"
default = "unknown shell"
2020-05-05 17:07:34 +00:00
```
2019-10-04 08:57:43 +00:00
2020-05-15 15:55:21 +00:00
## Erlang
2019-10-04 08:57:43 +00:00
2020-11-29 04:45:59 +00:00
The `erlang` module shows the currently installed version of Erlang/OTP. The module will be shown if any of the following conditions are met:
2020-05-15 15:55:21 +00:00
2020-10-01 01:23:36 +00:00
- Das aktuelle Verzeichnis enthält eine `rebar.config` -Datei.
- Das aktuelle Verzeichnis enthält eine `erlang.mk` -Datei.
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
### Optionen
2019-10-04 08:57:43 +00:00
2020-07-23 21:07:10 +00:00
| Option | Standardwert | Beschreibung |
| ---------- | ---------------------------------- | -------------------------------------------------------- |
2020-11-29 04:45:59 +00:00
| `symbol` | `" "` | The symbol used before displaying the version of erlang. |
2020-07-23 21:07:10 +00:00
| `style` | `"bold red"` | Stil für dieses Modul. |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `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
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
### Beispiel
2019-10-04 08:57:43 +00:00
```toml
# ~/.config/starship.toml
2020-05-15 15:55:21 +00:00
[erlang]
2020-07-23 21:07:10 +00:00
format = "via [e $version ](bold red ) "
2019-10-04 08:57:43 +00:00
```
2020-09-30 20:26:13 +00:00
## Gcloud
2019-10-04 08:57:43 +00:00
2020-09-30 20:26:13 +00:00
The `gcloud` module shows the current configuration for [`gcloud` ](https://cloud.google.com/sdk/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
2020-10-13 19:09:01 +00:00
| Option | Standardwert | Beschreibung |
| ---------------- | ------------------------------------------------ | --------------------------------------------------------------- |
| `format` | `'on [$symbol$account(\($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. |
2020-09-30 20:26:13 +00:00
### Variables
| Variable | Beispiel | Beschreibung |
| --------- | ----------------- | ------------------------------------------------------------------ |
| region | `us-central1` | The current GCP region |
| account | `foo@example.com` | The current GCP profile |
| 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
```toml
# ~/.config/starship.toml
[gcloud]
2020-10-13 19:09:01 +00:00
format = 'on [$symbol$account(\($project\)) ]($style ) '
2020-09-30 20:26:13 +00:00
```
#### Display active config name only
```toml
# ~/.config/starship.toml
[gcloud]
format = "[$symbol$active]($style) "
style = "bold yellow"
```
#### Display account and aliased region
```toml
# ~/.config/starship.toml
[gcloud]
symbol = "️🇬️ "
[gcloud.region_aliases]
us-central1 = "uc1"
asia-northeast1 = "an1"
```
2020-10-01 01:23:36 +00:00
## Git-Branch
2020-09-30 20:26:13 +00:00
2020-11-29 04:45:59 +00:00
The `git_branch` module shows the active branch of the repo in your current directory.
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
### Optionen
2019-10-04 08:57:43 +00:00
2020-11-29 04:45:59 +00:00
| 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 X graphemes. |
| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. |
| `only_attached` | `false` | Only show the branch name when not in a detached HEAD state. |
| `disabled` | `false` | Disables the `git_branch` module. |
2020-07-23 21:07:10 +00:00
### 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). |
2020-11-29 04:45:59 +00:00
| remote | `master` | The remote branch name. |
2020-07-23 21:07:10 +00:00
| 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
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
### Beispiel
2019-10-04 08:57:43 +00:00
```toml
# ~/.config/starship.toml
[git_branch]
symbol = "🌱 "
2019-10-21 14:42:08 +00:00
truncation_length = 4
2019-10-04 08:57:43 +00:00
truncation_symbol = ""
```
2019-12-06 22:07:57 +00:00
## Git Commit
2020-11-29 04:45:59 +00:00
The `git_commit` module shows the current commit hash and also the tag (if any) of the repo in your current directory.
2019-12-06 22:07:57 +00:00
### Optionen
2020-11-29 04:45:59 +00:00
| Option | Standartwert | 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. |
2020-07-23 21:07:10 +00:00
### 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
2019-12-06 22:07:57 +00:00
### Beispiel
```toml
# ~/.config/starship.toml
[git_commit]
commit_hash_length = 4
2020-11-29 04:45:59 +00:00
tag_symbol = "🔖 "
2019-12-06 22:07:57 +00:00
```
2020-10-01 01:23:36 +00:00
## Git-Zustand
2019-10-04 08:57:43 +00:00
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.
2019-10-21 14:42:08 +00:00
### Optionen
2019-10-04 08:57:43 +00:00
2020-10-13 19:09:01 +00:00
| 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. |
2020-07-23 21:07:10 +00:00
### 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
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
### Beispiel
2019-10-04 08:57:43 +00:00
```toml
# ~/.config/starship.toml
[git_state]
2020-10-13 19:09:01 +00:00
format = '[\($state( $progress_current of $progress_total)\)]($style) '
2020-07-23 21:07:10 +00:00
cherry_pick = "[🍒 PICKING](bold red)"
2019-10-04 08:57:43 +00:00
```
2020-10-01 01:23:36 +00:00
## Git-Status
2019-10-04 08:57:43 +00:00
The `git_status` module shows symbols representing the state of the repo in your current directory.
2019-11-02 11:12:46 +00:00
### Optionen
2020-10-13 19:09:01 +00:00
| 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. |
2020-07-23 21:07:10 +00:00
### 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. |
2020-09-30 20:26:13 +00:00
| `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. |
2020-07-23 21:07:10 +00:00
| 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 |
2019-11-02 11:12:46 +00:00
2019-10-21 14:42:08 +00:00
### Beispiel
2019-10-04 08:57:43 +00:00
```toml
# ~/.config/starship.toml
[git_status]
conflicted = "🏳"
ahead = "🏎💨"
behind = "😰"
diverged = "😵"
untracked = "🤷"
stashed = "📦"
modified = "📝"
2020-07-23 21:07:10 +00:00
staged = '[++\($count\)](green)'
2019-10-04 08:57:43 +00:00
renamed = "👅"
deleted = "🗑"
```
2020-09-30 20:26:13 +00:00
Show ahead/behind count of the branch being tracked
2020-10-01 01:23:36 +00:00
2020-09-30 20:26:13 +00:00
```toml
# ~/.config/starship.toml
[git_status]
ahead = "⇡${count}"
diverged = "⇕⇡${ahead_count}⇣${behind_count}"
behind = "⇣${count}"
```
2019-10-04 08:57:43 +00:00
## Golang
2020-11-29 04:45:59 +00:00
The `golang` module shows the currently installed version of Golang. The module will be shown if any of the following conditions are met:
2019-10-04 08:57:43 +00:00
2020-10-01 01:23:36 +00:00
- 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
2020-04-06 18:48:26 +00:00
- The current directory contains a `.go-version` file
2020-10-01 01:23:36 +00:00
- Das aktuelle Verzeichnis enthält ein `Godeps` -Verzeichnis
- Das aktuelle Verzeichnis enthält eine Datei mit der `.go` -Erweiterung
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
### Optionen
2019-10-04 08:57:43 +00:00
2020-09-30 20:26:13 +00:00
| Option | Standartwert | Beschreibung |
2020-07-23 21:07:10 +00:00
| ---------- | ---------------------------------- | ---------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
| `style` | `"bold cyan"` | Stil für dieses Modul. |
2020-10-01 01:23:36 +00:00
| `disabled` | `false` | Deaktiviert das `golang` -Modul. |
2020-07-23 21:07:10 +00:00
### 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
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
### Beispiel
2019-10-04 08:57:43 +00:00
```toml
# ~/.config/starship.toml
[golang]
2020-07-23 21:07:10 +00:00
format = "via [🏎💨 $version ](bold cyan ) "
2019-10-04 08:57:43 +00:00
```
2020-02-04 17:11:36 +00:00
2020-07-23 21:07:10 +00:00
## Helm
2020-02-04 17:11:36 +00:00
2020-11-29 04:45:59 +00:00
The `helm` module shows the currently installed version of Helm. The module will be shown if any of the following conditions are met:
2020-07-23 21:07:10 +00:00
2020-10-01 01:23:36 +00:00
- Das aktuelle Verzeichnis enthält eine `helmfile.yaml` -Datei
2020-07-23 21:07:10 +00:00
- The current directory contains a `Chart.yaml` file
2020-02-04 17:11:36 +00:00
### Optionen
2020-07-23 21:07:10 +00:00
| Option | Standartwert | Beschreibung |
| ---------- | ---------------------------------- | ------------------------------------------------ |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `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` |
2020-02-04 17:11:36 +00:00
2020-07-23 21:07:10 +00:00
\*: This variable can only be used as a part of a style string
2020-02-04 17:11:36 +00:00
### Beispiel
```toml
# ~/.config/starship.toml
2020-07-23 21:07:10 +00:00
[helm]
format = "via [⎈ $version ](bold white ) "
2020-02-04 17:11:36 +00:00
```
2019-10-04 08:57:43 +00:00
## Hostname
2020-11-29 04:45:59 +00:00
The `hostname` module shows the system hostname.
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
### Optionen
2019-10-04 08:57:43 +00:00
2020-07-23 21:07:10 +00:00
| Option | Standartwert | Beschreibung |
| ---------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
2020-10-01 01:23:36 +00:00
| `ssh_only` | `true` | Zeigt den Hostnamen nur, wenn via SSH-Sitzung verbunden. |
2020-07-23 21:07:10 +00:00
| `trim_at` | `"."` | String that the hostname is cut off at, after the first match. `"."` will stop after the first dot. `""` will disable any truncation |
2020-09-30 20:26:13 +00:00
| `format` | `"[$hostname]($style) in "` | The format for the module. |
2020-07-23 21:07:10 +00:00
| `style` | `"bold dimmed green"` | Stil für dieses Modul. |
2020-10-01 01:23:36 +00:00
| `disabled` | `false` | Deaktiviert das `hostname` -Modul. |
2020-07-23 21:07:10 +00:00
### 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
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
### Beispiel
2019-10-04 08:57:43 +00:00
```toml
# ~/.config/starship.toml
[hostname]
ssh_only = false
2020-07-23 21:07:10 +00:00
format = "on [$hostname ](bold red ) "
2019-10-21 14:42:08 +00:00
trim_at = ".companyname.com"
2019-10-04 08:57:43 +00:00
disabled = false
```
2020-04-03 16:35:39 +00:00
## Java
2020-11-29 04:45:59 +00:00
The `java` module shows the currently installed version of Java. The module will be shown if any of the following conditions are met:
2020-04-03 16:35:39 +00:00
2020-04-06 18:48:26 +00:00
- The current directory contains a `pom.xml` , `build.gradle.kts` , `build.sbt` or `.java-version` file
2020-04-03 16:35:39 +00:00
- The current directory contains a file with the `.java` , `.class` , `.gradle` or `.jar` extension
### Optionen
2020-07-23 21:07:10 +00:00
| Option | Standartwert | Beschreibung |
| ---------- | -------------------------------------- | ----------------------------------------------- |
| `format` | `"via [${symbol}${version}]($style) "` | The format for the module. |
| `symbol` | `"☕ "` | A format string representing the symbol of Java |
| `style` | `"red dimmed"` | Stil für dieses Modul. |
2020-10-01 01:23:36 +00:00
| `disabled` | `false` | Deaktiviert das `Java` -Modul. |
2020-07-23 21:07:10 +00:00
### 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
2020-04-03 16:35:39 +00:00
### Beispiel
```toml
# ~/.config/starship.toml
[java]
symbol = "🌟 "
```
2019-10-04 08:57:43 +00:00
## 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.
2019-10-21 14:42:08 +00:00
### Optionen
2019-10-04 08:57:43 +00:00
2020-10-01 01:23:36 +00:00
| Option | Standartwert | 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. |
2020-07-23 21:07:10 +00:00
### 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
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
### Beispiel
2019-10-04 08:57:43 +00:00
```toml
# ~/.config/starship.toml
[jobs]
symbol = "+ "
threshold = 4
```
2020-04-06 18:48:26 +00:00
## Julia
2020-11-29 04:45:59 +00:00
The `julia` module shows the currently installed version of Julia. The module will be shown if any of the following conditions are met:
2020-04-06 18:48:26 +00:00
- 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
2020-07-23 21:07:10 +00:00
| Option | Standartwert | Beschreibung |
| ---------- | ---------------------------------- | ------------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `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
2020-04-06 18:48:26 +00:00
### Beispiel
```toml
# ~/.config/starship.toml
[julia]
2020-05-05 17:07:34 +00:00
symbol = "∴ "
2020-04-06 18:48:26 +00:00
```
2020-07-23 21:07:10 +00:00
2019-10-04 08:57:43 +00:00
## Kubernetes
2019-11-02 11:12:46 +00:00
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` .
2019-10-04 08:57:43 +00:00
2020-10-01 01:23:36 +00:00
::: Tipp
2019-10-11 08:31:19 +00:00
2020-11-29 04:45:59 +00:00
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
2019-10-11 08:31:19 +00:00
:::
2019-10-21 14:42:08 +00:00
### Optionen
2019-10-04 08:57:43 +00:00
2020-10-13 19:09:01 +00:00
| 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. |
2020-07-23 21:07:10 +00:00
### 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
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
### Beispiel
2019-10-04 08:57:43 +00:00
```toml
# ~/.config/starship.toml
[kubernetes]
2020-10-13 19:09:01 +00:00
format = 'on [⛵ $context \($namespace\) ](dimmed green ) '
2019-10-11 08:31:19 +00:00
disabled = false
2020-04-06 18:48:26 +00:00
[kubernetes.context_aliases]
"dev.local.cluster.k8s" = "dev"
2019-10-04 08:57:43 +00:00
```
2020-10-01 01:23:36 +00:00
## Zeilenumbruch
2019-10-04 08:57:43 +00:00
2020-11-29 04:45:59 +00:00
The `line_break` module separates the prompt into two lines.
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
### Optionen
2019-10-04 08:57:43 +00:00
2020-10-01 01:23:36 +00:00
| Option | Standardwert | Beschreibung |
| ---------- | ------------ | ---------------------------------------------------------------------- |
| `disabled` | `false` | Deaktiviert das `line_break` -Modul, wodurch der Prompt einzeilig wird. |
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
### Beispiel
2019-10-04 08:57:43 +00:00
```toml
# ~/.config/starship.toml
[line_break]
disabled = true
```
2020-11-29 04:45:59 +00:00
## Lua
The `lua` module shows the currently installed version of Lua. 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 | Standartwert | Beschreibung |
| ------------ | ---------------------------------- | -------------------------------------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
| `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. |
2019-10-04 08:57:43 +00:00
2020-11-29 04:45:59 +00:00
### Variables
2019-10-04 08:57:43 +00:00
2020-11-29 04:45:59 +00:00
| 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
```toml
# ~/.config/starship.toml
[lua]
format = "via [🌕 $version ](bold blue ) "
```
## Memory Usage
The `memory_usage` module shows current system memory and swap usage.
By default the swap usage is displayed if the total system swap is non-zero.
2019-10-04 08:57:43 +00:00
2020-10-01 01:23:36 +00:00
::: Tipp
2019-12-24 21:54:29 +00:00
2020-11-29 04:45:59 +00:00
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
2019-12-24 21:54:29 +00:00
2020-04-03 16:35:39 +00:00
:::
2019-12-24 21:54:29 +00:00
### Optionen
2020-11-29 04:45:59 +00:00
| Option | Standartwert | Beschreibung |
| ----------- | --------------------------------------------- | -------------------------------------------------------- |
| `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. |
| `format` | `"via $symbol [${ram}( | ${swap})]($style) "` | The format for the module. |
| `symbol` | `"🐏"` | The symbol used before displaying the memory usage. |
| `style` | `"bold dimmed white"` | Stil für dieses Modul. |
| `disabled` | `true` | Disables the `memory_usage` module. |
2020-07-23 21:07:10 +00:00
### Variables
2020-09-30 20:26:13 +00:00
| 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` |
2020-07-23 21:07:10 +00:00
\*: 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
2019-12-24 21:54:29 +00:00
### Beispiel
```toml
# ~/.config/starship.toml
2020-04-03 16:35:39 +00:00
[memory_usage]
disabled = false
threshold = -1
symbol = " "
style = "bold dimmed green"
2019-12-24 21:54:29 +00:00
```
2020-04-03 16:35:39 +00:00
## Mercurial Branch
2019-10-04 08:57:43 +00:00
2020-04-03 16:35:39 +00:00
The `hg_branch` module shows the active branch of the repo in your current directory.
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
### Optionen
2019-10-04 08:57:43 +00:00
2020-07-23 21:07:10 +00:00
| Option | Standartwert | 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 X 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
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
### Beispiel
2019-10-04 08:57:43 +00:00
```toml
# ~/.config/starship.toml
2020-04-03 16:35:39 +00:00
[hg_branch]
2020-07-23 21:07:10 +00:00
format = "on [🌱 $branch ](bold purple )"
2020-04-03 16:35:39 +00:00
truncation_length = 4
truncation_symbol = ""
2019-10-04 08:57:43 +00:00
```
docs(i18n): new Crowdin translations (#1262)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (German)
* New translations README.md (French)
* New translations README.md (Japanese)
* New translations README.md (Spanish)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Traditional)
* New translations README.md (Chinese Simplified)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (French)
* New translations README.md (Japanese)
* New translations README.md (German)
* New translations README.md (Spanish)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Simplified)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Chinese Traditional)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Simplified)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (German)
* New translations README.md (Chinese Simplified)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Russian)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
2020-06-11 01:28:04 +00:00
## Nim
2020-11-29 04:45:59 +00:00
The `nim` module shows the currently installed version of Nim. The module will be shown if any of the following conditions are met:
2020-07-23 21:07:10 +00:00
2020-11-29 04:45:59 +00:00
- The current directory contains a `nim.cfg` file
docs(i18n): new Crowdin translations (#1262)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (German)
* New translations README.md (French)
* New translations README.md (Japanese)
* New translations README.md (Spanish)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Traditional)
* New translations README.md (Chinese Simplified)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (French)
* New translations README.md (Japanese)
* New translations README.md (German)
* New translations README.md (Spanish)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Simplified)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Chinese Traditional)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Simplified)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (German)
* New translations README.md (Chinese Simplified)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Russian)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
2020-06-11 01:28:04 +00:00
- 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
2020-07-23 21:07:10 +00:00
| Option | Standartwert | Beschreibung |
| ---------- | ---------------------------------- | ----------------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | The format for the module |
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
| `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
docs(i18n): new Crowdin translations (#1262)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (German)
* New translations README.md (French)
* New translations README.md (Japanese)
* New translations README.md (Spanish)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Traditional)
* New translations README.md (Chinese Simplified)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (French)
* New translations README.md (Japanese)
* New translations README.md (German)
* New translations README.md (Spanish)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Simplified)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Chinese Traditional)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Simplified)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (German)
* New translations README.md (Chinese Simplified)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Russian)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
2020-06-11 01:28:04 +00:00
### Beispiel
```toml
# ~/.config/starship.toml
[nim]
style = "yellow"
symbol = "🎣 "
```
2020-11-29 04:45:59 +00:00
## Nix-shell
2020-02-07 21:47:30 +00:00
2020-11-29 04:45:59 +00:00
The `nix_shell` module shows the nix-shell environment. The module will be shown when inside a nix-shell environment.
2020-02-07 21:47:30 +00:00
### Optionen
2020-10-13 19:09:01 +00:00
| Option | Standartwert | 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. |
2020-11-29 04:45:59 +00:00
| `disabled` | `false` | Disables the `nix_shell` module. |
2020-07-23 21:07:10 +00:00
### 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
2020-02-07 21:47:30 +00:00
### Beispiel
```toml
# ~/.config/starship.toml
2020-04-03 16:35:39 +00:00
[nix_shell]
disabled = true
2020-07-23 21:07:10 +00:00
impure_msg = "[impure shell](bold red)"
pure_msg = "[pure shell](bold green)"
2020-10-13 19:09:01 +00:00
format = 'via [☃️ $state( \($name\)) ](bold blue ) '
2020-02-07 21:47:30 +00:00
```
2019-10-04 08:57:43 +00:00
## NodeJS
2020-11-29 04:45:59 +00:00
The `nodejs` module shows the currently installed version of NodeJS. The module will be shown if any of the following conditions are met:
2019-10-04 08:57:43 +00:00
2020-11-29 04:45:59 +00:00
- The current directory contains a `package.json` file
2020-04-06 18:48:26 +00:00
- The current directory contains a `.node-version` file
2020-11-29 04:45:59 +00:00
- The current directory contains a `node_modules` directory
2020-07-23 21:07:10 +00:00
- The current directory contains a file with the `.js` , `.mjs` or `.cjs` extension
- The current directory contains a file with the `.ts` extension
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
### Optionen
2019-10-04 08:57:43 +00:00
2020-07-23 21:07:10 +00:00
| Option | Standartwert | Beschreibung |
| ---------- | ---------------------------------- | -------------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"⬢ "` | A format string representing the symbol of NodeJS. |
| `style` | `"bold green"` | Stil für dieses Modul. |
2020-11-29 04:45:59 +00:00
| `disabled` | `false` | Disables the `nodejs` module. |
2020-07-23 21:07:10 +00:00
###
| 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
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
### Beispiel
2019-10-04 08:57:43 +00:00
```toml
# ~/.config/starship.toml
[nodejs]
2020-07-23 21:07:10 +00:00
format = "via [🤖 $version ](bold green ) "
2019-10-04 08:57:43 +00:00
```
2020-11-29 04:45:59 +00:00
## OCaml
2019-10-04 08:57:43 +00:00
2020-11-29 04:45:59 +00:00
The `ocaml` module shows the currently installed version of OCaml. The module will be shown if any of the following conditions are met:
2019-10-04 08:57:43 +00:00
2020-11-29 04:45:59 +00:00
- 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
2019-10-04 08:57:43 +00:00
2020-11-29 04:45:59 +00:00
### Optionen
| Option | Standartwert | Beschreibung |
| ---------- | ---------------------------------- | ------------------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | The format string for the module. |
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
| `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` |
| 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
```toml
# ~/.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 ](https://docs.openstack.org/python-openstackclient/latest/configuration/index.html#configuration-files ). to fetch the current project in use.
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
### Optionen
2019-10-04 08:57:43 +00:00
2020-11-29 04:45:59 +00:00
| Option | Standartwert | 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. |
2020-07-23 21:07:10 +00:00
### Variables
| Variable | Beispiel | Beschreibung |
| --------- | -------- | ------------------------------------ |
2020-11-29 04:45:59 +00:00
| cloud | `corp` | The current OpenStack cloud |
| project | `dev` | The current OpenStack project |
2020-07-23 21:07:10 +00:00
| 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
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
### Beispiel
2019-10-04 08:57:43 +00:00
```toml
# ~/.config/starship.toml
2020-11-29 04:45:59 +00:00
[openstack]
format = "on [$symbol$cloud(\\($project\\)) ]($style ) "
style = "bold yellow"
symbol = "☁️ "
2019-10-04 08:57:43 +00:00
```
2020-11-29 04:45:59 +00:00
## Package Version
2020-05-23 23:10:58 +00:00
2020-11-29 04:45:59 +00:00
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm` , `cargo` , `poetry` , `composer` , `gradle` , `julia` , `mix` and `helm` packages.
2020-05-23 23:10:58 +00:00
2020-11-29 04:45:59 +00:00
- **npm** – `npm` package version is extracted from the `package.json` present in the current directory
- **cargo** – `cargo` package version is extracted from the `Cargo.toml` present in the current directory
- **poetry** – `poetry` package version is extracted from the `pyproject.toml` present in the current directory
- **composer** – `composer` package version is extracted from the `composer.json` present in the current directory
- **gradle** – `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
> ⚠️ Die angezeigte Version ist die des Pakets, dessen Quellcode im Verzeichnis liegt, nicht die des Paketmanagers.
2020-05-23 23:10:58 +00:00
### Optionen
2020-11-29 04:45:59 +00:00
| Option | Standardwert | Beschreibung |
| ----------------- | ---------------------------------- | ---------------------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"📦 "` | The symbol used before displaying the version the package. |
| `style` | `"bold 208"` | Stil für dieses Modul. |
| `display_private` | `false` | Enable displaying version for packages marked as private. |
| `disabled` | `false` | Disables the `package` module. |
2020-07-23 21:07:10 +00:00
### Variables
2020-11-29 04:45:59 +00:00
| 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` |
2020-07-23 21:07:10 +00:00
\*: This variable can only be used as a part of a style string
2020-05-23 23:10:58 +00:00
### Beispiel
```toml
# ~/.config/starship.toml
2020-11-29 04:45:59 +00:00
[package]
format = "via [🎁 $version ](208 bold ) "
2020-05-23 23:10:58 +00:00
```
2020-09-30 20:26:13 +00:00
## Perl
2020-11-29 04:45:59 +00:00
The `perl` module shows the currently installed version of Perl. The module will be shown if any of the following conditions are met:
2020-09-30 20:26:13 +00:00
- 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
2020-11-29 04:45:59 +00:00
| Option | Standardwert | Beschreibung |
2020-09-30 20:26:13 +00:00
| ---------- | ---------------------------------- | ----------------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | The format string for the module. |
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
| `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
```toml
# ~/.config/starship.toml
[perl]
format = "via [🦪 $version ]($style ) "
```
2019-12-06 22:07:57 +00:00
## PHP
2020-11-29 04:45:59 +00:00
The `php` module shows the currently installed version of PHP. The module will be shown if any of the following conditions are met:
2019-12-06 22:07:57 +00:00
2020-11-29 04:45:59 +00:00
- The current directory contains a `composer.json` file
2020-04-06 18:48:26 +00:00
- The current directory contains a `.php-version` file
2020-11-29 04:45:59 +00:00
- The current directory contains a `.php` file
2019-12-06 22:07:57 +00:00
### Optionen
2020-11-29 04:45:59 +00:00
| Option | Standardwert | Beschreibung |
| ---------- | ---------------------------------- | ----------------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. |
| `style` | `"147 bold"` | Stil für dieses Modul. |
| `disabled` | `false` | Disables the `php` module. |
2020-07-23 21:07:10 +00:00
### 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
2019-12-06 22:07:57 +00:00
### Beispiel
```toml
# ~/.config/starship.toml
[php]
2020-07-23 21:07:10 +00:00
format = "via [🔹 $version ](147 bold ) "
2019-12-06 22:07:57 +00:00
```
2020-11-29 04:45:59 +00:00
## PureScript
The `purescript` module shows the currently installed version of PureScript version. The module will be shown if any of the following conditions are met:
- The current directory contains a `spago.dhall` file
- The current directory contains a \*.purs files
### Optionen
| Option | Standardwert | Beschreibung |
| ---------- | ---------------------------------- | ------------------------------------------------------------ |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
| `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
```toml
# ~/.config/starship.toml
[purescript]
format = "via [$symbol$version ](bold white )"
```
2019-10-04 08:57:43 +00:00
## Python
2020-05-15 15:55:21 +00:00
The `python` module shows the currently installed version of Python and the current Python virtual environment if one is activated.
2019-10-04 08:57:43 +00:00
2020-05-15 15:55:21 +00:00
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` .
2019-10-04 08:57:43 +00:00
2020-11-29 04:45:59 +00:00
The module will be shown if any of the following conditions are met:
2019-10-04 08:57:43 +00:00
2020-11-29 04:45:59 +00:00
- The current directory contains a `.python-version` file
- The current directory contains a `requirements.txt` file
- The current directory contains a `pyproject.toml` file
2020-05-05 17:07:34 +00:00
- The current directory contains a file with the `.py` extension (and `scan_for_pyfiles` is true)
2020-11-29 04:45:59 +00:00
- The current directory contains a `Pipfile` file
- The current directory contains a `tox.ini` file
- The current directory contains a `setup.py` file
2020-05-05 17:07:34 +00:00
- The current directory contains a `__init__.py` file
2020-11-29 04:45:59 +00:00
- A virtual environment is currently activated
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
### Optionen
2019-10-04 08:57:43 +00:00
2020-10-13 19:09:01 +00:00
| Option | Standardwert | Beschreibung |
| -------------------- | ------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| `format` | `'via [${symbol}${pyenv_prefix}${version}( \($virtualenv\))]($style) '` | The format for the module. |
| `symbol` | `"🐍 "` | A format string representing the symbol of Python |
| `style` | `"yellow bold"` | Stil für dieses Modul. |
2020-11-29 04:45:59 +00:00
| `pyenv_version_name` | `false` | Use pyenv to get Python version |
2020-10-13 19:09:01 +00:00
| `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used |
| `scan_for_pyfiles` | `true` | If false, Python files in the current directory will not show this module. |
| `python_binary` | `python` | Configures the python binary that Starship executes when getting the version. |
2020-11-29 04:45:59 +00:00
| `disabled` | `false` | Disables the `python` module. |
2020-07-23 21:07:10 +00:00
### Variables
2020-09-30 20:26:13 +00:00
| 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 |
2020-06-19 21:05:45 +00:00
2020-10-13 19:09:01 +00:00
### Beispiel
2020-06-19 21:05:45 +00:00
```toml
# ~/.config/starship.toml
[python]
2020-10-13 19:09:01 +00:00
symbol = "👾 "
pyenv_version_name = true
2020-06-19 21:05:45 +00:00
```
2020-10-13 19:09:01 +00:00
Using the `python3` binary to get the version.
2019-10-04 08:57:43 +00:00
2020-10-13 19:09:01 +00:00
Note - The `python_binary` variable changes the binary that Starship executes to get the version of Python, it doesn't change the arguments that are used.
2019-10-04 08:57:43 +00:00
```toml
# ~/.config/starship.toml
[python]
2020-10-13 19:09:01 +00:00
python_binary = "python3"
2019-10-04 08:57:43 +00:00
```
## Ruby
2020-11-29 04:45:59 +00:00
The `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met:
2019-10-04 08:57:43 +00:00
2020-11-29 04:45:59 +00:00
- The current directory contains a `Gemfile` file
2020-04-06 18:48:26 +00:00
- The current directory contains a `.ruby-version` file
2020-11-29 04:45:59 +00:00
- The current directory contains a `.rb` file
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
### Optionen
2019-10-04 08:57:43 +00:00
2020-10-13 19:09:01 +00:00
| Option | Standardwert | Beschreibung |
2020-07-23 21:07:10 +00:00
| ---------- | ---------------------------------- | ------------------------------------------------ |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"💎 "` | A format string representing the symbol of Ruby. |
| `style` | `"bold red"` | Stil für dieses Modul. |
2020-11-29 04:45:59 +00:00
| `disabled` | `false` | Disables the `ruby` module. |
2020-07-23 21:07:10 +00:00
### 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
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
### Beispiel
2019-10-04 08:57:43 +00:00
```toml
# ~/.config/starship.toml
[ruby]
symbol = "🔺 "
```
## Rust
2020-11-29 04:45:59 +00:00
The `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met:
2019-10-04 08:57:43 +00:00
2020-11-29 04:45:59 +00:00
- The current directory contains a `Cargo.toml` file
- The current directory contains a file with the `.rs` extension
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
### Optionen
2019-10-04 08:57:43 +00:00
2020-10-13 19:09:01 +00:00
| Option | Standardwert | Beschreibung |
2020-07-23 21:07:10 +00:00
| ---------- | ---------------------------------- | ----------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"🦀 "` | A format string representing the symbol of Rust |
| `style` | `"bold red"` | Stil für dieses Modul. |
2020-11-29 04:45:59 +00:00
| `disabled` | `false` | Disables the `rust` module. |
2020-07-23 21:07:10 +00:00
### 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
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
### Beispiel
2019-10-04 08:57:43 +00:00
```toml
# ~/.config/starship.toml
[rust]
2020-07-23 21:07:10 +00:00
format = "via [⚙️ $version ](red bold )"
2019-10-04 08:57:43 +00:00
```
2020-09-30 20:26:13 +00:00
## 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
2020-10-13 19:09:01 +00:00
| Option | Standardwert | Beschreibung |
2020-09-30 20:26:13 +00:00
| ----------- | ---------------------------- | --------------------------------------- |
| `threshold` | `2` | Display threshold. |
| `format` | `"[$symbol$shlvl]($style) "` | The format for the module. |
| `symbol` | `"↕️ "` | The symbol used to represent the SHLVL. |
| `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
```toml
# ~/.config/starship.toml
[shlvl]
disabled = false
format = "$shlvl level(s) down"
threshold = 3
```
2020-04-03 16:35:39 +00:00
## Singularity
The `singularity` module shows the current singularity image, if inside a container and `$SINGULARITY_NAME` is set.
### Optionen
2020-10-13 19:09:01 +00:00
| 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. |
2020-07-23 21:07:10 +00:00
### 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
2020-04-03 16:35:39 +00:00
### Beispiel
```toml
# ~/.config/starship.toml
[singularity]
2020-10-13 19:09:01 +00:00
format = '[📦 \[$env\]]($style) '
2020-04-03 16:35:39 +00:00
```
2020-11-29 04:45:59 +00:00
## Status
2020-09-30 20:26:13 +00:00
2020-11-29 04:45:59 +00:00
The `status` module displays the exit code of the previous command. The module will be shown only if the exit code is not `0` .
2020-09-30 20:26:13 +00:00
2020-11-29 04:45:59 +00:00
::: Tipp
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. :::
2020-09-30 20:26:13 +00:00
### Optionen
2020-11-29 04:45:59 +00:00
| Option | Standardwert | Beschreibung |
| ---------- | -------------------------- | ------------------------------------------------------ |
| `format` | `[$symbol$status]($style)` | The format of the module |
| `symbol` | `"✖"` | A format string representing the symbol for the status |
| `style` | `"bold red"` | Stil für dieses Modul. |
| `disabled` | `true` | Disables the `status` module. |
2020-09-30 20:26:13 +00:00
### Variables
| Variable | Beispiel | Beschreibung |
| --------- | -------- | ------------------------------------ |
2020-11-29 04:45:59 +00:00
| status | `127` | The exit code of the last command |
2020-09-30 20:26:13 +00:00
| 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
```toml
2020-11-29 04:45:59 +00:00
2020-09-30 20:26:13 +00:00
# ~/.config/starship.toml
2020-11-29 04:45:59 +00:00
[status]
style = "bg:blue"
symbol = "💣 "
format = '[\[$symbol$status\]]($style) '
disabled = false
2020-09-30 20:26:13 +00:00
2020-11-29 04:45:59 +00:00
```
2020-09-30 20:26:13 +00:00
2020-11-29 04:45:59 +00:00
## Swift
2020-09-30 20:26:13 +00:00
2020-11-29 04:45:59 +00:00
The `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met:
2020-09-30 20:26:13 +00:00
2020-11-29 04:45:59 +00:00
- The current directory contains a `Package.swift` file
- The current directory contains a file with the `.swift` extension
2020-09-30 20:26:13 +00:00
### Optionen
2020-11-29 04:45:59 +00:00
| Option | Standardwert | Beschreibung |
| ---------- | ---------------------------------- | ------------------------------------------------ |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
| `style` | `"bold 202"` | Stil für dieses Modul. |
| `disabled` | `false` | Disables the `swift` module. |
2020-09-30 20:26:13 +00:00
### Variables
| Variable | Beispiel | Beschreibung |
| --------- | -------- | ------------------------------------ |
2020-11-29 04:45:59 +00:00
| version | `v5.2.4` | The version of `swift` |
2020-09-30 20:26:13 +00:00
| 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
2020-10-01 01:23:36 +00:00
2020-09-30 20:26:13 +00:00
```toml
# ~/.config/starship.toml
2020-11-29 04:45:59 +00:00
[swift]
format = "via [🏎 $version ](red bold )"
2020-09-30 20:26:13 +00:00
```
2019-12-14 23:46:45 +00:00
## Terraform
2019-10-04 08:57:43 +00:00
2020-11-29 04:45:59 +00:00
The `terraform` module shows the currently selected terraform workspace and version. By default the terraform version is not shown, since this is slow on current versions of terraform when a lot of plugins are in use. If you still want to enable it, [follow the example shown below ](#with-version ). The module will be shown if any of the following conditions are met:
2019-10-04 08:57:43 +00:00
2020-11-29 04:45:59 +00:00
- The current directory contains a `.terraform` folder
- Current directory contains a file with the `.tf` or `.hcl` extensions
2019-12-14 23:46:45 +00:00
### Optionen
2020-09-30 20:26:13 +00:00
| Option | Standardwert | Beschreibung |
2020-07-23 21:07:10 +00:00
| ---------- | ------------------------------------ | ----------------------------------------------------- |
| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. |
| `symbol` | `"💠 "` | A format string shown before the terraform workspace. |
| `style` | `"bold 105"` | Stil für dieses Modul. |
2020-11-29 04:45:59 +00:00
| `disabled` | `false` | Disables the `terraform` module. |
2020-07-23 21:07:10 +00:00
### 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
2019-12-14 23:46:45 +00:00
### Beispiel
2020-07-23 21:07:10 +00:00
#### With Version
2019-12-14 23:46:45 +00:00
```toml
# ~/.config/starship.toml
[terraform]
2020-07-23 21:07:10 +00:00
format = "[🏎💨 $version$workspace]($style) "
```
#### Without version
```toml
# ~/.config/starship.toml
[terraform]
format = "[🏎💨 $workspace]($style) "
2019-12-14 23:46:45 +00:00
```
2020-10-01 01:23:36 +00:00
## Zeit
2019-12-14 23:46:45 +00:00
2020-11-29 04:45:59 +00:00
The `time` module shows the current **local** time. The `format` configuration value is used by the [`chrono` ](https://crates.io/crates/chrono ) crate to control how the time is displayed. Take a look [at the chrono strftime docs ](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html ) to see what options are available.
2019-12-14 23:46:45 +00:00
2020-10-01 01:23:36 +00:00
::: Tipp
2019-10-04 08:57:43 +00:00
2020-11-29 04:45:59 +00:00
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
2019-10-04 08:57:43 +00:00
:::
2019-10-21 14:42:08 +00:00
### Optionen
2019-10-04 08:57:43 +00:00
2020-11-29 04:45:59 +00:00
| Option | Standardwert | Beschreibung |
| ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `format` | `"at [$time]($style) "` | The format string for the module. |
| `use_12hr` | `false` | Enables 12 hour formatting |
| `time_format` | see below | The [chrono format string ](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html ) used to format the time. |
| `style` | `"bold yellow"` | The style for the module time |
| `utc_time_offset` | `"local"` | Sets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. |
| `disabled` | `true` | Disables the `time` module. |
| `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format |
2020-07-23 21:07:10 +00:00
2020-11-29 04:45:59 +00:00
If `use_12hr` is `true` , then `time_format` defaults to `"%r"` . Otherwise, it defaults to `"%T"` . Manually setting `time_format` will override the `use_12hr` setting.
2020-07-23 21:07:10 +00:00
### Variables
| Variable | Beispiel | Beschreibung |
| --------- | ---------- | ----------------------------------- |
2020-11-29 04:45:59 +00:00
| time | `13:08:10` | The current time. |
2020-07-23 21:07:10 +00:00
| style\* | | Mirrors the value of option `style` |
2019-10-04 08:57:43 +00:00
2020-07-23 21:07:10 +00:00
\*: This variable can only be used as a part of a style string
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
### Beispiel
2019-10-04 08:57:43 +00:00
```toml
# ~/.config/starship.toml
[time]
disabled = false
2020-10-13 19:09:01 +00:00
format = '🕙[\[ $time \]]($style) '
2020-07-23 21:07:10 +00:00
time_format = "%T"
2020-04-03 16:35:39 +00:00
utc_time_offset = "-5"
docs(i18n): new Crowdin translations (#1262)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (German)
* New translations README.md (French)
* New translations README.md (Japanese)
* New translations README.md (Spanish)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Traditional)
* New translations README.md (Chinese Simplified)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (French)
* New translations README.md (Japanese)
* New translations README.md (German)
* New translations README.md (Spanish)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Simplified)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Chinese Traditional)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Simplified)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (German)
* New translations README.md (Chinese Simplified)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Russian)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
2020-06-11 01:28:04 +00:00
time_range = "10:00:00-14:00:00"
2019-10-04 08:57:43 +00:00
```
2020-05-05 17:07:34 +00:00
## Username
2019-10-04 08:57:43 +00:00
2020-11-29 04:45:59 +00:00
The `username` module shows active user's username. The module will be shown if any of the following conditions are met:
2019-10-04 08:57:43 +00:00
2020-11-29 04:45:59 +00:00
- The current user is root
- The current user isn't the same as the one that is logged in
- The user is currently connected as an SSH session
- The variable `show_always` is set to true
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
### Optionen
2019-10-04 08:57:43 +00:00
2020-11-29 04:45:59 +00:00
| Option | Standardwert | Beschreibung |
| ------------- | ----------------------- | ------------------------------------- |
| `style_root` | `"bold red"` | The style used when the user is root. |
| `style_user` | `"bold yellow"` | The style used for non-root users. |
| `format` | `"[$user]($style) in "` | The format for the module. |
| `show_always` | `false` | Always shows the `username` module. |
| `disabled` | `false` | Disables the `username` module. |
2020-07-23 21:07:10 +00:00
### 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. |
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
### Beispiel
2019-10-04 08:57:43 +00:00
```toml
# ~/.config/starship.toml
[username]
2020-07-23 21:07:10 +00:00
style_user = "white bold"
style_root = "black bold"
format = "user: [$user ]($style ) "
disabled = false
show_always = true
2019-10-04 08:57:43 +00:00
```
2020-05-05 17:07:34 +00:00
2020-05-23 23:10:58 +00:00
## Zig
2020-11-29 04:45:59 +00:00
The `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met:
2020-05-23 23:10:58 +00:00
- The current directory contains a `.zig` file
### Optionen
2020-09-30 20:26:13 +00:00
| Option | Standardwert | Beschreibung |
2020-07-23 21:07:10 +00:00
| ---------- | ---------------------------------- | ----------------------------------------------------- |
| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. |
| `style` | `"bold yellow"` | Stil für dieses Modul. |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `disabled` | `false` | Disables the `zig` 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
2020-05-23 23:10:58 +00:00
### Beispiel
```toml
# ~/.config/starship.toml
[zig]
symbol = "⚡️ "
```
2020-05-05 17:07:34 +00:00
## 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:
2020-07-23 21:07:10 +00:00
2020-05-05 17:07:34 +00:00
- 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
2020-10-01 01:23:36 +00:00
::: Tipp
2020-05-05 17:07:34 +00:00
Multiple custom modules can be defined by using a `.` .
:::
2020-10-01 01:23:36 +00:00
::: Tipp
2020-09-30 20:26:13 +00:00
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.
:::
2020-10-01 01:23:36 +00:00
::: Tipp
2020-05-05 17:07:34 +00:00
2020-09-30 20:26:13 +00:00
[Issue #1252 ](https://github.com/starship/starship/discussions/1252 ) contains examples of custom modules. If you have an interesting example not covered there, feel free to share it there!
2020-05-05 17:07:34 +00:00
:::
### Optionen
2020-11-29 04:45:59 +00:00
| 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 ](#custom-command-shell ) |
| `description` | `"<custom module>"` | The description of the module that is shown when running `starship explain` . |
| `files` | `[]` | The files that will be searched in the working directory for a match. |
| `directories` | `[]` | The directories that will be searched in the working directory for a match. |
| `extensions` | `[]` | The extensions that will be searched in the working directory for a match. |
| `symbol` | `""` | The symbol used before displaying the command output. |
| `style` | `"bold green"` | Stil für dieses Modul. |
| `format` | `"[$symbol$output]($style) "` | The format for the module. |
| `disabled` | `false` | Disables this `custom` module. |
2020-07-23 21:07:10 +00:00
### 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
docs(i18n): new Crowdin translations (#1262)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (German)
* New translations README.md (French)
* New translations README.md (Japanese)
* New translations README.md (Spanish)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Traditional)
* New translations README.md (Chinese Simplified)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (French)
* New translations README.md (Japanese)
* New translations README.md (German)
* New translations README.md (Spanish)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Simplified)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Chinese Traditional)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Simplified)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (German)
* New translations README.md (Chinese Simplified)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Russian)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
2020-06-11 01:28:04 +00:00
#### Custom command shell
`shell` accepts a non-empty list of strings, where:
2020-07-23 21:07:10 +00:00
docs(i18n): new Crowdin translations (#1262)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (German)
* New translations README.md (French)
* New translations README.md (Japanese)
* New translations README.md (Spanish)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Traditional)
* New translations README.md (Chinese Simplified)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (French)
* New translations README.md (Japanese)
* New translations README.md (German)
* New translations README.md (Spanish)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Simplified)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Chinese Traditional)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Simplified)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (German)
* New translations README.md (Chinese Simplified)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Russian)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
2020-06-11 01:28:04 +00:00
- 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.
2020-09-30 20:26:13 +00:00
The `command` will be passed in on stdin.
docs(i18n): new Crowdin translations (#1262)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (German)
* New translations README.md (French)
* New translations README.md (Japanese)
* New translations README.md (Spanish)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Traditional)
* New translations README.md (Chinese Simplified)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (French)
* New translations README.md (Japanese)
* New translations README.md (German)
* New translations README.md (Spanish)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Simplified)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Chinese Traditional)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Simplified)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (German)
* New translations README.md (Chinese Simplified)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Russian)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
2020-06-11 01:28:04 +00:00
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.
```toml
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 ](https://github.com/starship/starship/issues/new/choose ) with shell details and starship configuration if you hit such scenario.
:::
2020-05-05 17:07:34 +00:00
### Beispiel
```toml
# ~/.config/starship.toml
[custom.foo]
command = "echo foo" # shows output of command
files = ["foo"] # can specify filters
when = """ test "$HOME" == "$PWD" """
2020-09-30 20:26:13 +00:00
format = " transcending [$output ]($style )"
docs(i18n): new Crowdin translations (#1262)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (German)
* New translations README.md (French)
* New translations README.md (Japanese)
* New translations README.md (Spanish)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Traditional)
* New translations README.md (Chinese Simplified)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Chinese Simplified)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (French)
* New translations README.md (Japanese)
* New translations README.md (German)
* New translations README.md (Spanish)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Simplified)
* New translations README.md (Russian)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (Chinese Traditional)
* New translations README.md (Chinese Traditional)
* New translations README.md (Portuguese)
* New translations README.md (Portuguese)
* New translations README.md (Chinese Simplified)
* New translations README.md (Portuguese, Brazilian)
* New translations README.md (French)
* New translations README.md (French)
* New translations README.md (Spanish)
* New translations README.md (Spanish)
* New translations README.md (German)
* New translations README.md (German)
* New translations README.md (Chinese Simplified)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Russian)
* New translations README.md (Russian)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
* New translations README.md (Japanese)
2020-06-11 01:28:04 +00:00
[custom.time]
command = "time /T"
files = ["*.pst"]
shell = ["pwsh.exe", "-NoProfile", "-Command", "-"]
2020-05-05 17:07:34 +00:00
```
