Llewellyn/starship
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/starship.git synced 2024-12-01 01:04:00 +00:00
Code Issues Releases Activity

docs(i18n): new Crowdin updates (#1705)

Browse Source
This commit is contained in:
Matan Kushner 2020-09-30 21:23:36 -04:00 committed by GitHub
parent c02b335ee3
commit 15c04e7d18
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
18 changed files with 1887 additions and 1885 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

424
docs/de-DE/config/README.md
View File

@ -1,12 +1,12 @@
# Konfiguration
To get started configuring starship, create the following file: `~/.config/starship.toml`.
Um mit der Konfiguration von Starship zu beginnen, musst du die folgende Datei erstellen: `~/.config/starship.toml`.
```sh
mkdir -p ~/.config && touch ~/.config/starship.toml
```
All configuration for starship is done in this [TOML](https://github.com/toml-lang/toml) file:
Die gesamte Konfiguration von Starship wird über diese [TOML](https://github.com/toml-lang/toml)-Datei durchgeführt:
```toml
# Don't print a new line at the start of the prompt
@ -21,7 +21,7 @@ success_symbol = "[➜](bold green)" # The "success_symbol" segment is being
disabled = true
```
You can change default `starship.toml` file location with `STARSHIP_CONFIG` environment variable:
Sie können den Pfad zur `starship.toml` mit der `STARSHIP_CONFIG` Umgebungsvariable ändern:
```sh
export STARSHIP_CONFIG=~/.starship
@ -47,9 +47,9 @@ Equivalently in PowerShell (Windows) would be adding this line to your `$PROFILE
$ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp"
```
### Terminology
### Terminologie
**Module**: A component in the prompt giving information based on contextual information from your OS. For example, the "nodejs" module shows the version of NodeJS that is currently installed on your computer, if your current directory is a NodeJS project.
**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.
**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.
@ -85,7 +85,7 @@ For example:
#### Style-Strings
Most modules in starship allow you to configure their display styles. This is done with an entry (usually called `style`) which is a string specifying the configuration. Here are some examples of style strings along with what they do. For details on the full syntax, consult the [advanced config guide](/advanced-config/).
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/).
- `"fg:green bg:blue"` setzt grünen Text auf blauen Hintergrund
- `"bg:blue fg:bright-green"` setzt hell-grünen Text auf blauen Hintergrund
@ -94,7 +94,7 @@ Most modules in starship allow you to configure their display styles. This is do
- `"bold italic fg:purple"` setzt dicke lila Kursivschrift
- `""` deaktiviert explizit jeden Stil
Note that what styling looks like will be controlled by your terminal emulator. For example, some terminal emulators will brighten the colors instead of bolding text, and some color themes use the same values for the normal and bright colors. Also, to get italic text, your terminal must support italics.
Wie genau sich diese Konfiguration auswirkt liegt an deinem Terminal-Emulator. Einige Emulatoren zum Beispiel werden die Farben erhellen statt Text dick zu machen, und ein paar Farbthemen benutzen dieselben Werte für normale und helle Farben. Für kursiven Text muss dein Terminal Kursivschrift unterstützen.
#### Conditional Format Strings
@ -138,15 +138,15 @@ format = '''
## Prompt
This is the list of prompt-wide configuration options.
Dies ist eine Liste mit Prompt-weiten Konfigurationsoptionen.
### Optionen
| Option | Standardwert | Beschreibung |
| -------------- | ------------------------------ | ----------------------------------------------------- |
| `format` | [link](#default-prompt-format) | Configure the format of the prompt. |
| `scan_timeout` | `30` | Timeout for starship to scan files (in milliseconds). |
| `add_newline` | `true` | Add a new line before the start of the prompt. |
| 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. |
### Beispiel
@ -168,7 +168,7 @@ add_newline = false
### Default Prompt Format
The default `format` is used to define the format of the prompt, if empty or no `format` is provided. The default is as shown:
The default `format` is used to define the format of the prompt, if empty or no `format` is provided. Die Standardwerte sind folgende:
```toml
format = "$all"
@ -228,7 +228,7 @@ $character"""
## AWS
The `aws` module shows the current AWS region and profile. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file.
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.
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var.
@ -296,7 +296,7 @@ symbol = "🅰 "
## Akkustand
The `battery` module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%.
Das `battery` Modul zeigt, wie hoch der Akku des Geräts geladen ist und den aktuellen Ladestatus. Das Modul ist nur sichtbar, wenn der Akku des Geräts unter 10% geladen ist.
### Optionen
@ -310,7 +310,7 @@ The `battery` module shows how charged the device's battery is and its current c
| `disabled` | `false` | Wenn der Wert auf `true` steht, wird das Akkustand-Modul deaktiviert. |
<details>
<summary>There are also options for some uncommon battery states.</summary>
<summary>Das Batterie-Modul unterstützt auch einige untypische Zustände.</summary>
| Variable | Beschreibung |
| ---------------- | --------------------------------------------------- |
@ -332,9 +332,9 @@ charging_symbol = "⚡️"
discharging_symbol = "💀"
```
### Battery Display
### Anzeige des Akkustandes
The `display` configuration option is used to define when the battery indicator should be shown (threshold) and what it looks like (style). If no `display` is provided. The default is as shown:
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:
```toml
[[battery.display]]
@ -344,7 +344,7 @@ style = "bold red"
#### Optionen
The `display` option is an array of the following table.
Die `display`-Option beinhaltet ein Array mit den folgenden Werten.
| Variable | Beschreibung |
| ----------- | ------------------------------------------------------- |
@ -354,23 +354,23 @@ The `display` option is an array of the following table.
#### Beispiel
```toml
[[battery.display]] # "bold red" style when capacity is between 0% and 10%
[[battery.display]] # "bold red" bei Akkustand zwischen 0–10%
threshold = 10
style = "bold red"
[[battery.display]] # "bold yellow" style when capacity is between 10% and 30%
[[battery.display]] # "bold yellow" bei Akkustand zwischen 10–30%
threshold = 30
style = "bold yellow"
# when capacity is over 30%, the battery indicator will not be displayed
# Bei Akkustand über 30% wird der Akkustand nicht angezeigt
```
## Zeichen
The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal.
Das `character` Modul zeigt ein Zeichen ( meistens einen Pfeil "❯") vor der Texteingabe an.
The character will tell you whether the last command was successful or not. It can do this in two ways:
Das Zeichen zeigt an ob der letzte Befehl erfolgreich war, oder einen Fehler erzeugt hat. It can do this in two ways:
- changing color (`red`/`green`)
- changing shape (`❯`/`✖`)
@ -451,15 +451,15 @@ The `cmake` module shows the currently installed version of CMake if:
## Befehlsdauer
The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists.
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.
::: warning Do not hook the DEBUG trap in Bash
::: warning Nicht die DEBUG-trap in der Bash hooken
If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break.
Ist `bash` die Konsole der Wahl, dann nicht die `DEBUG`-trap nach der Ausführung von `eval $(starship init $0)` hooken, andernfalls **wird** dieses Modul unweigerlich untergehen.
:::
Bash 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.
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.
### Optionen
@ -492,11 +492,11 @@ format = "underwent [$duration](bold yellow)"
## Conda
The `conda` module shows the current conda environment, if `$CONDA_DEFAULT_ENV` is set.
Das `conda`-Modul zeigt dessen aktuelle Umgebung an, sofern `$CONDA_DEFAULT_ENV` gesetzt ist.
::: tip
::: Tipp
This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`.
Hinweis: Dies unterdrückt nicht conda's eigenen Prompt-Modifikator, sie können jedoch conda mit `conda config --set changeps1 False` konfigurieren, um die Ausgabe von conda selbst auszuschalten.
:::
@ -509,7 +509,7 @@ This does not suppress conda's own prompt modifier, you may want to run `conda c
| `style` | `"bold green"` | Stil für dieses Modul. |
| `format` | `"[$symbol$environment]($style) "` | The format for the module. |
| `ignore_base` | `true` | Ignores `base` environment when activated. |
| `disabled` | `false` | Disables the `conda` module. |
| `disabled` | `false` | Deaktiviert das `conda`-Modul. |
### Variables
@ -601,9 +601,9 @@ The `dart` module shows the currently installed version of Dart. Das Modul wird
format = "via [🔰 $version](bold red) "
```
## Directory
## Verzeichnis
The `directory` module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in.
Das `directory` -Modul zeigt den Pfad zu Ihrem aktuellen Verzeichnis an, abgeschnitten auf drei übergeordnete Ordner. Your directory will also be truncated to the root of the git repo that you're currently in.
When using the fish style pwd option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option.
@ -611,18 +611,18 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
### Optionen
| Variable | Standardwert | Beschreibung |
| ------------------------ | ----------------------------------------------- | -------------------------------------------------------------------------------- |
| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. |
| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. |
| `format` | `"[$path]($style)[$lock_symbol]($lock_style) "` | The format for the module. |
| `style` | `"bold cyan"` | Stil für dieses Modul. |
| `disabled` | `false` | Disables the `directory` module. |
| `read_only_symbol` | `"🔒"` | The symbol indicating current directory is read only. |
| `read_only_symbol_style` | `"red"` | The style for the read only symbol. |
| Variable | Standardwert | Beschreibung |
| ------------------- | -------------------------------------------------- | -------------------------------------------------------------------------------- |
| `truncation_length` | `3` | Die Anzahl der übergeordneten Ordner, die angezeigt werden. |
| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. |
| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | The format for the module. |
| `style` | `"bold cyan"` | Stil für dieses Modul. |
| `disabled` | `false` | Deaktiviert das `directory`-Modul. |
| `read_only` | `"🔒"` | The symbol indicating current directory is read only. |
| `read_only_style` | `"red"` | The style for the read only symbol. |
<details>
<summary>This module has a few advanced configuration options that control how the directory is displayed.</summary>
<summary>Dieses Modul hat einige erweiterte Konfigurationsoptionen, welche die Darstellung von Verzeichnissen steuern.</summary>
| Advanced Option | Standardwert | Beschreibung |
| --------------------------- | ------------ | ---------------------------------------------------------------------------------------- |
@ -717,13 +717,13 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
### Optionen
| Option | Standardwert | Beschreibung |
| ----------- | ---------------------------------------- | -------------------------------------------------------- |
| `format` | `"v[$symbol$version( 🎯 $tfm)]($style) "` | The format for the module. |
| `symbol` | `"•NET "` | The symbol used before displaying the version of dotnet. |
| `heuristic` | `true` | Use faster version detection to keep starship snappy. |
| `style` | `"bold blue"` | Stil für dieses Modul. |
| `disabled` | `false` | Disables the `dotnet` module. |
| 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. |
### Variables
@ -751,7 +751,7 @@ heuristic = false
The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist:
- The current directory contains a `mix.exs` file.
- Das aktuelle Verzeichnis enthält eine `mix.exs`-Datei.
### Optionen
@ -786,8 +786,8 @@ symbol = "🔮 "
The `elm` module shows the currently installed version of Elm. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist:
- The current directory contains a `elm.json` file
- The current directory contains a `elm-package.json` file
- Das aktuelle Verzeichnis enthält eine `elm.json`-Datei
- Das aktuelle Verzeichnis enthält eine `elm-package.json`-Datei
- The current directory contains a `.elm-version` file
- The current directory contains a `elm-stuff` folder
- The current directory contains a `*.elm` files
@ -820,7 +820,7 @@ The `elm` module shows the currently installed version of Elm. Das Modul wird ge
format = "via [ $version](cyan bold) "
```
## Environment Variable
## Umgebungsvariablen
The `env_var` module displays the current value of a selected environment variable. The module will be shown only if any of the following conditions are met:
@ -829,13 +829,13 @@ The `env_var` module displays the current value of a selected environment variab
### Optionen
| Option | Standardwert | Beschreibung |
| ---------- | ------------------------------ | ---------------------------------------------------------------------------- |
| `symbol` | | The symbol used before displaying the variable value. |
| `variable` | | The environment variable to be displayed. |
| `default` | | The default value to be displayed when the selected variable is not defined. |
| `format` | `"with [$env_value]($style) "` | The format for the module. |
| `disabled` | `false` | Disables the `env_var` module. |
| Option | Standardwert | Beschreibung |
| ---------- | ------------------------------ | ---------------------------------------------------------------------------------------- |
| `symbol` | | Das Symbol, das vor der Anzeige der Variable verwendet wird. |
| `variable` | | Die anzuzeigende Umgebungsvariable. |
| `default` | | Der Standardwert, der angezeigt wird, wenn die ausgewählte Variable nicht definiert ist. |
| `format` | `"with [$env_value]($style) "` | The format for the module. |
| `disabled` | `false` | Deaktiviert das `env_var`-Modul. |
### Variables
@ -861,8 +861,8 @@ default = "unknown shell"
The `erlang` module shows the currently installed version of Erlang/OTP. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist:
- The current directory contains a `rebar.config` file.
- The current directory contains a `erlang.mk` file.
- Das aktuelle Verzeichnis enthält eine `rebar.config`-Datei.
- Das aktuelle Verzeichnis enthält eine `erlang.mk`-Datei.
### Optionen
@ -952,9 +952,9 @@ us-central1 = "uc1"
asia-northeast1 = "an1"
```
## Git Branch
## Git-Branch
The `git_branch` module shows the active branch of the repo in your current directory.
Das `git_branch`-Modul zeigt den aktiven Git-Branch des Repositories im aktuellen Verzeichnis an.
### Optionen
@ -965,7 +965,7 @@ The `git_branch` module shows the active branch of the repo in your current dire
| `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. |
| `disabled` | `false` | Disables the `git_branch` module. |
| `disabled` | `false` | Deaktiviert das `git_branch`-Modul. |
### Variables
@ -1020,7 +1020,7 @@ The `git_commit` module shows the current commit hash of the repo in your curren
commit_hash_length = 4
```
## Git State
## Git-Zustand
The `git_state` module will show in directories which are part of a git repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. If there is progress information (e.g., REBASING 3/10), that information will be shown too.
@ -1037,7 +1037,7 @@ The `git_state` module will show in directories which are part of a git reposito
| `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` | Disables the `git_state` module. |
| `disabled` | `false` | Deaktiviert das `git_state`-Modul. |
### Variables
@ -1060,7 +1060,7 @@ format = "[\\($state( $progress_current of $progress_total)\\)]($style) "
cherry_pick = "[🍒 PICKING](bold red)"
```
## Git Status
## Git-Status
The `git_status` module shows symbols representing the state of the repo in your current directory.
@ -1080,7 +1080,7 @@ The `git_status` module shows symbols representing the state of the repo in your
| `renamed` | `"»"` | The format of `renamed` |
| `deleted` | `"✘"` | The format of `deleted` |
| `style` | `"bold red"` | Stil für dieses Modul. |
| `disabled` | `false` | Disables the `git_status` module. |
| `disabled` | `false` | Deaktiviert das `git_status`-Modul. |
### Variables
@ -1133,6 +1133,7 @@ deleted = "🗑"
```
Show ahead/behind count of the branch being tracked
```toml
# ~/.config/starship.toml
@ -1144,16 +1145,16 @@ behind = "⇣${count}"
## Golang
The `golang` module shows the currently installed version of Golang. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist:
Das `golang`-Modul zeigt die aktuell installierte Version von Golang. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist:
- The current directory contains a `go.mod` file
- The current directory contains a `go.sum` file
- The current directory contains a `glide.yaml` file
- The current directory contains a `Gopkg.yml` file
- The current directory contains a `Gopkg.lock` file
- Das aktuelle Verzeichnis enthält eine `go.mod`-Datei
- Das aktuelle Verzeichnis enthält eine `go.sum`-Datei
- Das aktuelle Verzeichnis enthält eine `glide.yaml`-Datei
- Das aktuelle Verzeichnis enthält eine `Gopkg.yml`-Datei
- Das aktuelle Verzeichnis enthält eine `Gopkg.lock`-Datei
- The current directory contains a `.go-version` file
- The current directory contains a `Godeps` directory
- The current directory contains a file with the `.go` extension
- Das aktuelle Verzeichnis enthält ein `Godeps`-Verzeichnis
- Das aktuelle Verzeichnis enthält eine Datei mit der `.go`-Erweiterung
### Optionen
@ -1162,7 +1163,7 @@ The `golang` module shows the currently installed version of Golang. Das Modul w
| `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. |
| `disabled` | `false` | Disables the `golang` module. |
| `disabled` | `false` | Deaktiviert das `golang`-Modul. |
### Variables
@ -1187,7 +1188,7 @@ format = "via [🏎💨 $version](bold cyan) "
The `helm` module shows the currently installed version of Helm. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist:
- The current directory contains a `helmfile.yaml` file
- Das aktuelle Verzeichnis enthält eine `helmfile.yaml`-Datei
- The current directory contains a `Chart.yaml` file
### Optionen
@ -1220,17 +1221,17 @@ format = "via [⎈ $version](bold white) "
## Hostname
The `hostname` module shows the system hostname.
Das `hostname`-Modul zeigt den Hostnamen des Systems an.
### Optionen
| Option | Standartwert | Beschreibung |
| ---------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `ssh_only` | `true` | Only show hostname when connected to an SSH session. |
| `ssh_only` | `true` | Zeigt den Hostnamen nur, wenn via SSH-Sitzung verbunden. |
| `trim_at` | `"."` | String that the hostname is cut off at, after the first match. `"."` will stop after the first dot. `""` will disable any truncation |
| `format` | `"[$hostname]($style) in "` | The format for the module. |
| `style` | `"bold dimmed green"` | Stil für dieses Modul. |
| `disabled` | `false` | Disables the `hostname` module. |
| `disabled` | `false` | Deaktiviert das `hostname`-Modul. |
### Variables
@ -1255,7 +1256,7 @@ disabled = false
## Java
The `java` module shows the currently installed version of Java. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist:
Das `java` Modul zeigt die derzeit installierte Version von Java an. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist:
- The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt` or `.java-version` file
- The current directory contains a file with the `.java`, `.class`, `.gradle` or `.jar` extension
@ -1267,7 +1268,7 @@ The `java` module shows the currently installed version of Java. Das Modul wird
| `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. |
| `disabled` | `false` | Disables the `java` module. |
| `disabled` | `false` | Deaktiviert das `Java`-Modul. |
### Variables
@ -1294,13 +1295,13 @@ The `jobs` module shows the current number of jobs running. The module will be s
### Optionen
| Option | Standartwert | Beschreibung |
| ----------- | ----------------------------- | ------------------------------------------------ |
| `threshold` | `1` | Show number of jobs if exceeded. |
| `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` | Disables the `jobs` module. |
| 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. |
### Variables
@ -1362,9 +1363,9 @@ symbol = "∴ "
Displays the current Kubernetes context name and, if set, the namespace from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via `kubectl config set-context starship-cluster --namespace astronaut`. If the `$KUBECONFIG` env var is set the module will use that if not it will use the `~/.kube/config`.
::: tip
::: Tipp
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren.
:::
@ -1377,7 +1378,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| `style` | `"cyan bold"` | Stil für dieses Modul. |
| `namespace_spaceholder` | `none` | The value to display if no namespace was found. |
| `context_aliases` | | Table of context aliases to display. |
| `disabled` | `true` | Disables the `kubernetes` module. |
| `disabled` | `true` | Deaktiviert das `kubernetes`-Modul. |
### Variables
@ -1402,15 +1403,15 @@ disabled = false
"dev.local.cluster.k8s" = "dev"
```
## Line Break
## Zeilenumbruch
The `line_break` module separates the prompt into two lines.
Das `line_break`-Modul unterteilt den Prompt in zwei Zeilen.
### Optionen
| Option | Standardwert | Beschreibung |
| ---------- | ------------ | ------------------------------------------------------------------ |
| `disabled` | `false` | Disables the `line_break` module, making the prompt a single line. |
| Option | Standardwert | Beschreibung |
| ---------- | ------------ | ---------------------------------------------------------------------- |
| `disabled` | `false` | Deaktiviert das `line_break`-Modul, wodurch der Prompt einzeilig wird. |
### Beispiel
@ -1421,27 +1422,27 @@ The `line_break` module separates the prompt into two lines.
disabled = true
```
## Memory Usage
## Speicherauslastung
The `memory_usage` module shows current system memory and swap usage.
Das `memory_usage` Modul zeigt den aktuellen Systemspeicher und die swap-Nutzung an.
By default the swap usage is displayed if the total system swap is non-zero.
Standardmäßig wird die swap-Nutzung angezeigt, wenn der gesamte System-swap nicht Null ist.
::: tip
::: Tipp
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren.
:::
### Optionen
| 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. |
| Option | Standartwert | Beschreibung |
| ----------- | --------------------------------------------- | --------------------------------------------------------------------- |
| `threshold` | `75` | Speicherauslastung ausblenden, wenn sie unter diesem Prozentsatz ist. |
| `format` | `"via $symbol [${ram}( | ${swap})]($style) "` | The format for the module. |
| `symbol` | `"🐏"` | Symbol das vor der Speicherauslastung angezeigt wird. |
| `style` | `"bold dimmed white"` | Stil für dieses Modul. |
| `disabled` | `true` | Deaktiviert das `memory_usage`-Modul. |
### Variables
@ -1511,7 +1512,7 @@ truncation_symbol = ""
The `nim` module shows the currently installed version of Nim. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist:
- The current directory contains a `nim.cfg` file
- Das aktuelle Verzeichnis enthält eine `nim.cfg`-Datei
- The current directory contains a file with the `.nim` extension
- The current directory contains a file with the `.nims` extension
- The current directory contains a file with the `.nimble` extension
@ -1545,9 +1546,9 @@ style = "yellow"
symbol = "🎣 "
```
## Nix-shell
## Nix-Shell
The `nix_shell` module shows the nix-shell environment. The module will be shown when inside a nix-shell environment.
Das `nix_shell`-Modul zeigt die nix-shell Umgebung an. Das Modul wird angezeigt, wenn es sich in einer nix-Shell-Umgebung befindet.
### Optionen
@ -1558,7 +1559,7 @@ The `nix_shell` module shows the nix-shell environment. The module will be shown
| `style` | `"bold blue"` | Stil für dieses Modul. |
| `impure_msg` | `"impure"` | A format string shown when the shell is impure. |
| `pure_msg` | `"pure"` | A format string shown when the shell is pure. |
| `disabled` | `false` | Disables the `nix_shell` module. |
| `disabled` | `false` | Deaktiviert das `nix_shell`-Modul. |
### Variables
@ -1585,11 +1586,11 @@ format = "via [☃️ $state( \\($name\\))](bold blue) "
## NodeJS
The `nodejs` module shows the currently installed version of NodeJS. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist:
Das `nodejs`-Modul zeigt die aktuell installierte Version von NodeJS. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist:
- The current directory contains a `package.json` file
- Das aktuelle Verzeichnis enthält eine `package.json`-Datei
- The current directory contains a `.node-version` file
- The current directory contains a `node_modules` directory
- Das aktuelle Verzeichnis enthält ein `node_modules`-Verzeichnis
- The current directory contains a file with the `.js`, `.mjs` or `.cjs` extension
- The current directory contains a file with the `.ts` extension
@ -1600,7 +1601,7 @@ The `nodejs` module shows the currently installed version of NodeJS. Das Modul w
| `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. |
| `disabled` | `false` | Disables the `nodejs` module. |
| `disabled` | `false` | Deaktiviert das `nodejs`-Modul. |
###  Variables
@ -1621,13 +1622,13 @@ The `nodejs` module shows the currently installed version of NodeJS. Das Modul w
format = "via [🤖 $version](bold green) "
```
## Package Version
## Paketversion
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.
Das `Package` Modul wird angezeigt, wenn das aktuelle Verzeichnis das Repository für ein Paket ist, und zeigt dessen aktuelle Version an. The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages.
- **npm** – The `npm` package version is extracted from the `package.json` present in the current directory
- **cargo** – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
- **poetry** – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
- **npm** – Die `npm` Paketversion wird aus dem `package.json` gelesen, das sich im aktuellen Verzeichnis befindet
- **Cargo** – Die `Cargo` Paketversion wird aus dem `Cargo.toml` gelesen, das sich im aktuellen Verzeichnis befindet
- **poetry** – Die `poetry` Paketversion wird aus der `pyproject.toml` gelesen, das sich im aktuellen Verzeichnis befindet
- **composer** – The `composer` package version is extracted from the `composer.json` present in the current directory
- **gradle** – The `gradle` package version is extracted from the `build.gradle` present
- **julia** - The package version is extracted from the `Project.toml` present
@ -1639,13 +1640,13 @@ The `package` module is shown when the current directory is the repository for a
### Optionen
| Option | Standartwert | 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. |
| Option | Standartwert | Beschreibung |
| ----------------- | ---------------------------------- | --------------------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"📦 "` | Symbol das vor der Paketversion angezeigt wird. |
| `style` | `"bold 208"` | Stil für dieses Modul. |
| `display_private` | `false` | Enable displaying version for packages marked as private. |
| `disabled` | `false` | Deaktiviert das `package`-Modul. |
### Variables
@ -1743,20 +1744,20 @@ format = "via [🦪 $version]($style) "
## PHP
The `php` module shows the currently installed version of PHP. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist:
Das `php`-Modul zeigt die aktuell installierte Version von PHP. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist:
- The current directory contains a `composer.json` file
- Das aktuelle Verzeichnis enthält eine `composer.json`-Datei
- The current directory contains a `.php-version` file
- The current directory contains a `.php` file
- Das aktuelle Verzeichnis enthält eine `.php`-Datei
### Optionen
| 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. |
| Option | Standardwert | Beschreibung |
| ---------- | ---------------------------------- | ---------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"🐘 "` | Symbol das vor der PHP-Version angezeigt wird. |
| `style` | `"147 bold"` | Stil für dieses Modul. |
| `disabled` | `false` | Deaktiviert das `php`-Modul. |
### Variables
@ -1785,15 +1786,15 @@ If `pyenv_version_name` is set to `true`, it will display the pyenv version name
Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist:
- The current directory contains a `.python-version` file
- The current directory contains a `requirements.txt` file
- The current directory contains a `pyproject.toml` file
- Das aktuelle Verzeichnis enthält eine `.python-version`-Datei
- Das aktuelle Verzeichnis enthält eine `requirements.txt`-Datei
- Das aktuelle Verzeichnis enthält eine `pyproject.toml`-Datei
- The current directory contains a file with the `.py` extension (and `scan_for_pyfiles` is true)
- The current directory contains a `Pipfile` file
- The current directory contains a `tox.ini` file
- The current directory contains a `setup.py` file
- Das aktuelle Verzeichnis enthält eine `Pipfile`-Datei
- Das aktuelle Verzeichnis enthält eine `tox.ini`-Datei
- Das aktuelle Verzeichnis enthält eine `setup.py`-Datei
- The current directory contains a `__init__.py` file
- A virtual environment is currently activated
- Ein virtualenv ist momentan aktiv
### Optionen
@ -1802,10 +1803,10 @@ Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist:
| `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. |
| `pyenv_version_name` | `false` | Use pyenv to get Python version |
| `pyenv_version_name` | `false` | Verwende `pyenv` um die Python-Versionzu beziehen. |
| `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used |
| `scan_for_pyfiles` | `true` | If false, Python files in the current directory will not show this module. |
| `disabled` | `false` | Disables the `python` module. |
| `disabled` | `false` | Deaktiviert das `python`-Modul. |
### Variables
@ -1847,11 +1848,11 @@ pyenv_version_name = true
## Ruby
The `ruby` module shows the currently installed version of Ruby. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist:
Das `ruby` Modul zeigt die derzeit installierte Version von Ruby an. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist:
- The current directory contains a `Gemfile` file
- Das aktuelle Verzeichnis enthält eine `Gemfile`-Datei
- The current directory contains a `.ruby-version` file
- The current directory contains a `.rb` file
- Das aktuelle Verzeichnis enthält eine `.rb`-Datei
### Optionen
@ -1860,7 +1861,7 @@ The `ruby` module shows the currently installed version of Ruby. Das Modul wird
| `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. |
| `disabled` | `false` | Disables the `ruby` module. |
| `disabled` | `false` | Deaktiviert das `ruby`-Modul. |
### Variables
@ -1883,10 +1884,10 @@ symbol = "🔺 "
## Rust
The `rust` module shows the currently installed version of Rust. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist:
Das `rust` Modul zeigt die derzeit installierte Version von Rust an. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist:
- The current directory contains a `Cargo.toml` file
- The current directory contains a file with the `.rs` extension
- Das aktuelle Verzeichnis enthält eine `Cargo.toml`-Datei
- Das aktuelle Verzeichnis enthält eine Datei mit der `.rs`-Erweiterung
### Optionen
@ -1895,7 +1896,7 @@ The `rust` module shows the currently installed version of Rust. Das Modul wird
| `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. |
| `disabled` | `false` | Disables the `rust` module. |
| `disabled` | `false` | Deaktiviert das `rust`-Modul. |
### Variables
@ -2022,9 +2023,9 @@ format = "via [🏎 $version](red bold)"
The `status` module displays the exit code of the previous command. The module will be shown only if the exit code is not `0`.
::: tip
::: Tipp
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. :::
Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. :::
### Optionen
@ -2035,7 +2036,6 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| `style` | `"bold red"` | Stil für dieses Modul. |
| `disabled` | `true` | Disables the `status` module. |
### Variables
| Variable | Beispiel | Beschreibung |
@ -2046,8 +2046,8 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
\*: This variable can only be used as a part of a style string
### Beispiel
```toml
# ~/.config/starship.toml
@ -2062,10 +2062,10 @@ disabled = false
## Terraform
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). Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist:
Das `Terraform` Modul zeigt den aktuell ausgewählten terraform Arbeitsbereich und die Version an. Standardmäßig wird die Terraform-Version nicht angezeigt, da dies bei aktuellen Versionen von Terraform langsam ist, wenn viele Plugins verwendet werden. If you still want to enable it, [follow the example shown below](#with-version). Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist:
- The current directory contains a `.terraform` folder
- Current directory contains a file with the `.tf` extension
- Das aktuelle Verzeichnis enthält eine `.terraform`-Datei
- Das aktuelle Verzeichnis enthält eine Datei mit der `.tf`-Erweiterung
### Optionen
@ -2074,7 +2074,7 @@ The `terraform` module shows the currently selected terraform workspace and vers
| `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. |
| `disabled` | `false` | Disables the `terraform` module. |
| `disabled` | `false` | Deaktiviert das `terraform` Modul. |
### Variables
@ -2107,35 +2107,35 @@ format = "[🏎💨 $version$workspace]($style) "
format = "[🏎💨 $workspace]($style) "
```
## Time
## Zeit
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.
Das `time` Modul zeigt die aktuelle **lokale** Zeit an. Der `format` Wert wird von der crate [`chrono`](https://crates.io/crates/chrono) benutzt um die Zeit zu formatieren. Schau dir [die chrono strftime Dokumentation](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) an, um die möglichen Optionen zu sehen.
::: tip
::: Tipp
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren.
:::
### Optionen
| Option | Standardwert | Beschreibung |
| ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `format` | `"at [$time]($style) "` | The format string for the module. |
| `use_12hr` | `false` | 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 &lt; x &lt; 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 |
| Option | Standardwert | Beschreibung |
| ----------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `format` | `"at [$time]($style) "` | The format string for the module. |
| `use_12hr` | `false` | Aktiviert 12-Stunden-Format |
| `time_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 |
| `utc_time_offset` | `"local"` | Verwendetes Zeitzonen-Offset. Range from -24 &lt; x &lt; 24. Allows floats to accommodate 30/45 minute timezone offsets. |
| `disabled` | `true` | Deaktiviert das `time`-Modul. |
| `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format |
If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Otherwise, it defaults to `"%T"`. Manually setting `time_format` will override the `use_12hr` setting.
If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Andernfalls ist es standardmäßig `"%T"`. Manually setting `time_format` will override the `use_12hr` setting.
### Variables
| Variable | Beispiel | Beschreibung |
| --------- | ---------- | ----------------------------------- |
| time | `13:08:10` | The current time. |
| zeit | `13:08:10` | The current time. |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
@ -2155,22 +2155,22 @@ time_range = "10:00:00-14:00:00"
## Username
The `username` module shows active user's username. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist:
Das `username` Modul zeigt den Namen des aktiven Benutzers. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist:
- 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
- Der aktuelle Benutzer ist root
- Der aktuelle Benutzer ist nicht der eingeloggte Benutzer
- Der Benutzer ist aktuell via SSH verbunden
- Die Variable `show_always` ist auf true gesetzt
### Optionen
| Option | Standardwert | Beschreibung |
| ------------- | ----------------------- | ------------------------------------- |
| `style_root` | `"bold red"` | The style used when the user is root. |
| `style_user` | `"bold yellow"` | The style used for non-root users. |
| `format` | `"[$user]($style) in "` | The format for the module. |
| `show_always` | `false` | Always shows the `username` module. |
| `disabled` | `false` | Disables the `username` module. |
| Option | Standardwert | Beschreibung |
| ------------- | ----------------------- | ---------------------------------------------- |
| `style_root` | `"bold red"` | Stil wenn der Benutzer unter root läuft. |
| `style_user` | `"bold yellow"` | Stil wenn der Benutzer nicht unter root läuft. |
| `format` | `"[$user]($style) in "` | The format for the module. |
| `show_always` | `false` | Immer das `username` Modul anzeigen. |
| `disabled` | `false` | Deavktiviert das `username` Modul. |
### Variables
@ -2237,19 +2237,19 @@ These modules will be shown if any of the following conditions are met:
- The current directory contains a file whose extension is in `extensions`
- The `when` command returns 0
::: tip
::: Tipp
Multiple custom modules can be defined by using a `.`.
:::
::: tip
::: Tipp
The order in which custom modules are shown can be individually set by including `${custom.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `custom` module will simply show all custom modules in the order they were defined.
:::
::: tip
::: Tipp
[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!
@ -2257,19 +2257,19 @@ The order in which custom modules are shown can be individually set by including
### Optionen
| Option | Standardwert | Beschreibung |
| ------------- | ----------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| `command` | | The command whose output should be printed. The command will be passed on stdin to the shell. |
| `when` | | A shell command used as a condition to show the module. The module will be shown if the command returns a `0` status code. |
| `shell` | | [See below](#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. |
| 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) |
| `beschreibung` | `"<custom module>"` | The description of the module that is shown when running `starship explain`. |
| `files` | `[]` | The files that will be searched in the working directory for a match. |
| `directories` | `[]` | The directories that will be searched in the working directory for a match. |
| `extensions` | `[]` | The extensions that will be searched in the working directory for a match. |
| `symbol` | `""` | The symbol used before displaying the command output. |
| `style` | `"bold green"` | Stil für dieses Modul. |
| `format` | `"[$symbol$output]($style) "` | The format for the module. |
| `disabled` | `false` | Disables this `custom` module. |
### Variables
@ -2331,7 +2331,7 @@ shell = ["pwsh.exe", "-NoProfile", "-Command", "-"]
The `purescript` module shows the currently installed version of PureScript version. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist:
- The current directory contains a `spago.dhall` file
- Das aktuelle Verzeichnis enthält eine `spago.dhall`-Datei
- The current directory contains a \*.purs files
### Optionen

10
docs/de-DE/migrating-to-0.45.0/README.md
View File

@ -123,7 +123,7 @@ error_symbol = "[✖](bold red) "
++ format = "took [$duration]($style)"
```
#### Directory
#### Verzeichnis
| Removed Property | Replacement |
| ---------------- | ----------- |
@ -134,10 +134,10 @@ error_symbol = "[✖](bold red) "
```diff
[directory]
-- prefix = "in "
++ format = "[$path]($style)[$lock_symbol]($lock_style)"
++ format = "[$path]($style)[$read_only]($read_only_style)"
```
#### Environment Variable
#### Umgebungsvariablen
| Removed Property | Replacement |
| ---------------- | ----------- |
@ -169,7 +169,7 @@ error_symbol = "[✖](bold red) "
++ format = "[\\($hash\\)]($style) "
```
#### Git Status
#### Git-Status
| Removed Property | Replacement |
| ----------------- | ----------- |
@ -233,7 +233,7 @@ behind = "⇣${count}"
++ format = "[$symbol\\[$env\\]]($style) "
```
#### Time
#### Zeit
| Removed Property | Replacement |
| ---------------- | ------------- |

268
docs/es-ES/config/README.md
View File

@ -48,23 +48,23 @@ El equivalente en PowerShell (Windows) es añadir esta línea a tu `$PROFILE`:
$ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp"
```
### Terminology
### Terminología
**Module**: A component in the prompt giving information based on contextual information from your OS. For example, the "nodejs" module shows the version of NodeJS that is currently installed on your computer, if your current directory is a NodeJS project.
**Módulo**: un componente en el símbolo de sistema que provee de información basada en información contextual de tu sistema operativo. Por ejemplo, el módulo "nodejs" muestra la versión de NodeJS que tienes actualmente instalada en tu ordenador, si el directorio actual es un proyecto NodeJS.
**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.
**Variable**: subcomponentes más pequeños que contienen información proporcionada por el módulo. Por ejemplo, la variable "version" en el módulo "nodejs" contiene la versión actual de NodeJS.
By convention, most modules have a prefix of default terminal color (e.g. `via` in "nodejs") and an empty space as a suffix.
Por convención, la mayoría de los módulos tienen un prefijo del color predeterminado de la terminal (por ejemplo, `vía` en "nodejs") y un espacio vacío como sufijo.
### Format Strings
### Formato de cadenas de texto
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.
Es el formato con el que un módulo imprime todas sus variables. La mayoría de los módulos tienen una entrada llamada `format` que configura el formato de visualización del módulo. Se puede utilizar textos, variables y grupos de texto.
#### Variable
A variable contains a `$` symbol followed by the name of the variable. The name of a variable only contains letters, numbers and `_`.
Una variable contiene un símbolo `$` seguido por el nombre de la variable. El nombre de una variable solo contiene letras, números y `_`.
For example:
Por ejemplo:
- `$version` es un formato de cadena de texto con una variable llamada `version`.
- `$git_branch$git_commit` es un formato de cadena de texto con dos variables nombradas `git_branch` y `git_commit`.
@ -72,13 +72,13 @@ For example:
#### Grupo de texto
A text group is made up of two different parts.
Un grupo de texto se compone de dos partes diferentes.
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.
La primera parte, que está encerrada en un `[]`, es un [formato de cadena de texto](#format-strings). Se puede agregar textos, variables, o incluso grupos de texto anidados.
In the second part, which is enclosed in a `()`, is a [style string](#style-strings). This can be used style the first part.
En la segunda parte, que está encerrada en un `()`, es un [formato de cadena de texto](#style-strings). Se puede utilizar el estilo de la primera parte.
For example:
Por ejemplo:
- `[on](bold red)` imprimirá una cadena `en` con texto en negrita color rojo.
- `[⬢ $version](bold green)` imprimirá un símbolo `⬢` seguido por el contenido de la variable `version`, con texto en negrita color verde.
@ -86,7 +86,7 @@ For example:
#### Cadenas de estilo
Most modules in starship allow you to configure their display styles. This is done with an entry (usually called `style`) which is a string specifying the configuration. Here are some examples of style strings along with what they do. For details on the full syntax, consult the [advanced config guide](/advanced-config/).
La mayoría de los módulos de starship permiten configurar los estilos de su cadenas texto. Esto se consigue con una entrada (normalmente llamada `style` - estilo) que no es más que un texto donde se especifica la configuración. A continuación mostramos algunos ejemplos de textos estilados junto con su funcionalidad. Para más detalles sobre la sintaxis completa, consulta [la guía de configuración avanzada](/advanced-config/).
- `"fg:green bg:blue"` pone texto verde sobre un fondo azul
- `"bg:blue fg:bright-green"` pone texto verde claro sobre un fondo azul
@ -95,13 +95,13 @@ Most modules in starship allow you to configure their display styles. This is do
- `"bold italic fg:purple"` pone texto color morado, en negrita y cursiva
- `""` desactiva explícitamente cualquier estilo
Note that what styling looks like will be controlled by your terminal emulator. For example, some terminal emulators will brighten the colors instead of bolding text, and some color themes use the same values for the normal and bright colors. Also, to get italic text, your terminal must support italics.
Nótese que el estilo es similar a como se controlaría por el emulador de su terminal. Por ejemplo, algunos emuladores de terminal harán los colores más brillantes en lugar de más gruesos, y algunos temas usan los mismos valores para texto normal y colores brillantes. Además, para mostrar textos en cursiva tu terminal debe tener soporte para hacerlo.
#### Cadenas de formato condicionales
A conditional format string wrapped in `(` and `)` will not render if all variables inside are empty.
Una cadena de formato condicional envuelto en `(` y `)` no se renderizará si todas las variables dentro están vacías.
For example:
Por ejemplo:
- `(@$region)` no mostrará nada si la variable `region` es `None`, de lo contrario `@` seguido por el valor de la región.
- `(algún texto)` siempre mostrará nada ya que no hay variables envueltas entre llaves.
@ -109,7 +109,7 @@ For example:
#### Carácteres de escape
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 (`\`).
Los siguientes símbolos tienen un uso especial en una cadena de formato. Si se quiere imprimir los siguientes símbolos, se tienen que escapar con una barra invertida (`\`).
- \$
- \\
@ -118,20 +118,20 @@ The following symbols have special usage in a format string. If you want to prin
- (
- )
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 `\`.
Se debe tener en cuenta que `toml` tiene [su propia sintaxis de escape](https://github.com/toml-lang/toml#user-content-string). Se recomienda usar una cadena literal (`''`) en la configuración. Si se desea utilizar una cadena básica (`""`), prestar atención para escapar la barra inversa `\`.
For example, when you want to print a `$` symbol on a new line, the following configs for `format` are equivalent:
Por ejemplo, cuando se desea imprimir un símbolo `$` en una nueva línea, las siguientes configuraciones para el `format` son equivalentes:
```toml
# with basic string
# con cadena básica
format = "\n\\$"
# with multiline basic string
# con cadena básica multilínea
format = """
\\$"""
# with literal string
# con cadena literal
format = '''
\$'''
@ -139,7 +139,7 @@ format = '''
## Prompt
This is the list of prompt-wide configuration options.
Esta es la lista de opciones de configuración.
### Opciones
@ -154,22 +154,22 @@ This is the list of prompt-wide configuration options.
```toml
# ~/.config/starship.toml
# Use custom format
# Usar formato personalizado
format = """
[┌───────────────────>](bold green)
[│](bold green)$directory$rust$package
[└─>](bold green) """
# Wait 10 milliseconds for starship to check files under the current directory.
# Espera 10 milisegundos para que starship revise los archivos del directorio actual.
scan_timeout = 10
# Disable the newline at the start of the prompt
# Desactiva la nueva línea al inicio del prompt
add_newline = false
```
### Default Prompt Format
### Formato predeterminado del Prompt
The default `format` is used to define the format of the prompt, if empty or no `format` is provided. The default is as shown:
El `format` predeterminado se utiliza para definir el formato del prompt, si está vacío o no `format` se proporciona. El valor por defecto es el siguiente:
```toml
format = "$all"
@ -229,9 +229,9 @@ $character"""
## AWS
The `aws` module shows the current AWS region and profile. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file.
El módulo `aws` muestra la región actual de AWS y el perfil. Éste se basa en las variables de entorno `AWS_REGION`, `AWS_DEFAULT_REGION`, y `AWS_PROFILE` del fichero `~/.aws/config`.
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var.
Cuando uses [aws-vault](https://github.com/99designs/aws-vault) el perfil se obtiene de la variable de entorno `AWS_VAULT`.
### Opciones
@ -254,7 +254,7 @@ When using [aws-vault](https://github.com/99designs/aws-vault) the profile is re
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
### Examples
### Ejemplos
#### Mostrar todo
@ -297,7 +297,7 @@ symbol = "🅰 "
## Battery
The `battery` module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%.
El módulo `battery` muestra la cantidad de batería y si está cargando o no. El módulo es solo visible cuando la batería está por debajo del 10%.
### Opciones
@ -311,7 +311,7 @@ The `battery` module shows how charged the device's battery is and its current c
| `disabled` | `false` | Desactiva el módulo `battery`. |
<details>
<summary>There are also options for some uncommon battery states.</summary>
<summary>Hay otras opciones para algunos estados de la batería menos comunes.</summary>
| Variable | Descripción |
| ---------------- | --------------------------------------------------- |
@ -333,9 +333,9 @@ charging_symbol = "⚡️"
discharging_symbol = "💀"
```
### Battery Display
### Indicador de batería
The `display` configuration option is used to define when the battery indicator should be shown (threshold) and what it looks like (style). If no `display` is provided. The default is as shown:
La configuración de la opción `display` es usada para definir cuándo se debe mostrar el indicador de batería y cómo debe mostrarse. Si no se provee ningún valor para `display` El valor por defecto es el siguiente:
```toml
[[battery.display]]
@ -345,7 +345,7 @@ style = "bold red"
#### Opciones
The `display` option is an array of the following table.
La opción `display` es un array de la siguiente tabla.
| Variable | Descripción |
| ----------- | --------------------------------------------------------------- |
@ -355,28 +355,28 @@ The `display` option is an array of the following table.
#### Ejemplo
```toml
[[battery.display]] # "bold red" style when capacity is between 0% and 10%
[[battery.display]] # "bold red" cuando la carga está entre 0% y 10%
threshold = 10
style = "bold red"
[[battery.display]] # "bold yellow" style when capacity is between 10% and 30%
[[battery.display]] # "bold yellow" cuando la carga está entre 10% y 30%
threshold = 30
style = "bold yellow"
# when capacity is over 30%, the battery indicator will not be displayed
# cuando la carga está por encima del 30% el indicador no se mostrará
```
## Character
The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal.
El módulo `character` muestra un carater (normalmente una flecha) tras el texto que introduces en el terminal.
The character will tell you whether the last command was successful or not. It can do this in two ways:
El carácter te dirá si el último comando funcionó o no. Se puede hacer de dos maneras:
- cambiando el color (`red`/`green`)
- cambiando la forma (`.`/`✖`)
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).
Por defecto sólo cambia el color. Si también se quiere cambiar su forma, ver [este ejemplo](#with-custom-error-shape).
### Opciones
@ -394,7 +394,7 @@ By default it only changes color. If you also want to change it's shape take a l
| -------- | ------- | -------------------------------------------------------------- |
| symbol | | Un espejo de `success_symbol`, `error_symbol` o `vicmd_symbol` |
### Examples
### Ejemplos
#### Con forma de error personalizada
@ -427,7 +427,7 @@ vicmd_symbol = "[V](bold green) "
## CMake
The `cmake` module shows the currently installed version of CMake if:
El módulo `cmake` muestra la versión actualmente instalada de CMake si:
- El directorio actual contiene un archivo `CMakeLists.txt`
@ -452,15 +452,15 @@ The `cmake` module shows the currently installed version of CMake if:
## Tiempo de ejecución
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.
El módulo `cmd_duration` muestra cuánto tiempo tardó el último comando en ejecutarse. El módulo se mostrará solo si el comando llevó dos segundos o más, o el valor de `min_time`, si existe.
::: warning Do not hook the DEBUG trap in Bash
::: warning No utilizar DEBUG en Bash
If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break.
Si estás usando Starship con `bash`, no uses `DEBUG` después de ejecutar `eval $(starship init $0)`, o el módulo **se romperá**.
:::
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.
Los usuarios de bash que necesiten la funcionalidad preexec-like pueden usar el framework rcaloras's bash_preexec. Simplemente define los arrays preexec_functions y precmd_functions antes de ejecutar eval $(starship init $0), y continúa con normalidad. Basta con definir los arrays `preexec_functions` y `precmd_functions` antes de ejecutar `eval $(starship init $0)`, y luego proceder como siempre.
### Opciones
@ -493,11 +493,11 @@ format = "underwent [$duration](bold yellow)"
## Conda
The `conda` module shows the current conda environment, if `$CONDA_DEFAULT_ENV` is set.
El módulo `conda` muestra el actual entorno conda, si la variable `$CONDA_DEFAULT_ENV` existe.
::: tip
This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`.
Esto no modifica el propio símbolo de sistema de conda. En caso de querer suprimirlo, ejecuta `conda config --set changeps1 False`.
:::
@ -533,7 +533,7 @@ format = "[$symbol$environment](dimmed green) "
## Crystal
The `crystal` module shows the currently installed version of Crystal. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
El módulo `crystal` muestra la versión actual de Crystal. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
- El directorio actual contiene un fichero `shard.yml`
- El directorio actual contiene un fichero `.cr`
@ -568,7 +568,7 @@ format = "via [✨ $version](bold blue) "
## Dart
The `dart` module shows the currently installed version of Dart. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
El módulo `dart` muestra la versión actualmente instalada de Dart. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
- El directorio actual contiene un archivo con la extensión `.dart`
- El directorio actual contiene un directorio `.dart_tool`
@ -604,26 +604,26 @@ format = "via [🔰 $version](bold red) "
## Directory
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.
El módulo `directory` muestra la ruta hasta el directorio actual, mostrando tres directorios padre como máximo. Tu directorio se truncará a la raíz del repositorio git en el que estés.
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.
Cuando usas el estilo fish de la opción pwd, en lugar de ocultar la ruta truncada, verás una versión acortada del nombre de cada directorio basada en el número que activa la opción.
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`.
Por ejemplo, dado `~/Dev/Nix/nixpkgs/pkgs` donde `nixpkgs` es la raíz del repositorio y el valor de la opción es `1`. En ese caso, verás `~/D/N/nixpkgs/pkgs`, cuando antes hubiera sido `nixpkgs/pkgs`.
### Opciones
| Variable | Por defecto | Descripción |
| ------------------------ | ----------------------------------------------- | --------------------------------------------------------------------- |
| `truncation_length` | `3` | El número de carpetas a las que se debe truncar el directorio actual. |
| `truncate_to_repo` | `true` | Truncar o no hasta la raíz del repositorio git en el que se esté. |
| `format` | `"[$path]($style)[$lock_symbol]($lock_style) "` | El formato del módulo. |
| `style` | `"bold cyan"` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `directory`. |
| `read_only_symbol` | `"🔒"` | El símbolo que indica si el directorio actual es de sólo lectura. |
| `read_only_symbol_style` | `"red"` | El estilo para el símbolo de sólo lectura. |
| Variable | Por defecto | Descripción |
| ------------------- | -------------------------------------------------- | --------------------------------------------------------------------- |
| `truncation_length` | `3` | El número de carpetas a las que se debe truncar el directorio actual. |
| `truncate_to_repo` | `true` | Truncar o no hasta la raíz del repositorio git en el que se esté. |
| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | El formato del módulo. |
| `style` | `"bold cyan"` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `directory`. |
| `read_only` | `"🔒"` | El símbolo que indica si el directorio actual es de sólo lectura. |
| `read_only_style` | `"red"` | El estilo para el símbolo de sólo lectura. |
<details>
<summary>This module has a few advanced configuration options that control how the directory is displayed.</summary>
<summary>Este módulo tiene algunas opciones avanzadas de configuración que controlan cómo se muestra el directorio.</summary>
| Advanced Option | Por defecto | Descripción |
| --------------------------- | ----------- | ---------------------------------------------------------------------------------------- |
@ -663,7 +663,7 @@ truncation_length = 8
## 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`.
El módulo `docker_context` muestra el [Docker context](https://docs.docker.com/engine/context/working-with-contexts/) activo si no está a `default`.
### Opciones
@ -696,9 +696,9 @@ format = "via [🐋 $context](blue bold)"
## Dotnet
The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK.
El módulo `dotnet` muestra la versión usada de .NET Core SDK para el directorio actual. Si el SDK ha sido anclado en el directorio actual, se mostrará la versión fijada. De lo contrario, el módulo muestra la última versión instalada del SDK.
This module will only be shown in your prompt when one or more of the following files are present in the current directory:
Este módulo solo se mostrará en tu mensaje cuando uno o más de los siguientes archivos estén presentes en el directorio actual:
- `global.json`
- `project.json`
@ -710,11 +710,11 @@ This module will only be shown in your prompt when one or more of the following
- `*.fsproj`
- `*.xproj`
You'll also need the .NET Core SDK installed in order to use it correctly.
También necesitará tener instalado .NET Core SDK para poder usarlo correctamente.
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.
Internamente, este módulo utiliza su propio mecanismo para la detección de versiones. Normalmente es el doble de rápido que ejecutar `dotnet --version`, pero puede mostrar una versión incorrecta si tu proyecto .NET tiene un diseño de directorio inusual. Si la precisión es más importante que la velocidad, puede desactivar el mecanismo estableciendo `heuristic = false` en las opciones del módulo.
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.
El módulo también mostrará el Target Framework Moniker ([https://docs.microsoft. om/es/dotnet/standard/frameworks#supported-target-framework-versions](https://docs.microsoft.com/en-us/dotnet/standard/frameworks#supported-target-framework-versions)) cuando exista un archivo csproj en el directorio actual.
### Opciones
@ -750,7 +750,7 @@ heuristic = false
## Elixir
The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
El módulo `elixir` muestra la version instalada actualmente de Elixir y Erlang/OTP. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
- El directorio actual contiene un archivo `mix.exs`.
@ -787,8 +787,8 @@ symbol = "🔮 "
The `elm` module shows the currently installed version of Elm. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
- The current directory contains a `elm.json` file
- The current directory contains a `elm-package.json` file
- El directorio actual contiene un fichero `elm.json`
- El directorio actual contiene un fichero `elm-package.json`
- The current directory contains a `.elm-version` file
- The current directory contains a `elm-stuff` folder
- The current directory contains a `*.elm` files
@ -821,7 +821,7 @@ The `elm` module shows the currently installed version of Elm. El módulo se mue
format = "via [ $version](cyan bold) "
```
## Environment Variable
## Variable de entorno
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:
@ -830,13 +830,13 @@ The `env_var` module displays the current value of a selected environment variab
### Opciones
| Opción | Por defecto | Descripción |
| ---------- | ------------------------------ | ---------------------------------------------------------------------------- |
| `symbol` | | The symbol used before displaying the variable value. |
| `variable` | | The environment variable to be displayed. |
| `default` | | The default value to be displayed when the selected variable is not defined. |
| `format` | `"with [$env_value]($style) "` | El formato del módulo. |
| `disabled` | `false` | Disables the `env_var` module. |
| Opción | Por defecto | Descripción |
| ------------- | ------------------------------ | ---------------------------------------------------------------------------- |
| `symbol` | | The symbol used before displaying the variable value. |
| `variable` | | The environment variable to be displayed. |
| `por defecto` | | The default value to be displayed when the selected variable is not defined. |
| `format` | `"with [$env_value]($style) "` | El formato del módulo. |
| `disabled` | `false` | Disables the `env_var` module. |
### Variables
@ -862,8 +862,8 @@ default = "unknown shell"
The `erlang` module shows the currently installed version of Erlang/OTP. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
- The current directory contains a `rebar.config` file.
- The current directory contains a `erlang.mk` file.
- El directorio actual contiene un fichero `rebar.config`.
- El directorio actual contiene un fichero `erlang.mk`.
### Opciones
@ -914,13 +914,13 @@ The `gcloud` module shows the current configuration for [`gcloud`](https://cloud
| 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` |
| active | `por defecto` | The active config name written in `~/.config/gcloud/active_config` |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
### Examples
### Ejemplos
#### Display account and project
@ -989,7 +989,7 @@ truncation_length = 4
truncation_symbol = ""
```
## Git Commit
## Git commit
The `git_commit` module shows the current commit hash of the repo in your current directory.
@ -1021,7 +1021,7 @@ The `git_commit` module shows the current commit hash of the repo in your curren
commit_hash_length = 4
```
## Git State
## Git state
The `git_state` module will show in directories which are part of a git repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. If there is progress information (e.g., REBASING 3/10), that information will be shown too.
@ -1061,7 +1061,7 @@ format = "[\\($state( $progress_current of $progress_total)\\)]($style) "
cherry_pick = "[🍒 PICKING](bold red)"
```
## Git Status
## Git status
The `git_status` module shows symbols representing the state of the repo in your current directory.
@ -1134,6 +1134,7 @@ deleted = "🗑"
```
Show ahead/behind count of the branch being tracked
```toml
# ~/.config/starship.toml
@ -1147,9 +1148,9 @@ behind = "⇣${count}"
The `golang` module shows the currently installed version of Golang. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
- The current directory contains a `go.mod` file
- The current directory contains a `go.sum` file
- The current directory contains a `glide.yaml` file
- El directorio actual contiene un fichero `go.mod`
- El directorio actual contiene un fichero `go.sum`
- El directorio actual contiene un fichero `glide.yaml`
- The current directory contains a `Gopkg.yml` file
- The current directory contains a `Gopkg.lock` file
- The current directory contains a `.go-version` file
@ -1188,7 +1189,7 @@ format = "via [🏎💨 $version](bold cyan) "
The `helm` module shows the currently installed version of Helm. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
- The current directory contains a `helmfile.yaml` file
- El directorio actual contiene un fichero `helmfile.yaml`
- The current directory contains a `Chart.yaml` file
### Opciones
@ -1403,7 +1404,7 @@ disabled = false
"dev.local.cluster.k8s" = "dev"
```
## Line Break
## Salto de línea
The `line_break` module separates the prompt into two lines.
@ -1422,7 +1423,7 @@ The `line_break` module separates the prompt into two lines.
disabled = true
```
## Memory Usage
## Memoria utilizada
The `memory_usage` module shows current system memory and swap usage.
@ -1512,7 +1513,7 @@ truncation_symbol = ""
The `nim` module shows the currently installed version of Nim. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
- The current directory contains a `nim.cfg` file
- El directorio actual contiene un fichero `nim.cfg`
- 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
@ -1521,7 +1522,7 @@ The `nim` module shows the currently installed version of Nim. El módulo se mue
| Opción | Por defecto | Descripción |
| ---------- | ---------------------------------- | ----------------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | The format for the module |
| `format` | `"via [$symbol$version]($style) "` | El formato del módulo |
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
| `style` | `"bold yellow"` | El estilo del módulo. |
| `disabled` | `false` | Disables the `nim` module. |
@ -1588,7 +1589,7 @@ format = "via [☃️ $state( \\($name\\))](bold blue) "
The `nodejs` module shows the currently installed version of NodeJS. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
- The current directory contains a `package.json` file
- El directorio actual contiene un fichero `package.json`
- The current directory contains a `.node-version` file
- The current directory contains a `node_modules` directory
- The current directory contains a file with the `.js`, `.mjs` or `.cjs` extension
@ -1622,7 +1623,7 @@ The `nodejs` module shows the currently installed version of NodeJS. El módulo
format = "via [🤖 $version](bold green) "
```
## Package Version
## Versión del paquete
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.
@ -1746,7 +1747,7 @@ format = "via [🦪 $version]($style) "
The `php` module shows the currently installed version of PHP. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
- The current directory contains a `composer.json` file
- El directorio actual contiene un fichero `composer.json`
- The current directory contains a `.php-version` file
- The current directory contains a `.php` file
@ -1787,12 +1788,12 @@ If `pyenv_version_name` is set to `true`, it will display the pyenv version name
El módulo se muestra si algunas de las siguientes condiciones se cumplen:
- The current directory contains a `.python-version` file
- The current directory contains a `requirements.txt` file
- The current directory contains a `pyproject.toml` file
- El directorio actual contiene un fichero `requirements.txt`
- El directorio actual contiene un fichero `pyproject.toml`
- The current directory contains a file with the `.py` extension (and `scan_for_pyfiles` is true)
- The current directory contains a `Pipfile` file
- The current directory contains a `tox.ini` file
- The current directory contains a `setup.py` file
- El directorio actual contiene un fichero `tox.ini`
- El directorio actual contiene un fichero `setup.py`
- The current directory contains a `__init__.py` file
- A virtual environment is currently activated
@ -2036,7 +2037,6 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| `style` | `"bold red"` | El estilo del módulo. |
| `disabled` | `true` | Disables the `status` module. |
### Variables
| Variable | Ejemplo | Descripción |
@ -2047,8 +2047,8 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
### Ejemplo
```toml
# ~/.config/starship.toml
@ -2079,12 +2079,12 @@ The `terraform` module shows the currently selected terraform workspace and vers
### Variables
| Variable | Ejemplo | Descripción |
| --------- | ---------- | -------------------------------------- |
| version | `v0.12.24` | The version of `terraform` |
| workspace | `default` | The current terraform workspace |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
| Variable | Ejemplo | Descripción |
| --------- | ------------- | -------------------------------------- |
| version | `v0.12.24` | The version of `terraform` |
| workspace | `por defecto` | The current terraform workspace |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
@ -2108,7 +2108,7 @@ format = "[🏎💨 $version$workspace]($style) "
format = "[🏎💨 $workspace]($style) "
```
## Time
## Hora
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.
@ -2123,12 +2123,12 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| Opción | Por defecto | Descripción |
| ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `format` | `"at [$time]($style) "` | The format string for the module. |
| `use_12hr` | `false` | Enables 12 hour formatting |
| `use_12hr` | `false` | Activa el formato de 12 horas |
| `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 |
| `style` | `"bold yellow"` | El estilo del módulo de la hora |
| `utc_time_offset` | `"local"` | Sets the UTC offset to use. Range from -24 &lt; x &lt; 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 |
| `time_range` | `"-"` | Establece el intervalo de tiempo durante el cual el módulo se mostrará. La hora debe ser especificada en formato de 24 horas |
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.
@ -2136,7 +2136,7 @@ If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Otherwise, it de
| Variable | Ejemplo | Descripción |
| --------- | ---------- | ------------------------------------- |
| time | `13:08:10` | The current time. |
| hora | `13:08:10` | The current time. |
| style\* | | Refleja el valor de la opción `style` |
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
@ -2154,7 +2154,7 @@ utc_time_offset = "-5"
time_range = "10:00:00-14:00:00"
```
## Username
## Nombre de usuario
The `username` module shows active user's username. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
@ -2227,7 +2227,7 @@ The `zig` module shows the currently installed version of Zig. El módulo se mue
symbol = "⚡️ "
```
## Custom commands
## Comandos personalizados
The `custom` modules show the output of some arbitrary commands.
@ -2263,7 +2263,7 @@ The order in which custom modules are shown can be individually set by including
| `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`. |
| `descripción` | `"<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. |
@ -2274,17 +2274,17 @@ The order in which custom modules are shown can be individually set by including
### Variables
| Variable | Descripción |
| --------- | -------------------------------------- |
| output | The output of shell command in `shell` |
| symbol | Refleja el valor de la opción `symbol` |
| style\* | Refleja el valor de la opción `style` |
| Variable | Descripción |
| --------- | ----------------------------------------- |
| output | La salida del comando de shell en `shell` |
| symbol | Refleja el valor de la opción `symbol` |
| style\* | Refleja el valor de la opción `style` |
\*: Esta variable sólo puede ser usada como parte de una cadena de estilo
#### Comando personalizado de shell
`shell` accepts a non-empty list of strings, where:
`shell` acepta una lista no vacía de cadenas, donde:
- La primera cadena es la ruta al intérprete de comandos a usar para ejecutar el comando.
- Otros argumentos siguientes son pasados al shell.
@ -2330,25 +2330,25 @@ shell = ["pwsh.exe", "-NoProfile", "-Command", "-"]
## PureScript
The `purescript` module shows the currently installed version of PureScript version. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
El módulo `purescript` muestra la versión actualmente instalada de PureScript. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
- El directorio actual contiene un archivo `spago.dhall`
- El directorio actual contiene un archivo \*.purs
### Opciones
| Opción | Por defecto | Descripción |
| ---------- | ---------------------------------- | ------------------------------------------------------------ |
| `format` | `"via [$symbol$version]($style) "` | El formato del módulo. |
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
| `style` | `"bold white"` | El estilo del módulo. |
| `disabled` | `false` | Disables the `purescript` module. |
| Opción | Por defecto | Descripción |
| ---------- | ---------------------------------- | ----------------------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | El formato del módulo. |
| `symbol` | `"<=> "` | El símbolo usado antes de mostrar la versión de PureScript. |
| `style` | `"bold white"` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `purescript`. |
### Variables
| Variable | Ejemplo | Descripción |
| --------- | -------- | -------------------------------------- |
| version | `0.13.5` | The version of `purescript` |
| version | `0.13.5` | La versión de `purescript` |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |

10
docs/es-ES/migrating-to-0.45.0/README.md
View File

@ -134,10 +134,10 @@ error_symbol = "[✖](bold red) "
```diff
[directory]
-- prefix = "in "
++ format = "[$path]($style)[$lock_symbol]($lock_style)"
++ format = "[$path]($style)[$read_only]($read_only_style)"
```
#### Environment Variable
#### Variable de entorno
| Removed Property | Replacement |
| ---------------- | ----------- |
@ -153,7 +153,7 @@ error_symbol = "[✖](bold red) "
++ format = "with [$env_value]($style) "
```
#### Git Commit
#### Git commit
| Removed Property | Replacement |
| ---------------- | ----------- |
@ -169,7 +169,7 @@ error_symbol = "[✖](bold red) "
++ format = "[\\($hash\\)]($style) "
```
#### Git Status
#### Git status
| Removed Property | Replacement |
| ----------------- | ----------- |
@ -233,7 +233,7 @@ behind = "⇣${count}"
++ format = "[$symbol\\[$env\\]]($style) "
```
#### Time
#### Hora
| Removed Property | Replacement |
| ---------------- | ------------- |

296
docs/fr-FR/config/README.md
View File

@ -47,23 +47,23 @@ De manière équivalente, pour Powershell (Windows), ajoutez la ligne suivante
$ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp"
```
### Terminology
### Terminologie
**Module**: A component in the prompt giving information based on contextual information from your OS. For example, the "nodejs" module shows the version of NodeJS that is currently installed on your computer, if your current directory is a NodeJS project.
**Module**: Un composant dans l'invite donnant des informations basées sur des informations contextuelles à propos de votre Système d'Exploitation. Par exemple, le module "nodejs" montre la version de NodeJS qui est actuellement installée sur votre ordinateur, si votre répertoire actuel est un projet NodeJS.
**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.
**Variable**: Petits sous-composants qui contiennent des informations fournies par le module. Par exemple, la variable "version" dans le module "nodejs" contient la version actuelle de NodeJS.
By convention, most modules have a prefix of default terminal color (e.g. `via` in "nodejs") and an empty space as a suffix.
Par convention, la plupart des modules ont un préfixe de la couleur par défaut du terminal (par exemple `via` dans "nodejs") et un espace vide comme suffixe.
### Format Strings
### Chaîne de formatage
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.
Les chaînes de formatage sont le format avec lequel un module affiche toutes ses variables. La plupart des modules ont une entrée appelée `format` qui configure le format d'affichage du module. Vous pouvez utiliser des textes, des variables et des groupes de texte dans une chaîne de format.
#### Variable
A variable contains a `$` symbol followed by the name of the variable. The name of a variable only contains letters, numbers and `_`.
Une variable contient un symbole `$` suivi du nom de la variable. Le nom d'une variable ne contient que des lettres, des chiffres et `_`.
For example:
Par exemple :
- `$version` est une chaîne de formatage avec une variable nommée `version`.
- `$git_branch$git_commit` est une chaîne de formatage avec deux variables appelées `git_branch` et `git_commit`.
@ -71,13 +71,13 @@ For example:
#### Groupe de texte
A text group is made up of two different parts.
Un groupe de texte se compose de deux parties différentes.
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.
La première partie, qui est entourée dans un `[]`, est une [chaîne de formatage](#format-strings). Vous pouvez y ajouter des textes, des variables, ou même des groupes de texte imbriqués.
In the second part, which is enclosed in a `()`, is a [style string](#style-strings). This can be used style the first part.
La deuxième partie, qui est entourée par `()`, est une [chaîne de style](#style-strings). Ceci peut être utilisé pour styliser la première partie.
For example:
Par exemple :
- `[on](red bold)` affichera une chaîne de caractères `on` avec un texte gras de couleur rouge.
- `[⬢ $version](bold green)` affichera un symbole `⬢` suivi du contenu de la variable `version`, avec un texte en gras de couleur verte.
@ -85,7 +85,7 @@ For example:
#### Chaînes de style
Most modules in starship allow you to configure their display styles. This is done with an entry (usually called `style`) which is a string specifying the configuration. Here are some examples of style strings along with what they do. For details on the full syntax, consult the [advanced config guide](/advanced-config/).
La plupart des modules de Starship vous permettent de configurer leurs styles d'affichage. Cela se fait avec une entrée (généralement appelée `style`) qui est une chaîne de caractères spécifiant la configuration. Voici quelques exemples de chaînes de style avec ce qu'elles font. Pour plus de détails sur la syntaxe complète, consultez le [guide de configuration avancé](/advanced-config/).
- `"fg:green bg:blue"` définit un texte vert sur un fond bleu
- `"bg:blue fg:bright-green"` définit un texte vert clair sur un fond bleu
@ -94,13 +94,13 @@ Most modules in starship allow you to configure their display styles. This is do
- `"bold italic fg:purple"` définit le texte en italique et gras sur un fond violet
- `""` désactive explicitement tous les styles
Note that what styling looks like will be controlled by your terminal emulator. For example, some terminal emulators will brighten the colors instead of bolding text, and some color themes use the same values for the normal and bright colors. Also, to get italic text, your terminal must support italics.
Notez que ce style sera contrôlé par votre émulateur de terminal. Par exemple, certains émulateurs de terminal éclairciront les couleurs au lieu de mettre le texte en gras, et certains thèmes de couleurs utilisent les mêmes valeurs pour les couleurs normales et claires. De plus, pour obtenir du texte italique, votre terminal doit prendre en charge l'italique.
#### Chaînes de formatage conditionnel
A conditional format string wrapped in `(` and `)` will not render if all variables inside are empty.
Une chaîne de formatage conditionnel enveloppée dans `(` et `)` ne sera pas rendue si toutes les variables à l'intérieur sont vides.
For example:
Par exemple :
- `(@$region)` ne montrera rien si la variable `région` est `None`, sinon `@` suivi de la valeur de la région.
- `(some text)` ne montrera toujours rien puisqu'il n'y a pas de variables enveloppées dans les accolades.
@ -108,7 +108,7 @@ For example:
#### Caractère d’échappement
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 (`\`).
Les symboles suivants ont une utilisation spéciale dans une chaîne de formatage. Si vous voulez afficher les symboles suivants, vous devez les échapper avec un antislash (`\`).
- \$
- \\
@ -117,20 +117,20 @@ The following symbols have special usage in a format string. If you want to prin
- (
- )
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 `\`.
Notez que `toml` a [sa propre syntaxe d'échappement](https://github.com/toml-lang/toml#user-content-string). Il est recommandé d'utiliser une chaîne littérale (`''`) dans votre configuration. Si vous voulez utiliser une chaîne de base (`""`), faites attention à l'échappement de l'antislash `\`.
For example, when you want to print a `$` symbol on a new line, the following configs for `format` are equivalent:
Par exemple, lorsque vous voulez imprimer un symbole `$` sur une nouvelle ligne, les configurations suivantes pour le `formatage` sont équivalentes :
```toml
# with basic string
# avec la chaîne de base
format = "\n\\$"
# with multiline basic string
# avec la chaîne de caractères de base multiligne
format = """
\\$"""
# with literal string
# avec la chaîne littérale
format = '''
\$'''
@ -138,7 +138,7 @@ format = '''
## Invite
This is the list of prompt-wide configuration options.
Voici la liste des options de configuration de l'invite en lui-même.
### Options
@ -151,24 +151,24 @@ This is the list of prompt-wide configuration options.
### Exemple
```toml
# ~/.config/starship.toml
# ~/.config/starship. oml
# Use custom format
# Utilisez un format personnalisé
format = """
[┌───────────────────>](bold green)
[│](bold green)$directory$rust$package
[└─>](bold green) """
# Wait 10 milliseconds for starship to check files under the current directory.
# Attendez 10 millisecondes pour que starship vérifie les fichiers dans le répertoire de travail.
scan_timeout = 10
# Disable the newline at the start of the prompt
# Désactive la nouvelle ligne au démarrage de l'invite
add_newline = false
```
### Default Prompt Format
### Format par Défaut
The default `format` is used to define the format of the prompt, if empty or no `format` is provided. The default is as shown:
Le `format` par défaut est utilisé pour définir le format de l'invite, si il est vide ou mal `formaté`. La valeur par défaut est la suivante :
```toml
format = "$all"
@ -228,9 +228,9 @@ $character"""
## AWS
The `aws` module shows the current AWS region and profile. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file.
Le module `aws` affiche la région et le profil AWS courant. Ces informations sont basées sur les variables d'environnement `AWS_REGION`, `AWS_DEFAULT_REGION`, et `AWS_PROFILE` ainsi que le fichier `~/.aws/config`.
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var.
Quand [aws-vault](https://github.com/99designs/aws-vault) est utilisé, la valeur du profil est lu dans la variable d'environnement: `AWS_VAULT`.
### Options
@ -251,9 +251,9 @@ When using [aws-vault](https://github.com/99designs/aws-vault) the profile is re
| symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` |
\*: This variable can only be used as a part of a style string
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Examples
### Exemples
#### Tout afficher
@ -296,7 +296,7 @@ symbol = "🅰 "
## Battery
The `battery` module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%.
Le module `battery` montre à quel point la batterie de l'appareil est chargée et son état de charge actuel. Ce module n'est visible que lorsque la batterie de l'appareil est inférieure à 10%.
### Options
@ -310,14 +310,14 @@ The `battery` module shows how charged the device's battery is and its current c
| `disabled` | `false` | Désactive le module `battery`. |
<details>
<summary>There are also options for some uncommon battery states.</summary>
<summary>Il existe aussi des options pour des états de batterie peu communs.</summary>
| Variable | Description |
| ---------------- | ------------------------------------------------------------- |
| `unknown_symbol` | Le symbole affiché lorsque l'état de la batterie est inconnu. |
| `empty_symbol` | Le symbole affiché lorsque la batterie est vide. |
Note: Battery indicator will be hidden if the status is `unknown` or `empty` unless you specify the option in the config.
Remarque : L'indicateur de batterie sera masqué si le statut est `unknown` ou `empty` sauf si vous spécifiez l'option dans la configuration.
</details>
@ -332,9 +332,9 @@ charging_symbol = "⚡️"
discharging_symbol = "💀"
```
### Battery Display
### Indicateur de batterie
The `display` configuration option is used to define when the battery indicator should be shown (threshold) and what it looks like (style). If no `display` is provided. The default is as shown:
L'option de configuration `display` est utilisée pour définir quand l'indicateur de batterie doit être affiché (seuil) et à quoi il ressemble (style). Si aucun `display` n'est fourni. La valeur par défaut est la suivante :
```toml
[[battery.display]]
@ -344,7 +344,7 @@ style = "bold red"
#### Options
The `display` option is an array of the following table.
L'option `display` est une array de la table suivante.
| Variable | Description |
| ----------- | -------------------------------------------------- |
@ -354,28 +354,28 @@ The `display` option is an array of the following table.
#### Exemple
```toml
[[battery.display]] # "bold red" style when capacity is between 0% and 10%
[[battery.display]] # le style "bold red" lorsque la capacité est comprise entre 0% et 10%
threshold = 10
style = "bold red"
[[battery.display]] # "bold yellow" style when capacity is between 10% and 30%
[[battery.display]] # le style "bold yellow" quand la capacité est comprise entre 10% et 30%
threshold = 30
style = "bold yellow"
# when capacity is over 30%, the battery indicator will not be displayed
# lorsque la capacité est supérieure à 30%, l'indicateur de batterie ne sera pas affiché
```
## Caractères
The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal.
Le module `character` affiche un caractère (habituellement une flèche) à côté de l'endroit où le texte est entré dans votre terminal.
The character will tell you whether the last command was successful or not. It can do this in two ways:
Le caractère vous dira si la dernière commande a été réussie ou pas. Cela peut être fait de deux manières:
- changement de couleur (`red`/`green`)
- changement de forme (`❯`/`✖`)
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).
Par défaut, il ne change que la couleur. Si vous voulez également changer sa forme, jetez un œil à [cet exemple](#with-custom-error-shape).
### Options
@ -393,7 +393,7 @@ By default it only changes color. If you also want to change it's shape take a l
| -------- | ------- | --------------------------------------------------------------- |
| symbol | | Reflète sois `success_symbol`, `error_symbol` ou `vicmd_symbol` |
### Examples
### Exemples
#### Avec une forme d'erreur personnalisée
@ -426,7 +426,7 @@ vicmd_symbol = "[V](bold green) "
## CMake
The `cmake` module shows the currently installed version of CMake if:
Le module `cmake` affiche la version actuellement installée de CMake si :
- Le répertoire actuel contient un fichier `CMakeLists.txt`
@ -447,19 +447,19 @@ The `cmake` module shows the currently installed version of CMake if:
| symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` |
\*: This variable can only be used as a part of a style string
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
## Temps d'exécution
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.
Le module `cmd_duration` montre le temps qu'a pris la dernière commande a pris pour s'exécuter. Le module ne sera affiché que si la commande a pris plus de deux secondes, ou si la valeur de configuration `min_time` existe.
::: warning Do not hook the DEBUG trap in Bash
::: attention, n'accrochez pas la trappe DEBUG en Bash
If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break.
Si vous utilisez starship en `bash`, n'accrochez pas `DEBUG` après avoir exécuté `eval $(starship init $0)`, ou ce module **cassera**.
:::
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.
Les utilisateurs de Bash qui ont besoin de fonctionnalité pré-exec peuvent utiliser [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Définissez simplement les array `preexec_functions` et `precmd_functions` avant d'éxécuter `eval $(starship init $0)`, puis procédez comme d'habitude.
### Options
@ -478,7 +478,7 @@ Bash users who need preexec-like functionality can use [rcaloras's bash_preexec
| duration | `16m40s` | Le temps nécessaire pour exécuter la commande |
| style\* | | Reflète la valeur de l'option `style` |
\*: This variable can only be used as a part of a style string
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Exemple
@ -492,11 +492,11 @@ format = "underwent [$duration](bold yellow)"
## Conda
The `conda` module shows the current conda environment, if `$CONDA_DEFAULT_ENV` is set.
Le module `conda` affiche l'environnement conda actuel, si `$CONDA_DEFAULT_ENV` est défini.
::: tip
This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`.
Cela ne supprime pas le modificateur d'invite de conda, vous pouvez exécuter `conda config --set changeps1 False`.
:::
@ -519,7 +519,7 @@ This does not suppress conda's own prompt modifier, you may want to run `conda c
| symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` |
\*: This variable can only be used as a part of a style string
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Exemple
@ -554,7 +554,7 @@ The `crystal` module shows the currently installed version of Crystal. Le module
| symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` |
\*: This variable can only be used as a part of a style string
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Exemple
@ -590,7 +590,7 @@ The `dart` module shows the currently installed version of Dart. Le module est a
| symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` |
\*: This variable can only be used as a part of a style string
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Exemple
@ -611,15 +611,15 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
### Options
| Variable | Défaut | Description |
| ------------------------ | ----------------------------------------------- | -------------------------------------------------------------------------------- |
| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. |
| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. |
| `format` | `"[$path]($style)[$lock_symbol]($lock_style) "` | Format du module. |
| `style` | `"bold cyan"` | Le style du module. |
| `disabled` | `false` | Disables the `directory` module. |
| `read_only_symbol` | `"🔒"` | The symbol indicating current directory is read only. |
| `read_only_symbol_style` | `"red"` | The style for the read only symbol. |
| Variable | Défaut | Description |
| ------------------- | -------------------------------------------------- | -------------------------------------------------------------------------------- |
| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. |
| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. |
| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | Format du module. |
| `style` | `"bold cyan"` | Le style du module. |
| `disabled` | `false` | Disables the `directory` module. |
| `read_only` | `"🔒"` | The symbol indicating current directory is read only. |
| `read_only_style` | `"red"` | The style for the read only symbol. |
<details>
<summary>This module has a few advanced configuration options that control how the directory is displayed.</summary>
@ -649,7 +649,7 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
| path | `"D:/Projects"` | The current directory path |
| style\* | `"black bold dimmed"` | Reflète la valeur de l'option `style` |
\*: This variable can only be used as a part of a style string
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Exemple
@ -682,7 +682,7 @@ The `docker_context` module shows the currently active [Docker context](https://
| symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` |
\*: This variable can only be used as a part of a style string
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Exemple
@ -734,7 +734,7 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
| symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` |
\*: This variable can only be used as a part of a style string
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Exemple
@ -771,7 +771,7 @@ The `elixir` module shows the currently installed version of Elixir and Erlang/O
| symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` |
\*: This variable can only be used as a part of a style string
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Exemple
@ -809,7 +809,7 @@ The `elm` module shows the currently installed version of Elm. Le module est aff
| symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` |
\*: This variable can only be used as a part of a style string
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Exemple
@ -833,7 +833,7 @@ The `env_var` module displays the current value of a selected environment variab
| ---------- | ------------------------------ | ---------------------------------------------------------------------------- |
| `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. |
| `défaut` | | The default value to be displayed when the selected variable is not defined. |
| `format` | `"with [$env_value]($style) "` | Format du module. |
| `disabled` | `false` | Disables the `env_var` module. |
@ -845,7 +845,7 @@ The `env_var` module displays the current value of a selected environment variab
| symbol | | Reflète la valeur de l'option `symbol` |
| style\* | `black bold dimmed` | Reflète la valeur de l'option `style` |
\*: This variable can only be used as a part of a style string
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Exemple
@ -881,7 +881,7 @@ The `erlang` module shows the currently installed version of Erlang/OTP. Le modu
| symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` |
\*: This variable can only be used as a part of a style string
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Exemple
@ -913,13 +913,13 @@ The `gcloud` module shows the current configuration for [`gcloud`](https://cloud
| 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` |
| active | `défaut` | The active config name written in `~/.config/gcloud/active_config` |
| symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` |
\*: This variable can only be used as a part of a style string
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Examples
### Exemples
#### Display account and project
@ -975,7 +975,7 @@ The `git_branch` module shows the active branch of the repo in your current dire
| symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` |
\*: This variable can only be used as a part of a style string
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Exemple
@ -1009,7 +1009,7 @@ The `git_commit` module shows the current commit hash of the repo in your curren
| hash | `b703eb3` | The current git commit hash |
| style\* | | Reflète la valeur de l'option `style` |
\*: This variable can only be used as a part of a style string
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Exemple
@ -1048,7 +1048,7 @@ The `git_state` module will show in directories which are part of a git reposito
| progress_total | `2` | The total operation progress |
| style\* | | Reflète la valeur de l'option `style` |
\*: This variable can only be used as a part of a style string
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Exemple
@ -1099,7 +1099,7 @@ The following variables can be used in `format`:
| `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. |
| style\* | Reflète la valeur de l'option `style` |
\*: This variable can only be used as a part of a style string
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
The following variables can be used in `diverged`:
@ -1133,6 +1133,7 @@ deleted = "🗑"
```
Show ahead/behind count of the branch being tracked
```toml
# ~/.config/starship.toml
@ -1172,7 +1173,7 @@ The `golang` module shows the currently installed version of Golang. Le module e
| symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` |
\*: This variable can only be used as a part of a style string
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Exemple
@ -1207,7 +1208,7 @@ The `helm` module shows the currently installed version of Helm. Le module est a
| symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` |
\*: This variable can only be used as a part of a style string
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Exemple
@ -1239,7 +1240,7 @@ The `hostname` module shows the system hostname.
| symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` |
\*: This variable can only be used as a part of a style string
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Exemple
@ -1277,7 +1278,7 @@ The `java` module shows the currently installed version of Java. Le module est a
| symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` |
\*: This variable can only be used as a part of a style string
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Exemple
@ -1310,7 +1311,7 @@ The `jobs` module shows the current number of jobs running. The module will be s
| symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` |
\*: This variable can only be used as a part of a style string
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Exemple
@ -1347,7 +1348,7 @@ The `julia` module shows the currently installed version of Julia. Le module est
| symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` |
\*: This variable can only be used as a part of a style string
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Exemple
@ -1364,7 +1365,7 @@ Displays the current Kubernetes context name and, if set, the namespace from the
::: tip
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration.
:::
@ -1388,7 +1389,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` |
\*: This variable can only be used as a part of a style string
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Exemple
@ -1429,7 +1430,7 @@ By default the swap usage is displayed if the total system swap is non-zero.
::: tip
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration.
:::
@ -1494,7 +1495,7 @@ The `hg_branch` module shows the active branch of the repo in your current direc
| symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` |
\*: This variable can only be used as a part of a style string
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Exemple
@ -1520,7 +1521,7 @@ The `nim` module shows the currently installed version of Nim. Le module est aff
| Option | Default | Description |
| ---------- | ---------------------------------- | ----------------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | The format for the module |
| `format` | `"via [$symbol$version]($style) "` | Format du module |
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
| `style` | `"bold yellow"` | Le style du module. |
| `disabled` | `false` | Disables the `nim` module. |
@ -1533,7 +1534,7 @@ The `nim` module shows the currently installed version of Nim. Le module est aff
| symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` |
\*: This variable can only be used as a part of a style string
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Exemple
@ -1569,7 +1570,7 @@ The `nix_shell` module shows the nix-shell environment. The module will be shown
| symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` |
\*: This variable can only be used as a part of a style string
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Exemple
@ -1610,7 +1611,7 @@ The `nodejs` module shows the currently installed version of NodeJS. Le module e
| symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` |
\*: This variable can only be used as a part of a style string
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Exemple
@ -1655,7 +1656,7 @@ The `package` module is shown when the current directory is the repository for a
| symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` |
\*: This variable can only be used as a part of a style string
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Exemple
@ -1694,7 +1695,7 @@ The `ocaml` module shows the currently installed version of OCaml. Le module est
| symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` |
\*: This variable can only be used as a part of a style string
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Exemple
@ -1766,7 +1767,7 @@ The `php` module shows the currently installed version of PHP. Le module est aff
| symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` |
\*: This variable can only be used as a part of a style string
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Exemple
@ -1870,7 +1871,7 @@ The `ruby` module shows the currently installed version of Ruby. Le module est a
| symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` |
\*: This variable can only be used as a part of a style string
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Exemple
@ -1905,7 +1906,7 @@ The `rust` module shows the currently installed version of Rust. Le module est a
| symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` |
\*: This variable can only be used as a part of a style string
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Exemple
@ -1938,7 +1939,7 @@ The `shlvl` module shows the current SHLVL ("shell level") environment variable,
| symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` |
\*: This variable can only be used as a part of a style string
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Exemple
@ -1972,7 +1973,7 @@ The `singularity` module shows the current singularity image, if inside a contai
| symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` |
\*: This variable can only be used as a part of a style string
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Exemple
@ -2007,7 +2008,7 @@ The `swift` module shows the currently installed version of Swift. Le module est
| symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` |
\*: This variable can only be used as a part of a style string
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Exemple
@ -2024,7 +2025,7 @@ The `status` module displays the exit code of the previous command. The module w
::: tip
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. :::
Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. :::
### Options
@ -2035,7 +2036,6 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| `style` | `"bold green"` | Le style du module. |
| `disabled` | `true` | Disables the `status` module. |
### Variables
| Variable | Exemple | Description |
@ -2044,10 +2044,10 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` |
\*: This variable can only be used as a part of a style string
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Exemple
```toml
# ~/.config/starship.toml
@ -2081,11 +2081,11 @@ The `terraform` module shows the currently selected terraform workspace and vers
| Variable | Exemple | Description |
| --------- | ---------- | -------------------------------------- |
| version | `v0.12.24` | The version of `terraform` |
| workspace | `default` | The current terraform workspace |
| workspace | `défaut` | The current terraform workspace |
| symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` |
\*: This variable can only be used as a part of a style string
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Exemple
@ -2107,38 +2107,38 @@ format = "[🏎💨 $version$workspace]($style) "
format = "[🏎💨 $workspace]($style) "
```
## Time
## Temps
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.
Le module `time` affiche l'heure actuelle **localement**. La valeur de `format` est utilisée par le package [`chrono`](https://crates.io/crates/chrono) pour contrôler la façon dont l'heure est affichée. Consultez la [doc de chrono strftime](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) pour découvrir les options disponibles.
::: tip
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration.
:::
### Options
| Option | Défaut | Description |
| ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `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 &lt; x &lt; 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 |
| Option | Défaut | Description |
| ----------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `format` | `"at [$time]($style) "` | The format string for the module. |
| `use_12hr` | `false` | Activer le format 12h |
| `time_format` | voir plus bas | Le [format chrono](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) utilisé pour formater l'heure. |
| `style` | `"bold yellow"` | Le style utilisé par le module |
| `utc_time_offset` | `"local"` | Définir le décalage horaire UTC à utiliser. Range from -24 &lt; x &lt; 24. Accepte des nombres décimaux pour s'adapter aux décalages de 30/45 minutes. |
| `disabled` | `true` | Désactiver le module `time`. |
| `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format |
If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Otherwise, it defaults to `"%T"`. Manually setting `time_format` will override the `use_12hr` setting.
If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Sinon, il est défini comme `"%T"`. Manually setting `time_format` will override the `use_12hr` setting.
### Variables
| Variable | Exemple | Description |
| --------- | ---------- | ------------------------------------- |
| time | `13:08:10` | The current time. |
| temps | `13:08:10` | The current time. |
| style\* | | Reflète la valeur de l'option `style` |
\*: This variable can only be used as a part of a style string
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Exemple
@ -2153,24 +2153,24 @@ utc_time_offset = "-5"
time_range = "10:00:00-14:00:00"
```
## Username
## Nom d'utilisateur
The `username` module shows active user's username. Le module est affiché si l'une des ces conditions est remplie :
Le module `username` affiche le nom d'utilisateur de l'utilisateur actif. Le module est affiché si l'une des ces conditions est remplie :
- 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
- L'utilisateur courant est root
- L'utilisateur courant est différent de celui connecté
- L'utilisateur est actuellement connecté à une session SSH
- La variable `show_always` a comme valeur true
### Options
| Option | Défaut | Description |
| ------------- | ----------------------- | ------------------------------------- |
| `style_root` | `"bold green"` | The style used when the user is root. |
| `style_user` | `"bold yellow"` | The style used for non-root users. |
| `format` | `"[$user]($style) in "` | Format du module. |
| `show_always` | `false` | Always shows the `username` module. |
| `disabled` | `false` | Disables the `username` module. |
| Option | Défaut | Description |
| ------------- | ----------------------- | ------------------------------------------------ |
| `style_root` | `"bold green"` | Le style utilisé quand l'utilisateur est root. |
| `style_user` | `"bold yellow"` | Le style utilisé pour les utilisateurs non-root. |
| `format` | `"[$user]($style) in "` | Format du module. |
| `show_always` | `false` | Toujours afficher le module `username`. |
| `disabled` | `false` | Désactiver le module `username`. |
### Variables
@ -2215,7 +2215,7 @@ The `zig` module shows the currently installed version of Zig. Le module est aff
| symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` |
\*: This variable can only be used as a part of a style string
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Exemple
@ -2279,7 +2279,7 @@ The order in which custom modules are shown can be individually set by including
| symbol | Reflète la valeur de l'option `symbol` |
| style\* | Reflète la valeur de l'option `style` |
\*: This variable can only be used as a part of a style string
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
#### Custom command shell
@ -2329,19 +2329,19 @@ shell = ["pwsh.exe", "-NoProfile", "-Command", "-"]
## PureScript
The `purescript` module shows the currently installed version of PureScript version. Le module est affiché si l'une des ces conditions est remplie :
Le module `purescript` affiche la version courante de Purescript installée. Le module est affiché si l'une des ces conditions est remplie :
- The current directory contains a `spago.dhall` file
- The current directory contains a \*.purs files
### Options
| Option | Défaut | Description |
| ---------- | ---------------------------------- | ------------------------------------------------------------ |
| `format` | `"via [$symbol$version]($style) "` | Format du module. |
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
| `style` | `"bold white"` | Le style du module. |
| `disabled` | `false` | Disables the `purescript` module. |
| Option | Défaut | Description |
| ---------- | ---------------------------------- | ------------------------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | Format du module. |
| `symbol` | `"<=> "` | Le symbole utilisé avant d'afficher la version de PureScript. |
| `style` | `"bold white"` | Le style du module. |
| `disabled` | `false` | Désactive le module `purescript`. |
### Variables
@ -2351,7 +2351,7 @@ The `purescript` module shows the currently installed version of PureScript vers
| symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` |
\*: This variable can only be used as a part of a style string
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Exemple

4
docs/fr-FR/migrating-to-0.45.0/README.md
View File

@ -134,7 +134,7 @@ error_symbol = "[✖](bold red) "
```diff
[directory]
-- prefix = "in "
++ format = "[$path]($style)[$lock_symbol]($lock_style)"
++ format = "[$path]($style)[$read_only]($read_only_style)"
```
#### Environment Variable
@ -233,7 +233,7 @@ behind = "⇣${count}"
++ format = "[$symbol\\[$env\\]]($style) "
```
#### Time
#### Temps
| Removed Property | Replacement |
| ---------------- | ------------- |

744
docs/ja-JP/config/README.md
View File

File diff suppressed because it is too large Load Diff

6
docs/ja-JP/migrating-to-0.45.0/README.md
View File

@ -1,4 +1,4 @@
# 0.45への移行
# v0.45への移行
Starship v0.45.0は、v1.0.0の準備として互換性の無い変更を含むリリースになります。 私たちはより多くのカスタマイズを可能にするために、プロンプトでの設定方法にいくつかの大きな変更を加えました。
@ -52,7 +52,7 @@ format = """\
"""
```
## `prefix`と `suffix` モジュールが`format`を置換
## `prefix`と `suffix` モジュールを`format`に置換
v0.45.0以前では、モジュールのレンダリング方法をスタイリングするために、 `prefix` や`suffix`の指定可能なモジュールがありました。
@ -134,7 +134,7 @@ error_symbol = "[✖](bold red) "
```diff
[directory]
-- prefix = "in "
++ format = "[$path]($style)[$lock_symbol]($lock_style)"
++ format = "[$path]($style)[$read_only]($read_only_style)"
```
#### Environment Variable

68
docs/pt-BR/config/README.md
View File

@ -1,12 +1,12 @@
# Configuração
To get started configuring starship, create the following file: `~/.config/starship.toml`.
Para começar a configurar a starship, crie o seguinte arquivo: `~/.config/starship.toml`.
```sh
mkdir -p ~/.config && touch ~/.config/starship.toml
```
All configuration for starship is done in this [TOML](https://github.com/toml-lang/toml) file:
Todas as configurações do starship são feitas neste arquivo [TOML](https://github.com/toml-lang/toml):
```toml
# Don't print a new line at the start of the prompt
@ -21,13 +21,13 @@ success_symbol = "[➜](bold green)" # The "success_symbol" segment is being
disabled = true
```
You can change default `starship.toml` file location with `STARSHIP_CONFIG` environment variable:
Você pode alterar o caminho padrão do arquivo `starship.toml` com a variável de ambiente `STARSHIP_CONFIG`:
```sh
export STARSHIP_CONFIG=~/.starship
```
Equivalently in PowerShell (Windows) would be adding this line to your `$PROFILE`:
No PowerShell (Windows) você pode adicionar a seguinte linha no seu `$PROFILE`:
```ps1
$ENV:STARSHIP_CONFIG = "$HOME\.starship"
@ -41,15 +41,15 @@ By default starship logs warnings and errors into a file named `~/.cache/starshi
export STARSHIP_CACHE=~/.starship/cache
```
Equivalently in PowerShell (Windows) would be adding this line to your `$PROFILE`:
No PowerShell (Windows) você pode adicionar a seguinte linha no seu `$PROFILE`:
```ps1
$ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp"
```
### Terminology
### Terminologia
**Module**: A component in the prompt giving information based on contextual information from your OS. For example, the "nodejs" module shows the version of NodeJS that is currently installed on your computer, if your current directory is a NodeJS project.
**Módulo**: Um componente no prompt que fornece informações baseado no contexto do seu SO. Por exemplo, o módulo "nodejs" mostra a versão do NodeJS instalado no seu computador, se o diretório atual for um projeto NodeJS.
**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.
@ -85,7 +85,7 @@ For example:
#### Estilo dos textos
Most modules in starship allow you to configure their display styles. This is done with an entry (usually called `style`) which is a string specifying the configuration. Here are some examples of style strings along with what they do. For details on the full syntax, consult the [advanced config guide](/advanced-config/).
A maioria dos módulos do starship permite que você configure o estilo de exibição dos textos. Isso é feito através de um parâmetro (geralmente chamado `style`) que é uma string especificando a configuração. Aqui estão alguns exemplos de strings de estilo e o que elas fazem. Para detalhes sobre a sintaxe completa, consulte o [guia de configurações avançadas](/advanced-config/).
- `"fg:green bg:blue"` deixa o texto verde com o fundo azul
- `"bg:blue fg:bright-green"` deixa o texto verde brilhante com o fundo azul
@ -94,7 +94,7 @@ Most modules in starship allow you to configure their display styles. This is do
- `"bold italic fg:purple"` deixa o texto em negrito e itálico com a cor roxa
- `""` desabilita explicitamente todos os estilos
Note that what styling looks like will be controlled by your terminal emulator. For example, some terminal emulators will brighten the colors instead of bolding text, and some color themes use the same values for the normal and bright colors. Also, to get italic text, your terminal must support italics.
Note que a aparência do estilo será controlado pelo seu terminal. Por exemplo, alguns terminais deixarão as cores mais brilhantes ao invés de deixar o texto em negrito, ou alguns temas podem usar as mesmas cores para cores brilhantes e normais. Além disso, para textos em itálico, o terminal precisa ter suporte.
#### Conditional Format Strings
@ -142,11 +142,11 @@ This is the list of prompt-wide configuration options.
### Opções
| Option | Padrão | Descrição |
| -------------- | ------------------------------ | ----------------------------------------------------- |
| `format` | [link](#default-prompt-format) | Configure the format of the prompt. |
| `scan_timeout` | `30` | Timeout for starship to scan files (in milliseconds). |
| `add_newline` | `true` | Add a new line before the start of the prompt. |
| Option | Padrão | Descrição |
| -------------- | ------------------------------ | ------------------------------------------------------------- |
| `format` | [link](#default-prompt-format) | Configure the format of the prompt. |
| `scan_timeout` | `30` | Timeout for starship to scan files (in milliseconds). |
| `add_newline` | `true` | Adiciona uma nova linha antes que o prompt de comando inicie. |
### Exemplo
@ -168,7 +168,7 @@ add_newline = false
### Default Prompt Format
The default `format` is used to define the format of the prompt, if empty or no `format` is provided. The default is as shown:
The default `format` is used to define the format of the prompt, if empty or no `format` is provided. Os valores padrão são os seguintes:
```toml
format = "$all"
@ -332,9 +332,9 @@ charging_symbol = "⚡️"
discharging_symbol = "💀"
```
### Battery Display
### Indicador de bateria
The `display` configuration option is used to define when the battery indicator should be shown (threshold) and what it looks like (style). If no `display` is provided. The default is as shown:
The `display` configuration option is used to define when the battery indicator should be shown (threshold) and what it looks like (style). If no `display` is provided. Os valores padrão são os seguintes:
```toml
[[battery.display]]
@ -453,7 +453,7 @@ The `cmake` module shows the currently installed version of CMake if:
The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists.
::: warning Do not hook the DEBUG trap in Bash
::: warning Não utilize o DEBUG-trap no Bash
If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break.
@ -601,7 +601,7 @@ The `dart` module shows the currently installed version of Dart. The module will
format = "via [🔰 $version](bold red) "
```
## Directory
## Diretório
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.
@ -611,15 +611,15 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
### Opções
| Variável | Padrão | Descrição |
| ------------------------ | ----------------------------------------------- | -------------------------------------------------------------------------------- |
| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. |
| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. |
| `format` | `"[$path]($style)[$lock_symbol]($lock_style) "` | The format for the module. |
| `style` | `"bold cyan"` | O estilo do módulo. |
| `disabled` | `false` | Disables the `directory` module. |
| `read_only_symbol` | `"🔒"` | The symbol indicating current directory is read only. |
| `read_only_symbol_style` | `"red"` | The style for the read only symbol. |
| Variável | Padrão | Descrição |
| ------------------- | -------------------------------------------------- | -------------------------------------------------------------------------------- |
| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. |
| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. |
| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | The format for the module. |
| `style` | `"bold cyan"` | O estilo do módulo. |
| `disabled` | `false` | Disables the `directory` module. |
| `read_only` | `"🔒"` | The symbol indicating current directory is read only. |
| `read_only_style` | `"red"` | The style for the read only symbol. |
<details>
<summary>This module has a few advanced configuration options that control how the directory is displayed.</summary>
@ -988,7 +988,7 @@ truncation_length = 4
truncation_symbol = ""
```
## Git Commit
## Git commit
The `git_commit` module shows the current commit hash of the repo in your current directory.
@ -1133,6 +1133,7 @@ deleted = "🗑"
```
Show ahead/behind count of the branch being tracked
```toml
# ~/.config/starship.toml
@ -1402,7 +1403,7 @@ disabled = false
"dev.local.cluster.k8s" = "dev"
```
## Line Break
## Quebra de linha
The `line_break` module separates the prompt into two lines.
@ -1421,7 +1422,7 @@ The `line_break` module separates the prompt into two lines.
disabled = true
```
## Memory Usage
## Uso de memória
The `memory_usage` module shows current system memory and swap usage.
@ -2035,7 +2036,6 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| `style` | `"bold red"` | O estilo do módulo. |
| `disabled` | `true` | Disables the `status` module. |
### Variables
| Variável | Exemplo | Descrição |
@ -2046,8 +2046,8 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
\*: This variable can only be used as a part of a style string
### Exemplo
```toml
# ~/.config/starship.toml
@ -2262,7 +2262,7 @@ The order in which custom modules are shown can be individually set by including
| `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`. |
| `descrição` | `"<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. |

6
docs/pt-BR/migrating-to-0.45.0/README.md
View File

@ -123,7 +123,7 @@ error_symbol = "[✖](bold red) "
++ format = "took [$duration]($style)"
```
#### Directory
#### Diretório
| Removed Property | Replacement |
| ---------------- | ----------- |
@ -134,7 +134,7 @@ error_symbol = "[✖](bold red) "
```diff
[directory]
-- prefix = "in "
++ format = "[$path]($style)[$lock_symbol]($lock_style)"
++ format = "[$path]($style)[$read_only]($read_only_style)"
```
#### Environment Variable
@ -153,7 +153,7 @@ error_symbol = "[✖](bold red) "
++ format = "with [$env_value]($style) "
```
#### Git Commit
#### Git commit
| Removed Property | Replacement |
| ---------------- | ----------- |

22
docs/pt-PT/config/README.md
View File

@ -611,15 +611,15 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
### Options
| Variable | Default | Description |
| ------------------------ | ----------------------------------------------- | -------------------------------------------------------------------------------- |
| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. |
| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. |
| `format` | `"[$path]($style)[$lock_symbol]($lock_style) "` | The format for the module. |
| `style` | `"bold cyan"` | The style for the module. |
| `disabled` | `false` | Disables the `directory` module. |
| `read_only_symbol` | `"🔒"` | The symbol indicating current directory is read only. |
| `read_only_symbol_style` | `"red"` | The style for the read only symbol. |
| Variable | Default | Description |
| ------------------- | -------------------------------------------------- | -------------------------------------------------------------------------------- |
| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. |
| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. |
| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | The format for the module. |
| `style` | `"bold cyan"` | The style for the module. |
| `disabled` | `false` | Disables the `directory` module. |
| `read_only` | `"🔒"` | The symbol indicating current directory is read only. |
| `read_only_style` | `"red"` | The style for the read only symbol. |
<details>
<summary>This module has a few advanced configuration options that control how the directory is displayed.</summary>
@ -1133,6 +1133,7 @@ deleted = "🗑"
```
Show ahead/behind count of the branch being tracked
```toml
# ~/.config/starship.toml
@ -2035,7 +2036,6 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| `style` | `"bold red"` | The style for the module. |
| `disabled` | `true` | Disables the `status` module. |
### Variables
| Variable | Example | Description |
@ -2046,8 +2046,8 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
\*: This variable can only be used as a part of a style string
### Example
```toml
# ~/.config/starship.toml

2
docs/pt-PT/migrating-to-0.45.0/README.md
View File

@ -134,7 +134,7 @@ error_symbol = "[✖](bold red) "
```diff
[directory]
-- prefix = "in "
++ format = "[$path]($style)[$lock_symbol]($lock_style)"
++ format = "[$path]($style)[$read_only]($read_only_style)"
```
#### Environment Variable

524
docs/ru-RU/config/README.md
View File

File diff suppressed because it is too large Load Diff

14
docs/ru-RU/migrating-to-0.45.0/README.md
View File

@ -123,7 +123,7 @@ error_symbol = "[✖](bold red) "
++ format = "took [$duration]($style)"
```
#### Directory
#### Каталог
| Removed Property | Replacement |
| ---------------- | ----------- |
@ -134,10 +134,10 @@ error_symbol = "[✖](bold red) "
```diff
[directory]
-- prefix = "in "
++ format = "[$path]($style)[$lock_symbol]($lock_style)"
++ format = "[$path]($style)[$read_only]($read_only_style)"
```
#### Environment Variable
#### Переменная Окружения
| Removed Property | Replacement |
| ---------------- | ----------- |
@ -153,7 +153,7 @@ error_symbol = "[✖](bold red) "
++ format = "with [$env_value]($style) "
```
#### Git Commit
#### Коммит Git
| Removed Property | Replacement |
| ---------------- | ----------- |
@ -169,7 +169,7 @@ error_symbol = "[✖](bold red) "
++ format = "[\\($hash\\)]($style) "
```
#### Git Status
#### Статус Git
| Removed Property | Replacement |
| ----------------- | ----------- |
@ -200,7 +200,7 @@ diverged = "⇕⇡${ahead_count}⇣${behind_count}"
behind = "⇣${count}"
```
#### Hostname
#### Имя хоста
| Removed Property | Replacement |
| ---------------- | ----------- |
@ -233,7 +233,7 @@ behind = "⇣${count}"
++ format = "[$symbol\\[$env\\]]($style) "
```
#### Time
#### Время
| Removed Property | Replacement |
| ---------------- | ------------- |

962
docs/zh-CN/config/README.md
View File

File diff suppressed because it is too large Load Diff

2
docs/zh-CN/migrating-to-0.45.0/README.md
View File

@ -134,7 +134,7 @@ error_symbol = "[✖](bold red) "
```diff
[directory]
-- prefix = "in "
++ format = "[$path]($style)[$lock_symbol]($lock_style)"
++ format = "[$path]($style)[$read_only]($read_only_style)"
```
#### Environment Variable

400
docs/zh-TW/config/README.md
View File

@ -1,12 +1,12 @@
# 設定
To get started configuring starship, create the following file: `~/.config/starship.toml`.
為了開始設定 Starship，請建立下右檔案： `~/.config/starship.toml`.
```sh
mkdir -p ~/.config && touch ~/.config/starship.toml
```
All configuration for starship is done in this [TOML](https://github.com/toml-lang/toml) file:
所有關於 Starship 的設定都在這個 [TOML](https://github.com/toml-lang/toml) 檔案內：
```toml
# Don't print a new line at the start of the prompt
@ -21,7 +21,7 @@ success_symbol = "[➜](bold green)" # The "success_symbol" segment is being
disabled = true
```
You can change default `starship.toml` file location with `STARSHIP_CONFIG` environment variable:
你可以藉由修改 `STARSHIP_CONFIG`環境變數而改變預設的`starship.toml` 檔案位置
```sh
export STARSHIP_CONFIG=~/.starship
@ -47,9 +47,9 @@ Equivalently in PowerShell (Windows) would be adding this line to your `$PROFILE
$ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp"
```
### Terminology
### 術語
**Module**: A component in the prompt giving information based on contextual information from your OS. For example, the "nodejs" module shows the version of NodeJS that is currently installed on your computer, if your current directory is a NodeJS project.
**模組 (Module)**： 提示字元中的一個元件，基於你的作業系統提供的背景資訊來提供訊息。 舉例來說，如果你現在的資料夾是一個 NodeJS 專案，"nodejs" 模組會顯示出現在安裝在你的電腦上的 NodeJS 版本。
**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.
@ -85,7 +85,7 @@ For example:
#### 風格字串
Most modules in starship allow you to configure their display styles. This is done with an entry (usually called `style`) which is a string specifying the configuration. Here are some examples of style strings along with what they do. For details on the full syntax, consult the [advanced config guide](/advanced-config/).
Starship 內大多數的模組允許你設定他們的顯示風格。 這要透過一個條目 (通常叫做 `style`)，這個條目使用一個字串來進行設定。 這裡給幾個風格字串的例子，以及這些字串的功用。 對於完整語法的詳細說明，請參照 [進階設定指南](/advanced-config/)。
- `"fg:green bg:blue"` 在一個藍色背景上設定綠色文字
- `"bg:blue fg:bright-green"` 在一個藍色背景上設定亮綠色文字
@ -94,7 +94,7 @@ Most modules in starship allow you to configure their display styles. This is do
- `"bold italic fg:purple"` 設定粗體、斜體且紫色的文字
- `""` 明確地關閉所有風格
Note that what styling looks like will be controlled by your terminal emulator. For example, some terminal emulators will brighten the colors instead of bolding text, and some color themes use the same values for the normal and bright colors. Also, to get italic text, your terminal must support italics.
注意風格產出的樣子取決於你的終端機模擬器。 例如，有些終端機模擬器會提升顏色的亮度而不是讓文字變粗體，而且有些色彩主題對一般與加亮顏色使用的是相同色碼。 除此之外，為了要有斜體字，你的終端機一定要支援斜體。
#### Conditional Format Strings
@ -138,7 +138,7 @@ format = '''
## 提示字元
This is the list of prompt-wide configuration options.
以下是針對提示字元內容的設定。
### 選項
@ -146,7 +146,7 @@ This is the list of prompt-wide configuration options.
| -------------- | ---------------------------- | ----------------------------------------------------- |
| `format` | [連結](#default-prompt-format) | Configure the format of the prompt. |
| `scan_timeout` | `30` | Timeout for starship to scan files (in milliseconds). |
| `add_newline` | `true` | Add a new line before the start of the prompt. |
| `add_newline` | `true` | 在提示字元前面加上換行字元。 |
### 範例
@ -168,7 +168,7 @@ add_newline = false
### Default Prompt Format
The default `format` is used to define the format of the prompt, if empty or no `format` is provided. The default is as shown:
The default `format` is used to define the format of the prompt, if empty or no `format` is provided. 預設如下：
```toml
format = "$all"
@ -228,9 +228,9 @@ $character"""
## AWS
The `aws` module shows the current AWS region and profile. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file.
`aws` 模組顯示現在 AWS 的區域與概況。 這是根據 `AWS_REGION`、`AWS_DEFAULT_REGION` 與 `AWS_PROFILE` 環境變數及 `~/.aws/config` 檔案。
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var.
從 `AWS_VAULT`讀取而使用 [aws-vault](https://github.com/99designs/aws-vault) 這個設定檔
### 選項
@ -296,7 +296,7 @@ symbol = "🅰 "
## 電池
The `battery` module shows how charged the device's battery is and its current charging status. The module is only visible when the device's battery is below 10%.
`battery` 模組顯示電池的電量以及現在的充電狀態。 這個模組只會在裝置的電量低於 10% 的時候看見。
### 選項
@ -310,14 +310,14 @@ The `battery` module shows how charged the device's battery is and its current c
| `disabled` | `false` | 停用 `battery` 模組。 |
<details>
<summary>There are also options for some uncommon battery states.</summary>
<summary>也有些針對不常見的電池狀態設定的選項。</summary>
| 變數 | 說明 |
| ---------------- | -------------- |
| `unknown_symbol` | 當電池狀態不明時顯示的符號。 |
| `empty_symbol` | 當電池沒電時顯示的符號。 |
Note: Battery indicator will be hidden if the status is `unknown` or `empty` unless you specify the option in the config.
注意：電池指示會在電池狀態`不明`或`沒電`時隱藏起來，除非你在設定之中有特別指定選項。
</details>
@ -332,9 +332,9 @@ charging_symbol = "⚡️"
discharging_symbol = "💀"
```
### Battery Display
### 電池顯示
The `display` configuration option is used to define when the battery indicator should be shown (threshold) and what it looks like (style). If no `display` is provided. The default is as shown:
`display` 設定是用來定義甚麼時候電池指示會顯示出來 (threshold)，以及它長甚麼樣子 (style)。 如果沒有提供 `display`。 預設如下：
```toml
[[battery.display]]
@ -344,7 +344,7 @@ style = "bold red"
#### 選項
The `display` option is an array of the following table.
`display` 選項是一個下列表格的陣列。
| 變數 | 說明 |
| ----------- | ----------- |
@ -354,23 +354,23 @@ The `display` option is an array of the following table.
#### 範例
```toml
[[battery.display]] # "bold red" style when capacity is between 0% and 10%
[[battery.display]] # 0% 到 10% 電量之間時，使用 "bold red" 風格
threshold = 10
style = "bold red"
[[battery.display]] # "bold yellow" style when capacity is between 10% and 30%
[[battery.display]] # 10% 到 30% 電量之間時，使用 "bold yellow" 風格
threshold = 30
style = "bold yellow"
# when capacity is over 30%, the battery indicator will not be displayed
# 當電量超過 30% 時，電量指示就不會顯示出來
```
## 字元
The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal.
`character` 模組在你的文字輸入處旁顯示一個字元 (通常是箭頭)。
The character will tell you whether the last command was successful or not. It can do this in two ways:
這個字元會告訴你最後的指令是成功還是失敗。 It can do this in two ways:
- changing color (`red`/`green`)
- changing shape (`❯`/`✖`)
@ -451,15 +451,15 @@ The `cmake` module shows the currently installed version of CMake if:
## 指令持續時間
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.
`cmd_duration` 模組顯示最後一個指令執行所花費的時間。 這個模組只會在指令花費超過兩秒或是有設定 `min_time` 時，超過設定值時出現。
::: warning Do not hook the DEBUG trap in Bash
::: warning 不要在 Bash 中設置 DEBUG trap
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` 中使用 Starship，不要在執行 `eval $(starship init $0)` 之後設置 `DEBUG` trap，不然這個模組**會**壞掉。
:::
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.
想使用類似 preexec 功能的 Bash 使用者可以 [rcaloras 的 bash_preexec 框架](https://github.com/rcaloras/bash-preexec)。 只要在 `eval $(starship init $0)` 之前簡單地定義 `preexec_functions` 與 `precmd_functions` 兩個陣列，然後就可以照常進行。
### 選項
@ -492,7 +492,7 @@ format = "underwent [$duration](bold yellow)"
## Conda
The `conda` module shows the current conda environment, if `$CONDA_DEFAULT_ENV` is set.
如果有設定 `$CONDA_DEFAULT_ENV` 時，`conda` 模組顯示現在 conda 的環境。
::: tip
@ -509,7 +509,7 @@ This does not suppress conda's own prompt modifier, you may want to run `conda c
| `style` | `"bold green"` | 這個模組的風格。 |
| `format` | `"[$symbol$environment]($style) "` | The format for the module. |
| `ignore_base` | `true` | Ignores `base` environment when activated. |
| `disabled` | `false` | Disables the `conda` module. |
| `disabled` | `false` | 停用 `conda` 模組。 |
### Variables
@ -532,7 +532,7 @@ format = "[$symbol$environment](dimmed green) "
## Crystal
The `crystal` module shows the currently installed version of Crystal. 這個模組在下列其中一個條件達成時顯示：
`crystal` 模組顯示現在所安裝的Crystal版本 這個模組在下列其中一個條件達成時顯示：
- 現在資料夾中含有一個 `shard.yml` 檔案
- 現在資料夾中含有一個`.cr`檔案
@ -601,34 +601,34 @@ The `dart` module shows the currently installed version of Dart. 這個模組在
format = "via [🔰 $version](bold red) "
```
## Directory
## 資料夾
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.
`directory` 模組顯示到現在資料夾的路徑，並裁減到前三層資料夾。 你的資料夾也會被裁減到你所在的 git 儲存庫的根目錄。
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.
如果正在使用 fish 風格的 pwd 選項，將不會隱藏被裁減的資料夾，而是會根據你在選項中設定的數字看到每一層資料夾的縮寫。
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`.
例如，給定一個右列的路徑 `~/Dev/Nix/nixpkgs/pkgs` 其中 `nixpkgs` 是儲存庫的根目錄，而且該選項被設定為 `1`。 你會看到 `~/D/N/nixpkgs/pkgs`，而在這個設定之前則是 `nixpkgs/pkgs`。
### 選項
| 變數 | 預設 | 說明 |
| ------------------------ | ----------------------------------------------- | -------------------------------------------------------------------------------- |
| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. |
| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. |
| `format` | `"[$path]($style)[$lock_symbol]($lock_style) "` | The format for the module. |
| `style` | `"bold cyan"` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `directory` module. |
| `read_only_symbol` | `"🔒"` | The symbol indicating current directory is read only. |
| `read_only_symbol_style` | `"red"` | The style for the read only symbol. |
| 變數 | 預設 | 說明 |
| ------------------- | -------------------------------------------------- | ----------------------------------------------------- |
| `truncation_length` | `3` | 到達現在資料夾的路徑中，要被裁減掉的資料夾數目。 |
| `truncate_to_repo` | `true` | 是否要裁減到你現在所在的 git 儲存庫的根目錄。 |
| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | The format for the module. |
| `style` | `"bold cyan"` | 這個模組的風格。 |
| `disabled` | `false` | 停用 `directory` 模組。 |
| `read_only` | `"🔒"` | The symbol indicating current directory is read only. |
| `read_only_style` | `"red"` | The style for the read only symbol. |
<details>
<summary>This module has a few advanced configuration options that control how the directory is displayed.</summary>
<summary>這個模組有些進階設定選項可以控制顯示資料夾。</summary>
| Advanced Option | 預設 | 說明 |
| --------------------------- | ------ | ---------------------------------------------------------------------------------------- |
| `substitutions` | | A table of substitutions to be made to the path. |
| `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. |
| `use_logical_path` | `true` | Displays the logical path provided by the shell (`PWD`) instead of the path from the OS. |
| Advanced Option | 預設 | 說明 |
| --------------------------- | ------ | ------------------------------------------------ |
| `substitutions` | | A table of substitutions to be made to the path. |
| `fish_style_pwd_dir_length` | `0` | 當使用 fish shell 的 pwd 路徑邏輯時使用的字元數量。 |
| `use_logical_path` | `true` | 顯示 shell (`PWD`) 提供的邏輯路徑，而不是 OS 的路徑。 |
`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.
@ -695,7 +695,7 @@ format = "via [🐋 $context](blue bold)"
## Dotnet
The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK.
`dotnet` 模組顯示現在資料夾使用的 .NET Core SDK 的版本。 如果這個資料夾已經選定一個 SDK，則顯示這個 SDK 的版本。 如果沒有的話，則顯示最新安裝的 SDK 版本。
This module will only be shown in your prompt when one or more of the following files are present in the current directory:
@ -711,19 +711,19 @@ This module will only be shown in your prompt when one or more of the following
You'll also need the .NET Core SDK installed in order to use it correctly.
Internally, this module uses its own mechanism for version detection. Typically it is twice as fast as running `dotnet --version`, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting `heuristic = false` in the module options.
這個模組內部是使用它自己的機制來偵測版本。 一般來說這個模組有 `dotnet --version` 的兩倍快，但是它可能會在你的 .NET 專案有不尋常的資料夾結構時顯示不正確的版本。 如果精確度比速度更重要的話，你可以藉由設定模組中的 `heuristic = false` 選項來停用這個功能。
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.
### 選項
| Option | 預設 | 說明 |
| ----------- | ---------------------------------------- | -------------------------------------------------------- |
| `format` | `"v[$symbol$version( 🎯 $tfm)]($style) "` | The format for the module. |
| `symbol` | `"•NET "` | The symbol used before displaying the version of dotnet. |
| `heuristic` | `true` | Use faster version detection to keep starship snappy. |
| `style` | `"bold blue"` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `dotnet` module. |
| Option | 預設 | 說明 |
| ----------- | ---------------------------------------- | ---------------------------- |
| `format` | `"v[$symbol$version( 🎯 $tfm)]($style) "` | The format for the module. |
| `symbol` | `"•NET "` | 在顯示 dotnet 版本之前用的符號。 |
| `heuristic` | `true` | 使用更快速的版本偵測法來保持 starship 的速度。 |
| `style` | `"bold blue"` | 這個模組的風格。 |
| `disabled` | `false` | 停用 `dotnet` 模組。 |
### Variables
@ -751,7 +751,7 @@ heuristic = false
The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. 這個模組在下列其中一個條件達成時顯示：
- The current directory contains a `mix.exs` file.
- 現在資料夾中包含一個 `mix.exs` 檔案.
### 選項
@ -786,8 +786,8 @@ symbol = "🔮 "
The `elm` module shows the currently installed version of Elm. 這個模組在下列其中一個條件達成時顯示：
- The current directory contains a `elm.json` file
- The current directory contains a `elm-package.json` file
- 現在資料夾中包含一個 `elm.json` 檔案
- 現在資料夾中包含一個 `elm-package.json` 檔案
- The current directory contains a `.elm-version` file
- The current directory contains a `elm-stuff` folder
- The current directory contains a `*.elm` files
@ -820,22 +820,22 @@ The `elm` module shows the currently installed version of Elm. 這個模組在
format = "via [ $version](cyan bold) "
```
## Environment Variable
## 環境變數
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:
`env_var`模組顯示一個選擇的環境變數的現在數值。 這個模組只在下列條件其中之一達到時顯示：
- The `variable` configuration option matches an existing environment variable
- The `variable` configuration option is not defined, but the `default` configuration option is
- `variable` 設定選項符合一個存在的環境變數。
- 沒有設定 `variable` 選項，但是有設定 `default` 選項。
### 選項
| Option | 預設 | 說明 |
| ---------- | ------------------------------ | ---------------------------------------------------------------------------- |
| `symbol` | | The symbol used before displaying the variable value. |
| `variable` | | The environment variable to be displayed. |
| `default` | | The default value to be displayed when the selected variable is not defined. |
| `format` | `"with [$env_value]($style) "` | The format for the module. |
| `disabled` | `false` | Disables the `env_var` module. |
| Option | 預設 | 說明 |
| ---------- | ------------------------------ | -------------------------- |
| `symbol` | | 顯示在變數數值之前的符號。 |
| `variable` | | 要顯示的環境變數。 |
| `default` | | 在選擇的變數值沒有定義時，顯示的預設值。 |
| `format` | `"with [$env_value]($style) "` | The format for the module. |
| `disabled` | `false` | 停用 `env_var` 模組。 |
### Variables
@ -861,8 +861,8 @@ default = "unknown shell"
The `erlang` module shows the currently installed version of Erlang/OTP. 這個模組在下列其中一個條件達成時顯示：
- The current directory contains a `rebar.config` file.
- The current directory contains a `erlang.mk` file.
- 現在資料夾中包含一個 `rebar.config` 檔案.
- 現在資料夾中包含一個 `erlang.mk` 檔案.
### 選項
@ -952,20 +952,20 @@ us-central1 = "uc1"
asia-northeast1 = "an1"
```
## Git Branch
## Git 分支
The `git_branch` module shows the active branch of the repo in your current directory.
`git_branch` 模組顯示現在的資料夾中使用中的儲存庫的分支。
### 選項
| Option | 預設 | 說明 |
| ------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- |
| `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"` | 這個模組的風格。 |
| `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. |
| `disabled` | `false` | Disables the `git_branch` module. |
| Option | 預設 | 說明 |
| ------------------- | -------------------------------- | ------------------------------------------------------------------------------- |
| `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"` | 這個模組的風格。 |
| `truncation_length` | `2^63 - 1` | Truncates a git branch to X graphemes. |
| `truncation_symbol` | `"…"` | 用來指示分支名稱被縮減的符號。 You can use `""` for no symbol. |
| `disabled` | `false` | 停用 `git_branch` 模組。 |
### Variables
@ -1022,7 +1022,7 @@ commit_hash_length = 4
## Git State
The `git_state` module will show in directories which are part of a git repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. If there is progress information (e.g., REBASING 3/10), that information will be shown too.
`git_state` 模組會顯示在 git 儲存庫中的資料夾內，以及會在有作業正在進行時顯示，像是：_REBASING_、_BISECTING_ 等等。 如果有進展的資訊 (像是 REBASING 3/10)，也會一併顯示出來。
### 選項
@ -1037,7 +1037,7 @@ The `git_state` module will show in directories which are part of a git reposito
| `am_or_rebase` | `"AM/REBASE"` | A format string displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. |
| `style` | `"bold yellow"` | 這個模組的風格。 |
| `format` | `"\\([$state( $progress_current/$progress_total)]($style)\\) "` | The format for the module. |
| `disabled` | `false` | Disables the `git_state` module. |
| `disabled` | `false` | 停用 `git_state` 模組。 |
### Variables
@ -1062,14 +1062,14 @@ cherry_pick = "[🍒 PICKING](bold red)"
## Git Status
The `git_status` module shows symbols representing the state of the repo in your current directory.
`git_status` 模組顯示用來表示現在資料夾之中儲存庫狀態的符號。
### 選項
| Option | 預設 | 說明 |
| ------------ | --------------------------------------------- | ----------------------------------- |
| `format` | `"[\[$all_status$ahead_behind\]]($style) "` | The default format for `git_status` |
| `conflicted` | `"="` | This branch has merge conflicts. |
| `conflicted` | `"="` | 這個分支有合併衝突。 |
| `ahead` | `"⇡"` | The format of `ahead` |
| `behind` | `"⇣"` | The format of `behind` |
| `diverged` | `"⇕"` | The format of `diverged` |
@ -1080,7 +1080,7 @@ The `git_status` module shows symbols representing the state of the repo in your
| `renamed` | `"»"` | The format of `renamed` |
| `deleted` | `"✘"` | The format of `deleted` |
| `style` | `"bold red"` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `git_status` module. |
| `disabled` | `false` | 停用 `git_status` 模組。 |
### Variables
@ -1133,6 +1133,7 @@ deleted = "🗑"
```
Show ahead/behind count of the branch being tracked
```toml
# ~/.config/starship.toml
@ -1144,16 +1145,16 @@ behind = "⇣${count}"
## Golang
The `golang` module shows the currently installed version of Golang. 這個模組在下列其中一個條件達成時顯示：
`golang` 模組顯示現在安裝的 Golang 版本。 這個模組在下列其中一個條件達成時顯示：
- The current directory contains a `go.mod` file
- The current directory contains a `go.sum` file
- The current directory contains a `glide.yaml` file
- The current directory contains a `Gopkg.yml` file
- The current directory contains a `Gopkg.lock` file
- 現在資料夾中含有一個 `go.mod` 檔案
- 現在資料夾中含有一個 `go.sum` 檔案
- 現在資料夾中含有一個 `glide.yaml` 檔案
- 現在資料夾中含有一個 `Gopkg.yml` 檔案
- 現在資料夾中含有一個 `Gopkg.lock` 檔案
- The current directory contains a `.go-version` file
- The current directory contains a `Godeps` directory
- The current directory contains a file with the `.go` extension
- 現在資料夾中含有一個 `Godeps` 資料夾
- 現在資料夾中含有一個檔案具有 `.go` 副檔名
### 選項
@ -1162,7 +1163,7 @@ The `golang` module shows the currently installed version of Golang. 這個模
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
| `style` | `"bold cyan"` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `golang` module. |
| `disabled` | `false` | 停用 `golang` 模組。 |
### Variables
@ -1187,7 +1188,7 @@ format = "via [🏎💨 $version](bold cyan) "
The `helm` module shows the currently installed version of Helm. 這個模組在下列其中一個條件達成時顯示：
- The current directory contains a `helmfile.yaml` file
- 現在資料夾中包含一個 `helmfile.yaml` 檔案
- The current directory contains a `Chart.yaml` file
### 選項
@ -1218,19 +1219,19 @@ The `helm` module shows the currently installed version of Helm. 這個模組在
format = "via [⎈ $version](bold white) "
```
## Hostname
## 主機名稱
The `hostname` module shows the system hostname.
`hostname` 模組顯示系統的主機名稱。
### 選項
| Option | 預設 | 說明 |
| ---------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `ssh_only` | `true` | Only show hostname when connected to an SSH session. |
| `trim_at` | `"."` | String that the hostname is cut off at, after the first match. `"."` will stop after the first dot. `""` will disable any truncation |
| `format` | `"[$hostname]($style) in "` | The format for the module. |
| `style` | `"bold dimmed green"` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `hostname` module. |
| Option | 預設 | 說明 |
| ---------- | --------------------------- | ---------------------------------------------------------- |
| `ssh_only` | `true` | 只在連接到一個 SSH session 時顯示主機名稱。 |
| `trim_at` | `"."` | 擷取出主機名稱的斷點，以第一個符合的為準。 `"."` 會讓它停在第一個點的符號。 `""` 會停用任何的截斷功能。 |
| `format` | `"[$hostname]($style) in "` | The format for the module. |
| `style` | `"bold dimmed green"` | 這個模組的風格。 |
| `disabled` | `false` | 停用 `hostname` 模組。 |
### Variables
@ -1255,7 +1256,7 @@ disabled = false
## Java
The `java` module shows the currently installed version of Java. 這個模組在下列其中一個條件達成時顯示：
`java` 模組顯示現在安裝的 Java 版本。 這個模組在下列其中一個條件達成時顯示：
- The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt` or `.java-version` file
- The current directory contains a file with the `.java`, `.class`, `.gradle` or `.jar` extension
@ -1267,7 +1268,7 @@ The `java` module shows the currently installed version of Java. 這個模組在
| `format` | `"via [${symbol}${version}]($style) "` | The format for the module. |
| `symbol` | `"☕ "` | A format string representing the symbol of Java |
| `style` | `"red dimmed"` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `java` module. |
| `disabled` | `false` | 停用 `java` 模組。 |
### Variables
@ -1288,19 +1289,19 @@ The `java` module shows the currently installed version of Java. 這個模組在
symbol = "🌟 "
```
## Jobs
## 工作
The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists.
`jobs` 模組顯示現在正在執行中的工作。 這個模組只會在有背景工作正在執行時顯示。 這個模組會在工作數量超過一個，或者有設定 `threshold` 時且數量超過設定值時，顯示工作的數量。
### 選項
| Option | 預設 | 說明 |
| ----------- | ----------------------------- | ------------------------------------------------ |
| `threshold` | `1` | Show number of jobs if exceeded. |
| `threshold` | `1` | 在超過指定值時顯示工作數量。 |
| `format` | `"[$symbol$number]($style) "` | The format for the module. |
| `symbol` | `"✦"` | A format string representing the number of jobs. |
| `style` | `"bold blue"` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `jobs` module. |
| `disabled` | `false` | 停用 `jobs` 模組。 |
### Variables
@ -1364,7 +1365,7 @@ Displays the current Kubernetes context name and, if set, the namespace from the
::: tip
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
這個模組預設是停用的。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。
:::
@ -1402,15 +1403,15 @@ disabled = false
"dev.local.cluster.k8s" = "dev"
```
## Line Break
## 換行
The `line_break` module separates the prompt into two lines.
`line_break` 模組將提示字元分成兩行。
### 選項
| Option | 預設 | 說明 |
| ---------- | ------- | ------------------------------------------------------------------ |
| `disabled` | `false` | Disables the `line_break` module, making the prompt a single line. |
| Option | 預設 | 說明 |
| ---------- | ------- | ----------------------------- |
| `disabled` | `false` | 停用 `line_break` 模組，讓提示字元變成一行。 |
### 範例
@ -1421,27 +1422,27 @@ The `line_break` module separates the prompt into two lines.
disabled = true
```
## Memory Usage
## 記憶體使用量
The `memory_usage` module shows current system memory and swap usage.
`memory_usage` 模組顯示現在系統記憶體與 swap 的使用量。
By default the swap usage is displayed if the total system swap is non-zero.
預設 swap 使用量會在系統總 swap 使用量不為 0 時顯示出來。
::: tip
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
這個模組預設是停用的。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。
:::
### 選項
| Option | 預設 | 說明 |
| ----------- | --------------------------------------------- | -------------------------------------------------------- |
| `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"` | 這個模組的風格。 |
| `disabled` | `true` | Disables the `memory_usage` module. |
| Option | 預設 | 說明 |
| ----------- | --------------------------------------------- | -------------------------- |
| `threshold` | `75` | 將記憶體使用量隱藏，除非使用量超過指定值。 |
| `format` | `"via $symbol [${ram}( | ${swap})]($style) "` | The format for the module. |
| `symbol` | `"🐏"` | 顯示在記憶體使用量之前的符號。 |
| `style` | `"bold dimmed white"` | 這個模組的風格。 |
| `disabled` | `true` | 停用 `memory_usage` 模組。 |
### Variables
@ -1483,7 +1484,7 @@ The `hg_branch` module shows the active branch of the repo in your current direc
| `style` | `"bold purple"` | 這個模組的風格。 |
| `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. |
| `truncation_symbol` | `"…"` | 用來指示分支名稱被縮減的符號。 |
| `disabled` | `true` | Disables the `hg_branch` module. |
### Variables
@ -1511,7 +1512,7 @@ truncation_symbol = ""
The `nim` module shows the currently installed version of Nim. 這個模組在下列其中一個條件達成時顯示：
- The current directory contains a `nim.cfg` file
- 現在資料夾中包含一個 `nim.cfg` 檔案
- 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
@ -1547,7 +1548,7 @@ symbol = "🎣 "
## Nix-shell
The `nix_shell` module shows the nix-shell environment. The module will be shown when inside a nix-shell environment.
`nix_shell` 模組顯示 nix-shell 環境。 這個模組會在 nix-shell 環境中顯示。
### 選項
@ -1558,7 +1559,7 @@ The `nix_shell` module shows the nix-shell environment. The module will be shown
| `style` | `"bold blue"` | 這個模組的風格。 |
| `impure_msg` | `"impure"` | A format string shown when the shell is impure. |
| `pure_msg` | `"pure"` | A format string shown when the shell is pure. |
| `disabled` | `false` | Disables the `nix_shell` module. |
| `disabled` | `false` | 停用 `nix_shell` 模組。 |
### Variables
@ -1585,11 +1586,11 @@ format = "via [☃️ $state( \\($name\\))](bold blue) "
## NodeJS
The `nodejs` module shows the currently installed version of NodeJS. 這個模組在下列其中一個條件達成時顯示：
`nodejs` 模組顯示現在安裝的 NodeJS 版本。 這個模組在下列其中一個條件達成時顯示：
- The current directory contains a `package.json` file
- 現在資料夾中包含一個 `package.json` 檔案
- The current directory contains a `.node-version` file
- The current directory contains a `node_modules` directory
- 現在資料夾中包含一個 `node_modules` 資料夾
- The current directory contains a file with the `.js`, `.mjs` or `.cjs` extension
- The current directory contains a file with the `.ts` extension
@ -1600,7 +1601,7 @@ The `nodejs` module shows the currently installed version of NodeJS. 這個模
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"⬢ "` | A format string representing the symbol of NodeJS. |
| `style` | `"bold green"` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `nodejs` module. |
| `disabled` | `false` | 停用 `nodejs` 模組。 |
###  Variables
@ -1621,13 +1622,13 @@ The `nodejs` module shows the currently installed version of NodeJS. 這個模
format = "via [🤖 $version](bold green) "
```
## Package Version
## 套件版本
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages.
The `package` 模組在現在資料夾是一個套件的儲藏庫時出現，並顯示他的現在版本。 The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages.
- **npm** – The `npm` package version is extracted from the `package.json` present in the current directory
- **cargo** – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
- **poetry** – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
- **npm** – `npm` 套件的版本是從現在資料夾中的 `package.json` 之中擷取出來的
- **cargo** – `cargo` 套件的版本是從現在資料夾中的 `Cargo.toml` 之中擷取出來的
- **poetry** – `poetry` 套件的版本是從現在資料夾中的 `pyproject.toml` 之中擷取出來的
- **composer** – The `composer` package version is extracted from the `composer.json` present in the current directory
- **gradle** – The `gradle` package version is extracted from the `build.gradle` present
- **julia** - The package version is extracted from the `Project.toml` present
@ -1639,13 +1640,13 @@ The `package` module is shown when the current directory is the repository for a
### 選項
| Option | 預設 | 說明 |
| ----------------- | ---------------------------------- | ---------------------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"📦 "` | The symbol used before displaying the version the package. |
| `style` | `"bold 208"` | 這個模組的風格。 |
| `display_private` | `false` | Enable displaying version for packages marked as private. |
| `disabled` | `false` | Disables the `package` module. |
| Option | 預設 | 說明 |
| ----------------- | ---------------------------------- | --------------------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"📦 "` | 顯示在套件的版本之前的符號。 |
| `style` | `"bold 208"` | 這個模組的風格。 |
| `display_private` | `false` | Enable displaying version for packages marked as private. |
| `disabled` | `false` | 停用 `package` 模組。 |
### Variables
@ -1745,7 +1746,7 @@ format = "via [🦪 $version]($style) "
The `php` module shows the currently installed version of PHP. 這個模組在下列其中一個條件達成時顯示：
- The current directory contains a `composer.json` file
- 現在資料夾中包含一個 `composer.json` 檔案
- The current directory contains a `.php-version` file
- The current directory contains a `.php` file
@ -1785,13 +1786,13 @@ If `pyenv_version_name` is set to `true`, it will display the pyenv version name
這個模組在下列其中一個條件達成時顯示：
- The current directory contains a `.python-version` file
- The current directory contains a `requirements.txt` file
- The current directory contains a `pyproject.toml` file
- 目前資料夾中有一個 `.python-version` 檔案
- 目前資料夾中有一個 `requirements.txt` 檔案
- 目前資料夾中有一個 `pyproject.toml` 檔案
- The current directory contains a file with the `.py` extension (and `scan_for_pyfiles` is true)
- The current directory contains a `Pipfile` file
- The current directory contains a `tox.ini` file
- The current directory contains a `setup.py` file
- 目前資料夾中有一個 `Pipfile` 檔案
- 目前資料夾中有一個 `tox.ini` 檔案
- 現在資料夾中包含一個 `setup.py` 檔案
- The current directory contains a `__init__.py` file
- A virtual environment is currently activated
@ -1802,10 +1803,10 @@ If `pyenv_version_name` is set to `true`, it will display the pyenv version name
| `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"` | 這個模組的風格。 |
| `pyenv_version_name` | `false` | Use pyenv to get Python version |
| `pyenv_version_name` | `false` | 使用 pyenv 取得 Python 的版本。 |
| `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. |
| `disabled` | `false` | Disables the `python` module. |
| `disabled` | `false` | 停用 `python` 模組。 |
### Variables
@ -1847,11 +1848,11 @@ pyenv_version_name = true
## Ruby
The `ruby` module shows the currently installed version of Ruby. 這個模組在下列其中一個條件達成時顯示：
`ruby` 模組顯示現在安裝的 Ruby 版本。 這個模組在下列其中一個條件達成時顯示：
- The current directory contains a `Gemfile` file
- 目前資料夾中有一個 `Gemfile` 檔案
- The current directory contains a `.ruby-version` file
- The current directory contains a `.rb` file
- 目前資料夾中有一個 `.rb` 檔案
### 選項
@ -1860,7 +1861,7 @@ The `ruby` module shows the currently installed version of Ruby. 這個模組在
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"💎 "` | A format string representing the symbol of Ruby. |
| `style` | `"bold red"` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `ruby` module. |
| `disabled` | `false` | 停用 `ruby` 模組。 |
### Variables
@ -1883,10 +1884,10 @@ symbol = "🔺 "
## Rust
The `rust` module shows the currently installed version of Rust. 這個模組在下列其中一個條件達成時顯示：
`rust` 模組顯示現在安裝的 Rust 版本。 這個模組在下列其中一個條件達成時顯示：
- The current directory contains a `Cargo.toml` file
- The current directory contains a file with the `.rs` extension
- 目前資料夾中有一個 `Cargo.toml` 檔案
- 現在資料夾中包含一個檔案具有 `.rs` 副檔名
### 選項
@ -1895,7 +1896,7 @@ The `rust` module shows the currently installed version of Rust. 這個模組在
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"🦀 "` | A format string representing the symbol of Rust |
| `style` | `"bold red"` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `rust` module. |
| `disabled` | `false` | 停用 `rust` 模組。 |
### Variables
@ -2024,7 +2025,7 @@ The `status` module displays the exit code of the previous command. The module w
::: tip
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. :::
這個模組預設是停用的。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 :::
### 選項
@ -2035,7 +2036,6 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| `style` | `"bold red"` | 這個模組的風格。 |
| `disabled` | `true` | Disables the `status` module. |
### Variables
| 變數 | 範例 | 說明 |
@ -2046,8 +2046,8 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
\*: This variable can only be used as a part of a style string
### 範例
```toml
# ~/.config/starship.toml
@ -2107,35 +2107,35 @@ format = "[🏎💨 $version$workspace]($style) "
format = "[🏎💨 $workspace]($style) "
```
## Time
## 時間
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.
`time` 模組顯示目前的**當地**時間. `format` 設定值被 [`chrono`](https://crates.io/crates/chrono) crate 用來控制時間如何顯示。 請看 [chrono 的 strftime 文件](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html)來了解有那些選項可以使用。
::: tip
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
這個模組預設是停用的。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。
:::
### 選項
| Option | 預設 | 說明 |
| ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `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 &lt; x &lt; 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 |
| Option | 預設 | 說明 |
| ----------------- | ----------------------- | ----------------------------------------------------------------------------------------------------- |
| `format` | `"at [$time]($style) "` | The format string for the module. |
| `use_12hr` | `false` | 啟用 12 小時格式。 |
| `time_format` | 請看下列 | 用來顯示時間的 [chrono 格式字串](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html)。 |
| `style` | `"bold yellow"` | 這個模組的時間的風格。 |
| `utc_time_offset` | `"local"` | 設定相對於 UTC 的時差。 Range from -24 &lt; x &lt; 24. 允許使用浮點數來表示 30/45 分鐘時差的時區。 |
| `disabled` | `true` | 停用 `time` 模組。 |
| `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format |
If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Otherwise, it defaults to `"%T"`. Manually setting `time_format` will override the `use_12hr` setting.
If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. 不然的話，它會被預設為 `"%T"`。 Manually setting `time_format` will override the `use_12hr` setting.
### Variables
| 變數 | 範例 | 說明 |
| --------- | ---------- | ----------------------------------- |
| time | `13:08:10` | The current time. |
| 時間 | `13:08:10` | The current time. |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
@ -2153,24 +2153,24 @@ utc_time_offset = "-5"
time_range = "10:00:00-14:00:00"
```
## Username
## 使用者名稱
The `username` module shows active user's username. 這個模組在下列其中一個條件達成時顯示：
`username` 模組顯示現在使用中的使用者名稱。 這個模組在下列其中一個條件達成時顯示：
- 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
- 目前使用者為 root
- 目前使用者並非登入時的使用者
- 使用者透過 SSH session 進行連線
- 變數 `show_always` 被設為 true
### 選項
| Option | 預設 | 說明 |
| ------------- | ----------------------- | ------------------------------------- |
| `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. |
| Option | 預設 | 說明 |
| ------------- | ----------------------- | -------------------------- |
| `style_root` | `"bold red"` | 使用者為 root 時使用的風格。 |
| `style_user` | `"bold yellow"` | 非 root 使用者時使用的風格。 |
| `format` | `"[$user]($style) in "` | The format for the module. |
| `show_always` | `false` | 總是顯示 `username` 模組。 |
| `disabled` | `false` | 停用 `username` 模組。 |
### Variables
@ -2262,7 +2262,7 @@ The order in which custom modules are shown can be individually set by including
| `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`. |
| `說明` | `"<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. |
@ -2331,7 +2331,7 @@ shell = ["pwsh.exe", "-NoProfile", "-Command", "-"]
The `purescript` module shows the currently installed version of PureScript version. 這個模組在下列其中一個條件達成時顯示：
- The current directory contains a `spago.dhall` file
- 現在資料夾中包含一個 `spago.dhall` 檔案
- The current directory contains a \*.purs files
### 選項

10
docs/zh-TW/migrating-to-0.45.0/README.md
View File

@ -123,7 +123,7 @@ error_symbol = "[✖](bold red) "
++ format = "took [$duration]($style)"
```
#### Directory
#### 資料夾
| Removed Property | Replacement |
| ---------------- | ----------- |
@ -134,10 +134,10 @@ error_symbol = "[✖](bold red) "
```diff
[directory]
-- prefix = "in "
++ format = "[$path]($style)[$lock_symbol]($lock_style)"
++ format = "[$path]($style)[$read_only]($read_only_style)"
```
#### Environment Variable
#### 環境變數
| Removed Property | Replacement |
| ---------------- | ----------- |
@ -200,7 +200,7 @@ diverged = "⇕⇡${ahead_count}⇣${behind_count}"
behind = "⇣${count}"
```
#### Hostname
#### 主機名稱
| Removed Property | Replacement |
| ---------------- | ----------- |
@ -233,7 +233,7 @@ behind = "⇣${count}"
++ format = "[$symbol\\[$env\\]]($style) "
```
#### Time
#### 時間
| Removed Property | Replacement |
| ---------------- | ------------- |