utilities/starship
utilities/starship
1
0
Fork 0
mirror of https://github.com/starship/starship synced 2024-09-15 22:10:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs(i18n): Update documentation translations (#575)

Browse source
This commit is contained in:
Matan Kushner 2019-11-02 20:12:46 +09:00 committed by GitHub
parent 42f6868e3f
commit d30a2c2705
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
16 changed files with 519 additions and 393 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
docs/de-DE/advanced-config/README.md
View file

@ -61,7 +61,7 @@ Um die Funktion dauerhaft zu machen, schreiben Sie diese in die Shell-Konfigurat
## Style-Strings
Style strings are a list of words, separated by whitespace. The words are not case sensitive (i.e. `bold` and `BoLd` are considered the same string). Each word can be one of the following:
Style strings are a list of words, separated by whitespace. The words are not case sensitive (i.e. `bold` and `BoLd` are considered the same string). Jedes Wort kann eines der folgenden sein:
- `bold`
- `underline`
@ -71,14 +71,14 @@ Style strings are a list of words, separated by whitespace. The words are not ca
- `<color>`
- `none`
where `<color>` is a color specifier (discussed below). `fg:<color>` and `<color>` currently do the same thing , though this may change in the future. The order of words in the string does not matter.
where `<color>` is a color specifier (discussed below). `fg:<color>` and `<color>` currently do the same thing , though this may change in the future. Die Reihenfolge der Wörter in der Zeichenkette spielt keine Rolle.
The `none` token overrides all other tokens in a string, so that e.g. `fg:red none fg:blue` will still create a string with no styling. It may become an error to use `none` in conjunction with other tokens in the future.
A color specifier can be one of the following:
- One of the standard terminal colors: `black`, `red`, `green`, `blue`, `yellow`, `purple`, `cyan`, `white`. You can optionally prefix these with `bright-` to get the bright version (e.g. `bright-white`).
- A `#` followed by a six-digit hexadecimal number. This specifies an [RGB color hex code](https://www.w3schools.com/colors/colors_hexadecimal.asp).
- A number between 0-255. This specifies an [8-bit ANSI Color Code](https://i.stack.imgur.com/KTSQa.png).
- Eine `#` gefolgt von einer sechsstelligen Hexadezimalnummer. This specifies an [RGB color hex code](https://www.w3schools.com/colors/colors_hexadecimal.asp).
- Eine Zahl zwischen 0-255. This specifies an [8-bit ANSI Color Code](https://i.stack.imgur.com/KTSQa.png).
If multiple colors are specified for foreground/background, the last one in the string will take priority.

128
docs/de-DE/config/README.md
View file

@ -29,11 +29,11 @@ disabled = true
### Terminologie
**Module**: Eine Komponente in der Konsole, die auf kontextualisierte Informationen des OS basiert. Zum Beispiel das "nodejs" Modul zeigt die version von NodeJS, die derzeit auf deinem Rechner installiert ist, wenn dein Arbeitsordner ein NodeJS Projekt umfasst.
**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.
**Segment**: Kleinere Sub-Komponente die ein Modul ergeben. Zum Beispiel, das "symbol" Segment im "nodejs" Modul beinhaltet das Symbol das vor der Versionsnummer gezeigt wird (Standard: ⬢).
**Segment**: Kleinere Unterkomponenten, die ein Modul erstellen. Zum Beispiel, das "symbol" Segment im "nodejs" Modul beinhaltet das Symbol das vor der Versionsnummer gezeigt wird (Standard: ⬢).
Hier ist die Darstellung des Node Moduls. Im folgenden Beispiel betrachten wir die Segmente "symbol" und "version". Jedes Modul hat auch einen Prefix und einen Suffix, das auf die Standardfarbe des Terminals gesetzt ist.
Hier eine Darstellung des Node-Moduls. Im folgenden Beispiel betrachten wir die Segmente "symbol" und "version". Jedes Modul hat einen Präfix und einen Suffix, welche auf die Standardfarbe des Terminals gesetzt sind.
```
[prefix] [symbol] [version] [suffix]
@ -42,16 +42,16 @@ Hier ist die Darstellung des Node Moduls. Im folgenden Beispiel betrachten wir d
### Style-Strings
Die meisten Module in starship lassen dich den Darstellungsstil verändern. Dies passiert meistens an einem bestimmten Eintrag (gewöhnlich `style` genannt), der einen String mit den Einstellungen darstellt. Es folgen ein paar Beispiele für solche Strings zusammen mit Beschreibungen was sie bewirken. Details zur vollen Syntax findest du im [Erweiterten Einstellungshandbuch](/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
- `"bold fg:27"` setzt dicke Schrift auf [ANSI Farbe](https://i.stack.imgur.com/KTSQa.png) 27
- `"underline bg:#bf5700"` setzt unterstrichenen Text auf einen orangenen Hintergrund
- `"bold italic fg:purple"` setzt dicke Kursivschrift lila
- `""` deativiert explizit jeden Stil
- `"bold italic fg:purple"` setzt dicke lila Kursivschrift
- `""` deaktiviert explizit jeden Stil
Wie genau sich diese Konfiguration auswirkt liegt an deinem Shell Emulator. Einige Emulatoren zum Beispiel werden die Farben erhellen statt Text dick zu machen, und ein paar Farbthemata benutzen dieselben werte für normale und helle Farben. Für kursiven Text muss dein Terminal Kursivschrift unterstützen.
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.
## Prompt
@ -63,22 +63,24 @@ Dies ist eine Liste mit Prompt-weiten Konfigurationsoptionen.
| -------------- | ----------------------------- | ------------------------------------------------------------------ |
| `add_newline` | `true` | Neuer Zeilenumbruch bei Start des Prompts. |
| `prompt_order` | [link](#default-prompt-order) | Stelle die Reihenfolge ein, in der die Module den prompt aufbauen. |
| `scan_timeout` | `30` | Timeout for starship to scan files (in milliseconds). |
### Beispiel
```toml
# ~/.config/starship.toml
# Kein Zeilenumbruch am Anfang der Eingabe
# Disable the newline at the start of the prompt
add_newline = false
# Überscheibt die Standard-Reihenfolge und nutzt die folgende
# Overwrite a default_prompt_order and use custom prompt_order
prompt_order=["rust","line_break","package","line_break","character"]
# Wait 10 milliseconds for starship to check files under the current directory.
scan_timeout = 10
```
### Default Promp Order
### Standard-Promptreihenfolge
Die Standard `prompt_order` wird benutzt um die Reihenfolge der Module im Prompt zu definieren, falls `prompt_order` leer oder nicht gesetzt ist. Der default sieht wie folgt aus:
Die Standard `prompt_order` wird benutzt um die Reihenfolge der Module im Prompt zu definieren, falls `prompt_order` leer oder nicht gesetzt ist. Die Standardwerte sind folgende:
```toml
prompt_order = [
@ -117,11 +119,11 @@ Das `aws`-Modul zeigt das aktuelle AWS-Profil an. Dies basiert auf den Umgebungs
### Optionen
| Variable | Standardwert | Beschreibung |
| ---------- | --------------- | ------------------------------------------------------------------- |
| `symbol` | `"☁️ "` | Symbol das vor der Anzahl des aktuellen AWS-Profils angezeigt wird. |
| `style` | `"bold yellow"` | Stil für dieses Modul. |
| `disabled` | `false` | Deaktiviert das `aws`-Modul. |
| Variable | Standardwert | Beschreibung |
| ---------- | --------------- | ------------------------------------------------------- |
| `symbol` | `"☁️ "` | Symbol das vor dem aktuellen AWS-Profil angezeigt wird. |
| `style` | `"bold yellow"` | Stil für dieses Modul. |
| `disabled` | `false` | Deaktiviert das `aws`-Modul. |
### Beispiel
@ -148,9 +150,9 @@ Das `battery` Modul zeigt, wie hoch der Akku des Geräts geladen ist und den akt
| `disabled` | `false` | Wenn der Wert auf `true` steht, wird das Akkustand-Modul deaktiviert. |
<details>
<summary>Das Batterie-Modul unterstützt auch einige ungewöhnliche Zustände.</summary>
<summary>Das Batterie-Modul unterstützt auch einige untypische Zustände.</summary>
| Variable | Description |
| Variable | Beschreibung |
| ---------------- | --------------------------------------------------- |
| `unknown_symbol` | The symbol shown when the battery state is unknown. |
| `empty_symbol` | The symbol shown when the battery state is empty. |
@ -172,7 +174,7 @@ discharging_symbol = "💀"
### Anzeige des Akkustandes
Die `display` Konfiguration "threshold" stellt ein ab wann die Akkuanzeige eingeblendet wird. Mit "style" wird das Erscheinungsbild festgelegt. Wenn `display` nicht angegeben ist. Werden die folgenden Standardwerte verwendet:
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]]
@ -235,7 +237,7 @@ use_symbol_for_status = true
## 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 <0>cmd_duration</0> angezeigt wird.
::: warning Nicht die DEBUG-trap in der Bash hooken
@ -436,25 +438,39 @@ cherry_pick = "🍒 PICKING"
The `git_status` module shows symbols representing the state of the repo in your current directory.
### Options
### Optionen
| Variable | Standardwert | Beschreibung |
| ------------------ | -------------------------- | ------------------------------------------------------- |
| `conflicted` | `"="` | This branch has merge conflicts. |
| `conflicted_count` | [link](#git-status-counts) | Show and style the number of conflicts. |
| `ahead` | `"⇡"` | This branch is ahead of the branch being tracked. |
| `behind` | `"⇣"` | This branch is behind of the branch being tracked. |
| `diverged` | `"⇕"` | This branch has diverged from the branch being tracked. |
| `untracked` | `"?"` | There are untracked files in the working directory. |
| `untracked_count` | [link](#git-status-counts) | Show and style the number of untracked files. |
| `stashed` | `"$"` | A stash exists for the local repository. |
| `modified` | `"!"` | There are file modifications in the working directory. |
| `modified_count` | [link](#git-status-counts) | Show and style the number of modified files. |
| `staged` | `"+"` | A new file has been added to the staging area. |
| `staged_count` | [link](#git-status-counts) | Show and style the number of files staged files. |
| `renamed` | `"»"` | A renamed file has been added to the staging area. |
| `renamed_count` | [link](#git-status-counts) | Show and style the number of renamed files. |
| `deleted` | `"✘"` | A file's deletion has been added to the staging area. |
| `deleted_count` | [link](#git-status-counts) | Show and style the number of deleted files. |
| `show_sync_count` | `false` | Show ahead/behind count of the branch being tracked. |
| `prefix` | `[` | Prefix to display immediately before git status. |
| `suffix` | `]` | Suffix to display immediately after git status. |
| `style` | `"bold red"` | Stil für dieses Modul. |
| `disabled` | `false` | Deaktiviert das `git_status`-Modul. |
#### Git Status Counts
| Variable | Standardwert | Beschreibung |
| --------- | ------------ | ------------------------------------------------------ |
| `enabled` | `false` | Show the number of files |
| `style` | | Optionally style the count differently than the module |
| Variable | Standardwert | Beschreibung |
| ----------------- | ------------ | ------------------------------------------------------- |
| `conflicted` | `"="` | This branch has merge conflicts. |
| `ahead` | `"⇡"` | This branch is ahead of the branch being tracked. |
| `behind` | `"⇣"` | This branch is behind of the branch being tracked. |
| `diverged` | `"⇕"` | This branch has diverged from the branch being tracked. |
| `untracked` | `"?"` | There are untracked files in the working directory. |
| `stashed` | `"$"` | A stash exists for the local repository. |
| `modified` | `"!"` | There are file modifications in the working directory. |
| `staged` | `"+"` | A new file has been added to the staging area. |
| `renamed` | `"»"` | A renamed file has been added to the staging area. |
| `deleted` | `"✘"` | A file's deletion has been added to the staging area. |
| `show_sync_count` | `false` | Show ahead/behind count of the branch being tracked. |
| `prefix` | `[` | Prefix to display immediately before git status. |
| `suffix` | `]` | Suffix to display immediately after git status. |
| `style` | `"bold red"` | Stil für dieses Modul. |
| `disabled` | `false` | Deaktiviert das `git_status`-Modul. |
### Beispiel
@ -469,7 +485,10 @@ diverged = "😵"
untracked = "🤷‍"
stashed = "📦"
modified = "📝"
staged = "➕"
staged.value = "++"
staged.style = "green"
staged_count.enabled = true
staged_count.style = "green"
renamed = "👅"
deleted = "🗑"
```
@ -515,8 +534,8 @@ Das `hostname`-Modul zeigt den Hostnamen des Systems an.
| `prefix` | `""` | Prefix der unmittelbar vor dem Hostnamen angezeigt wird. |
| `suffix` | `""` | Suffix der unmittelbar nach dem Hostnamen angezeigt wird. |
| `trim_at` | `"."` | String that the hostname is cut off at, after the first match. `"."` will stop after the first dot. `""` will disable any truncation |
| `style` | `"bold dimmed green"` | The style for the module. |
| `disabled` | `false` | Disables the `hostname` module. |
| `style` | `"bold dimmed green"` | Stil für dieses Modul. |
| `disabled` | `false` | Deaktiviert das `hostname`-Modul. |
### Beispiel
@ -554,11 +573,9 @@ symbol = "+ "
threshold = 4
```
## Kubernetes
Displays the current Kubernetes context name and, if set, the namespace from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via `kubectl config set-context starship-cluster --namespace
astronaut`. If the `$KUBECONFIG` env var is set the module will use that if not it will use the `~/.kube/config`.
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
@ -585,7 +602,6 @@ style = "dim green"
disabled = false
```
## Zeilenumbruch
Das `line_break`-Modul unterteilt den Prompt in zwei Zeilen.
@ -669,7 +685,7 @@ style = "bold dimmed green"
## Java
The `java` module shows the currently installed version of Java. The module will be shown if any of the following conditions are met:
Das `java` Modul zeigt die derzeit installierte Version von Java an. Das Modul wird nur dann angezeigt, wenn eine der folgenden Bedingungen zutrifft:
- The current directory contains a `pom.xml`, `build.gradle` or `build.sbt` file
- The current directory contains a file with the `.java`, `.class` or `.jar` extension
@ -693,9 +709,9 @@ symbol = "🌟 "
## NodeJS
The `nodejs` module shows the currently installed version of NodeJS. The module will be shown if any of the following conditions are met:
Das `nodejs` Modul zeigt die derzeit installierte Version von NodeJS. Das Modul wird nur dann angezeigt, wenn eine der folgenden Bedingungen zutrifft:
- The current directory contains a `package.json` file
- Das aktuelle Verzeichnis enthält eine `package.json`-Datei
- The current directory contains a `node_modules` directory
- The current directory contains a file with the `.js` extension
@ -751,14 +767,14 @@ If `pyenv_version_name` is set to `true`, it will display the pyenv version name
Otherwise, it will display the version number from `python --version` and show the current Python virtual environment if one is activated.
The module will be shown if any of the following conditions are met:
Das Modul wird nur dann angezeigt, wenn eine der folgenden Bedingungen zutrifft:
- 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 `requirements.txt`-Datei
- Das aktuelle Verzeichnis enthält eine `pyproject.toml`-Datei
- The current directory contains a file with the `.py` extension
- The current directory contains a `Pipfile` file
- The current directory contains a `tox.ini` file
- Das aktuelle Verzeichnis enthält eine `tox.ini`-Datei
### Optionen
@ -783,7 +799,7 @@ pyenv_prefix = "foo "
## Ruby
The `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met:
The `ruby` module shows the currently installed version of Ruby. Das Modul wird nur dann angezeigt, wenn eine der folgenden Bedingungen zutrifft:
- The current directory contains a `Gemfile` file
- The current directory contains a `.rb` file
@ -807,7 +823,7 @@ symbol = "🔺 "
## Rust
The `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met:
The `rust` module shows the currently installed version of Rust. Das Modul wird nur dann angezeigt, wenn eine der folgenden Bedingungen zutrifft:
- The current directory contains a `Cargo.toml` file
- The current directory contains a file with the `.rs` extension
@ -843,7 +859,7 @@ Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `dis
| Variable | Standardwert | Beschreibung |
| ----------------- | ------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `12hr` | `false` | Aktiviert die Formatierung der Uhrzeit im 12-Stunden-Format. |
| `use_12hr` | `false` | Aktiviert die Formatierung der Uhrzeit im 12-Stunden-Format. |
| `format` | Siehe unten | Das Format zum Anzeigen der Uhrzeit in [chrono-Formatierung](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html). |
| `style` | `bold yellow` | Stil für dieses Modul. |
| `disabled` | `true` | Deaktiviert das `time`-Modul. |

10
docs/de-DE/guide/README.md
View file

@ -20,12 +20,12 @@
<a href="#contributors">
<img
src="https://badgen.net/badge/all%20contributors/42/orange"
alt="All Contributors" /></a>
alt="Alle Mitwirkenden" /></a>
<!-- ALL-CONTRIBUTORS-BADGE:END -->
<a href="https://discord.gg/8Jzqu3T"
><img
src="https://badgen.net/badge/chat/on%20discord/7289da"
alt="Chat on Discord" /></a>
alt="Auf Discord chatten" /></a>
</p>
<h4 align="center">
@ -123,7 +123,7 @@
```
#### Rust (v1.38 oder höher)
#### Rust (v1.38 oder neuer)
```sh
$ cargo install starship
@ -290,6 +290,10 @@ Danke an diese wunderbaren Leute ([emoji-Schlüssel](https://allcontributors.org
</tr>
<tr>
<td align="center"><a href="https://github.com/CSumm"><img src="https://avatars1.githubusercontent.com/u/31711543?v=4" width="100px;" alt="Carl Summers" /><br /><sub><b>Carl Summers</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=CSumm" title="Documentation">📖</a></td>
<td align="center"><a href="http://www.slmt.tw"><img src="https://avatars2.githubusercontent.com/u/6824412?v=4" width="100px;" alt="Yushan Lin" /><br /><sub><b>Yushan Lin</b></sub></a><br /><a href="#translation-SLMT" title="Translation">🌍</a></td>
<td align="center"><a href="https://weihanglo.tw"><img src="https://avatars2.githubusercontent.com/u/14314532?v=4" width="100px;" alt="Weihang Lo" /><br /><sub><b>Weihang Lo</b></sub></a><br /><a href="#translation-weihanglo" title="Translation">🌍</a></td>
<td align="center"><a href="https://github.com/pinshan"><img src="https://avatars0.githubusercontent.com/u/7709675?v=4" width="100px;" alt="pinshan" /><br /><sub><b>pinshan</b></sub></a><br /><a href="#translation-pinshan" title="Translation">🌍</a></td>
<td align="center"><a href="https://github.com/brianlow"><img src="https://avatars2.githubusercontent.com/u/938138?v=4" width="100px;" alt="Brian Low" /><br /><sub><b>Brian Low</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=brianlow" title="Code">💻</a> <a href="https://github.com/starship/starship/commits?author=brianlow" title="Documentation">📖</a> <a href="https://github.com/starship/starship/commits?author=brianlow" title="Tests">⚠️</a></td>
</tr>
</table>

22
docs/fr-FR/README.md
View file

@ -9,15 +9,15 @@ footer: ISC licencié | Copyright © 2019-present Starship Contributors
<div class="features">
<div class="feature">
<h2>Compatibilité d'abord</h2>
<p>Works on the most common shells on the most common operating systems. Use it everywhere!</p>
<p>Fonctionne sur tous les principaux shells et système d'exploitation. Utilisez-le partout !</p>
</div>
<div class="feature">
<h2>Rust-Powered</h2>
<p>Brings the best-in-class speed and safety of Rust, to make your prompt as quick and reliable as possible.</p>
<h2>Propulsé par Rust</h2>
<p>Profiter de toute la rapidité et la securité de Rust, pour rendre votre prompt le plus rapide et fiable possible.</p>
</div>
<div class="feature">
<h2>Customizable</h2>
<p>Every little detail is customizable to your liking, to make this prompt as minimal or feature-rich as you'd like it to be.</p>
<h2>Personnalisable</h2>
<p>Tous les petits détails sont personnalisable à votre goût, pour rendre votre prompt aussi léger ou complet que le vous souhaitez.</p>
</div>
</div>
@ -28,11 +28,11 @@ footer: ISC licencié | Copyright © 2019-present Starship Contributors
</video>
</div>
### Quick Install
### Installation
1. Install the **starship** binary:
1. Installer le binaire **starship** :
**[Download archives of precompiled binaries](https://github.com/starship/starship/releases)** if you don't use the platforms below.
**[Télécharger les archives des binaires précompilés](https://github.com/starship/starship/releases)** si vous n'utilisez pas une des plateformes citées ci-dessous.
#### Homebrew
@ -42,7 +42,7 @@ footer: ISC licencié | Copyright © 2019-present Starship Contributors
```
#### Rust (v1.38 or higher)
#### Rust (v1.38 ou plus)
```sh
$ cargo install starship
@ -51,14 +51,14 @@ footer: ISC licencié | Copyright © 2019-present Starship Contributors
#### Arch Linux (AUR)
Starship is available on the AUR under the name `starship`. Install it with `yay` or your favorite AUR helper.
Starship is disponible sur AUR sous le nom `starship`. Installer le avec `yay` ou votre client AUR favori.
```sh
$ yay -S starship
```
#### Nix (unstable)
#### Nix (non stable)
```sh
$ nix-env --install starship

73
docs/fr-FR/config/README.md
View file

@ -40,7 +40,7 @@ Voici la représentation du module node. Dans l'exemple suivant, "symbol" et "ve
"via " "⬢" "v10.4.1" ""
```
### Style Strings
### 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/).
@ -63,6 +63,7 @@ This is the list of prompt-wide configuration options.
| -------------- | ----------------------------- | ------------------------------------------------------ |
| `add_newline` | `true` | Add a new line before the start of the prompt. |
| `prompt_order` | [link](#default-prompt-order) | Configure the order in which the prompt module occurs. |
| `scan_timeout` | `30` | Timeout for starship to scan files (in milliseconds). |
### Example
@ -73,6 +74,8 @@ This is the list of prompt-wide configuration options.
add_newline = false
# Overwrite a default_prompt_order and use custom prompt_order
prompt_order=["rust","line_break","package","line_break","character"]
# Wait 10 milliseconds for starship to check files under the current directory.
scan_timeout = 10
```
### Default Prompt Order
@ -118,7 +121,7 @@ The `aws` module shows the current AWS region and profile. This is based on `AWS
| Variable | Default | Description |
| ---------- | --------------- | ---------------------------------------------------------- |
| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
| `style` | `"bold yellow"` | The style for the module. |
| `disabled` | `false` | Disables the `AWS` module. |
@ -437,23 +440,37 @@ The `git_status` module shows symbols representing the state of the repo in your
### Options
| Variable | Default | Description |
| ----------------- | ------------ | ------------------------------------------------------- |
| `conflicted` | `"="` | This branch has merge conflicts. |
| `ahead` | `"⇡"` | This branch is ahead of the branch being tracked. |
| `behind` | `"⇣"` | This branch is behind of the branch being tracked. |
| `diverged` | `"⇕"` | This branch has diverged from the branch being tracked. |
| `untracked` | `"?"` | There are untracked files in the working directory. |
| `stashed` | `"$"` | A stash exists for the local repository. |
| `modified` | `"!"` | There are file modifications in the working directory. |
| `staged` | `"+"` | A new file has been added to the staging area. |
| `renamed` | `"»"` | A renamed file has been added to the staging area. |
| `deleted` | `"✘"` | A file's deletion has been added to the staging area. |
| `show_sync_count` | `false` | Show ahead/behind count of the branch being tracked. |
| `prefix` | `[` | Prefix to display immediately before git status. |
| `suffix` | `]` | Suffix to display immediately after git status. |
| `style` | `"bold red"` | The style for the module. |
| `disabled` | `false` | Disables the `git_status` module. |
| Variable | Default | Description |
| ------------------ | -------------------------- | ------------------------------------------------------- |
| `conflicted` | `"="` | This branch has merge conflicts. |
| `conflicted_count` | [link](#git-status-counts) | Show and style the number of conflicts. |
| `ahead` | `"⇡"` | This branch is ahead of the branch being tracked. |
| `behind` | `"⇣"` | This branch is behind of the branch being tracked. |
| `diverged` | `"⇕"` | This branch has diverged from the branch being tracked. |
| `untracked` | `"?"` | There are untracked files in the working directory. |
| `untracked_count` | [link](#git-status-counts) | Show and style the number of untracked files. |
| `stashed` | `"$"` | A stash exists for the local repository. |
| `modified` | `"!"` | There are file modifications in the working directory. |
| `modified_count` | [link](#git-status-counts) | Show and style the number of modified files. |
| `staged` | `"+"` | A new file has been added to the staging area. |
| `staged_count` | [link](#git-status-counts) | Show and style the number of files staged files. |
| `renamed` | `"»"` | A renamed file has been added to the staging area. |
| `renamed_count` | [link](#git-status-counts) | Show and style the number of renamed files. |
| `deleted` | `"✘"` | A file's deletion has been added to the staging area. |
| `deleted_count` | [link](#git-status-counts) | Show and style the number of deleted files. |
| `show_sync_count` | `false` | Show ahead/behind count of the branch being tracked. |
| `prefix` | `[` | Prefix to display immediately before git status. |
| `suffix` | `]` | Suffix to display immediately after git status. |
| `style` | `"bold red"` | The style for the module. |
| `disabled` | `false` | Disables the `git_status` module. |
#### Git Status Counts
| Variable | Default | Description |
| --------- | ------- | ------------------------------------------------------ |
| `enabled` | `false` | Show the number of files |
| `style` | | Optionally style the count differently than the module |
### Example
@ -468,7 +485,10 @@ diverged = "😵"
untracked = "🤷‍"
stashed = "📦"
modified = "📝"
staged = "➕"
staged.value = "++"
staged.style = "green"
staged_count.enabled = true
staged_count.style = "green"
renamed = "👅"
deleted = "🗑"
```
@ -553,13 +573,11 @@ symbol = "+ "
threshold = 4
```
## Kubernetes
Displays the current Kubernetes context name and, if set, the namespace from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via `kubectl config set-context starship-cluster --namespace
astronaut`. If the `$KUBECONFIG` env var is set the module will use that if not it will use the `~/.kube/config`.
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
::: remarque
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
@ -584,7 +602,6 @@ style = "dim green"
disabled = false
```
## Line Break
The `line_break` module separates the prompt into two lines.
@ -636,7 +653,7 @@ The `memory_usage` module shows current system memory and swap usage.
By default the swap usage is displayed if the total system swap is non-zero.
::: tip
::: remarque
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
@ -832,7 +849,7 @@ symbol = "⚙️ "
The `time` module shows the current **local** time. The `format` configuration value is used by the [`chrono`](https://crates.io/crates/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) to see what options are available.
::: tip
::: remarque
This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
@ -842,7 +859,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| Variable | Default | Description |
| ----------------- | ------------- | ------------------------------------------------------------------------------------------------------------------- |
| `12hr` | `false` | Enables 12 hour formatting |
| `use_12hr` | `false` | Enables 12 hour formatting |
| `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 |
| `disabled` | `true` | Disables the `time` module. |

4
docs/fr-FR/guide/README.md
View file

@ -290,6 +290,10 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
</tr>
<tr>
<td align="center"><a href="https://github.com/CSumm"><img src="https://avatars1.githubusercontent.com/u/31711543?v=4" width="100px;" alt="Carl Summers" /><br /><sub><b>Carl Summers</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=CSumm" title="Documentation">📖</a></td>
<td align="center"><a href="http://www.slmt.tw"><img src="https://avatars2.githubusercontent.com/u/6824412?v=4" width="100px;" alt="Yushan Lin" /><br /><sub><b>Yushan Lin</b></sub></a><br /><a href="#translation-SLMT" title="Translation">🌍</a></td>
<td align="center"><a href="https://weihanglo.tw"><img src="https://avatars2.githubusercontent.com/u/14314532?v=4" width="100px;" alt="Weihang Lo" /><br /><sub><b>Weihang Lo</b></sub></a><br /><a href="#translation-weihanglo" title="Translation">🌍</a></td>
<td align="center"><a href="https://github.com/pinshan"><img src="https://avatars0.githubusercontent.com/u/7709675?v=4" width="100px;" alt="pinshan" /><br /><sub><b>pinshan</b></sub></a><br /><a href="#translation-pinshan" title="Translation">🌍</a></td>
<td align="center"><a href="https://github.com/brianlow"><img src="https://avatars2.githubusercontent.com/u/938138?v=4" width="100px;" alt="Brian Low" /><br /><sub><b>Brian Low</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=brianlow" title="Code">💻</a> <a href="https://github.com/starship/starship/commits?author=brianlow" title="Documentation">📖</a> <a href="https://github.com/starship/starship/commits?author=brianlow" title="Tests">⚠️</a></td>
</tr>
</table>

2
docs/ja-JP/README.md
View file

@ -109,7 +109,7 @@ footer: ISC Licensed | Copyright © 2019-present Starship Contributors
#### Powershell
Add the following to the end of `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` (or `~/.config/powershell/Microsoft.PowerShell_profile.ps1` on -Nix):
`~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` (それか Nix上の `~/.config/powershell/Microsoft.PowerShell_profile.ps1` )の末尾に以下を追加してください。
```sh
# ~\Documents\PowerShell\Profile.ps1

109
docs/ja-JP/config/README.md
View file

@ -59,20 +59,23 @@ Starshipのほとんどのモジュールでは、表示スタイルを設定で
### オプション
| 変数 | デフォルト | 説明 |
| -------------- | ----------------------- | ------------------------ |
| `add_newline` | `true` | プロンプトの開始前に新しい行を追加します。 |
| `prompt_order` | [link](#デフォルトのプロンプト表示順) | プロンプトモジュールを出力する順序を設定します。 |
| 変数 | デフォルト | 説明 |
| -------------- | ----------------------- | ----------------------------------------------------- |
| `add_newline` | `true` | プロンプトの開始前に新しい行を追加します。 |
| `prompt_order` | [link](#デフォルトのプロンプト表示順) | プロンプトモジュールを出力する順序を設定します。 |
| `scan_timeout` | `30` | Timeout for starship to scan files (in milliseconds). |
### 設定例
```toml
# ~/.config/starship.toml
# プロンプト表示の改行を無効にする
# Disable the newline at the start of the prompt
add_newline = false
# デフォルトのプロンプト表示順を書き換える
# Overwrite a default_prompt_order and use custom prompt_order
prompt_order=["rust","line_break","package","line_break","character"]
# Wait 10 milliseconds for starship to check files under the current directory.
scan_timeout = 10
```
### デフォルトのプロンプト表示順
@ -112,13 +115,13 @@ prompt_order = [
## 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/config` に記述されている `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` 環境変数に基づいています。
### オプション
| 変数 | デフォルト | 説明 |
| ---------- | --------------- | ----------------------------- |
| `symbol` | `"☁️ "` | 現在のAWSプロファイルを表示する前に表示される記号です。 |
| `symbol` | `"☁️ "` | 現在のAWSプロファイルを表示する前に表示される記号です。 |
| `style` | `"bold yellow"` | モジュールのスタイルです。 |
| `disabled` | `false` | `aws`モジュールを無効にします。 |
@ -266,7 +269,7 @@ prefix = "underwent "
## Conda
`$CONDA_DEFAULT_ENV`が設定されている場合、`conda`モジュールは現在のcondaの環境を表示します。 Note: This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`
`$CONDA_DEFAULT_ENV`が設定されている場合、`conda`モジュールは現在のcondaの環境を表示します。 Note: これはconda自身の プロンプト修飾子 を抑制しません。`conda config --set changeps1 False` で実行することができます。
### オプション
@ -331,12 +334,12 @@ This module will only be shown in your prompt when one of the following files ar
### オプション
| 変数 | デフォルト | 説明 |
| ----------- | ------------- | ----------------------------------------------------- |
| `symbol` | `•NET "` | dotnetのバージョンを表示する前に使用される記号です。 |
| `style` | `"bold blue"` | モジュールのスタイルです。 |
| `heuristic` | `true` | Use faster version detection to keep starship snappy. |
| `disabled` | `false` | `dotnet`モジュールを無効にします。 |
| 変数 | デフォルト | 説明 |
| ----------- | ------------- | ------------------------------------ |
| `symbol` | `•NET "` | dotnetのバージョンを表示する前に使用される記号です。 |
| `style` | `"bold blue"` | モジュールのスタイルです。 |
| `heuristic` | `true` | より高速なバージョン検出を使用して、starshipの動作を維持します。 |
| `disabled` | `false` | `dotnet`モジュールを無効にします。 |
### 設定例
@ -438,23 +441,37 @@ cherry_pick = "🍒 PICKING"
### オプション
| 変数 | デフォルト | 説明 |
| ----------------- | ------------ | ------------------------------ |
| `conflicted` | `"="` | このブランチにはマージの競合があります。 |
| `ahead` | `"⇡"` | このブランチは、追跡されるブランチよりも先にあります。 |
| `behind` | `"⇣"` | このブランチは、追跡されているブランチの背後にあります。 |
| `diverged` | `"⇕"` | このブランチは、追跡されているブランチから分岐しています。 |
| `untracked` | `"?"` | 作業ディレクトリに追跡されていないファイルがあります。 |
| `stashed` | `"$"` | ローカルリポジトリ用のスタッシュが存在します。 |
| `modified` | `"!"` | 作業ディレクトリにファイルの変更があります。 |
| `staged` | `"+"` | 新しいファイルがステージング領域に追加されました。 |
| `renamed` | `"»"` | 名前が変更されたファイルがステージング領域に追加されました。 |
| `deleted` | `"✘"` | ファイルの削除がステージング領域に追加されました。 |
| `show_sync_count` | `false` | 追跡されているブランチの先行/後方カウントを表示します。 |
| `prefix` | `[` | このモジュールの先頭に表示される文字列です。 |
| `suffix` | `]` | このモジュールの末尾に表示される文字列です。 |
| `style` | `"bold red"` | モジュールのスタイルです。 |
| `disabled` | `false` | `git_status`モジュールを無効にします。 |
| 変数 | デフォルト | 説明 |
| ------------------ | -------------------------- | ------------------------------------------------ |
| `conflicted` | `"="` | このブランチにはマージの競合があります。 |
| `conflicted_count` | [link](#git-status-counts) | Show and style the number of conflicts. |
| `ahead` | `"⇡"` | このブランチは、追跡されるブランチよりも先にあります。 |
| `behind` | `"⇣"` | このブランチは、追跡されているブランチの背後にあります。 |
| `diverged` | `"⇕"` | このブランチは、追跡されているブランチから分岐しています。 |
| `untracked` | `"?"` | 作業ディレクトリに追跡されていないファイルがあります。 |
| `untracked_count` | [link](#git-status-counts) | Show and style the number of untracked files. |
| `stashed` | `"$"` | ローカルリポジトリ用のスタッシュが存在します。 |
| `modified` | `"!"` | 作業ディレクトリにファイルの変更があります。 |
| `modified_count` | [link](#git-status-counts) | Show and style the number of modified files. |
| `staged` | `"+"` | 新しいファイルがステージング領域に追加されました。 |
| `staged_count` | [link](#git-status-counts) | Show and style the number of files staged files. |
| `renamed` | `"»"` | 名前が変更されたファイルがステージング領域に追加されました。 |
| `renamed_count` | [link](#git-status-counts) | Show and style the number of renamed files. |
| `deleted` | `"✘"` | ファイルの削除がステージング領域に追加されました。 |
| `deleted_count` | [link](#git-status-counts) | Show and style the number of deleted files. |
| `show_sync_count` | `false` | 追跡されているブランチの先行/後方カウントを表示します。 |
| `prefix` | `[` | このモジュールの先頭に表示される文字列です。 |
| `suffix` | `]` | このモジュールの末尾に表示される文字列です。 |
| `style` | `"bold red"` | モジュールのスタイルです。 |
| `disabled` | `false` | `git_status`モジュールを無効にします。 |
#### Git Status Counts
| 変数 | デフォルト | 説明 |
| --------- | ------- | ------------------------------------------------------ |
| `enabled` | `false` | Show the number of files |
| `style` | | Optionally style the count differently than the module |
### 設定例
@ -469,7 +486,10 @@ diverged = "😵"
untracked = "🤷‍"
stashed = "📦"
modified = "📝"
staged = "➕"
staged.value = "++"
staged.style = "green"
staged_count.enabled = true
staged_count.style = "green"
renamed = "👅"
deleted = "🗑"
```
@ -554,11 +574,9 @@ symbol = "+ "
threshold = 4
```
## Kubernetes
現在のKubernetesコンテキスト名と、設定されている場合は、kubeconfigファイルに基づいてネームスペースを表示します。 ネームスペースはkubeconfigファイルで設定する必要があります。`kubectl config set-context starship-cluster --namespace
astronaut`。 `$KUBECONFIG` 環境変数が設定されている場合、モジュールはそれを使用します `~/.kube/config` は使用しません。
現在のKubernetesコンテキスト名と、設定されている場合は、kubeconfigファイルに基づいてネームスペースを表示します。 The namespace needs to be set in the kubeconfig file, this can be done via `kubectl config set-context starship-cluster --namespace astronaut`. `$KUBECONFIG` 環境変数が設定されている場合、モジュールはそれを使用します `~/.kube/config` は使用しません。
::: tip
@ -585,7 +603,6 @@ style = "dim green"
disabled = false
```
## 改行
`line_break`モジュールは、プロンプトを2行に分割します。
@ -842,15 +859,15 @@ symbol = "⚙️ "
### オプション
| 変数 | デフォルト | 説明 |
| ----------------- | ------------- | ------------------------------------------------------------------------------------------------------------------- |
| `12hr` | `false` | Enables 12 hour formatting |
| `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 |
| `disabled` | `true` | Disables the `time` module. |
| `utc_time_offset` | `local` | Sets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. |
| 変数 | デフォルト | 説明 |
| ----------------- | -------------- | ---------------------------------------------------------------------------------------------------------------- |
| `use_12hr` | `false` | 12時間のフォーマットを有効にします。 |
| `format` | この表の下を参照してください | 時刻のフォーマットに使用される[クロノフォーマット文字列](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) です。 |
| `style` | `bold yellow` | モジュールのスタイルです。 |
| `disabled` | `true` | `time`モジュールを無効にします。 |
| `utc_time_offset` | `local` | Sets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. |
`use_12hr`が`true`の場合、`format`のデフォルトは`"%r"`です。 それ以外の場合、デフォルトは`"%T"`です。 Manually setting `format` will override the `use_12hr` setting.
`use_12hr`が`true`の場合、`format`のデフォルトは`"%r"`です。 それ以外の場合、デフォルトは`"%T"`です。 `format`を手動で設定すると、`use_12hr`の設定が上書きされます。
### 設定例
@ -874,7 +891,7 @@ utc_time_offset = -5
### オプション
| Variable | Default | Description |
| 変数 | デフォルト | 説明 |
| ------------- | --------------- | ------------------------- |
| `style_root` | `"bold red"` | ユーザーがrootのときに使用されるスタイルです。 |
| `style_user` | `"bold yellow"` | 非rootユーザーに使用されるスタイルです。 |

12
docs/ja-JP/guide/README.md
View file

@ -101,7 +101,7 @@
- 閾値を超えた際の、コマンドの実行時間
- バックグラウンドジョブのインジケーター (`✦`)
- 現在のKubernetesクラスタとネームスペース (`☸`)
- Current AWS profile (`☁️`)
- 現在のAWSプロファイル (`☁️`)
## 🚀 インストール
@ -153,9 +153,9 @@
```
#### Other x86-64 Linux Platforms
#### 他の x86-64 Linux プラットフォーム
Download a prebuilt binary and place in /usr/local/bin/
ビルド済みのバイナリをダウンロードして、/usr/local/bin/ に配置します
```sh
$ wget -q --show-progress https://github.com/starship/starship/releases/latest/download/starship-x86_64-unknown-linux-gnu.tar.gz
@ -201,7 +201,7 @@
#### Powershell
Add the following to the end of `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` (or `~/.config/powershell/Microsoft.PowerShell_profile.ps1` on -Nix):
`~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` (それか Nix上の `~/.config/powershell/Microsoft.PowerShell_profile.ps1` )の末尾に以下を追加してください。
```sh
# ~\Documents\PowerShell\Profile.ps1
@ -290,6 +290,10 @@ Starship の設定方法の詳細に関しては、[ドキュメント](https://
</tr>
<tr>
<td align="center"><a href="https://github.com/CSumm"><img src="https://avatars1.githubusercontent.com/u/31711543?v=4" width="100px;" alt="Carl Summers" /><br /><sub><b>Carl Summers</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=CSumm" title="Documentation">📖</a></td>
<td align="center"><a href="http://www.slmt.tw"><img src="https://avatars2.githubusercontent.com/u/6824412?v=4" width="100px;" alt="Yushan Lin" /><br /><sub><b>Yushan Lin</b></sub></a><br /><a href="#translation-SLMT" title="Translation">🌍</a></td>
<td align="center"><a href="https://weihanglo.tw"><img src="https://avatars2.githubusercontent.com/u/14314532?v=4" width="100px;" alt="Weihang Lo" /><br /><sub><b>Weihang Lo</b></sub></a><br /><a href="#translation-weihanglo" title="Translation">🌍</a></td>
<td align="center"><a href="https://github.com/pinshan"><img src="https://avatars0.githubusercontent.com/u/7709675?v=4" width="100px;" alt="pinshan" /><br /><sub><b>pinshan</b></sub></a><br /><a href="#translation-pinshan" title="Translation">🌍</a></td>
<td align="center"><a href="https://github.com/brianlow"><img src="https://avatars2.githubusercontent.com/u/938138?v=4" width="100px;" alt="Brian Low" /><br /><sub><b>Brian Low</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=brianlow" title="Code">💻</a> <a href="https://github.com/starship/starship/commits?author=brianlow" title="Documentation">📖</a> <a href="https://github.com/starship/starship/commits?author=brianlow" title="Tests">⚠️</a></td>
</tr>
</table>

2
docs/ru-RU/advanced-config/README.md
View file

@ -59,7 +59,7 @@ precmd_functions+=(set_win_title)
If you like the result, add these lines to your shell configuration file (`~/.bashrc` or `~/.zsrhc`) to make it permanent.
## Style Strings
## Стиль строк
Style strings are a list of words, separated by whitespace. The words are not case sensitive (i.e. `bold` and `BoLd` are considered the same string). Each word can be one of the following:

353
docs/ru-RU/config/README.md
View file

@ -1,83 +1,86 @@
# Configuration
# Конфигурация
::: tip
🔥 Configuration is currently being worked on. Many new configuration options will be available in coming releases.
🔥 Конфигурация все еще находится в стадии разработки. Много новых опций будут доступны в будущих версиях.
:::
To get started configuring starship, create the following file: `~/.config/starship.toml`.
Чтобы начать конфигурацию Starship, создайте следующий файл: `~/.config/starship.toml`.
```shell
$ 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
# Не добавлять пустую строку в начале ввода
add_newline = false
# Replace the "❯" symbol in the prompt with "➜"
[character] # The name of the module we are configuring is "character"
symbol = "➜" # The "symbol" segment is being set to "➜"
# Поменять символ "❯" на символ "➜"
[character] # Имя настраемого модуля - "character"
symbol = "➜" # Сегменту "symbol" присваеваем значение "➜"
# Disable the package module, hiding it from the prompt completely
# Отключить модуль пакетов, полностью скрывая его из терминала
[package]
disabled = true
```
### 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.
**Модуль**: Компонент строки, дающий информацию на основе контекстной информации вашей ОС. Например, модуль "nodejs" показывает установленную версию NodeJS на вашем компьютере, если вы находитесь в директории проекта NodeJS.
**Segment**: Smaller sub-components that compose a module. For example, the "symbol" segment in the "nodejs" module contains the character that is shown before the version number (⬢ by default).
**Сегмент**: Меньшие подкомпоненты, составляющие модуль. Например, сегмент "symbol" в модуле "nodejs" хранит символ, показываемый перед версией NodeJS (⬢, по умолчанию).
Here is the representation of the node module. In the following example, "symbol" and "version" are segments within it. Every module also has a prefix and suffix that are the default terminal color.
Вот представление модуля "nodejs". В примере, "symbol" и "version" - его сегменты. Также, каждый модуль имеет префикс и суффикс, являющиеся цветом терминала по умолчанию.
```
[prefix] [symbol] [version] [suffix]
"via " "⬢" "v10.4.1" ""
```
### 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/).
В Starship, большинство модулей позволяют настроить стили отображения. Это делается записью (обычно называется `style`), которая представляет собой строку, определяющую конфигурацию. Ниже приведены несколько примеров стилей строк, а также, их действия. Подробнее о полном синтаксисе можно прочитать в [расширенном разделе конфигурации](/advanced-config/).
- `"fg:green bg:blue"` sets green text on a blue background
- `"bg:blue fg:bright-green"` sets bright green text on a blue background
- `"bold fg:27"` sets bold text with [ANSI color](https://i.stack.imgur.com/KTSQa.png) 27
- `"underline bg:#bf5700"` sets underlined text on a burnt orange background
- `"bold italic fg:purple"` sets bold italic purple text
- `""` explicitly disables all styling
- `"fg:green bg:blue"` устанавливает зеленый текст на синем фоне
- `"bg:blue fg:bright-green"` устанавливает ярко-зеленый текст на синем фоне
- `"bold fg:27"` устанавливает жирный текст с [цветом ANSI](https://i.stack.imgur.com/KTSQa.png) 27
- `"underline bg:#bf5700"` устанавливает подчёркиваемый текст цвета сожженного апельсина
- `"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.
Обратите внимание на то, что, вид стиля зависит от вашего эмулятора терминала. Например, некоторые эмуляторы терминала будут использовать яркие цвета вместо жирного текста, и некоторые цветовые темы используют одинаковые значение для обычных и ярких цветов. Также, чтобы получить курсивный текст, ваш терминал должен поддерживать курсив.
## Prompt
## Командная строка
This is the list of prompt-wide configuration options.
Ниже находится список опций, применяющихся для всей командной строки.
### Options
### Опции
| Variable | Default | Description |
| -------------- | ----------------------------- | ------------------------------------------------------ |
| `add_newline` | `true` | Add a new line before the start of the prompt. |
| `prompt_order` | [link](#default-prompt-order) | Configure the order in which the prompt module occurs. |
| Переменная | По умолчанию | Описание |
| -------------- | ----------------------------- | -------------------------------------------------------- |
| `add_newline` | `true` | Добавление пустой строки перед началом командной строки. |
| `prompt_order` | [link](#default-prompt-order) | Настройка порядка появления модулей командной строки. |
| `scan_timeout` | `30` | Тайм-аут запуска сканирования файлов (в миллисекундах). |
### Example
### Пример
```toml
# ~/.config/starship.toml
# Disable the newline at the start of the prompt
# Не добавлять пустую строку перед началом командной строки
add_newline = false
# Overwrite a default_prompt_order and use custom prompt_order
# Перезаписать default_prompt_order и использовать пользовательский prompt_order
prompt_order=["rust","line_break","package","line_break","character"]
# Ждать 10 миллисекунд перед запуском сканирования файлов.
scan_timeout = 10
```
### Default Prompt Order
### Порядок модулей командной строки по умолчанию
The default `prompt_order` is used to define the order in which modules are shown in the prompt, if empty or no `prompt_order` is provided. The default is as shown:
По умолчанию, `prompt_order` определеят порядок появления модулей командной строки, если `prompt_order` пустой или не объявлен. Значение по умолчанию:
```toml
prompt_order = [
@ -112,17 +115,17 @@ prompt_order = [
## 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`.
### Options
### Опции
| Variable | Default | Description |
| ---------- | --------------- | ---------------------------------------------------------- |
| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
| `style` | `"bold yellow"` | The style for the module. |
| `disabled` | `false` | Disables the `AWS` module. |
| Переменная | По умолчанию | Описание |
| ---------- | --------------- | ----------------------------------------------- |
| `symbol` | `"☁️ "` | Символ перед отображением текущего профиля AWS. |
| `style` | `"bold yellow"` | Стиль модуля. |
| `disabled` | `false` | Отключает модуль `AWS`. |
### Example
### Пример
```toml
# ~/.config/starship.toml
@ -132,24 +135,24 @@ style = "bold blue"
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%.
Модуль `battery` показывает насколько заряжена батарея девайса и статус зарядки на данный момент. Модуль виден только, если заряд батареи устройства меньше 10%.
### Options
### Опции
| Variable | Default | Description |
| -------------------- | ------------------------ | ------------------------------------------------- |
| `full_symbol` | `"•"` | The symbol shown when the battery is full. |
| `charging_symbol` | `"⇡"` | The symbol shown when the battery is charging. |
| `discharging_symbol` | `"⇣"` | The symbol shown when the battery is discharging. |
| `display` | [link](#battery-display) | Display threshold and style for the module. |
| `disabled` | `false` | Disables the `battery` module. |
| Переменная | По умолчанию | Описание |
| -------------------- | ------------------------ | ----------------------------------------------- |
| `full_symbol` | `"•"` | Символ, отображаемый при полной батарее. |
| `charging_symbol` | `"⇡"` | Символ, показываемый при зарядке аккумулятора. |
| `discharging_symbol` | `"⇣"` | Символ, показываемый при разрядке аккумулятора. |
| `display` | [link](#battery-display) | Порог отображения и стиль для модуля. |
| `disabled` | `false` | Отключает модуль `battery`. |
<details>
<summary>There are also options for some uncommon battery states.</summary>
<summary>Также, есть опции для некоторых нетипичных состояний батареи.</summary>
| Variable | Description |
| Переменная | Описание |
| ---------------- | --------------------------------------------------- |
| `unknown_symbol` | The symbol shown when the battery state is unknown. |
| `empty_symbol` | The symbol shown when the battery state is empty. |
@ -158,7 +161,7 @@ Note: Battery indicator will be hidden if the status is `unknown` or `empty` unl
</details>
### Example
### Пример
```toml
# ~/.config/starship.toml
@ -169,9 +172,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` используется для определения того, когда индикатор батареи должен быть показан (threshhold) и как он выглядит (style). Если `display` не предоставлено. Значение по умолчанию:
```toml
[[battery.display]]
@ -179,16 +182,16 @@ threshold = 10
style = "bold red"
```
#### Options
#### Опции
The `display` option is an array of the following table.
| Variable | Description |
| Переменная | Описание |
| ----------- | ----------------------------------------------- |
| `threshold` | The upper bound for the display option. |
| `style` | The style used if the display option is in use. |
#### Example
#### Пример
```toml
[[battery.display]] # "bold red" style when capacity is between 0% and 10%
@ -209,9 +212,9 @@ The `character` module shows a character (usually an arrow) beside where the tex
The character will tell you whether the last command was successful or not. It can do this in two ways: by changing color (red/green) or by changing its shape (❯/✖). The latter will only be done if `use_symbol_for_status` is set to `true`.
### Options
### Опции
| Variable | Default | Description |
| Переменная | По умолчанию | Описание |
| ----------------------- | -------------- | ----------------------------------------------------------------------------------- |
| `symbol` | `"❯"` | The symbol used before the text input in the prompt. |
| `error_symbol` | `"✖"` | The symbol used before text input if the previous command failed. |
@ -221,7 +224,7 @@ The character will tell you whether the last command was successful or not. It c
| `style_failure` | `"bold red"` | The style used if the last command failed. |
| `disabled` | `false` | Disables the `character` module. |
### Example
### Пример
```toml
# ~/.config/starship.toml
@ -244,16 +247,16 @@ If you are running Starship in `bash`, do not hook the `DEBUG` trap after runnin
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.
### Options
### Опции
| Variable | Default | Description |
| Переменная | По умолчанию | Описание |
| ---------- | --------------- | ---------------------------------------------------------- |
| `min_time` | `2` | Shortest duration to show time for. |
| `prefix` | `took` | Prefix to display immediately before the command duration. |
| `style` | `"bold yellow"` | The style for the module. |
| `disabled` | `false` | Disables the `cmd_duration` module. |
### Example
### Пример
```toml
# ~/.config/starship.toml
@ -267,15 +270,15 @@ prefix = "underwent "
The `conda` module shows the current conda environment, if `$CONDA_DEFAULT_ENV` is set. Note: This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`
### Options
### Опции
| Variable | Default | Description |
| Переменная | По умолчанию | Описание |
| ---------- | -------------- | -------------------------------------------- |
| `symbol` | `"C "` | The symbol used before the environment name. |
| `style` | `"bold green"` | The style for the module. |
| `disabled` | `false` | Disables the `conda` module. |
### Example
### Пример
```toml
# ~/.config/starship.toml
@ -292,9 +295,9 @@ When using the fish style pwd option, instead of hiding the path that is truncat
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`.
### 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. |
@ -304,14 +307,14 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
<details>
<summary>This module has a few advanced configuration options that control how the directory is displayed.</summary>
| Variable | Default | Description |
| --------------------------- | ------- | ---------------------------------------------------------------------------------------- |
| `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. |
| Переменная | По умолчанию | Описание |
| --------------------------- | ------------ | ---------------------------------------------------------------------------------------- |
| `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. |
</details>
### Example
### Пример
```toml
# ~/.config/starship.toml
@ -328,16 +331,16 @@ This module will only be shown in your prompt when one of the following files ar
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.
### Options
### Опции
| Variable | Default | Description |
| Переменная | По умолчанию | Описание |
| ----------- | ------------- | -------------------------------------------------------- |
| `symbol` | `"•NET "` | The symbol used before displaying the version of dotnet. |
| `style` | `"bold blue"` | The style for the module. |
| `heuristic` | `true` | Use faster version detection to keep starship snappy. |
| `disabled` | `false` | Disables the `dotnet` module. |
### Example
### Пример
```toml
# ~/.config/starship.toml
@ -355,19 +358,19 @@ The `env_var` module displays the current value of a selected environment variab
- The `variable` configuration option matches an existing environment variable
- The `variable` configuration option is not defined, but the `default` configuration option is
### Options
### Опции
| Variable | Default | Description |
| ---------- | ---------------- | ---------------------------------------------------------------------------- |
| `symbol` | | The symbol used before displaying the variable value. |
| `variable` | | The environment variable to be displayed. |
| `default` | | The default value to be displayed when the selected variable is not defined. |
| `prefix` | `""` | Prefix to display immediately before the variable value. |
| `suffix` | `""` | Suffix to display immediately after the variable value. |
| `style` | `"dimmed black"` | The style for the module. |
| `disabled` | `false` | Disables the `env_var` module. |
| Переменная | По умолчанию | Описание |
| -------------- | ---------------- | ---------------------------------------------------------------------------- |
| `symbol` | | The symbol used before displaying the variable value. |
| `переменная` | | The environment variable to be displayed. |
| `по умолчанию` | | The default value to be displayed when the selected variable is not defined. |
| `prefix` | `""` | Prefix to display immediately before the variable value. |
| `suffix` | `""` | Suffix to display immediately after the variable value. |
| `style` | `"dimmed black"` | The style for the module. |
| `disabled` | `false` | Disables the `env_var` module. |
### Example
### Пример
```toml
# ~/.config/starship.toml
@ -381,9 +384,9 @@ default = "unknown shell"
The `git_branch` module shows the active branch of the repo in your current directory.
### Options
### Опции
| Variable | Default | Description |
| Переменная | По умолчанию | Описание |
| ------------------- | --------------- | ------------------------------------------------------------------------------------- |
| `symbol` | `" "` | The symbol used before the branch name of the repo in your current directory. |
| `truncation_length` | `2^63 - 1` | Truncates a git branch to X graphemes |
@ -391,7 +394,7 @@ The `git_branch` module shows the active branch of the repo in your current dire
| `style` | `"bold purple"` | The style for the module. |
| `disabled` | `false` | Disables the `git_branch` module. |
### Example
### Пример
```toml
# ~/.config/starship.toml
@ -406,9 +409,9 @@ truncation_symbol = ""
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.
### Options
### Опции
| Variable | Default | Description |
| Переменная | По умолчанию | Описание |
| ------------------ | ------------------ | ---------------------------------------------------------------------------------------------------------------- |
| `rebase` | `"REBASING"` | The text displayed when a `rebase` is in progress. |
| `merge` | `"MERGING"` | The text displayed when a `merge` is in progress. |
@ -421,7 +424,7 @@ The `git_state` module will show in directories which are part of a git reposito
| `style` | `"bold yellow"` | The style for the module. |
| `disabled` | `false` | Disables the `git_state` module. |
### Example
### Пример
```toml
# ~/.config/starship.toml
@ -435,27 +438,41 @@ cherry_pick = "🍒 PICKING"
The `git_status` module shows symbols representing the state of the repo in your current directory.
### Options
### Опции
| Variable | Default | Description |
| ----------------- | ------------ | ------------------------------------------------------- |
| `conflicted` | `"="` | This branch has merge conflicts. |
| `ahead` | `"⇡"` | This branch is ahead of the branch being tracked. |
| `behind` | `"⇣"` | This branch is behind of the branch being tracked. |
| `diverged` | `"⇕"` | This branch has diverged from the branch being tracked. |
| `untracked` | `"?"` | There are untracked files in the working directory. |
| `stashed` | `"$"` | A stash exists for the local repository. |
| `modified` | `"!"` | There are file modifications in the working directory. |
| `staged` | `"+"` | A new file has been added to the staging area. |
| `renamed` | `"»"` | A renamed file has been added to the staging area. |
| `deleted` | `"✘"` | A file's deletion has been added to the staging area. |
| `show_sync_count` | `false` | Show ahead/behind count of the branch being tracked. |
| `prefix` | `[` | Prefix to display immediately before git status. |
| `suffix` | `]` | Suffix to display immediately after git status. |
| `style` | `"bold red"` | The style for the module. |
| `disabled` | `false` | Disables the `git_status` module. |
| Переменная | По умолчанию | Описание |
| ------------------ | -------------------------- | ------------------------------------------------------- |
| `conflicted` | `"="` | This branch has merge conflicts. |
| `conflicted_count` | [link](#git-status-counts) | Show and style the number of conflicts. |
| `ahead` | `"⇡"` | This branch is ahead of the branch being tracked. |
| `behind` | `"⇣"` | This branch is behind of the branch being tracked. |
| `diverged` | `"⇕"` | This branch has diverged from the branch being tracked. |
| `untracked` | `"?"` | There are untracked files in the working directory. |
| `untracked_count` | [link](#git-status-counts) | Show and style the number of untracked files. |
| `stashed` | `"$"` | A stash exists for the local repository. |
| `modified` | `"!"` | There are file modifications in the working directory. |
| `modified_count` | [link](#git-status-counts) | Show and style the number of modified files. |
| `staged` | `"+"` | A new file has been added to the staging area. |
| `staged_count` | [link](#git-status-counts) | Show and style the number of files staged files. |
| `renamed` | `"»"` | A renamed file has been added to the staging area. |
| `renamed_count` | [link](#git-status-counts) | Show and style the number of renamed files. |
| `deleted` | `"✘"` | A file's deletion has been added to the staging area. |
| `deleted_count` | [link](#git-status-counts) | Show and style the number of deleted files. |
| `show_sync_count` | `false` | Show ahead/behind count of the branch being tracked. |
| `prefix` | `[` | Prefix to display immediately before git status. |
| `suffix` | `]` | Suffix to display immediately after git status. |
| `style` | `"bold red"` | The style for the module. |
| `disabled` | `false` | Disables the `git_status` module. |
### Example
#### Git Status Counts
| Переменная | По умолчанию | Описание |
| ---------- | ------------ | ------------------------------------------------------ |
| `enabled` | `false` | Show the number of files |
| `style` | | Optionally style the count differently than the module |
### Пример
```toml
# ~/.config/starship.toml
@ -468,7 +485,10 @@ diverged = "😵"
untracked = "🤷‍"
stashed = "📦"
modified = "📝"
staged = "➕"
staged.value = "++"
staged.style = "green"
staged_count.enabled = true
staged_count.style = "green"
renamed = "👅"
deleted = "🗑"
```
@ -485,15 +505,15 @@ The `golang` module shows the currently installed version of Golang. The module
- The current directory contains a `Godeps` directory
- The current directory contains a file with the `.go` extension
### Options
### Опции
| Variable | Default | Description |
| Переменная | По умолчанию | Описание |
| ---------- | ------------- | -------------------------------------------------------- |
| `symbol` | `"🐹 "` | The symbol used before displaying the version of Golang. |
| `style` | `"bold cyan"` | The style for the module. |
| `disabled` | `false` | Disables the `golang` module. |
### Example
### Пример
```toml
# ~/.config/starship.toml
@ -506,9 +526,9 @@ symbol = "🏎💨 "
The `hostname` module shows the system hostname.
### Options
### Опции
| Variable | Default | Description |
| Переменная | По умолчанию | Описание |
| ---------- | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `ssh_only` | `true` | Only show hostname when connected to an SSH session. |
| `prefix` | `""` | Prefix to display immediately before the hostname. |
@ -517,7 +537,7 @@ The `hostname` module shows the system hostname.
| `style` | `"bold dimmed green"` | The style for the module. |
| `disabled` | `false` | Disables the `hostname` module. |
### Example
### Пример
```toml
# ~/.config/starship.toml
@ -534,16 +554,16 @@ disabled = false
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.
### Options
### Опции
| Variable | Default | Description |
| Переменная | По умолчанию | Описание |
| ----------- | ------------- | ----------------------------------------------------- |
| `symbol` | `"✦"` | The symbol used before displaying the number of jobs. |
| `threshold` | `1` | Show number of jobs if exceeded. |
| `style` | `"bold blue"` | The style for the module. |
| `disabled` | `false` | Disables the `jobs` module. |
### Example
### Пример
```toml
# ~/.config/starship.toml
@ -553,11 +573,9 @@ symbol = "+ "
threshold = 4
```
## Kubernetes
Displays the current Kubernetes context name and, if set, the namespace from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via `kubectl config set-context starship-cluster --namespace
astronaut`. If the `$KUBECONFIG` env var is set the module will use that if not it will use the `~/.kube/config`.
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
@ -565,15 +583,15 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
:::
### Options
### Опции
| Variable | Default | Description |
| Переменная | По умолчанию | Описание |
| ---------- | ------------- | --------------------------------------------------- |
| `symbol` | `"☸ "` | The symbol used before displaying the Cluster info. |
| `style` | `"bold blue"` | The style for the module. |
| `disabled` | `true` | Disables the `kubernetes` module |
### Example
### Пример
```toml
# ~/.config/starship.toml
@ -584,18 +602,17 @@ style = "dim green"
disabled = false
```
## Line Break
The `line_break` module separates the prompt into two lines.
### Options
### Опции
| Variable | Default | Description |
| ---------- | ------- | ------------------------------------------------------------------ |
| `disabled` | `false` | Disables the `line_break` module, making the prompt a single line. |
| Переменная | По умолчанию | Описание |
| ---------- | ------------ | ------------------------------------------------------------------ |
| `disabled` | `false` | Disables the `line_break` module, making the prompt a single line. |
### Example
### Пример
```toml
# ~/.config/starship.toml
@ -608,9 +625,9 @@ disabled = true
The `nix_shell` module shows the nix-shell environment. The module will be shown when inside a nix-shell environment.
### Options
### Опции
| Variable | Default | Description |
| Переменная | По умолчанию | Описание |
| ------------ | ------------ | ---------------------------------- |
| `use_name` | `false` | Display the name of the nix-shell. |
| `impure_msg` | `impure` | Customize the "impure" msg. |
@ -618,7 +635,7 @@ The `nix_shell` module shows the nix-shell environment. The module will be shown
| `style` | `"bold red"` | The style for the module. |
| `disabled` | `false` | Disables the `nix_shell` module. |
### Example
### Пример
```toml
# ~/.config/starship.toml
@ -642,9 +659,9 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
:::
### Options
### Опции
| Variable | Default | Description |
| Переменная | По умолчанию | Описание |
| ----------------- | --------------------- | ------------------------------------------------------------- |
| `show_percentage` | `false` | Display memory usage as a percentage of the available memory. |
| `show_swap` | `true` | Display swap usage if total swap is non-zero. |
@ -653,7 +670,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| `style` | `"bold dimmed white"` | The style for the module. |
| `disabled` | `true` | Disables the `memory_usage` module. |
### Example
### Пример
```toml
# ~/.config/starship.toml
@ -673,15 +690,15 @@ The `java` module shows the currently installed version of Java. The module will
- The current directory contains a `pom.xml`, `build.gradle` or `build.sbt` file
- The current directory contains a file with the `.java`, `.class` or `.jar` extension
### Options
### Опции
| Variable | Default | Description |
| Переменная | По умолчанию | Описание |
| ---------- | -------------- | ------------------------------------------------------ |
| `symbol` | `"☕ "` | The symbol used before displaying the version of Java. |
| `style` | `"dimmed red"` | The style for the module. |
| `disabled` | `false` | Disables the `java` module. |
### Example
### Пример
```toml
# ~/.config/starship.toml
@ -698,15 +715,15 @@ The `nodejs` module shows the currently installed version of NodeJS. The module
- The current directory contains a `node_modules` directory
- The current directory contains a file with the `.js` extension
### Options
### Опции
| Variable | Default | Description |
| Переменная | По умолчанию | Описание |
| ---------- | -------------- | -------------------------------------------------------- |
| `symbol` | `"⬢ "` | The symbol used before displaying the version of NodeJS. |
| `style` | `"bold green"` | The style for the module. |
| `disabled` | `false` | Disables the `nodejs` module. |
### Example
### Пример
```toml
# ~/.config/starship.toml
@ -725,15 +742,15 @@ The `package` module is shown when the current directory is the repository for a
> ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager.
### Options
### Опции
| Variable | Default | Description |
| Переменная | По умолчанию | Описание |
| ---------- | ------------ | ---------------------------------------------------------- |
| `symbol` | `"📦 "` | The symbol used before displaying the version the package. |
| `style` | `"bold red"` | The style for the module. |
| `disabled` | `false` | Disables the `package` module. |
### Example
### Пример
```toml
# ~/.config/starship.toml
@ -759,9 +776,9 @@ The module will be shown if any of the following conditions are met:
- The current directory contains a `Pipfile` file
- The current directory contains a `tox.ini` file
### Options
### Опции
| Variable | Default | Description |
| Переменная | По умолчанию | Описание |
| -------------------- | --------------- | --------------------------------------------------------------------------- |
| `symbol` | `"🐍 "` | The symbol used before displaying the version of Python. |
| `pyenv_version_name` | `false` | Use pyenv to get Python version |
@ -769,7 +786,7 @@ The module will be shown if any of the following conditions are met:
| `style` | `"bold yellow"` | The style for the module. |
| `disabled` | `false` | Disables the `python` module. |
### Example
### Пример
```toml
# ~/.config/starship.toml
@ -787,15 +804,15 @@ The `ruby` module shows the currently installed version of Ruby. The module will
- The current directory contains a `Gemfile` file
- The current directory contains a `.rb` file
### Options
### Опции
| Variable | Default | Description |
| Переменная | По умолчанию | Описание |
| ---------- | ------------ | ------------------------------------------------------ |
| `symbol` | `"💎 "` | The symbol used before displaying the version of Ruby. |
| `style` | `"bold red"` | The style for the module. |
| `disabled` | `false` | Disables the `ruby` module. |
### Example
### Пример
```toml
# ~/.config/starship.toml
@ -811,15 +828,15 @@ The `rust` module shows the currently installed version of Rust. The module will
- The current directory contains a `Cargo.toml` file
- The current directory contains a file with the `.rs` extension
### Options
### Опции
| Variable | Default | Description |
| Переменная | По умолчанию | Описание |
| ---------- | ------------ | ------------------------------------------------------ |
| `symbol` | `"🦀 "` | The symbol used before displaying the version of Rust. |
| `style` | `"bold red"` | The style for the module. |
| `disabled` | `false` | Disables the `rust` module. |
### Example
### Пример
```toml
# ~/.config/starship.toml
@ -838,11 +855,11 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
:::
### Options
### Опции
| Variable | Default | Description |
| Переменная | По умолчанию | Описание |
| ----------------- | ------------- | ------------------------------------------------------------------------------------------------------------------- |
| `12hr` | `false` | Enables 12 hour formatting |
| `use_12hr` | `false` | Enables 12 hour formatting |
| `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 |
| `disabled` | `true` | Disables the `time` module. |
@ -850,7 +867,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
If `use_12hr` is `true`, then `format` defaults to `"%r"`. Otherwise, it defaults to `"%T"`. Manually setting `format` will override the `use_12hr` setting.
### Example
### Пример
```toml
# ~/.config/starship.toml
@ -870,16 +887,16 @@ The `username` module shows active user's username. The module will be shown if
- The user is currently connected as an SSH session
- The variable `show_always` is set to true
### Options
### Опции
| Variable | Default | Description |
| Переменная | По умолчанию | Описание |
| ------------- | --------------- | ------------------------------------- |
| `style_root` | `"bold red"` | The style used when the user is root. |
| `style_user` | `"bold yellow"` | The style used for non-root users. |
| `show_always` | `false` | Always shows the `username` module. |
| `disabled` | `false` | Disables the `username` module. |
### Example
### Пример
```toml
# ~/.config/starship.toml

6
docs/ru-RU/guide/README.md
View file

@ -208,7 +208,7 @@
Invoke-Expression (&starship init powershell)
```
## 🔧 Configuration
## 🔧 Конфигурация
For details on how to configure Starship, check out our [documentation](https://starship.rs/config/).
@ -290,6 +290,10 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
</tr>
<tr>
<td align="center"><a href="https://github.com/CSumm"><img src="https://avatars1.githubusercontent.com/u/31711543?v=4" width="100px;" alt="Carl Summers" /><br /><sub><b>Carl Summers</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=CSumm" title="Documentation">📖</a></td>
<td align="center"><a href="http://www.slmt.tw"><img src="https://avatars2.githubusercontent.com/u/6824412?v=4" width="100px;" alt="Yushan Lin" /><br /><sub><b>Yushan Lin</b></sub></a><br /><a href="#translation-SLMT" title="Translation">🌍</a></td>
<td align="center"><a href="https://weihanglo.tw"><img src="https://avatars2.githubusercontent.com/u/14314532?v=4" width="100px;" alt="Weihang Lo" /><br /><sub><b>Weihang Lo</b></sub></a><br /><a href="#translation-weihanglo" title="Translation">🌍</a></td>
<td align="center"><a href="https://github.com/pinshan"><img src="https://avatars0.githubusercontent.com/u/7709675?v=4" width="100px;" alt="pinshan" /><br /><sub><b>pinshan</b></sub></a><br /><a href="#translation-pinshan" title="Translation">🌍</a></td>
<td align="center"><a href="https://github.com/brianlow"><img src="https://avatars2.githubusercontent.com/u/938138?v=4" width="100px;" alt="Brian Low" /><br /><sub><b>Brian Low</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=brianlow" title="Code">💻</a> <a href="https://github.com/starship/starship/commits?author=brianlow" title="Documentation">📖</a> <a href="https://github.com/starship/starship/commits?author=brianlow" title="Tests">⚠️</a></td>
</tr>
</table>

67
docs/zh-CN/config/README.md
View file

@ -40,7 +40,7 @@ Here is the representation of the node module. In the following example, "symbol
"via " "⬢" "v10.4.1" ""
```
### 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/).
@ -63,6 +63,7 @@ This is the list of prompt-wide configuration options.
| -------------- | ----------------------------- | ------------------------------------------------------ |
| `add_newline` | `true` | Add a new line before the start of the prompt. |
| `prompt_order` | [link](#default-prompt-order) | Configure the order in which the prompt module occurs. |
| `scan_timeout` | `30` | Timeout for starship to scan files (in milliseconds). |
### Example
@ -73,6 +74,8 @@ This is the list of prompt-wide configuration options.
add_newline = false
# Overwrite a default_prompt_order and use custom prompt_order
prompt_order=["rust","line_break","package","line_break","character"]
# Wait 10 milliseconds for starship to check files under the current directory.
scan_timeout = 10
```
### Default Prompt Order
@ -118,7 +121,7 @@ The `aws` module shows the current AWS region and profile. This is based on `AWS
| Variable | Default | Description |
| ---------- | --------------- | ---------------------------------------------------------- |
| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
| `style` | `"bold yellow"` | The style for the module. |
| `disabled` | `false` | Disables the `AWS` module. |
@ -437,23 +440,37 @@ The `git_status` module shows symbols representing the state of the repo in your
### Options
| Variable | Default | Description |
| ----------------- | ------------ | ------------------------------------------------------- |
| `conflicted` | `"="` | This branch has merge conflicts. |
| `ahead` | `"⇡"` | This branch is ahead of the branch being tracked. |
| `behind` | `"⇣"` | This branch is behind of the branch being tracked. |
| `diverged` | `"⇕"` | This branch has diverged from the branch being tracked. |
| `untracked` | `"?"` | There are untracked files in the working directory. |
| `stashed` | `"$"` | A stash exists for the local repository. |
| `modified` | `"!"` | There are file modifications in the working directory. |
| `staged` | `"+"` | A new file has been added to the staging area. |
| `renamed` | `"»"` | A renamed file has been added to the staging area. |
| `deleted` | `"✘"` | A file's deletion has been added to the staging area. |
| `show_sync_count` | `false` | Show ahead/behind count of the branch being tracked. |
| `prefix` | `[` | Prefix to display immediately before git status. |
| `suffix` | `]` | Suffix to display immediately after git status. |
| `style` | `"bold red"` | The style for the module. |
| `disabled` | `false` | Disables the `git_status` module. |
| Variable | Default | Description |
| ------------------ | -------------------------- | ------------------------------------------------------- |
| `conflicted` | `"="` | This branch has merge conflicts. |
| `conflicted_count` | [link](#git-status-counts) | Show and style the number of conflicts. |
| `ahead` | `"⇡"` | This branch is ahead of the branch being tracked. |
| `behind` | `"⇣"` | This branch is behind of the branch being tracked. |
| `diverged` | `"⇕"` | This branch has diverged from the branch being tracked. |
| `untracked` | `"?"` | There are untracked files in the working directory. |
| `untracked_count` | [link](#git-status-counts) | Show and style the number of untracked files. |
| `stashed` | `"$"` | A stash exists for the local repository. |
| `modified` | `"!"` | There are file modifications in the working directory. |
| `modified_count` | [link](#git-status-counts) | Show and style the number of modified files. |
| `staged` | `"+"` | A new file has been added to the staging area. |
| `staged_count` | [link](#git-status-counts) | Show and style the number of files staged files. |
| `renamed` | `"»"` | A renamed file has been added to the staging area. |
| `renamed_count` | [link](#git-status-counts) | Show and style the number of renamed files. |
| `deleted` | `"✘"` | A file's deletion has been added to the staging area. |
| `deleted_count` | [link](#git-status-counts) | Show and style the number of deleted files. |
| `show_sync_count` | `false` | Show ahead/behind count of the branch being tracked. |
| `prefix` | `[` | Prefix to display immediately before git status. |
| `suffix` | `]` | Suffix to display immediately after git status. |
| `style` | `"bold red"` | The style for the module. |
| `disabled` | `false` | Disables the `git_status` module. |
#### Git Status Counts
| Variable | Default | Description |
| --------- | ------- | ------------------------------------------------------ |
| `enabled` | `false` | Show the number of files |
| `style` | | Optionally style the count differently than the module |
### Example
@ -468,7 +485,10 @@ diverged = "😵"
untracked = "🤷‍"
stashed = "📦"
modified = "📝"
staged = "➕"
staged.value = "++"
staged.style = "green"
staged_count.enabled = true
staged_count.style = "green"
renamed = "👅"
deleted = "🗑"
```
@ -553,11 +573,9 @@ symbol = "+ "
threshold = 4
```
## Kubernetes
Displays the current Kubernetes context name and, if set, the namespace from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via `kubectl config set-context starship-cluster --namespace
astronaut`. If the `$KUBECONFIG` env var is set the module will use that if not it will use the `~/.kube/config`.
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
@ -584,7 +602,6 @@ style = "dim green"
disabled = false
```
## Line Break
The `line_break` module separates the prompt into two lines.
@ -842,7 +859,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| Variable | Default | Description |
| ----------------- | ------------- | ------------------------------------------------------------------------------------------------------------------- |
| `12hr` | `false` | Enables 12 hour formatting |
| `use_12hr` | `false` | Enables 12 hour formatting |
| `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 |
| `disabled` | `true` | Disables the `time` module. |

36
docs/zh-CN/guide/README.md
View file

@ -20,21 +20,21 @@
<a href="#contributors">
<img
src="https://badgen.net/badge/all%20contributors/42/orange"
alt="All Contributors" /></a>
alt="所有贡献者" /></a>
<!-- ALL-CONTRIBUTORS-BADGE:END -->
<a href="https://discord.gg/8Jzqu3T"
><img
src="https://badgen.net/badge/chat/on%20discord/7289da"
alt="Chat on Discord" /></a>
alt="加入 Discord" /></a>
</p>
<h4 align="center">
<br />
<a href="https://starship.rs">Website</a>
<a href="https://starship.rs">网站</a>
·
<a href="#-installation">Installation</a>
<a href="#-installation">安装</a>
·
<a href="https://starship.rs/config/">Configuration</a>
<a href="https://starship.rs/config/">配置</a>
</h4>
<p align="center">
<a href="https://github.com/starship/starship/blob/master/README.md"
@ -61,11 +61,11 @@
<h1></h1>
<p align="center"> Starship is the minimal, blazing fast, and extremely customizable prompt for any shell!<br /> The prompt shows information you need while you're working, while staying sleek and out of the way. <p>
<p align="center"> Starship 是轻量的，快速的，可以快速定制的，适用于任何 shell 的提示符！<br /> 它可以在不影响流畅性=的情况下，在你工作时展示你所需要的信息。 <p>
<p align="center">
<br>
<img alt="Starship with iTerm2 and the Snazzy theme" src="https://raw.githubusercontent.com/starship/starship/master/media/demo.gif" width="80%">
<img alt="使用 iTerm 和 Snazz 主题的 Starship" src="https://raw.githubusercontent.com/starship/starship/master/media/demo.gif" width="80%">
<br>
<br>
</p>
@ -155,7 +155,7 @@
#### Other x86-64 Linux Platforms
Download a prebuilt binary and place in /usr/local/bin/
下载预编译好的二进制文件到 /usr/local/bin/ 目录
```sh
$ wget -q --show-progress https://github.com/starship/starship/releases/latest/download/starship-x86_64-unknown-linux-gnu.tar.gz
@ -201,7 +201,7 @@
#### Powershell
Add the following to the end of `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` (or `~/.config/powershell/Microsoft.PowerShell_profile.ps1` on -Nix):
添加 `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` (或者`~/.config/powershell/Microsoft.PowerShell_profile.ps1` on -Nix)到：
```sh
# ~\Documents\PowerShell\Profile.ps1
@ -210,11 +210,11 @@
## 🔧 配置
For details on how to configure Starship, check out our [documentation](https://starship.rs/config/).
关于如何配置 Starship ，详情请查看我们的[文档](https://starship.rs/config/)。
## 🤝 贡献
We are always looking for contributors of **all skill levels**! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue).
我们一直在寻找贡献者！你都可以参与贡献 ** 不论你的技能如何 **。 如果您希望快速为项目作出贡献，请尝试解决 [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue)。
### 急需
@ -225,11 +225,11 @@ We are always looking for contributors of **all skill levels**! If you're lookin
- 👩‍💻 **Rust 开发者**
- 我们需要符合语言习惯的，高效的代码，需要性能优化与跨平台编译优化……你可以在这里收获_大量_的成果！ 我 ([@matchai](https://github.com/matchai)) 是一枚 Rust 新手. 快来为我们指点迷津！
If you are interested in helping contribute to starship, please take a look at our [Contributing Guide](https://github.com/starship/starship/blob/master/CONTRIBUTING.md). Also, feel free to drop into our [Discord server](https://discord.gg/8Jzqu3T) and say hi. 👋
如果您有兴趣贡献于 Starship，请查看我们的[贡献指南](https://github.com/starship/starship/blob/master/CONTRIBUTING.md)。 另外，你可以自由加入我们的 [Discord 服务器](https://discord.gg/8Jzqu3T) 。 👋
### 贡献者
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
感谢这些优秀的人 ([emoji key](https://allcontributors.org/docs/en/emoji-key))：
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore -->
@ -237,9 +237,9 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
<tr>
<td align="center"><a href="https://twitter.com/matchai"><img src="https://avatars0.githubusercontent.com/u/4658208?v=4" width="100px;" alt="Matan Kushner" /><br /><sub><b>Matan Kushner</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=matchai" title="Code">💻</a> <a href="#design-matchai" title="Design">🎨</a> <a href="#ideas-matchai" title="Ideas, Planning, & Feedback">🤔</a> <a href="#infra-matchai" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="#maintenance-matchai" title="Maintenance">🚧</a> <a href="#review-matchai" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/starship/starship/commits?author=matchai" title="Tests">⚠️</a></td>
<td align="center"><a href="https://github.com/johnletey"><img src="https://avatars0.githubusercontent.com/u/30328854?v=4" width="100px;" alt="John Letey" /><br /><sub><b>John Letey</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=johnletey" title="Code">💻</a> <a href="#ideas-johnletey" title="Ideas, Planning, & Feedback">🤔</a> <a href="#review-johnletey" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/starship/starship/commits?author=johnletey" title="Tests">⚠️</a></td>
<td align="center"><a href="https://github.com/johnletey"><img src="https://avatars0.githubusercontent.com/u/30328854?v=4" width="100px;" alt="John Letey" /><br /><sub><b>John Letey</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=johnletey" title="Code">💻</a> <a href="#ideas-johnletey" title="Ideas, Planning, & Feedback">🤔</a> <a href="#review-johnletey" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/starship/starship/commits?author=johnletey" title="Tests">⚠️</a></td>
<td align="center"><a href="http://timmulqueen.com"><img src="https://avatars1.githubusercontent.com/u/6132021?v=4" width="100px;" alt="Tim Mulqueen" /><br /><sub><b>Tim Mulqueen</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=Multimo" title="Code">💻</a> <a href="#ideas-Multimo" title="Ideas, Planning, & Feedback">🤔</a> <a href="#review-Multimo" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/starship/starship/commits?author=Multimo" title="Tests">⚠️</a></td>
<td align="center"><a href="https://github.com/sirMerr"><img src="https://avatars2.githubusercontent.com/u/11183523?v=4" width="100px;" alt="Tiffany Le-Nguyen" /><br /><sub><b>Tiffany Le-Nguyen</b></sub></a><br /><a href="#ideas-sirMerr" title="Ideas, Planning, & Feedback">🤔</a> <a href="#maintenance-sirMerr" title="Maintenance">🚧</a> <a href="#review-sirMerr" title="Reviewed Pull Requests">👀</a> <a href="https://github.com/starship/starship/commits?author=sirMerr" title="Documentation">📖</a></td>
<td align="center"><a href="https://about.snuggi.es"><img src="https://avatars0.githubusercontent.com/u/26250962?v=4" width="100px;" alt="​Snuggle" /><br /><sub><b>​Snuggle</b></sub></a><br /><a href="#design-Snuggle" title="Design">🎨</a> <a href="#ideas-Snuggle" title="Ideas, Planning, & Feedback">🤔</a> <a href="#maintenance-Snuggle" title="Maintenance">🚧</a> <a href="#review-Snuggle" title="Reviewed Pull Requests">👀</a></td>
<td align="center"><a href="https://github.com/mehcode"><img src="https://avatars1.githubusercontent.com/u/753919?v=4" width="100px;" alt="Ryan Leckey" /><br /><sub><b>Ryan Leckey</b></sub></a><br /><a href="#review-mehcode" title="Reviewed Pull Requests">👀</a></td>
<td align="center"><a href="https://github.com/youssefhabri"><img src="https://avatars3.githubusercontent.com/u/1578005?v=4" width="100px;" alt="Youssef Habri" /><br /><sub><b>Youssef Habri</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=youssefhabri" title="Code">💻</a></td>
</tr>
@ -290,16 +290,20 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
</tr>
<tr>
<td align="center"><a href="https://github.com/CSumm"><img src="https://avatars1.githubusercontent.com/u/31711543?v=4" width="100px;" alt="Carl Summers" /><br /><sub><b>Carl Summers</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=CSumm" title="Documentation">📖</a></td>
<td align="center"><a href="http://www.slmt.tw"><img src="https://avatars2.githubusercontent.com/u/6824412?v=4" width="100px;" alt="Yushan Lin" /><br /><sub><b>Yushan Lin</b></sub></a><br /><a href="#translation-SLMT" title="Translation">🌍</a></td>
<td align="center"><a href="https://weihanglo.tw"><img src="https://avatars2.githubusercontent.com/u/14314532?v=4" width="100px;" alt="Weihang Lo" /><br /><sub><b>Weihang Lo</b></sub></a><br /><a href="#translation-weihanglo" title="Translation">🌍</a></td>
<td align="center"><a href="https://github.com/pinshan"><img src="https://avatars0.githubusercontent.com/u/7709675?v=4" width="100px;" alt="pinshan" /><br /><sub><b>pinshan</b></sub></a><br /><a href="#translation-pinshan" title="Translation">🌍</a></td>
<td align="center"><a href="https://github.com/brianlow"><img src="https://avatars2.githubusercontent.com/u/938138?v=4" width="100px;" alt="Brian Low" /><br /><sub><b>Brian Low</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=brianlow" title="Code">💻</a> <a href="https://github.com/starship/starship/commits?author=brianlow" title="Documentation">📖</a> <a href="https://github.com/starship/starship/commits?author=brianlow" title="Tests">⚠️</a></td>
</tr>
</table>
<!-- ALL-CONTRIBUTORS-LIST:END -->
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
此项目遵循 [all-contributors](https://github.com/all-contributors/all-contributors) 标准。 任何形式的贡献都将受到欢迎！
## 💭该项目受以下项目启发
Please check out these previous works that helped inspire the creation of starship. 🙏
请参考这些曾经为 Starship 提供启发的工程。 🙏
- **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** - A ZSH prompt for astronauts.

76
docs/zh-TW/config/README.md
View file

@ -59,20 +59,23 @@ Starship 內大多數的模組允許你設定他們的顯示風格。 這要透
### 選項
| 變數 | 預設 | 說明 |
| -------------- | --------------------------- | ---------------- |
| `add_newline` | `true` | 在提示字元前面加上換行字元。 |
| `prompt_order` | [連結](#default-prompt-order) | 調整各個提示字元模組的顯示順序。 |
| 變數 | 預設 | 說明 |
| -------------- | --------------------------- | ----------------------------------------------------- |
| `add_newline` | `true` | 在提示字元前面加上換行字元。 |
| `prompt_order` | [連結](#default-prompt-order) | 調整各個提示字元模組的顯示順序。 |
| `scan_timeout` | `30` | Timeout for starship to scan files (in milliseconds). |
### 範例
```toml
# ~/.config/starship.toml
# 停用在提示字元前換行的功能
# Disable the newline at the start of the prompt
add_newline = false
# 覆寫 default_prompt_order 並使用自訂的 prompt_order
# Overwrite a default_prompt_order and use custom prompt_order
prompt_order=["rust","line_break","package","line_break","character"]
# Wait 10 milliseconds for starship to check files under the current directory.
scan_timeout = 10
```
### 預設的提示字元順序
@ -118,7 +121,7 @@ prompt_order = [
| 變數 | 預設 | 說明 |
| ---------- | --------------- | ------------------ |
| `symbol` | `"☁️ "` | 顯示在目前 AWS 配置之前的符號。 |
| `symbol` | `"☁️ "` | 顯示在目前 AWS 配置之前的符號。 |
| `style` | `"bold yellow"` | 這個模組的風格。 |
| `disabled` | `false` | 停用 `AWS` 模組。 |
@ -437,23 +440,37 @@ cherry_pick = "🍒 PICKING"
### 選項
| 變數 | 預設 | 說明 |
| ----------------- | ------------ | -------------------------------- |
| `conflicted` | `"="` | 這個分支有合併衝突。 |
| `ahead` | `"⇡"` | 這個分支超前正在追蹤的分支。 |
| `behind` | `"⇣"` | 這個分支落後正在追蹤的分支。 |
| `diverged` | `"⇕"` | 這個分支偏離正在追蹤的分支。 |
| `untracked` | `"?"` | 工作資料夾中有沒有追蹤的檔案。 |
| `stashed` | `"$"` | 本地儲存庫有 stash。 |
| `modified` | `"!"` | 工作資料夾中有修改過的檔案。 |
| `staged` | `"+"` | 一個新檔案被加入了暫存區 (staging area)。 |
| `renamed` | `"»"` | 一個被改名的檔案被加入了暫存區 (staging area)。 |
| `deleted` | `"✘"` | 一個刪除檔案的動作被加入了暫存區 (staging area)。 |
| `show_sync_count` | `false` | 顯示超前/落後追蹤的分支的數量。 |
| `prefix` | `[` | 在 git 狀態正前方顯示的前綴。 |
| `suffix` | `]` | 在 git 狀態正後方顯示的後綴。 |
| `style` | `"bold red"` | 這個模組的風格。 |
| `disabled` | `false` | 停用 `git_status` 模組。 |
| 變數 | 預設 | 說明 |
| ------------------ | ------------------------ | ------------------------------------------------ |
| `conflicted` | `"="` | 這個分支有合併衝突。 |
| `conflicted_count` | [連結](#git-status-counts) | Show and style the number of conflicts. |
| `ahead` | `"⇡"` | 這個分支超前正在追蹤的分支。 |
| `behind` | `"⇣"` | 這個分支落後正在追蹤的分支。 |
| `diverged` | `"⇕"` | 這個分支偏離正在追蹤的分支。 |
| `untracked` | `"?"` | 工作資料夾中有沒有追蹤的檔案。 |
| `untracked_count` | [連結](#git-status-counts) | Show and style the number of untracked files. |
| `stashed` | `"$"` | 本地儲存庫有 stash。 |
| `modified` | `"!"` | 工作資料夾中有修改過的檔案。 |
| `modified_count` | [連結](#git-status-counts) | Show and style the number of modified files. |
| `staged` | `"+"` | 一個新檔案被加入了暫存區 (staging area)。 |
| `staged_count` | [連結](#git-status-counts) | Show and style the number of files staged files. |
| `renamed` | `"»"` | 一個被改名的檔案被加入了暫存區 (staging area)。 |
| `renamed_count` | [連結](#git-status-counts) | Show and style the number of renamed files. |
| `deleted` | `"✘"` | 一個刪除檔案的動作被加入了暫存區 (staging area)。 |
| `deleted_count` | [連結](#git-status-counts) | Show and style the number of deleted files. |
| `show_sync_count` | `false` | 顯示超前/落後追蹤的分支的數量。 |
| `prefix` | `[` | 在 git 狀態正前方顯示的前綴。 |
| `suffix` | `]` | 在 git 狀態正後方顯示的後綴。 |
| `style` | `"bold red"` | 這個模組的風格。 |
| `disabled` | `false` | 停用 `git_status` 模組。 |
#### Git Status Counts
| 變數 | 預設 | 說明 |
| --------- | ------- | ------------------------------------------------------ |
| `enabled` | `false` | Show the number of files |
| `style` | | Optionally style the count differently than the module |
### 範例
@ -468,7 +485,10 @@ diverged = "😵"
untracked = "🤷‍"
stashed = "📦"
modified = "📝"
staged = "➕"
staged.value = "++"
staged.style = "green"
staged_count.enabled = true
staged_count.style = "green"
renamed = "👅"
deleted = "🗑"
```
@ -553,10 +573,9 @@ symbol = "+ "
threshold = 4
```
## Kubernetes
顯示現在 Kubernetes 主體名稱以及從 kubeconfig 檔案來的名稱空間 (如果有設定的話)。 這個名稱空間必須設定在 kubeconfig 檔案內，你可以透過 `kubectl config set-context starship-cluster --namespace astronaut` 指令做到。 如果有設定 `$KUBECONFIG` 環境變數，這個模組就會使用設定值；如果沒有，它就會使用 `~/.kube/config`。
顯示現在 Kubernetes 主體名稱以及從 kubeconfig 檔案來的名稱空間 (如果有設定的話)。 The namespace needs to be set in the kubeconfig file, this can be done via `kubectl config set-context starship-cluster --namespace astronaut`. 如果有設定 `$KUBECONFIG` 環境變數，這個模組就會使用設定值；如果沒有，它就會使用 `~/.kube/config`。
::: tip
@ -583,7 +602,6 @@ style = "dim green"
disabled = false
```
## 換行
`line_break` 模組將提示字元分成兩行。
@ -841,7 +859,7 @@ symbol = "⚙️ "
| 變數 | 預設 | 說明 |
| ----------------- | ------------- | -------------------------------------------------------------------------------------- |
| `12hr` | `false` | 啟用 12 小時格式。 |
| `use_12hr` | `false` | 啟用 12 小時格式。 |
| `format` | 請看下列 | 用來顯示時間的 [chrono 格式字串](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html)。 |
| `style` | `bold yellow` | 這個模組的時間的風格。 |
| `disabled` | `true` | 停用 `time` 模組。 |

4
docs/zh-TW/guide/README.md
View file

@ -290,6 +290,10 @@
</tr>
<tr>
<td align="center"><a href="https://github.com/CSumm"><img src="https://avatars1.githubusercontent.com/u/31711543?v=4" width="100px;" alt="Carl Summers" /><br /><sub><b>Carl Summers</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=CSumm" title="Documentation">📖</a></td>
<td align="center"><a href="http://www.slmt.tw"><img src="https://avatars2.githubusercontent.com/u/6824412?v=4" width="100px;" alt="Yushan Lin" /><br /><sub><b>Yushan Lin</b></sub></a><br /><a href="#translation-SLMT" title="Translation">🌍</a></td>
<td align="center"><a href="https://weihanglo.tw"><img src="https://avatars2.githubusercontent.com/u/14314532?v=4" width="100px;" alt="Weihang Lo" /><br /><sub><b>Weihang Lo</b></sub></a><br /><a href="#translation-weihanglo" title="Translation">🌍</a></td>
<td align="center"><a href="https://github.com/pinshan"><img src="https://avatars0.githubusercontent.com/u/7709675?v=4" width="100px;" alt="pinshan" /><br /><sub><b>pinshan</b></sub></a><br /><a href="#translation-pinshan" title="Translation">🌍</a></td>
<td align="center"><a href="https://github.com/brianlow"><img src="https://avatars2.githubusercontent.com/u/938138?v=4" width="100px;" alt="Brian Low" /><br /><sub><b>Brian Low</b></sub></a><br /><a href="https://github.com/starship/starship/commits?author=brianlow" title="Code">💻</a> <a href="https://github.com/starship/starship/commits?author=brianlow" title="Documentation">📖</a> <a href="https://github.com/starship/starship/commits?author=brianlow" title="Tests">⚠️</a></td>
</tr>
</table>