2019-10-21 14:42:08 +00:00
# Konfiguration
2019-10-04 08:57:43 +00:00
::: tip
2019-10-21 14:42:08 +00:00
🔥 Die Konfiguration befindet sich derzeit noch in der Entwicklung. Viele neue Konfigurationsoptionen werden in den kommenden Versionen verfügbar sein.
2019-10-04 08:57:43 +00:00
:::
2019-10-21 14:42:08 +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
```shell
$ touch ~/.config/starship.toml
```
2019-10-21 14:42:08 +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
2019-10-21 14:42:08 +00:00
# Kein Zeilenumbruch am Anfang der Eingabe
2019-10-04 08:57:43 +00:00
add_newline = false
2019-10-21 14:42:08 +00:00
# Ersetze das "❯ " Symbol in der Konsole mit "➜"
[character] # Wir nehmen Änderungen im Module "character" vor
symbol = "➜" # Das "symbol" Feld wird "➜" gesetzt
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
# Deaktiviere das "package" Modul um es ganz aus der Anzeige zu entfernen
2019-10-04 08:57:43 +00:00
[package]
disabled = true
```
2019-10-21 14:42:08 +00:00
### Terminologie
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
**Module**: Eine Komponente in der Konsole, die auf kontextualisierte Informationen des OS basiert. Zum Beispiel das "nodejs" Modul zeigt die version von NodeJS, die derzeit auf deinem Rechner installiert ist, wenn dein Arbeitsordner ein NodeJS Projekt umfasst.
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
**Segment**: Kleinere Sub-Komponente die ein Modul ergeben. Zum Beispiel, das "symbol" Segment im "nodejs" Modul beinhaltet das Symbol das vor der Versionsnummer gezeigt wird (Standard: ⬢).
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
Hier ist die Darstellung des Node Moduls. Im folgenden Beispiel betrachten wir die Segmente "symbol" und "version". Jedes Modul hat auch einen Prefix und einen Suffix, das auf die Standardfarbe des Terminals gesetzt ist.
2019-10-04 08:57:43 +00:00
```
[prefix] [symbol] [version] [suffix]
"via " "⬢" "v10.4.1" ""
```
2019-10-21 14:42:08 +00:00
### Style-Strings
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +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 Einstellungshandbuch ](/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
- `"bold italic fg:purple"` setzt dicke Kursivschrift lila
- `""` deativiert explizit jeden Stil
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
Wie genau sich diese Konfiguration auswirkt liegt an deinem Shell Emulator. Einige Emulatoren zum Beispiel werden die Farben erhellen statt Text dick zu machen, und ein paar Farbthemata 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
## Prompt
2019-10-21 14:42:08 +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
2019-10-21 14:42:08 +00:00
| Variable | Standardwert | Beschreibung |
| -------------- | ----------------------------- | ------------------------------------------------------------------ |
| `add_newline` | `true` | Neuer Zeilenumbruch bei Start des Prompts. |
| `prompt_order` | [link ](#default-prompt-order ) | Stelle die Reihenfolge ein, in der die Module den prompt aufbauen. |
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
2019-10-21 14:42:08 +00:00
# Kein Zeilenumbruch am Anfang der Eingabe
2019-10-04 08:57:43 +00:00
add_newline = false
2019-10-21 14:42:08 +00:00
# Überscheibt die Standard-Reihenfolge und nutzt die folgende
2019-10-04 08:57:43 +00:00
prompt_order=["rust","line_break","package","line_break","character"]
```
2019-10-21 14:42:08 +00:00
### Default Promp Order
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
Die Standard `prompt_order` wird benutzt um die Reihenfolge der Module im Prompt zu definieren, falls `prompt_order` leer oder nicht gesetzt ist. Der default sieht wie folgt aus:
2019-10-04 08:57:43 +00:00
```toml
prompt_order = [
"username",
"hostname",
"kubernetes",
"directory",
"git_branch",
"git_state",
"git_status",
"package",
"dotnet",
"golang",
"java",
"nodejs",
"python",
"ruby",
"rust",
"nix_shell",
2019-10-11 08:31:19 +00:00
"conda",
2019-10-04 08:57:43 +00:00
"memory_usage",
"aws",
"env_var",
"cmd_duration",
"line_break",
"jobs",
"battery",
"time",
"character",
]
```
## AWS
2019-10-21 14:42:08 +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
2019-10-21 14:42:08 +00:00
### Optionen
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
| Variable | Standardwert | Beschreibung |
| ---------- | --------------- | ------------------------------------------------------------------- |
| `symbol` | `"☁️ "` | Symbol das vor der Anzahl des aktuellen AWS-Profils angezeigt wird. |
| `style` | `"bold yellow"` | Stil für dieses Modul. |
| `disabled` | `false` | Deaktiviert das `aws` -Modul. |
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
[aws]
style = "bold blue"
symbol = "🅰 "
```
2019-10-21 14:42:08 +00:00
## Akkustand
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +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
2019-10-21 14:42:08 +00:00
| Variable | Standardwert | 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. |
| `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 >
2019-10-21 14:42:08 +00:00
< summary > Das Batterie-Modul unterstützt auch einige ungewöhnliche Zustände.< / summary >
2019-10-04 08:57:43 +00:00
| Variable | Description |
| ---------------- | --------------------------------------------------- |
| `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 = "💀"
```
2019-10-21 14:42:08 +00:00
### Anzeige des Akkustandes
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +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. Werden die folgenden Standardwerte verwendet:
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
2019-10-21 14:42:08 +00:00
Die `display` -Option beinhaltet ein Array mit den folgenden Werten.
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
| Variable | Beschreibung |
| ----------- | ------------------------------------------------------- |
| `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
2019-10-21 14:42:08 +00:00
[[battery.display]] # "bold red" bei Akkustand zwischen 0– 10%
2019-10-04 08:57:43 +00:00
threshold = 10
style = "bold red"
2019-10-21 14:42:08 +00:00
[[battery.display]] # "bold yellow" bei Akkustand zwischen 10– 30%
2019-10-04 08:57:43 +00:00
threshold = 30
style = "bold yellow"
2019-10-21 14:42:08 +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
2019-10-21 14:42:08 +00:00
Das `character` Modul zeigt ein Zeichen ( meistens einen Pfeil "❯ ") vor der Texteingabe an.
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
Das Zeichen zeigt an ob der letzte Befehl erfolgreich war, oder einen Fehler erzeugt hat. Das Modul ändert entweder die Farbe, ("style_success","style_failure") standardmäßig Grün/Rot. Oder das Symbol, wenn `use_symbol_for_status` auf `true` steht.
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
2019-10-21 14:42:08 +00:00
| Variable | Standardwert | Beschreibung |
| ----------------------- | -------------- | ----------------------------------------------------------------------------------------------------------------- |
| `symbol` | `"❯ "` | Das Symbol, das vor der Texteingabe im Prompt verwendet wird. |
| `error_symbol` | `"✖"` | Das Symbol, das vor der Texteingabe angezeigt wird, wenn der letzte Befehl fehlgeschlagen ist. |
| `use_symbol_for_status` | `false` | Fehlerstatus durch Ändern des Symbols anzeigen. |
| `vicmd_symbol` | `"❮ "` | Das Symbol, das vor Texteingaben im Prompt verwendet wird, wenn die Shell sich im "normal mode" von vim befindet. |
| `style_success` | `"bold green"` | Der Stil, der verwendet wird, wenn der letzte Befehl erfolgreich war. |
| `style_failure` | `"bold red"` | Der Stil, der verwendet wird, wenn der letzte Befehl fehlgeschlagen ist. |
| `disabled` | `false` | Deaktiviert das `character` -Modul. |
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
[character]
symbol = "➜"
error_symbol = "✗"
use_symbol_for_status = true
```
2019-10-21 14:42:08 +00:00
## Befehlsdauer
2019-10-04 08:57:43 +00:00
The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists.
2019-10-21 14:42:08 +00:00
::: warning Nicht die DEBUG-trap in der Bash hooken
2019-10-04 08:57:43 +00:00
If you are running Starship in `bash` , do not hook the `DEBUG` trap after running `eval $(starship init $0)` , or this module **will** break.
:::
Bash users who need preexec-like functionality can use [rcaloras's bash_preexec framework ](https://github.com/rcaloras/bash-preexec ). Simply define the arrays `preexec_functions` and `precmd_functions` before running `eval $(starship init $0)` , and then proceed as normal.
2019-10-21 14:42:08 +00:00
### Optionen
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
| Variable | Standardwert | Beschreibung |
| ---------- | --------------- | ------------------------------------------------------------------------- |
| `min_time` | `2` | Kürzestes Wert für den die Ausführungsdauer angezeigt wird (in Sekunden). |
| `prefix` | `took` | Prefix der unmittelbar vor der Ausführungszeit angezeigt wird. |
| `style` | `"bold yellow"` | Stil für dieses Modul. |
| `disabled` | `false` | Deaktiviert das `cmd_duration` -Modul. |
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]
min_time = 4
prefix = "underwent "
```
2019-10-11 08:31:19 +00:00
## Conda
2019-10-21 14:42:08 +00:00
Das `conda` -Modul zeigt dessen aktuelle Umgebung an, sofern `$CONDA_DEFAULT_ENV` gesetzt ist. Hinweis: Dies unterdrückt conda's eigenen Prompt-Modifikator nicht, sie können jedoch `conda config --set changeps1 False` setzen, um dies zu realisieren.
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
2019-10-21 14:42:08 +00:00
| Variable | Standardwert | Beschreibung |
| ---------- | -------------- | ------------------------------------------------- |
| `symbol` | `"C "` | Symbol das vor dem Umgebungsnamen angezeigt wird. |
| `style` | `"bold green"` | Stil für dieses Modul. |
| `disabled` | `false` | Deaktiviert das `conda` -Modul. |
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]
style = "dimmed green"
```
2019-10-21 14:42:08 +00:00
## Verzeichnis
2019-10-04 08:57:43 +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.
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
2019-10-21 14:42:08 +00:00
| Variable | Standardwert | Beschreibung |
2019-10-04 08:57:43 +00:00
| ------------------- | ------------- | -------------------------------------------------------------------------------- |
2019-10-21 14:42:08 +00:00
| `truncation_length` | `3` | Die Anzahl der übergeordneten Ordner, die angezeigt werden. |
2019-10-04 08:57:43 +00:00
| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. |
2019-10-21 14:42:08 +00:00
| `style` | `"bold cyan"` | Stil für dieses Modul. |
| `disabled` | `false` | Deaktiviert das `directory` -Modul. |
2019-10-04 08:57:43 +00:00
< details >
2019-10-21 14:42:08 +00:00
< summary > Dieses Modul hat einige erweiterte Konfigurationsoptionen, welche die Darstellung von Verzeichnissen steuern.< / summary >
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
| Variable | Standardwert | Beschreibung |
| --------------------------- | ------------ | ---------------------------------------------------------------------------------------- |
| `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
< / details >
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
```
## 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.
This module will only be shown in your prompt when one of the following files are present in the current directory: `global.json` , `project.json` , `*.sln` , `*.csproj` , `*.fsproj` , `*.xproj` . You'll also need the .NET Core command-line tools installed in order to use it correctly.
Internally, this module uses its own mechanism for version detection. Typically it is twice as fast as running `dotnet --version` , but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting `heuristic = false` in the module options.
2019-10-21 14:42:08 +00:00
### Optionen
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
| Variable | Standardwert | Beschreibung |
| ----------- | ------------- | ------------------------------------------------------------------ |
| `symbol` | `"•NET "` | Symbol das vor der dotnet-Version angezeigt wird. |
| `style` | `"bold blue"` | Stil für dieses Modul. |
| `heuristic` | `true` | Schnelle Versionserkennung nutzen um Starship bedienbar zu halten. |
| `disabled` | `false` | Deaktiviert das `dotnet` -Modul. |
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
```
2019-10-21 14:42:08 +00:00
## Umgebungsvariablen
2019-10-04 08:57:43 +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:
- The `variable` configuration option matches an existing environment variable
- The `variable` configuration option is not defined, but the `default` configuration option is
2019-10-21 14:42:08 +00:00
### Optionen
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
| Variable | Standardwert | Beschreibung |
2019-10-04 08:57:43 +00:00
| ---------- | ---------------- | ---------------------------------------------------------------------------- |
| `symbol` | | The symbol used before displaying the variable value. |
| `variable` | | The environment variable to be displayed. |
| `default` | | The default value to be displayed when the selected variable is not defined. |
| `prefix` | `""` | Prefix to display immediately before the variable value. |
| `suffix` | `""` | Suffix to display immediately after the variable value. |
2019-10-21 14:42:08 +00:00
| `style` | `"dimmed black"` | Stil für dieses Modul. |
| `disabled` | `false` | Deaktiviert das `env_var` -Modul. |
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
[env_var]
variable = "SHELL"
default = "unknown shell"
```
2019-10-21 14:42:08 +00:00
## Git-Branch
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
Das `git_branch` -Modul zeigt den aktiven Git-Branch des Repositories im aktuellen Verzeichnis an.
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
2019-10-21 14:42:08 +00:00
| Variable | Standardwert | Beschreibung |
2019-10-04 08:57:43 +00:00
| ------------------- | --------------- | ------------------------------------------------------------------------------------- |
| `symbol` | `" "` | The symbol used before the branch name of the repo in your current directory. |
| `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 |
2019-10-21 14:42:08 +00:00
| `style` | `"bold purple"` | Stil für dieses Modul. |
| `disabled` | `false` | Deaktiviert das `git_branch` -Modul. |
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-10-21 14:42:08 +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
2019-10-21 14:42:08 +00:00
| Variable | Standardwert | Beschreibung |
2019-10-04 08:57:43 +00:00
| ------------------ | ------------------ | ---------------------------------------------------------------------------------------------------------------- |
| `rebase` | `"REBASING"` | The text displayed when a `rebase` is in progress. |
| `merge` | `"MERGING"` | The text displayed when a `merge` is in progress. |
| `revert` | `"REVERTING"` | The text displayed when a `revert` is in progress. |
| `cherry_pick` | `"CHERRY-PICKING"` | The text displayed when a `cherry-pick` is in progress. |
| `bisect` | `"BISECTING"` | The text displayed when a `bisect` is in progress. |
| `am` | `"AM"` | The text displayed when an `apply-mailbox` (`git am`) is in progress. |
| `am_or_rebase` | `"AM/REBASE"` | The text displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. |
| `progress_divider` | `"/"` | The symbol or text which will separate the current and total progress amounts. (e.g., `" of "` , for `"3 of 10"` ) |
2019-10-21 14:42:08 +00:00
| `style` | `"bold yellow"` | Stil für dieses Modul. |
| `disabled` | `false` | Deaktiviert das `git_state` -Modul. |
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]
progress_divider = " of "
cherry_pick = "🍒 PICKING"
```
2019-10-21 14:42:08 +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.
### Options
2019-10-21 14:42:08 +00:00
| Variable | Standardwert | Beschreibung |
2019-10-04 08:57:43 +00:00
| ----------------- | ------------ | ------------------------------------------------------- |
| `conflicted` | `"="` | This branch has merge conflicts. |
| `ahead` | `"⇡"` | This branch is ahead of the branch being tracked. |
| `behind` | `"⇣"` | This branch is behind of the branch being tracked. |
| `diverged` | `"⇕"` | This branch has diverged from the branch being tracked. |
| `untracked` | `"?"` | There are untracked files in the working directory. |
| `stashed` | `"$"` | A stash exists for the local repository. |
| `modified` | `"!"` | There are file modifications in the working directory. |
| `staged` | `"+"` | A new file has been added to the staging area. |
| `renamed` | `"»"` | A renamed file has been added to the staging area. |
| `deleted` | `"✘"` | A file's deletion has been added to the staging area. |
| `show_sync_count` | `false` | Show ahead/behind count of the branch being tracked. |
| `prefix` | `[` | Prefix to display immediately before git status. |
| `suffix` | `]` | Suffix to display immediately after git status. |
2019-10-21 14:42:08 +00:00
| `style` | `"bold red"` | Stil für dieses Modul. |
| `disabled` | `false` | Deaktiviert das `git_status` -Modul. |
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_status]
conflicted = "🏳"
ahead = "🏎💨"
behind = "😰"
diverged = "😵"
untracked = "🤷"
stashed = "📦"
modified = "📝"
staged = "➕ "
renamed = "👅"
deleted = "🗑"
```
## Golang
2019-10-21 14:42:08 +00:00
Das `golang` -Modul zeigt die aktuell installierte Version von Golang. Das Modul wird nur dann angezeigt, wenn eine der folgenden Bedingungen zutrifft:
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +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
- 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
2019-10-21 14:42:08 +00:00
| Variable | Standardwert | Beschreibung |
| ---------- | ------------- | ------------------------------------------------- |
| `symbol` | `"🐹 "` | Symbol das vor der Golang-Version angezeigt wird. |
| `style` | `"bold cyan"` | Stil für dieses Modul. |
| `disabled` | `false` | Deaktiviert das `golang` -Modul. |
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]
symbol = "🏎💨 "
```
## Hostname
2019-10-21 14:42:08 +00:00
Das `hostname` -Modul zeigt den Hostnamen des Systems an.
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
2019-10-21 14:42:08 +00:00
| Variable | Standardwert | Beschreibung |
| ---------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `ssh_only` | `true` | Zeigt den Hostnamen nur, wenn via SSH-Sitzung verbunden. |
| `prefix` | `""` | Prefix der unmittelbar vor dem Hostnamen angezeigt wird. |
| `suffix` | `""` | Suffix der unmittelbar nach dem Hostnamen angezeigt wird. |
| `trim_at` | `"."` | String that the hostname is cut off at, after the first match. `"."` will stop after the first dot. `""` will disable any truncation |
| `style` | `"bold dimmed green"` | The style for the module. |
| `disabled` | `false` | Disables the `hostname` module. |
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
2019-10-21 14:42:08 +00:00
prefix = "10218;"
suffix = " 10219;"
trim_at = ".companyname.com"
2019-10-04 08:57:43 +00:00
disabled = false
```
## 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
2019-10-21 14:42:08 +00:00
| Variable | Standardwert | Beschreibung |
| ----------- | ------------- | -------------------------------------------------------------------------------- |
| `symbol` | `"✦"` | Symbol das vor der Anzahl der Jobs angezeigt wird. |
| `threshold` | `1` | Zeigt die Anzahl der Jobs wenn der angegebene Schwellenwert überschritten wurde. |
| `style` | `"bold blue"` | Stil für dieses Modul. |
| `disabled` | `false` | Deaktiviert das `jobs` -Modul. |
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
```
## Kubernetes
Displays the current Kubernetes context name and, if set, the namespace from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via `kubectl config set-context starship-cluster --namespace
astronaut`. If the `$KUBECONFIG` env var is set the module will use that if not it will use the `~/.kube/config` .
2019-10-11 08:31:19 +00:00
::: tip
2019-10-21 14:42:08 +00:00
Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren.
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
2019-10-21 14:42:08 +00:00
| Variable | Standardwert | Beschreibung |
| ---------- | ------------- | ------------------------------------------------------ |
| `symbol` | `"☸ "` | Symbol das vor der Cluster-Information angezeigt wird. |
| `style` | `"bold blue"` | Stil für dieses Modul. |
| `disabled` | `true` | Deaktiviert das `kubernetes` -Modul |
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]
symbol = "⛵ "
style = "dim green"
2019-10-11 08:31:19 +00:00
disabled = false
2019-10-04 08:57:43 +00:00
```
2019-10-21 14:42:08 +00:00
## Zeilenumbruch
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
Das `line_break` -Modul unterteilt den Prompt in zwei Zeilen.
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
2019-10-21 14:42:08 +00:00
| Variable | 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
```
2019-10-21 14:42:08 +00:00
## Nix-Shell
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
Das `nix_shell` -Modul zeigt die nix-shell Umgebung an. Das Modul wird angezeigt, wenn es sich in einer nix-Shell-Umgebung befindet.
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
2019-10-21 14:42:08 +00:00
| Variable | Standardwert | Beschreibung |
2019-10-04 08:57:43 +00:00
| ------------ | ------------ | ---------------------------------- |
2019-10-21 14:42:08 +00:00
| `use_name` | `false` | Namen der nix-Shell anzeigen. |
| `impure_msg` | `impure` | Passt die "impure"-Nachricht an. |
| `pure_msg` | `pure` | Passt die "pure"-Nachricht an. |
| `style` | `"bold red"` | Stil für dieses Modul. |
| `disabled` | `false` | Deaktiviert das `nix_shell` -Modul. |
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
[nix_shell]
disabled = true
use_name = true
impure_msg = "impure shell"
pure_msg = "pure shell"
```
2019-10-21 14:42:08 +00:00
## Speicherauslastung
2019-10-04 08:57:43 +00:00
The `memory_usage` module shows current system memory and swap usage.
By default the swap usage is displayed if the total system swap is non-zero.
::: tip
2019-10-21 14:42:08 +00:00
Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren.
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
2019-10-21 14:42:08 +00:00
| Variable | Standardwert | Beschreibung |
| ----------------- | --------------------- | ------------------------------------------------------------- |
| `show_percentage` | `false` | Display memory usage as a percentage of the available memory. |
| `show_swap` | `true` | Display swap usage if total swap is non-zero. |
| `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. |
| `symbol` | `"🐏 "` | Symbol das vor der Speicherauslastung angezeigt wird. |
| `style` | `"bold dimmed white"` | Stil für dieses Modul. |
| `disabled` | `true` | Deaktiviert das `memory_usage` -Modul. |
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
[memory_usage]
show_percentage = true
show_swap = true
threshold = -1
2019-10-25 00:58:10 +00:00
symbol = " "
2019-10-04 08:57:43 +00:00
style = "bold dimmed green"
```
## Java
The `java` module shows the currently installed version of Java. The module will be shown if any of the following conditions are met:
2019-10-11 08:31:19 +00:00
- The current directory contains a `pom.xml` , `build.gradle` or `build.sbt` file
2019-10-04 08:57:43 +00:00
- The current directory contains a file with the `.java` , `.class` or `.jar` extension
2019-10-21 14:42:08 +00:00
### Optionen
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
| Variable | Standardwert | Beschreibung |
| ---------- | -------------- | ----------------------------------------------- |
| `symbol` | `"☕ "` | Symbol das vor der Java-Version angezeigt wird. |
| `style` | `"dimmed red"` | Stil für dieses Modul. |
| `disabled` | `false` | Deaktiviert das `Java` -Modul. |
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
[java]
symbol = "🌟 "
```
## NodeJS
The `nodejs` module shows the currently installed version of NodeJS. The module will be shown if any of the following conditions are met:
- The current directory contains a `package.json` file
- The current directory contains a `node_modules` directory
- The current directory contains a file with the `.js` extension
2019-10-21 14:42:08 +00:00
### Optionen
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
| Variable | Standardwert | Beschreibung |
| ---------- | -------------- | ------------------------------------------------- |
| `symbol` | `"⬢ "` | Symbol das vor der NodeJS-Version angezeigt wird. |
| `style` | `"bold green"` | Stil für dieses Modul. |
| `disabled` | `false` | Deaktiviert das `nodejs` -Modul. |
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]
symbol = "🤖 "
```
2019-10-21 14:42:08 +00:00
## Paketversion
2019-10-04 08:57:43 +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` , and `poetry` packages.
- **npm** – The `npm` package version is extracted from the `package.json` present in the current directory
- **cargo** – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
- **poetry** – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
> ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager.
2019-10-21 14:42:08 +00:00
### Optionen
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
| Variable | Standardwert | Beschreibung |
| ---------- | ------------ | ----------------------------------------------- |
| `symbol` | `"📦 "` | Symbol das vor der Paketversion angezeigt wird. |
| `style` | `"bold red"` | Stil für dieses Modul. |
| `disabled` | `false` | Deaktiviert das `package` -Modul. |
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
[package]
symbol = "🎁 "
```
## Python
The `python` module shows the currently installed version of Python.
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` and show the current Python virtual environment if one is activated.
The module will be shown if any of the following conditions are met:
- The current directory contains a `.python-version` file
- The current directory contains a `requirements.txt` file
- The current directory contains a `pyproject.toml` file
- The current directory contains a file with the `.py` extension
- The current directory contains a `Pipfile` file
- The current directory contains a `tox.ini` file
2019-10-21 14:42:08 +00:00
### Optionen
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
| Variable | Standardwert | Beschreibung |
| -------------------- | --------------- | ------------------------------------------------------------------- |
| `symbol` | `"🐍 "` | Symbol das vor der Python-Version angezeigt wird. |
| `pyenv_version_name` | `false` | Verwende `pyenv` um die Python-Versionzu beziehen. |
| `pyenv_prefix` | `"pyenv "` | Prefix zur Anzeige der pyenv-Version (Standard: `pyenv MY_VERSION` ) |
| `style` | `"bold yellow"` | Stil für dieses Modul. |
| `disabled` | `false` | Deaktiviert das `python` -Modul. |
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
[python]
symbol = "👾 "
pyenv_version_name = true
pyenv_prefix = "foo "
```
## Ruby
The `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met:
- The current directory contains a `Gemfile` file
- The current directory contains a `.rb` file
2019-10-21 14:42:08 +00:00
### Optionen
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
| Variable | Standardwert | Beschreibung |
| ---------- | ------------ | ----------------------------------------------- |
| `symbol` | `"💎 "` | Symbol das vor der Ruby-Version angezeigt wird. |
| `style` | `"bold red"` | Stil für dieses Modul. |
| `disabled` | `false` | Deaktiviert das `ruby` -Modul. |
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
The `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met:
- The current directory contains a `Cargo.toml` file
- The current directory contains a file with the `.rs` extension
2019-10-21 14:42:08 +00:00
### Optionen
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
| Variable | Standardwert | Beschreibung |
| ---------- | ------------ | ----------------------------------------------- |
| `symbol` | `"🦀 "` | Symbol das vor der Rust-Version angezeigt wird. |
| `style` | `"bold red"` | Stil für dieses Modul. |
| `disabled` | `false` | Deaktiviert das `rust` -Modul. |
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]
symbol = "⚙️ "
```
2019-10-21 14:42:08 +00:00
## Uhrzeit
2019-10-04 08:57:43 +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.
::: tip
2019-10-21 14:42:08 +00:00
Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren.
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
2019-10-21 14:42:08 +00:00
| Variable | Standardwert | Beschreibung |
| ----------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `12hr` | `false` | Aktiviert die Formatierung der Uhrzeit im 12-Stunden-Format. |
| `format` | Siehe unten | Das Format zum Anzeigen der Uhrzeit in [chrono-Formatierung ](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html ). |
| `style` | `bold yellow` | Stil für dieses Modul. |
| `disabled` | `true` | Deaktiviert das `time` -Modul. |
| `utc_time_offset` | `lokal` | Legt das UTC-Offset fest, das verwendet werden soll. Reicht von -24 < x < 24 . Allows floats to accommodate 30 / 45 minute timezone offsets . |
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
Wird `use_12hr` auf `true` gestellt, so wird `format` automatisch auf `"%r"` gesetzt. Ansonsten ist der Standardwert hierfür `"%T"` . Wird hingegen `format` gesetzt, so überschreibt dies die Einstellung `use_12hr` .
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
format = "🕙[ %T ]"
2019-10-11 08:31:19 +00:00
utc_time_offset = -5
2019-10-04 08:57:43 +00:00
```
2019-10-21 14:42:08 +00:00
## Benutzername
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
Das Modul `username` zeigt den Benutzernamen des aktiven Benutzers. Das Modul wird nur dann angezeigt, wenn eine der folgenden Bedingungen zutrifft:
2019-10-04 08:57:43 +00:00
2019-10-21 14:42:08 +00:00
- Der aktuelle Benutzer ist root
- Der aktuelle Benutzer ist nicht derjenige, der derzeit angemeldet ist
- Der Benutzer ist über eine SSH-Sitzung verbunden
- Die Variale `show_always` ist auf `true` gesetzt
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
2019-10-21 14:42:08 +00:00
| Variable | Standardwert | Beschreibung |
| ------------- | --------------- | --------------------------------- |
| `style_root` | `"bold red"` | Stil beim root-Benutzer. |
| `style_user` | `"bold yellow"` | Stil bei allen anderen Benutzern. |
| `show_always` | `false` | `username` -Modul immer anzeigen. |
| `disabled` | `false` | Deaktiviert das `username` -Modul. |
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]
disabled = true
```