Llewellyn/starship
1
0
Fork 0
mirror of https://github.com/Llewellynvdm/starship.git synced 2024-11-24 21:57:41 +00:00
Code Issues Releases Activity

docs(i18n): New Crowdin updates (#1788)

Browse Source
This commit is contained in:
Matan Kushner 2020-11-28 23:45:59 -05:00 committed by GitHub
parent 3dfe4ca932
commit ea6f5e429c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
41 changed files with 3920 additions and 3165 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/de-DE/README.md
View File

@ -94,11 +94,9 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
#### Powershell #### Powershell
Trage folgendes in das Powershell-Profil ($Profile) ein. Standardmäßig gespeichert unter: `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` auf Windows, oder `~/.config/powershell/Microsoft.PowerShell_profile.ps1` auf -Nix: Add the following to the end of `Microsoft.PowerShell_profile.ps1`. You can check the location of this file by querying the `$PROFILE` variable in PowerShell. Typically the path is `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` or `~/.config/powershell/Microsoft.PowerShell_profile.ps1` on -Nix.
```sh ```sh
# ~\Documents\PowerShell\Profile.ps1
Invoke-Expression (&starship init powershell) Invoke-Expression (&starship init powershell)
``` ```

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

@ -214,11 +214,13 @@ $conda\
$memory_usage\ $memory_usage\
$aws\ $aws\
$gcloud\ $gcloud\
$openstack\
$env_var\ $env_var\
$crystal\ $crystal\
$cmd_duration\ $cmd_duration\
$custom\ $custom\
$line_break\ $line_break\
$lua\
$jobs\ $jobs\
$battery\ $battery\
$time\ $time\
@ -426,16 +428,17 @@ vicmd_symbol = "[V](bold green) "
## CMake ## CMake
The `cmake` module shows the currently installed version of CMake if: The `cmake` module shows the currently installed version of CMake if any of the following conditions are met:
- The current directory contains a `CMakeLists.txt` file - The current directory contains a `CMakeLists.txt` file
- The current directory contains a `CMakeCache.txt` file
### Optionen ### Optionen
| Option | Standardwert | Beschreibung | | Option | Standardwert | Beschreibung |
| ---------- | ---------------------------------- | -------------------------------------------- | | ---------- | ---------------------------------- | -------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. | | `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"🛆 "` | The symbol used before the version of cmake. | | `symbol` | `"喝 "` | The symbol used before the version of cmake. |
| `style` | `"bold blue"` | Stil für dieses Modul. | | `style` | `"bold blue"` | Stil für dieses Modul. |
| `disabled` | `false` | Disables the `cmake` module. | | `disabled` | `false` | Disables the `cmake` module. |
@ -463,13 +466,21 @@ Bash Nutzer, die eine "preexec" ähnliche Funktion benötigen, können [rcaloras
### Optionen ### Optionen
| Option | Standardwert | Beschreibung | | Option | Standardwert | Beschreibung |
| ------------------- | ----------------------------- | ------------------------------------------------------------------ | | -------------------- | ----------------------------- | ------------------------------------------------------------------ |
| `min_time` | `2_000` | Schwellwert für kleinste anzuzeigende Laufzeit (in Millisekunden). | | `min_time` | `2_000` | Schwellwert für kleinste anzuzeigende Laufzeit (in Millisekunden). |
| `show_milliseconds` | `false` | Zeige Millisekunden zusätzlich zu Sekunden. | | `show_milliseconds` | `false` | Zeige Millisekunden zusätzlich zu Sekunden. |
| `format` | `"took [$duration]($style) "` | The format for the module. | | `format` | `"took [$duration]($style) "` | The format for the module. |
| `style` | `"bold yellow"` | Stil für dieses Modul. | | `style` | `"bold yellow"` | Stil für dieses Modul. |
| `disabled` | `false` | Deaktiviert das `cmd_duration`-Modul. | | `disabled` | `false` | Deaktiviert das `cmd_duration`-Modul. |
| `show_notifications` | `false` | Show desktop notifications when command completes. |
| `min_time_to_notify` | `45_000` | Shortest duration for notification (in milliseconds). |
::: Tipp
Showing desktop notifications requires starship to be built with `rust-notify` support. You check if your starship supports notifications by running `STARSHIP_LOG=debug starship module cmd_duration -d 60000` when `show_notifications` is set to `true`.
:::
### Variables ### Variables
@ -492,11 +503,11 @@ format = "underwent [$duration](bold yellow)"
## Conda ## Conda
Das `conda`-Modul zeigt dessen aktuelle Umgebung an, sofern `$CONDA_DEFAULT_ENV` gesetzt ist. The `conda` module shows the current conda environment, if `$CONDA_DEFAULT_ENV` is set.
::: Tipp ::: Tipp
Hinweis: Dies unterdrückt nicht conda's eigenen Prompt-Modifikator, sie können jedoch conda mit `conda config --set changeps1 False` konfigurieren, um die Ausgabe von conda selbst auszuschalten. This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`.
::: :::
@ -532,7 +543,7 @@ format = "[$symbol$environment](dimmed green) "
## Crystal ## Crystal
The `crystal` module shows the currently installed version of Crystal. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: The `crystal` module shows the currently installed version of Crystal. The module will be shown if any of the following conditions are met:
- Das aktuelle Verzeichnis enthält eine `shard.yml`-Datei - Das aktuelle Verzeichnis enthält eine `shard.yml`-Datei
- The current directory contains a `.cr` file - The current directory contains a `.cr` file
@ -567,7 +578,7 @@ format = "via [✨ $version](bold blue) "
## Dart ## Dart
The `dart` module shows the currently installed version of Dart. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: The `dart` module shows the currently installed version of Dart. The module will be shown if any of the following conditions are met:
- The current directory contains a file with `.dart` extension - The current directory contains a file with `.dart` extension
- The current directory contains a `.dart_tool` directory - The current directory contains a `.dart_tool` directory
@ -603,7 +614,7 @@ format = "via [🔰 $version](bold red) "
## Verzeichnis ## Verzeichnis
Das `directory` -Modul zeigt den Pfad zu Ihrem aktuellen Verzeichnis an, abgeschnitten auf drei übergeordnete Ordner. Your directory will also be truncated to the root of the git repo that you're currently in. The `directory` module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in.
When using the fish style pwd option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option. When using the fish style pwd option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option.
@ -623,7 +634,7 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
| `truncation_symbol` | `""` | The symbol to prefix to truncated paths. eg: "…/" | | `truncation_symbol` | `""` | The symbol to prefix to truncated paths. eg: "…/" |
<details> <details>
<summary>Dieses Modul hat einige erweiterte Konfigurationsoptionen, welche die Darstellung von Verzeichnissen steuern.</summary> <summary>This module has a few advanced configuration options that control how the directory is displayed.</summary>
| Advanced Option | Standardwert | Beschreibung | | Advanced Option | Standardwert | Beschreibung |
| --------------------------- | ------------ | ---------------------------------------------------------------------------------------- | | --------------------------- | ------------ | ---------------------------------------------------------------------------------------- |
@ -751,7 +762,7 @@ heuristic = false
## Elixir ## Elixir
The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. The module will be shown if any of the following conditions are met:
- Das aktuelle Verzeichnis enthält eine `mix.exs`-Datei. - Das aktuelle Verzeichnis enthält eine `mix.exs`-Datei.
@ -786,7 +797,7 @@ symbol = "🔮 "
## Elm ## Elm
The `elm` module shows the currently installed version of Elm. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: The `elm` module shows the currently installed version of Elm. The module will be shown if any of the following conditions are met:
- Das aktuelle Verzeichnis enthält eine `elm.json`-Datei - Das aktuelle Verzeichnis enthält eine `elm.json`-Datei
- Das aktuelle Verzeichnis enthält eine `elm-package.json`-Datei - Das aktuelle Verzeichnis enthält eine `elm-package.json`-Datei
@ -861,7 +872,7 @@ default = "unknown shell"
## Erlang ## Erlang
The `erlang` module shows the currently installed version of Erlang/OTP. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: The `erlang` module shows the currently installed version of Erlang/OTP. The module will be shown if any of the following conditions are met:
- Das aktuelle Verzeichnis enthält eine `rebar.config`-Datei. - Das aktuelle Verzeichnis enthält eine `rebar.config`-Datei.
- Das aktuelle Verzeichnis enthält eine `erlang.mk`-Datei. - Das aktuelle Verzeichnis enthält eine `erlang.mk`-Datei.
@ -870,7 +881,7 @@ The `erlang` module shows the currently installed version of Erlang/OTP. Das Mod
| Option | Standardwert | Beschreibung | | Option | Standardwert | Beschreibung |
| ---------- | ---------------------------------- | -------------------------------------------------------- | | ---------- | ---------------------------------- | -------------------------------------------------------- |
| `symbol` | `"🖧 "` | The symbol used before displaying the version of erlang. | | `symbol` | `" "` | The symbol used before displaying the version of erlang. |
| `style` | `"bold red"` | Stil für dieses Modul. | | `style` | `"bold red"` | Stil für dieses Modul. |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. | | `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `disabled` | `false` | Disables the `erlang` module. | | `disabled` | `false` | Disables the `erlang` module. |
@ -956,24 +967,27 @@ asia-northeast1 = "an1"
## Git-Branch ## Git-Branch
Das `git_branch`-Modul zeigt den aktiven Git-Branch des Repositories im aktuellen Verzeichnis an. The `git_branch` module shows the active branch of the repo in your current directory.
### Optionen ### Optionen
| Option | Standardwert | Beschreibung | | Option | Standardwert | Beschreibung |
| ------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | | -------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- |
| `format` | `"on [$symbol$branch]($style) "` | The format for the module. Use `"$branch"` to refer to the current branch name. | | `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. |
| `symbol` | `" "` | A format string representing the symbol of git branch. | | `format` | `"on [$symbol$branch]($style) "` | The format for the module. Use `"$branch"` to refer to the current branch name. |
| `style` | `"bold purple"` | Stil für dieses Modul. | | `symbol` | `" "` | A format string representing the symbol of git branch. |
| `truncation_length` | `2^63 - 1` | Truncates a git branch to X graphemes. | | `style` | `"bold purple"` | Stil für dieses Modul. |
| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. | | `truncation_length` | `2^63 - 1` | Truncates a git branch to X graphemes. |
| `disabled` | `false` | Deaktiviert das `git_branch`-Modul. | | `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. |
| `only_attached` | `false` | Only show the branch name when not in a detached HEAD state. |
| `disabled` | `false` | Disables the `git_branch` module. |
### Variables ### Variables
| Variable | Beispiel | Beschreibung | | Variable | Beispiel | Beschreibung |
| --------- | -------- | ---------------------------------------------------------------------------------------------------- | | --------- | -------- | ---------------------------------------------------------------------------------------------------- |
| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached HEAD). | | branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached HEAD). |
| remote | `master` | The remote branch name. |
| symbol | | Mirrors the value of option `symbol` | | symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` | | style\* | | Mirrors the value of option `style` |
@ -992,17 +1006,19 @@ truncation_symbol = ""
## Git Commit ## Git Commit
The `git_commit` module shows the current commit hash of the repo in your current directory. The `git_commit` module shows the current commit hash and also the tag (if any) of the repo in your current directory.
### Optionen ### Optionen
| Option | Standartwert | Beschreibung | | Option | Standartwert | Beschreibung |
| -------------------- | -------------------------- | ----------------------------------------------------- | | -------------------- | ------------------------------------------------------ | ----------------------------------------------------- |
| `commit_hash_length` | `7` | The length of the displayed git commit hash. | | `commit_hash_length` | `7` | The length of the displayed git commit hash. |
| `format` | `'[\($hash\)]($style) '` | The format for the module. | | `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | The format for the module. |
| `style` | `"bold green"` | Stil für dieses Modul. | | `style` | `"bold green"` | Stil für dieses Modul. |
| `only_detached` | `true` | Only show git commit hash when in detached HEAD state | | `only_detached` | `true` | Only show git commit hash when in detached HEAD state |
| `disabled` | `false` | Disables the `git_commit` module. | | `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown |
| `disabled` | `false` | Disables the `git_commit` module. |
### Variables ### Variables
@ -1020,6 +1036,7 @@ The `git_commit` module shows the current commit hash of the repo in your curren
[git_commit] [git_commit]
commit_hash_length = 4 commit_hash_length = 4
tag_symbol = "🔖 "
``` ```
## Git-Zustand ## Git-Zustand
@ -1147,7 +1164,7 @@ behind = "⇣${count}"
## Golang ## Golang
Das `golang`-Modul zeigt die aktuell installierte Version von Golang. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: The `golang` module shows the currently installed version of Golang. The module will be shown if any of the following conditions are met:
- Das aktuelle Verzeichnis enthält eine `go.mod`-Datei - Das aktuelle Verzeichnis enthält eine `go.mod`-Datei
- Das aktuelle Verzeichnis enthält eine `go.sum`-Datei - Das aktuelle Verzeichnis enthält eine `go.sum`-Datei
@ -1188,7 +1205,7 @@ format = "via [🏎💨 $version](bold cyan) "
## Helm ## Helm
The `helm` module shows the currently installed version of Helm. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: The `helm` module shows the currently installed version of Helm. The module will be shown if any of the following conditions are met:
- Das aktuelle Verzeichnis enthält eine `helmfile.yaml`-Datei - Das aktuelle Verzeichnis enthält eine `helmfile.yaml`-Datei
- The current directory contains a `Chart.yaml` file - The current directory contains a `Chart.yaml` file
@ -1223,7 +1240,7 @@ format = "via [⎈ $version](bold white) "
## Hostname ## Hostname
Das `hostname`-Modul zeigt den Hostnamen des Systems an. The `hostname` module shows the system hostname.
### Optionen ### Optionen
@ -1258,7 +1275,7 @@ disabled = false
## Java ## Java
Das `java` Modul zeigt die derzeit installierte Version von Java an. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: The `java` module shows the currently installed version of Java. The module will be shown if any of the following conditions are met:
- The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt` or `.java-version` file - The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt` or `.java-version` file
- The current directory contains a file with the `.java`, `.class`, `.gradle` or `.jar` extension - The current directory contains a file with the `.java`, `.class`, `.gradle` or `.jar` extension
@ -1327,7 +1344,7 @@ threshold = 4
## Julia ## Julia
The `julia` module shows the currently installed version of Julia. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: The `julia` module shows the currently installed version of Julia. The module will be shown if any of the following conditions are met:
- The current directory contains a `Project.toml` file - The current directory contains a `Project.toml` file
- The current directory contains a `Manifest.toml` file - The current directory contains a `Manifest.toml` file
@ -1367,7 +1384,7 @@ Displays the current Kubernetes context name and, if set, the namespace from the
::: Tipp ::: Tipp
Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
::: :::
@ -1406,7 +1423,7 @@ disabled = false
## Zeilenumbruch ## Zeilenumbruch
Das `line_break`-Modul unterteilt den Prompt in zwei Zeilen. The `line_break` module separates the prompt into two lines.
### Optionen ### Optionen
@ -1423,27 +1440,64 @@ Das `line_break`-Modul unterteilt den Prompt in zwei Zeilen.
disabled = true disabled = true
``` ```
## Speicherauslastung ## Lua
Das `memory_usage` Modul zeigt den aktuellen Systemspeicher und die swap-Nutzung an. The `lua` module shows the currently installed version of Lua. The module will be shown if any of the following conditions are met:
Standardmäßig wird die swap-Nutzung angezeigt, wenn der gesamte System-swap nicht Null ist. - The current directory contains a `.lua-version` file
- The current directory contains a `lua` directory
- The current directory contains a file with the `.lua` extension
### Optionen
| Option | Standartwert | Beschreibung |
| ------------ | ---------------------------------- | -------------------------------------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
| `style` | `"bold blue"` | Stil für dieses Modul. |
| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. |
| `disabled` | `false` | Disables the `lua` module. |
### Variables
| Variable | Beispiel | Beschreibung |
| --------- | -------- | ------------------------------------ |
| version | `v5.4.0` | The version of `lua` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### Beispiel
```toml
# ~/.config/starship.toml
[lua]
format = "via [🌕 $version](bold blue) "
```
## Memory Usage
The `memory_usage` module shows current system memory and swap usage.
By default the swap usage is displayed if the total system swap is non-zero.
::: Tipp ::: Tipp
Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
::: :::
### Optionen ### Optionen
| Option | Standartwert | Beschreibung | | Option | Standartwert | Beschreibung |
| ----------- | --------------------------------------------- | --------------------------------------------------------------------- | | ----------- | --------------------------------------------- | -------------------------------------------------------- |
| `threshold` | `75` | Speicherauslastung ausblenden, wenn sie unter diesem Prozentsatz ist. | | `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. |
| `format` | `"via $symbol [${ram}( | ${swap})]($style) "` | The format for the module. | | `format` | `"via $symbol [${ram}( | ${swap})]($style) "` | The format for the module. |
| `symbol` | `"🐏"` | Symbol das vor der Speicherauslastung angezeigt wird. | | `symbol` | `"🐏"` | The symbol used before displaying the memory usage. |
| `style` | `"bold dimmed white"` | Stil für dieses Modul. | | `style` | `"bold dimmed white"` | Stil für dieses Modul. |
| `disabled` | `true` | Deaktiviert das `memory_usage`-Modul. | | `disabled` | `true` | Disables the `memory_usage` module. |
### Variables ### Variables
@ -1465,11 +1519,8 @@ Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `dis
[memory_usage] [memory_usage]
disabled = false disabled = false
show_percentage = true
show_swap = true
threshold = -1 threshold = -1
symbol = " " symbol = " "
separator = "/"
style = "bold dimmed green" style = "bold dimmed green"
``` ```
@ -1511,9 +1562,9 @@ truncation_symbol = ""
## Nim ## Nim
The `nim` module shows the currently installed version of Nim. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: The `nim` module shows the currently installed version of Nim. The module will be shown if any of the following conditions are met:
- Das aktuelle Verzeichnis enthält eine `nim.cfg`-Datei - The current directory contains a `nim.cfg` file
- The current directory contains a file with the `.nim` extension - The current directory contains a file with the `.nim` extension
- The current directory contains a file with the `.nims` extension - The current directory contains a file with the `.nims` extension
- The current directory contains a file with the `.nimble` extension - The current directory contains a file with the `.nimble` extension
@ -1547,9 +1598,9 @@ style = "yellow"
symbol = "🎣 " symbol = "🎣 "
``` ```
## Nix-Shell ## Nix-shell
Das `nix_shell`-Modul zeigt die nix-shell Umgebung an. Das Modul wird angezeigt, wenn es sich in einer nix-Shell-Umgebung befindet. The `nix_shell` module shows the nix-shell environment. The module will be shown when inside a nix-shell environment.
### Optionen ### Optionen
@ -1560,7 +1611,7 @@ Das `nix_shell`-Modul zeigt die nix-shell Umgebung an. Das Modul wird angezeigt,
| `style` | `"bold blue"` | Stil für dieses Modul. | | `style` | `"bold blue"` | Stil für dieses Modul. |
| `impure_msg` | `"impure"` | A format string shown when the shell is impure. | | `impure_msg` | `"impure"` | A format string shown when the shell is impure. |
| `pure_msg` | `"pure"` | A format string shown when the shell is pure. | | `pure_msg` | `"pure"` | A format string shown when the shell is pure. |
| `disabled` | `false` | Deaktiviert das `nix_shell`-Modul. | | `disabled` | `false` | Disables the `nix_shell` module. |
### Variables ### Variables
@ -1587,11 +1638,11 @@ format = 'via [☃️ $state( \($name\))](bold blue) '
## NodeJS ## NodeJS
Das `nodejs`-Modul zeigt die aktuell installierte Version von NodeJS. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: The `nodejs` module shows the currently installed version of NodeJS. The module will be shown if any of the following conditions are met:
- Das aktuelle Verzeichnis enthält eine `package.json`-Datei - The current directory contains a `package.json` file
- The current directory contains a `.node-version` file - The current directory contains a `.node-version` file
- Das aktuelle Verzeichnis enthält ein `node_modules`-Verzeichnis - The current directory contains a `node_modules` directory
- The current directory contains a file with the `.js`, `.mjs` or `.cjs` extension - The current directory contains a file with the `.js`, `.mjs` or `.cjs` extension
- The current directory contains a file with the `.ts` extension - The current directory contains a file with the `.ts` extension
@ -1602,7 +1653,7 @@ Das `nodejs`-Modul zeigt die aktuell installierte Version von NodeJS. Das Modul
| `format` | `"via [$symbol$version]($style) "` | The format for the module. | | `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"⬢ "` | A format string representing the symbol of NodeJS. | | `symbol` | `"⬢ "` | A format string representing the symbol of NodeJS. |
| `style` | `"bold green"` | Stil für dieses Modul. | | `style` | `"bold green"` | Stil für dieses Modul. |
| `disabled` | `false` | Deaktiviert das `nodejs`-Modul. | | `disabled` | `false` | Disables the `nodejs` module. |
###  Variables ###  Variables
@ -1623,54 +1674,9 @@ Das `nodejs`-Modul zeigt die aktuell installierte Version von NodeJS. Das Modul
format = "via [🤖 $version](bold green) " format = "via [🤖 $version](bold green) "
``` ```
## Paketversion
Das `Package` Modul wird angezeigt, wenn das aktuelle Verzeichnis das Repository für ein Paket ist, und zeigt dessen aktuelle Version an. The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages.
- **npm** – Die `npm` Paketversion wird aus dem `package.json` gelesen, das sich im aktuellen Verzeichnis befindet
- **Cargo** – Die `Cargo` Paketversion wird aus dem `Cargo.toml` gelesen, das sich im aktuellen Verzeichnis befindet
- **poetry** – Die `poetry` Paketversion wird aus der `pyproject.toml` gelesen, das sich im aktuellen Verzeichnis befindet
- **composer** – The `composer` package version is extracted from the `composer.json` present in the current directory
- **gradle** – The `gradle` package version is extracted from the `build.gradle` present
- **julia** - The package version is extracted from the `Project.toml` present
- **mix** - The `mix` package version is extracted from the `mix.exs` present
- **helm** - The `helm` chart version is extracted from the `Chart.yaml` present
- **maven** - The `maven` package version is extracted from the `pom.xml` present
> ⚠️ Die angezeigte Version ist die des Pakets, dessen Quellcode im Verzeichnis liegt, nicht die des Paketmanagers.
### Optionen
| Option | Standartwert | Beschreibung |
| ----------------- | ---------------------------------- | --------------------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"📦 "` | Symbol das vor der Paketversion angezeigt wird. |
| `style` | `"bold 208"` | Stil für dieses Modul. |
| `display_private` | `false` | Enable displaying version for packages marked as private. |
| `disabled` | `false` | Deaktiviert das `package`-Modul. |
### Variables
| Variable | Beispiel | Beschreibung |
| --------- | -------- | ------------------------------------ |
| version | `v1.0.0` | The version of your package |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### Beispiel
```toml
# ~/.config/starship.toml
[package]
format = "via [🎁 $version](208 bold) "
```
## OCaml ## OCaml
The `ocaml` module shows the currently installed version of OCaml. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: The `ocaml` module shows the currently installed version of OCaml. The module will be shown if any of the following conditions are met:
- The current directory contains a file with `.opam` extension or `_opam` directory - The current directory contains a file with `.opam` extension or `_opam` directory
- The current directory contains a `esy.lock` directory - The current directory contains a `esy.lock` directory
@ -1707,9 +1713,89 @@ The `ocaml` module shows the currently installed version of OCaml. Das Modul wir
format = "via [🐪 $version]($style) " format = "via [🐪 $version]($style) "
``` ```
## OpenStack
The `openstack` module shows the current OpenStack cloud and project. The module only active when the `OS_CLOUD` env var is set, in which case it will read `clouds.yaml` file from any of the [default locations](https://docs.openstack.org/python-openstackclient/latest/configuration/index.html#configuration-files). to fetch the current project in use.
### Optionen
| Option | Standartwert | Beschreibung |
| ---------- | --------------------------------------------------- | -------------------------------------------------------------- |
| `format` | `"on [$symbol$cloud(\\($project\\))]($style) "` | The format for the module. |
| `symbol` | `"☁️ "` | The symbol used before displaying the current OpenStack cloud. |
| `style` | `"bold yellow"` | Stil für dieses Modul. |
| `disabled` | `false` | Disables the `OpenStack` module. |
### Variables
| Variable | Beispiel | Beschreibung |
| --------- | -------- | ------------------------------------ |
| cloud | `corp` | The current OpenStack cloud |
| project | `dev` | The current OpenStack project |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### Beispiel
```toml
# ~/.config/starship.toml
[openstack]
format = "on [$symbol$cloud(\\($project\\))]($style) "
style = "bold yellow"
symbol = "☁️ "
```
## Package Version
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages.
- **npm** – The `npm` package version is extracted from the `package.json` present in the current directory
- **cargo** – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
- **poetry** – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
- **composer** – The `composer` package version is extracted from the `composer.json` present in the current directory
- **gradle** – The `gradle` package version is extracted from the `build.gradle` present
- **julia** - The package version is extracted from the `Project.toml` present
- **mix** - The `mix` package version is extracted from the `mix.exs` present
- **helm** - The `helm` chart version is extracted from the `Chart.yaml` present
- **maven** - The `maven` package version is extracted from the `pom.xml` present
> ⚠️ Die angezeigte Version ist die des Pakets, dessen Quellcode im Verzeichnis liegt, nicht die des Paketmanagers.
### Optionen
| Option | Standardwert | Beschreibung |
| ----------------- | ---------------------------------- | ---------------------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"📦 "` | The symbol used before displaying the version the package. |
| `style` | `"bold 208"` | Stil für dieses Modul. |
| `display_private` | `false` | Enable displaying version for packages marked as private. |
| `disabled` | `false` | Disables the `package` module. |
### Variables
| Variable | Beispiel | Beschreibung |
| --------- | -------- | ------------------------------------ |
| version | `v1.0.0` | The version of your package |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### Beispiel
```toml
# ~/.config/starship.toml
[package]
format = "via [🎁 $version](208 bold) "
```
## Perl ## Perl
The `perl` module shows the currently installed version of Perl. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: The `perl` module shows the currently installed version of Perl. The module will be shown if any of the following conditions are met:
- The current directory contains a `Makefile.PL` or `Build.PL` file - The current directory contains a `Makefile.PL` or `Build.PL` file
- The current directory contains a `cpanfile` or `cpanfile.snapshot` file - The current directory contains a `cpanfile` or `cpanfile.snapshot` file
@ -1719,7 +1805,7 @@ The `perl` module shows the currently installed version of Perl. Das Modul wird
### Optionen ### Optionen
| Option | Standartwert | Beschreibung | | Option | Standardwert | Beschreibung |
| ---------- | ---------------------------------- | ----------------------------------------------------- | | ---------- | ---------------------------------- | ----------------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | The format string for the module. | | `format` | `"via [$symbol$version]($style) "` | The format string for the module. |
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | | `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
@ -1745,20 +1831,20 @@ format = "via [🦪 $version]($style) "
## PHP ## PHP
Das `php`-Modul zeigt die aktuell installierte Version von PHP. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: The `php` module shows the currently installed version of PHP. The module will be shown if any of the following conditions are met:
- Das aktuelle Verzeichnis enthält eine `composer.json`-Datei - The current directory contains a `composer.json` file
- The current directory contains a `.php-version` file - The current directory contains a `.php-version` file
- Das aktuelle Verzeichnis enthält eine `.php`-Datei - The current directory contains a `.php` file
### Optionen ### Optionen
| Option | Standardwert | Beschreibung | | Option | Standardwert | Beschreibung |
| ---------- | ---------------------------------- | ---------------------------------------------- | | ---------- | ---------------------------------- | ----------------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. | | `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"🐘 "` | Symbol das vor der PHP-Version angezeigt wird. | | `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. |
| `style` | `"147 bold"` | Stil für dieses Modul. | | `style` | `"147 bold"` | Stil für dieses Modul. |
| `disabled` | `false` | Deaktiviert das `php`-Modul. | | `disabled` | `false` | Disables the `php` module. |
### Variables ### Variables
@ -1779,23 +1865,58 @@ Das `php`-Modul zeigt die aktuell installierte Version von PHP. Das Modul wird g
format = "via [🔹 $version](147 bold) " format = "via [🔹 $version](147 bold) "
``` ```
## PureScript
The `purescript` module shows the currently installed version of PureScript version. The module will be shown if any of the following conditions are met:
- The current directory contains a `spago.dhall` file
- The current directory contains a \*.purs files
### Optionen
| Option | Standardwert | Beschreibung |
| ---------- | ---------------------------------- | ------------------------------------------------------------ |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
| `style` | `"bold white"` | Stil für dieses Modul. |
| `disabled` | `false` | Disables the `purescript` module. |
### Variables
| Variable | Beispiel | Beschreibung |
| --------- | -------- | ------------------------------------ |
| version | `0.13.5` | The version of `purescript` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### Beispiel
```toml
# ~/.config/starship.toml
[purescript]
format = "via [$symbol$version](bold white)"
```
## Python ## Python
The `python` module shows the currently installed version of Python and the current Python virtual environment if one is activated. The `python` module shows the currently installed version of Python and the current Python virtual environment if one is activated.
If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. 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`.
Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: The module will be shown if any of the following conditions are met:
- Das aktuelle Verzeichnis enthält eine `.python-version`-Datei - The current directory contains a `.python-version` file
- Das aktuelle Verzeichnis enthält eine `requirements.txt`-Datei - The current directory contains a `requirements.txt` file
- Das aktuelle Verzeichnis enthält eine `pyproject.toml`-Datei - The current directory contains a `pyproject.toml` file
- The current directory contains a file with the `.py` extension (and `scan_for_pyfiles` is true) - The current directory contains a file with the `.py` extension (and `scan_for_pyfiles` is true)
- Das aktuelle Verzeichnis enthält eine `Pipfile`-Datei - The current directory contains a `Pipfile` file
- Das aktuelle Verzeichnis enthält eine `tox.ini`-Datei - The current directory contains a `tox.ini` file
- Das aktuelle Verzeichnis enthält eine `setup.py`-Datei - The current directory contains a `setup.py` file
- The current directory contains a `__init__.py` file - The current directory contains a `__init__.py` file
- Ein virtualenv ist momentan aktiv - A virtual environment is currently activated
### Optionen ### Optionen
@ -1804,11 +1925,11 @@ Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist:
| `format` | `'via [${symbol}${pyenv_prefix}${version}( \($virtualenv\))]($style) '` | The format for the module. | | `format` | `'via [${symbol}${pyenv_prefix}${version}( \($virtualenv\))]($style) '` | The format for the module. |
| `symbol` | `"🐍 "` | A format string representing the symbol of Python | | `symbol` | `"🐍 "` | A format string representing the symbol of Python |
| `style` | `"yellow bold"` | Stil für dieses Modul. | | `style` | `"yellow bold"` | Stil für dieses Modul. |
| `pyenv_version_name` | `false` | Verwende `pyenv` um die Python-Versionzu beziehen. | | `pyenv_version_name` | `false` | Use pyenv to get Python version |
| `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used |
| `scan_for_pyfiles` | `true` | If false, Python files in the current directory will not show this module. | | `scan_for_pyfiles` | `true` | If false, Python files in the current directory will not show this module. |
| `python_binary` | `python` | Configures the python binary that Starship executes when getting the version. | | `python_binary` | `python` | Configures the python binary that Starship executes when getting the version. |
| `disabled` | `false` | Deaktiviert das `python`-Modul. | | `disabled` | `false` | Disables the `python` module. |
### Variables ### Variables
@ -1844,11 +1965,11 @@ python_binary = "python3"
## Ruby ## Ruby
Das `ruby` Modul zeigt die derzeit installierte Version von Ruby an. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: The `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met:
- Das aktuelle Verzeichnis enthält eine `Gemfile`-Datei - The current directory contains a `Gemfile` file
- The current directory contains a `.ruby-version` file - The current directory contains a `.ruby-version` file
- Das aktuelle Verzeichnis enthält eine `.rb`-Datei - The current directory contains a `.rb` file
### Optionen ### Optionen
@ -1857,7 +1978,7 @@ Das `ruby` Modul zeigt die derzeit installierte Version von Ruby an. Das Modul w
| `format` | `"via [$symbol$version]($style) "` | The format for the module. | | `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"💎 "` | A format string representing the symbol of Ruby. | | `symbol` | `"💎 "` | A format string representing the symbol of Ruby. |
| `style` | `"bold red"` | Stil für dieses Modul. | | `style` | `"bold red"` | Stil für dieses Modul. |
| `disabled` | `false` | Deaktiviert das `ruby`-Modul. | | `disabled` | `false` | Disables the `ruby` module. |
### Variables ### Variables
@ -1880,10 +2001,10 @@ symbol = "🔺 "
## Rust ## Rust
Das `rust` Modul zeigt die derzeit installierte Version von Rust an. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: The `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met:
- Das aktuelle Verzeichnis enthält eine `Cargo.toml`-Datei - The current directory contains a `Cargo.toml` file
- Das aktuelle Verzeichnis enthält eine Datei mit der `.rs`-Erweiterung - The current directory contains a file with the `.rs` extension
### Optionen ### Optionen
@ -1892,7 +2013,7 @@ Das `rust` Modul zeigt die derzeit installierte Version von Rust an. Das Modul w
| `format` | `"via [$symbol$version]($style) "` | The format for the module. | | `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"🦀 "` | A format string representing the symbol of Rust | | `symbol` | `"🦀 "` | A format string representing the symbol of Rust |
| `style` | `"bold red"` | Stil für dieses Modul. | | `style` | `"bold red"` | Stil für dieses Modul. |
| `disabled` | `false` | Deaktiviert das `rust`-Modul. | | `disabled` | `false` | Disables the `rust` module. |
### Variables ### Variables
@ -1980,48 +2101,13 @@ The `singularity` module shows the current singularity image, if inside a contai
format = '[📦 \[$env\]]($style) ' format = '[📦 \[$env\]]($style) '
``` ```
## Swift
The `swift` module shows the currently installed version of Swift. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist:
- The current directory contains a `Package.swift` file
- The current directory contains a file with the `.swift` extension
### Optionen
| Option | Standardwert | Beschreibung |
| ---------- | ---------------------------------- | ------------------------------------------------ |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
| `style` | `"bold 202"` | Stil für dieses Modul. |
| `disabled` | `false` | Disables the `swift` module. |
### Variables
| Variable | Beispiel | Beschreibung |
| --------- | -------- | ------------------------------------ |
| version | `v5.2.4` | The version of `swift` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### Beispiel
```toml
# ~/.config/starship.toml
[swift]
format = "via [🏎 $version](red bold)"
```
## Status ## Status
The `status` module displays the exit code of the previous command. The module will be shown only if the exit code is not `0`. The `status` module displays the exit code of the previous command. The module will be shown only if the exit code is not `0`.
::: Tipp ::: Tipp
Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. ::: This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. :::
### Optionen ### Optionen
@ -2056,12 +2142,47 @@ disabled = false
``` ```
## Swift
The `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met:
- The current directory contains a `Package.swift` file
- The current directory contains a file with the `.swift` extension
### Optionen
| Option | Standardwert | Beschreibung |
| ---------- | ---------------------------------- | ------------------------------------------------ |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
| `style` | `"bold 202"` | Stil für dieses Modul. |
| `disabled` | `false` | Disables the `swift` module. |
### Variables
| Variable | Beispiel | Beschreibung |
| --------- | -------- | ------------------------------------ |
| version | `v5.2.4` | The version of `swift` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### Beispiel
```toml
# ~/.config/starship.toml
[swift]
format = "via [🏎 $version](red bold)"
```
## Terraform ## Terraform
Das `Terraform` Modul zeigt den aktuell ausgewählten terraform Arbeitsbereich und die Version an. Standardmäßig wird die Terraform-Version nicht angezeigt, da dies bei aktuellen Versionen von Terraform langsam ist, wenn viele Plugins verwendet werden. If you still want to enable it, [follow the example shown below](#with-version). Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: The `terraform` module shows the currently selected terraform workspace and version. By default the terraform version is not shown, since this is slow on current versions of terraform when a lot of plugins are in use. If you still want to enable it, [follow the example shown below](#with-version). The module will be shown if any of the following conditions are met:
- Das aktuelle Verzeichnis enthält eine `.terraform`-Datei - The current directory contains a `.terraform` folder
- Das aktuelle Verzeichnis enthält eine Datei mit der `.tf`-Erweiterung - Current directory contains a file with the `.tf` or `.hcl` extensions
### Optionen ### Optionen
@ -2070,7 +2191,7 @@ Das `Terraform` Modul zeigt den aktuell ausgewählten terraform Arbeitsbereich u
| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | | `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. |
| `symbol` | `"💠 "` | A format string shown before the terraform workspace. | | `symbol` | `"💠 "` | A format string shown before the terraform workspace. |
| `style` | `"bold 105"` | Stil für dieses Modul. | | `style` | `"bold 105"` | Stil für dieses Modul. |
| `disabled` | `false` | Deaktiviert das `terraform` Modul. | | `disabled` | `false` | Disables the `terraform` module. |
### Variables ### Variables
@ -2105,33 +2226,33 @@ format = "[🏎💨 $workspace]($style) "
## Zeit ## Zeit
Das `time` Modul zeigt die aktuelle **lokale** Zeit an. Der `format` Wert wird von der crate [`chrono`](https://crates.io/crates/chrono) benutzt um die Zeit zu formatieren. Schau dir [die chrono strftime Dokumentation](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) an, um die möglichen Optionen zu sehen. 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.
::: Tipp ::: Tipp
Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
::: :::
### Optionen ### Optionen
| Option | Standardwert | Beschreibung | | Option | Standardwert | Beschreibung |
| ----------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | | ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `format` | `"at [$time]($style) "` | The format string for the module. | | `format` | `"at [$time]($style) "` | The format string for the module. |
| `use_12hr` | `false` | Aktiviert 12-Stunden-Format | | `use_12hr` | `false` | Enables 12 hour formatting |
| `time_format` | siehe unten | Das Format zum Anzeigen der Uhrzeit in [chrono-Formatierung](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html). | | `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. |
| `style` | `"bold yellow"` | Stil für dieses Modul | | `style` | `"bold yellow"` | The style for the module time |
| `utc_time_offset` | `"local"` | Verwendetes Zeitzonen-Offset. Range from -24 &lt; x &lt; 24. Allows floats to accommodate 30/45 minute timezone offsets. | | `utc_time_offset` | `"local"` | Sets the UTC offset to use. Range from -24 &lt; x &lt; 24. Allows floats to accommodate 30/45 minute timezone offsets. |
| `disabled` | `true` | Deaktiviert das `time`-Modul. | | `disabled` | `true` | Disables the `time` module. |
| `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | | `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format |
If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Andernfalls ist es standardmäßig `"%T"`. Manually setting `time_format` will override the `use_12hr` setting. If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Otherwise, it defaults to `"%T"`. Manually setting `time_format` will override the `use_12hr` setting.
### Variables ### Variables
| Variable | Beispiel | Beschreibung | | Variable | Beispiel | Beschreibung |
| --------- | ---------- | ----------------------------------- | | --------- | ---------- | ----------------------------------- |
| zeit | `13:08:10` | The current time. | | time | `13:08:10` | The current time. |
| style\* | | Mirrors the value of option `style` | | style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string \*: This variable can only be used as a part of a style string
@ -2151,22 +2272,22 @@ time_range = "10:00:00-14:00:00"
## Username ## Username
Das `username` Modul zeigt den Namen des aktiven Benutzers. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: The `username` module shows active user's username. The module will be shown if any of the following conditions are met:
- Der aktuelle Benutzer ist root - The current user is root
- Der aktuelle Benutzer ist nicht der eingeloggte Benutzer - The current user isn't the same as the one that is logged in
- Der Benutzer ist aktuell via SSH verbunden - The user is currently connected as an SSH session
- Die Variable `show_always` ist auf true gesetzt - The variable `show_always` is set to true
### Optionen ### Optionen
| Option | Standardwert | Beschreibung | | Option | Standardwert | Beschreibung |
| ------------- | ----------------------- | ---------------------------------------------- | | ------------- | ----------------------- | ------------------------------------- |
| `style_root` | `"bold red"` | Stil wenn der Benutzer unter root läuft. | | `style_root` | `"bold red"` | The style used when the user is root. |
| `style_user` | `"bold yellow"` | Stil wenn der Benutzer nicht unter root läuft. | | `style_user` | `"bold yellow"` | The style used for non-root users. |
| `format` | `"[$user]($style) in "` | The format for the module. | | `format` | `"[$user]($style) in "` | The format for the module. |
| `show_always` | `false` | Immer das `username` Modul anzeigen. | | `show_always` | `false` | Always shows the `username` module. |
| `disabled` | `false` | Deavktiviert das `username` Modul. | | `disabled` | `false` | Disables the `username` module. |
### Variables ### Variables
@ -2190,7 +2311,7 @@ show_always = true
## Zig ## Zig
The `zig` module shows the currently installed version of Zig. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: The `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met:
- The current directory contains a `.zig` file - The current directory contains a `.zig` file
@ -2253,19 +2374,19 @@ The order in which custom modules are shown can be individually set by including
### Optionen ### Optionen
| Option | Standardwert | Beschreibung | | Option | Standardwert | Beschreibung |
| -------------- | ----------------------------- | -------------------------------------------------------------------------------------------------------------------------- | | ------------- | ----------------------------- | -------------------------------------------------------------------------------------------------------------------------- |
| `command` | | The command whose output should be printed. The command will be passed on stdin to the shell. | | `command` | | The command whose output should be printed. The command will be passed on stdin to the shell. |
| `when` | | A shell command used as a condition to show the module. The module will be shown if the command returns a `0` status code. | | `when` | | A shell command used as a condition to show the module. The module will be shown if the command returns a `0` status code. |
| `shell` | | [See below](#custom-command-shell) | | `shell` | | [See below](#custom-command-shell) |
| `beschreibung` | `"<custom module>"` | The description of the module that is shown when running `starship explain`. | | `description` | `"<custom module>"` | The description of the module that is shown when running `starship explain`. |
| `files` | `[]` | The files that will be searched in the working directory for a match. | | `files` | `[]` | The files that will be searched in the working directory for a match. |
| `directories` | `[]` | The directories that will be searched in the working directory for a match. | | `directories` | `[]` | The directories that will be searched in the working directory for a match. |
| `extensions` | `[]` | The extensions that will be searched in the working directory for a match. | | `extensions` | `[]` | The extensions that will be searched in the working directory for a match. |
| `symbol` | `""` | The symbol used before displaying the command output. | | `symbol` | `""` | The symbol used before displaying the command output. |
| `style` | `"bold green"` | Stil für dieses Modul. | | `style` | `"bold green"` | Stil für dieses Modul. |
| `format` | `"[$symbol$output]($style) "` | The format for the module. | | `format` | `"[$symbol$output]($style) "` | The format for the module. |
| `disabled` | `false` | Disables this `custom` module. | | `disabled` | `false` | Disables this `custom` module. |
### Variables ### Variables
@ -2322,38 +2443,3 @@ command = "time /T"
files = ["*.pst"] files = ["*.pst"]
shell = ["pwsh.exe", "-NoProfile", "-Command", "-"] shell = ["pwsh.exe", "-NoProfile", "-Command", "-"]
``` ```
## PureScript
The `purescript` module shows the currently installed version of PureScript version. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist:
- Das aktuelle Verzeichnis enthält eine `spago.dhall`-Datei
- The current directory contains a \*.purs files
### Optionen
| Option | Standardwert | Beschreibung |
| ---------- | ---------------------------------- | ------------------------------------------------------------ |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
| `style` | `"bold white"` | Stil für dieses Modul. |
| `disabled` | `false` | Disables the `purescript` module. |
### Variables
| Variable | Beispiel | Beschreibung |
| --------- | -------- | ------------------------------------ |
| version | `0.13.5` | The version of `purescript` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### Beispiel
```toml
# ~/.config/starship.toml
[purescript]
format = "via [$symbol$version](bold white)"
```

2
docs/de-DE/guide/README.md
View File

@ -199,7 +199,7 @@
#### PowerShell #### PowerShell
Trage folgendes am Ende der `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` (oder `~/.config/powershell/Microsoft.PowerShell_profile.ps1` auf -Nix) ein: Add the following to the end of `Microsoft.PowerShell_profile.ps1`. You can check the location of this file by querying the `$PROFILE` variable in PowerShell. Typically the path is `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` or `~/.config/powershell/Microsoft.PowerShell_profile.ps1` on -Nix.
```sh ```sh
Invoke-Expression (&starship init powershell) Invoke-Expression (&starship init powershell)

2
docs/de-DE/presets/README.md
View File

@ -84,7 +84,7 @@ symbol = " "
symbol = " " symbol = " "
[rust] [rust]
symbol = " " symbol = " "
[swift] [swift]
symbol = "ﯣ " symbol = "ﯣ "

8
docs/es-ES/README.md
View File

@ -2,7 +2,7 @@
home: true home: true
heroImage: /logo.svg heroImage: /logo.svg
heroText: heroText:
tagline: '¡El prompt minimalista, increíblemente rápido, e infinitamente personalizable para cualquier shell!' tagline: '¡El prompt minimalista, ultrarápido e infinitamente personalizable para cualquier intérprete de comandos!'
actionText: Comenzar → actionText: Comenzar →
actionLink: ./guide/ actionLink: ./guide/
features: features:
@ -30,7 +30,7 @@ description: Starship es el símbolo de sistema minimalista, ultrarápido e infi
### Instalación rápida ### Instalación rápida
1. Instalar el binario de **starship**: 1. Instalar el binario de **Starship**:
#### Instalar la última versión #### Instalar la última versión
@ -94,11 +94,9 @@ description: Starship es el símbolo de sistema minimalista, ultrarápido e infi
#### Powershell #### Powershell
Añade el siguiente código al final de `~\Documentos\PowerShell\Microsoft.PowerShell_profile.ps1` (o `~/.config/powershell/Microsoft.PowerShell_profile.ps1` en sistemas *nix): Añade lo siguiente al final de `Microsoft.PowerShell_profile.ps1`. Puedes comprobar la ubicación de este archivo consultando la variable `$PROFILE` en PowerShell. Normalmente la ruta es `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` o `~/.config/powershell/Microsoft.PowerShell_profile.ps1` en -Nix.
```sh ```sh
# ~\Documentos\PowerShell\Profile.ps1
Invoke-Expression (&starship init powershell) Invoke-Expression (&starship init powershell)
``` ```

32
docs/es-ES/advanced-config/README.md
View File

@ -1,6 +1,6 @@
# Configuración Avanzada # Configuración Avanzada
Mientras que Starship es un prompt versátil, a veces necesitas más que editar `starhip.toml` para que haga ciertas cosas. Esta página detalla algunas de las técnicas de configuración más avanzadas en starship. Mientras que Starship es un prompt versátil, a veces necesitas más que editar `starhip.toml` para que haga ciertas cosas. Esta página detalla algunas de las técnicas de configuración más avanzadas en Starship.
::: aviso ::: aviso
@ -8,11 +8,11 @@ Las configuraciones de esta sección están sujetos a cambios en futuras version
::: :::
## Comandos pre-prompt y pre-ejecucucióne personalizados en Bash ## Comandos pre-prompt y pre-ejecucución personalizados en Bash
Bash no posee un framework formal de preexec/precmd como la mayoría de las demás shells. Por lo tanto, es complicado proveer una personalización completa en `bash`. Sin embargo, Starship te da la posibilidad de insertar de forma limitada tus propias funciones en el proceso de renderizado del prompt: Bash no posee un framework oficial de preexec/precmd como la mayoría de los demás intérpretes de comandos. Debido a esto, es difícil proporcionar "hooks" totalmente personalizables en `Bash`. Sin embargo, Starship te da la posibilidad de insertar de forma limitada tus propias funciones en el proceso de renderizado del prompt:
- Para ejecutar una función personalizada previa al renderizado del prompt, defina una nueva función y asigne su nombre a `starship_precmd_user_func`. Por ejemplo, para renderizar un cohete antes del prompt, se puede realizar así: - Para ejecutar una función personalizada previa al renderizado del prompt, define una nueva función y asigna su nombre a `starship_precmd_user_func`. Por ejemplo, para renderizar un cohete antes del prompt, se puede realizar así:
```bash ```bash
function blastoff(){ function blastoff(){
@ -21,21 +21,21 @@ function blastoff(){
starship_precmd_user_func="blastoff" starship_precmd_user_func="blastoff"
``` ```
- Para ejecutar una función personalizada antes de que un comando sea ejecutado, es posible usar el [mecanismo trap `DEBUG`](https://jichu4n.com/posts/debug-trap-and-prompt_command-in-bash/). No obstante, ¡**debes** atrapar la señal DEBUG *antes* de inicializar Starship! Starship puede preservar el valor de la trampa DEBUG, pero si el trampa es reemplazada después de que Starship inicie, alguna funcionalidad fallará. - Para ejecutar una función personalizada antes de que un comando sea ejecutado, es posible usar el [mecanismo trap `DEBUG`](https://jichu4n.com/posts/debug-trap-and-prompt_command-in-bash/). No obstante, ¡**debes** atrapar la señal DEBUG *antes* de inicializar Starship! Starship puede preservar el valor de la trampa DEBUG, pero si la trampa es reemplazada después de que Starship inicie, alguna funcionalidad fallará.
```bash ```bash
function blastoff(){ function blastoff(){
echo "🚀" echo "🚀"
} }
trap blastoff DEBUG # Trap DEBUG *before* running starship trap blastoff DEBUG # Trampa DEBUG *antes* de la ejecución de Starship
eval $(starship init bash) eval $(starship init bash)
``` ```
## Cambiar el título de la ventana ## Cambiar el Título de la Ventana
Algunas shells van a cambiar automáticamente el título de la ventana por ti. (por ejemplo, para mostrar tu directorio actual). Fish incluso lo hace de forma predeterminada. Starship no hace esto, pero es bastante sencillo añadir esta funcionalidad a `bash` o `zsh`. Algunos intérpretes de comandos van a cambiar automáticamente el título de la ventana por ti (p. ej., para mostrar tu directorio actual). Fish incluso lo hace por defecto. Starship no hace esto, pero es bastante sencillo añadir esta funcionalidad a `Bash` o `zsh`.
Primero, define una función para el cambio de titulo de la ventana (idéntico en bash y zsh): Primero, define una función para el cambio de título de la ventana (idéntico en Bash y zsh):
```bash ```bash
function set_win_title(){ function set_win_title(){
@ -43,9 +43,9 @@ function set_win_title(){
} }
``` ```
Puedes usar variables para personalizar este titulo (`$USER`, `$HOSTNAME` y `$PWD` son opciones populares). Puedes usar variables para personalizar este título (`$USER`, `$HOSTNAME` y `$PWD` son opciones populares).
En `bash`, establece que esta función sea la función precmd de Starship: En `Bash`, establece que esta función sea la función precmd de Starship:
```bash ```bash
starship_precmd_user_func="set_win_title" starship_precmd_user_func="set_win_title"
@ -57,9 +57,9 @@ En `zsh`, añade esto al array `precmd_functions`:
precmd_functions+=(set_win_title) precmd_functions+=(set_win_title)
``` ```
Si te gusta el resultado, añade estas líneas a tu archivo de configuración del shell (`~/.bashrc` o `~/.zsrhc`) para hacerlo permanente. Si te gusta el resultado, añade estas líneas a tu archivo de configuración del intérprete de comandos (`~/.bashrc` o `~/.zsrhc`) para hacerlo permanente.
Por ejemplo, si quieres mostrar tu directorio actual en el título de la pestaña de la terminal, añade el siguiente fragmento a tu `~/.ashrc` o `~/.zshrc`: Por ejemplo, si quieres mostrar tu directorio actual en el título de la pestaña de la terminal, añade el siguiente fragmento a tu `~/.bashrc` o `~/.zshrc`:
```bash ```bash
function set_win_title(){ function set_win_title(){
@ -68,9 +68,9 @@ function set_win_title(){
starship_precmd_user_func="set_win_title" starship_precmd_user_func="set_win_title"
``` ```
## Estilo de cadenas de texto ## Cadenas de Estilo
Los estilos de cadenas de texto son una lista de palabras, separadas por espacios en blanco. Las palabras no son sensibles a mayúsculas (es decir, `negrita` y `NeGriTa` se consideran la misma cadena). Cada palabra puede ser una de las siguientes: Las cadenas de estilo son una lista de palabras, separadas por espacios en blanco. Las palabras no son sensibles a mayúsculas (es decir, `bold` y `BoLd` se consideran la misma cadena). Cada palabra puede ser una de las siguientes:
- `bold` - `bold`
- `underline` - `underline`
@ -82,7 +82,7 @@ Los estilos de cadenas de texto son una lista de palabras, separadas por espacio
donde `<color>` es un especificador de color (discutido a continuación). `fg:<color>` y `<color>` hacen actualmente lo mismo, aunque esto puede cambiar en el futuro. El orden de las palabras en la cadena no importa. donde `<color>` es un especificador de color (discutido a continuación). `fg:<color>` y `<color>` hacen actualmente lo mismo, aunque esto puede cambiar en el futuro. El orden de las palabras en la cadena no importa.
El estilo `none` anula todas los otros estilos en una cadena de texto, por lo que, por ejemplo, `fg:red none fg:blue` creará una cadena de texto sin ningún tipo de estilo. Puede convertirse en un error usar `none` junto con otros estilos en el futuro. El token `none` anula todas las otras fichas en una cadena, por lo que, por ejemplo, `fg:red none fg:blue` creará una cadena sin ningún tipo de estilo. Puede convertirse en un error usar `none` junto con otros estilos en el futuro.
Un especificador de color puede ser uno de los siguientes: Un especificador de color puede ser uno de los siguientes:

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

File diff suppressed because it is too large Load Diff

40
docs/es-ES/faq/README.md
View File

@ -10,15 +10,15 @@
- **Configuración**: [archivos de configuración de matchai](https://github.com/matchai/dotfiles/blob/b6c6a701d0af8d145a8370288c00bb9f0648b5c2/.config/fish/config.fish) - **Configuración**: [archivos de configuración de matchai](https://github.com/matchai/dotfiles/blob/b6c6a701d0af8d145a8370288c00bb9f0648b5c2/.config/fish/config.fish)
- **Prompt**: [Starship](https://starship.rs/) - **Prompt**: [Starship](https://starship.rs/)
## How do I get command completion as shown in the demo GIF? ## ¿Cómo obtengo el autocompletado del comando como se muestra en el GIF?
Completion support is provided by your shell of choice. In the case of the demo, the demo was done with [Fish Shell](https://fishshell.com/), which provides completions by default. If you use Z Shell (zsh), I'd suggest taking a look at [zsh-autosuggestions](https://github.com/zsh-users/zsh-autosuggestions). El soporte de completado es proporcionado por el intérprete de órdenes elegido. En el caso de la demo, la demo se realizó con [Fish Shell](https://fishshell.com/), que proporciona el completado por defecto. Si usas Z Shell (zsh), te sugeriría echar un vistazo a [zsh-autosuggeries,](https://github.com/zsh-users/zsh-autosuggestions).
## Do top level `format` and `<module>.disabled` do the same thing? ## ¿`prompt_order` y `<module>.disabled` hacen lo mismo?
Sí, se pueden usar ambos para desactivar los módulos en el símbolo del sistema. Si todo lo que planeas es desactivar módulos, `<module>.disabled` es el método preferido por las siguientes razones: Sí, se pueden usar ambos para desactivar los módulos en el símbolo del sistema. Si todo lo que planeas es desactivar módulos, `<module>.disabled` es el método preferido por las siguientes razones:
- Disabling modules is more explicit than omitting them from the top level `format` - Deshabilitar módulos es más explícito que omitirlos del nivel superior `format`
- Los nuevos módulos se añadirán al símbolo del sistema en cuanto Starship se actualice - Los nuevos módulos se añadirán al símbolo del sistema en cuanto Starship se actualice
## La documentación dice que Starship es compatible con cualquier intérprete de comandos pero no soporta X Shell. ¿Por qué? ## La documentación dice que Starship es compatible con cualquier intérprete de comandos pero no soporta X Shell. ¿Por qué?
@ -34,7 +34,7 @@ STATUS=$?
# Calcula el número de tareas ejecutándose. # Calcula el número de tareas ejecutándose.
NUM_JOBS=$(jobs -p | wc -l) NUM_JOBS=$(jobs -p | wc -l)
# Set the prompt to the output of `starship prompt` # Establece el prompt a la salida de `starship prompt`
PS1="$(starship prompt --status=$STATUS --jobs=$NUM_JOBS)" PS1="$(starship prompt --status=$STATUS --jobs=$NUM_JOBS)"
``` ```
@ -56,37 +56,37 @@ Si obtienes un error como "_version 'GLIBC_2.18' not found (required by starship
curl -fsSL https://starship.rs/install.sh | bash -s -- --platform unknown-linux-musl curl -fsSL https://starship.rs/install.sh | bash -s -- --platform unknown-linux-musl
``` ```
## Why don't I see a glyph symbol in my prompt? ## ¿Por qué no veo un símbolo de glifo en mi prompt?
The most common cause of this is system misconfiguration. Some Linux distros in particular do not come with font support out-of-the-box. You need to ensure that: La causa más común de esto es la mala configuración del sistema. Algunas distribuciones de Linux en particular no vienen con soporte de fuentes "listo para usare". Tienes que asegurar que:
- Your locale is set to a UTF-8 value, like `de_DE.UTF-8` or `ja_JP.UTF-8`. If `LC_ALL` is not a UTF-8 value, [you will need to change it](https://www.tecmint.com/set-system-locales-in-linux/). - Tu configuración regional está establecida con un valor UTF-8, como `de_DE.UTF-8` o `ja_JP.UTF-8`. Si `LC_ALL` no es un valor UTF-8, [necesitarás cambiarlo](https://www.tecmint.com/set-system-locales-in-linux/).
- You have an emoji font installed. Most systems come with an emoji font by default, but some (notably Arch Linux) do not. You can usually install one through your system's package manager--[noto emoji](https://www.google.com/get/noto/help/emoji/) is a popular choice. - Tienes una fuente emoji instalada. La mayoría de los sistemas vienen con una fuente emoji por defecto, pero algunos (notablemente Arch Linux) no. Generalmente puedes instalar uno a través del gestor de paquetes del sistema --[noto emoji](https://www.google.com/get/noto/help/emoji/) es una elección popular.
- You are using a [Nerd Font](https://www.nerdfonts.com/). - Estás usando un [Nerd Font](https://www.nerdfonts.com/).
To test your system, run the following commands in a terminal: Para probar tu sistema, ejecuta los siguientes comandos en un terminal:
```sh ```sh
echo -e "\xf0\x9f\x90\x8d" echo -e "\xf0\x9f\x90\x8d"
echo -e "\xee\x82\xa0" echo -e "\xee\x82\xa0"
``` ```
The first line should produce a [snake emoji](https://emojipedia.org/snake/), while the second should produce a [powerline branch symbol (e0a0)](https://github.com/ryanoasis/powerline-extra-symbols#glyphs). La primera línea debe producir un [emoji snake](https://emojipedia.org/snake/), mientras que la segunda debe producir un [símbolo de rama de powerline (e0a0)](https://github.com/ryanoasis/powerline-extra-symbols#glyphs).
If either symbol fails to display correctly, your system is still misconfigured. Unfortunately, getting font configuration correct is sometimes difficult. Users on the Discord may be able to help. If both symbols display correctly, but you still don't see them in starship, [file a bug report!](https://github.com/starship/starship/issues/new/choose) Si cualquiera de los dos símbolos no se puede mostrar correctamente, tu sistema todavía está mal configurado. Desafortunadamente, obtener la configuración correcta de las fuentes es a veces difícil. Los usuarios en el Discord te pueden ayudar. Si ambos símbolos se muestran correctamente, pero todavía no los ves en starship, [¡envía un informe de error!](https://github.com/starship/starship/issues/new/choose)
## How do I uninstall Starship? ## ¿Cómo puedo desinstalar Starship?
Starship is just as easy to uninstall as it is to install in the first place. Starship es tan fácil de desinstalar como de instalar en primer lugar.
1. Remove any lines in your shell config (e.g. `~/.bashrc`) used to initialize Starship. 1. Elimina cualquier línea de tu configuración de shell (por ejemplo, `~/.bashrc`) usada para inicializar Starship.
1. Delete the Starship binary. 1. Elimina el binario de Starship.
If Starship was installed using a package manager, please refer to their docs for uninstallation instructions. Si Starship fue instalado usando un gestor de paquetes, por favor refiérere a sus documentos para instrucciones de desinstalación.
If Starship was installed using the `curl | bash` script, the following command will delete the binary: Si Starship fue instalado usando el script `curl | bash`, el siguiente comando eliminará el binario:
```sh ```sh
# Locate and delete the starship binary # Localiza y elimina el binario de starship
rm "$(which starship)" rm "$(which starship)"
``` ```

28
docs/es-ES/guide/README.md
View File

@ -2,7 +2,7 @@
<img <img
width="400" width="400"
src="https://raw.githubusercontent.com/starship/starship/master/media/logo.png" src="https://raw.githubusercontent.com/starship/starship/master/media/logo.png"
alt="Starship - Prompt multi interfaz de línea de comandos" /> alt="Starship - Prompt multi intérprete de comandos" />
</p> </p>
<p align="center"> <p align="center">
@ -101,18 +101,18 @@
align="right" /> align="right" />
**El símbolo del sistema minimalista, ultrarápido e infinitamente customizable para cualquier intérprete de comandos!** **¡El prompt minimalista, ultrarápido e infinitamente personalizable para cualquier intérprete de comandos!**
- **Rápido:** es rápido – _muy muy_ rápido! 🚀 - **Rápido:** es rápido – _realmente_ rápido! 🚀
- **Personalizable:** configura cada parte de tu intérprete de comandos. - **Personalizable:** configura cada parte de tu prompt.
- **Universal:** funciona en cualquier intérprete de comandos, en cualquier sistema operativo. - **Universal:** funciona en cualquier intérprete de comandos, en cualquier sistema operativo.
- **Inteligente:** muestra información relevante de un vistazo. - **Inteligente:** muestra información relevante de un vistazo.
- **Repleto de funciones**: con soporte para tus herramientas favoritas. - **Repleto de funciones**: con soporte para tus herramientas favoritas.
- **Fácil:** rápido de instalar – empieza a usarlo en minutos. - **Fácil:** rápido de instalar – empieza a usarlo en minutos.
<p align="center"> <p align="center">
<a href="https://starship.rs/config/"><strong>Explora la documentación de Starship&nbsp;&nbsp;</strong></a> <a href="https://starship.rs/config/"><strong>Explora la documentación de Starship&nbsp;&nbsp;▶</strong></a>
</p> </p>
<a name="🚀-installation"></a> <a name="🚀-installation"></a>
@ -125,13 +125,13 @@
### Comenzar ### Comenzar
1. Instala el binario de **starship**: 1. Instala el binario de **Starship**:
#### Instalar la última versión #### Instalar la última versión
##### Desde un binario precontruido, con Shell: ##### Desde un binario preconstruido, con el intérprete de comandos:
```sh ```sh
curl -fsSL https://starship.rs/install.sh | bash curl -fsSL https://starship.rs/install.sh | bash
@ -145,7 +145,7 @@
``` ```
#### Instalar vía un gestor de paquetes #### Instalar con un gestor de paquetes
##### Con [Homebew](https://brew.sh/): ##### Con [Homebew](https://brew.sh/):
@ -199,7 +199,7 @@
#### PowerShell #### PowerShell
Añade el siguiente código al final de `~\Documentos\PowerShell\Microsoft.PowerShell_profile.ps1` (o `~/.config/powershell/Microsoft.PowerShell_profile.ps1` en *nix): Añade lo siguiente al final de `Microsoft.PowerShell_profile.ps1`. Puedes comprobar la ubicación de este archivo consultando la variable `$PROFILE` en PowerShell. Normalmente la ruta es `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` o `~/.config/powershell/Microsoft.PowerShell_profile.ps1` en -Nix.
```sh ```sh
Invoke-Expression (&starship init powershell) Invoke-Expression (&starship init powershell)
@ -218,9 +218,9 @@
## 🤝 Colaborando ## 🤝 Colaborando
¡Siempre estamos buscando por colaboradores de **cualquier nivel**! Si estas buscando una manera fácil de ayudar este proyecto, puedes intentar resolver un problema con la etiqueta "[good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue)". ¡Siempre estamos buscando colaboradores de **todos los niveles y habilidades**! Si estas buscando una manera fácil de ayudar este proyecto, puedes intentar resolver un problema con la etiqueta "[good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue)".
Si quieres ayudar a colaborar a starship, por favor mira nuestra [Guía de Colaboradores](https://github.com/starship/starship/blob/master/CONTRIBUTING.md). Además, siéntete libre de entrar en nuestro [servidor de Discord](https://discord.gg/8Jzqu3T) y di "¡Hola!". 👋 Si quieres ayudar a colaborar a Starship, por favor mira nuestra [Guía de Colaboradores](https://github.com/starship/starship/blob/master/CONTRIBUTING.md). Además, siéntete libre de entrar en nuestro [servidor de Discord](https://discord.gg/8Jzqu3T) y di "¡Hola!". 👋
### Desarrolladores ### Desarrolladores
@ -252,13 +252,13 @@ Apoya este proyecto con tu organización. Su logo se mostrará aquí con un enla
## 💭 Inspirado por ## 💭 Inspirado por
Por favor, revisa estos proyectos que inspiraron la creación de starship. 🙏 Por favor, revisa estos proyectos que inspiraron la creación de Starship. 🙏
- **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** - Una prompt ZSH para astronautas. - **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** - Una prompt ZSH para astronautas.
- **[denysdovhan/robbyrussell-node](https://github.com/denysdovhan/robbyrussell-node)** - robbyrussel, tema multi interfaz de línea de comandos escrito en JavaScript. - **[denysdovhan/robbyrussell-node](https://github.com/denysdovhan/robbyrussell-node)** - robbyrussel, tema multi intérprete de comandos escrito en JavaScript.
- **[reujab/silver](https://github.com/reujab/silver)** - Una prompt con iconos, personalizable y multi interfaz de línea de comandos basada en PowerLine. - **[reujab/silver](https://github.com/reujab/silver)** - Una prompt multi intérprete de comandos personalizable, basada en Powerline con iconos.
<p align="center"> <p align="center">
<br> <br>

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

@ -1,16 +1,16 @@
# Migrating to v0.45.0 # Migrando a v0.45.0
Starship v0.45.0 is a release containing breaking changes, in preparation for the big v1.0.0. We have made some major changes around how configuration is done on the prompt, to allow for a greater degree of customization. Starship v0.45.0 es un lanzamiento que contiene cambios de ruptura, en preparación para la gran v1.0.0. Hemos hecho algunos cambios importantes en la forma en que se realiza la configuración en el prompt, para permitir un mayor grado de personalización.
This guide is intended to walk you through the breaking changes. Esta guía pretende guiarle a través de los cambios de ruptura.
## `prompt_order` has been replaced by a root-level `format` ## `prompt_order` ha sido reemplazado por un "nivel raíz" `format`
Previously to v0.45.0, `prompt_order` would accept an array of module names in the order which they should be rendered by Starship. Anterioramente a v0.45.0, `prompt_order` aceptaría un array de nombres de módulos en el orden que deberían ser renderizados por Starship.
Starship v0.45.0 instead accepts a `format` value, allowing for customization of the prompt outside of the modules themselves. En su lugar, Starship v0.45.0 acepta un valor de `format`, permitiendo la personalización del indicador fuera de los propios módulos.
**Example pre-v0.45.0 configuration** **Configuración de ejemplo pre-v0.45.0**
```toml ```toml
prompt_order = [ prompt_order = [
@ -31,7 +31,7 @@ prompt_order = [
] ]
``` ```
**Example v0.45.0 configuration** **Configuración de ejemplo v0.45.0**
```toml ```toml
format = """\ format = """\
@ -52,40 +52,40 @@ format = """\
""" """
``` ```
## Module `prefix` and `suffix` have been replaced by `format` ## El módulo `prefix` y `suffix` han sido reemplazados por `format`
Previously to v0.45.0, some modules would accept `prefix` and/or `suffix` in order to stylize the way that modules are rendered. Anteriormente a v0.45.0, algunos módulos aceptarían `prefix` y/o `suffix` para estilizar la forma en que se renderizan los módulos.
Starship v0.45.0 instead accepts a `format` value, allowing for further customization of how modules are rendered. Instead of defining a prefix and suffix for the context-based variables, the variables can now be substituted from within a format string, which represents the module's output. En su lugar, Starship v0.45.0 acepta un valor `format`, lo que permite una mayor personalización de cómo se renderizan los módulos. En lugar de definir un prefijo y un sufijo para las variables basadas en contextos, las variables ahora pueden ser sustituidas dentro de una cadena de formato, que representa la salida del módulo.
**Example pre-v0.45.0 configuration** **Configuración de ejemplo pre-v0.45.0**
```toml ```toml
[cmd_duration] [cmd_duration]
prefix = "took " prefix = "tomó "
``` ```
**Example v0.45.0 configuration** **Configuración de ejemplo v0.45.0**
```toml ```toml
[cmd_duration] [cmd_duration]
# $duration – The command duration (e.g. "15s") # $duration – La duración del comando (p. ej. "15s")
# $style – The default style of the module (e.g. "bold yellow") # $style – El estilo predeterminado del módulo (p. ej. "bold yellow")
format = "took [$duration]($style) " format = "tomó [$duration]($style) "
``` ```
### Affected Modules ### Módulos afectados
#### Character #### Character
| Removed Property | Replacement | | Propiedad eliminada | Reemplazo |
| ----------------------- | ---------------- | | ----------------------- | ---------------- |
| `symbol` | `success_symbol` | | `symbol` | `success_symbol` |
| `use_symbol_for_status` | `error_symbol` | | `use_symbol_for_status` | `error_symbol` |
| `style_success` | `success_symbol` | | `style_success` | `success_symbol` |
| `style_failure` | `error_symbol` | | `style_failure` | `error_symbol` |
**Changes to the Default Configuration** **Cambios a la configuración por defecto**
```diff ```diff
[character] [character]
@ -98,26 +98,26 @@ format = "took [$duration]($style) "
++ vicmd_symbol = "[❮](bold green)" ++ vicmd_symbol = "[❮](bold green)"
``` ```
Previously, the `use_symbol_for_status` property was used to configure the prompt to show the `error_symbol` when the last command resulted in a non-zero status code. Anteriormente, la propiedad `use_symbol_for_status` fue usada para configurar el prompt para mostrar el `error_symbol` cuando el último comando resultó en un código de estado distinto de cero.
With the release of v0.45.0, we now always use `error_symbol` after non-zero status codes, unifying `use_symbol_for_status` and `error_symbol` properties. Con la liberación de v0.45.0, ahora siempre usamos las propiedades `error_symbol` después de códigos de estado diferentes de cero, unificando `use_symbol_for_status` y `error_symbol`.
To configure the prompt to use the older `use_symbol_for_status = true` configuration, add the following to your config file: Para configurar el prompt para usar la configuración anterior `use_symbol_for_status = true`, agrega lo siguiente a tu archivo de configuración:
```toml ```toml
[character] [character]
error_symbol = "[✖](bold red)" error_symbol = "[✖](bold red)"
``` ```
*Note:* The `character` element automatically adds a space after, so unlike the other `format` strings, we specifically do not add one in the above examples. *Nota:* El elemento `character` añade automáticamente un espacio, así que a diferencia del otras cadenas `format`, no añadimos uno en los ejemplos anteriores.
#### Tiempo de ejecución #### Tiempo de Ejecución
| Removed Property | Replacement | | Propiedad eliminada | Reemplazo |
| ---------------- | ----------- | | ------------------- | --------- |
| `prefix` | `format` | | `prefix` | `format` |
**Changes to the Default Configuration** **Cambios a la configuración por defecto**
```diff ```diff
[cmd_duration] [cmd_duration]
@ -127,11 +127,11 @@ error_symbol = "[✖](bold red)"
#### Directory #### Directory
| Removed Property | Replacement | | Propiedad eliminada | Reemplazo |
| ---------------- | ----------- | | ------------------- | --------- |
| `prefix` | `format` | | `prefix` | `format` |
**Changes to the Default Configuration** **Cambios a la configuración por defecto**
```diff ```diff
[directory] [directory]
@ -141,12 +141,12 @@ error_symbol = "[✖](bold red)"
#### Variable de entorno #### Variable de entorno
| Removed Property | Replacement | | Propiedad eliminada | Reemplazo |
| ---------------- | ----------- | | ------------------- | --------- |
| `prefix` | `format` | | `prefix` | `format` |
| `suffix` | `format` | | `suffix` | `format` |
**Changes to the Default Configuration** **Cambios a la configuración por defecto**
```diff ```diff
[env_var] [env_var]
@ -157,12 +157,12 @@ error_symbol = "[✖](bold red)"
#### Git commit #### Git commit
| Removed Property | Replacement | | Propiedad eliminada | Reemplazo |
| ---------------- | ----------- | | ------------------- | --------- |
| `prefix` | `format` | | `prefix` | `format` |
| `suffix` | `format` | | `suffix` | `format` |
**Changes to the Default Configuration** **Cambios a la configuración por defecto**
```diff ```diff
[git_commit] [git_commit]
@ -173,13 +173,13 @@ error_symbol = "[✖](bold red)"
#### Git status #### Git status
| Removed Property | Replacement | | Propiedad eliminada | Reemplazo |
| ----------------- | ----------- | | ------------------- | --------- |
| `prefix` | `format` | | `prefix` | `format` |
| `suffix` | `format` | | `suffix` | `format` |
| `show_sync_count` | `format` | | `show_sync_count` | `format` |
**Changes to the Default Configuration** **Cambios a la configuración por defecto**
```diff ```diff
[git_status] [git_status]
@ -189,11 +189,11 @@ error_symbol = "[✖](bold red)"
++ format = '([\[$all_status$ahead_behind\]]($style) )' ++ format = '([\[$all_status$ahead_behind\]]($style) )'
``` ```
Previously, the `show_sync_count` property was used to configure the prompt to show the number of commits the branch was ahead or behind the remote branch. Anteriormente, la propiedad `show_sync_count` fue usada para configurar el prompt para mostrar el número de confirmaciones que la rama estaba por delante o detrás de la rama remota.
With the release of v0.45.0, this has been replaced with three separate properties, `ahead`, `behind`, and `diverged`. Con el lanzamiento de v0.45.0, esto ha sido reemplazado por tres propiedades separadas, `ahead`, `behind`, y `diverged`.
To configure the prompt to use the older `show_sync_count = true` configuration, set the following to your config file: Para configurar el prompt para usar la configuración anterior `show_sync_count = true`, establece lo siguiente en tu archivo de configuración:
```toml ```toml
[git_status] [git_status]
@ -204,12 +204,12 @@ behind = "⇣${count}"
#### Hostname #### Hostname
| Removed Property | Replacement | | Propiedad eliminada | Reemplazo |
| ---------------- | ----------- | | ------------------- | --------- |
| `prefix` | `format` | | `prefix` | `format` |
| `suffix` | `format` | | `suffix` | `format` |
**Changes to the Default Configuration** **Cambios a la configuración por defecto**
```diff ```diff
[hostname] [hostname]
@ -220,13 +220,13 @@ behind = "⇣${count}"
#### Singularity #### Singularity
| Removed Property | Replacement | | Propiedad eliminada | Reemplazo |
| ---------------- | ----------- | | ------------------- | --------- |
| `label` | `format` | | `label` | `format` |
| `prefix` | `format` | | `prefix` | `format` |
| `suffix` | `format` | | `suffix` | `format` |
**Changes to the Default Configuration** **Cambios a la configuración por defecto**
```diff ```diff
[singularity] [singularity]
@ -237,11 +237,11 @@ behind = "⇣${count}"
#### Hora #### Hora
| Removed Property | Replacement | | Propiedad eliminada | Reemplazo |
| ---------------- | ------------- | | ------------------- | ------------- |
| `format` | `time_format` | | `format` | `time_format` |
**Changes to the Default Configuration** **Cambios a la configuración por defecto**
```diff ```diff
[time] [time]
@ -250,14 +250,14 @@ behind = "⇣${count}"
++ format = "at 🕙[$time]($style) " ++ format = "at 🕙[$time]($style) "
``` ```
#### Custom Commands #### Comandos Personalizados
| Removed Property | Replacement | | Propiedad eliminada | Reemplazo |
| ---------------- | ----------- | | ------------------- | --------- |
| `prefix` | `format` | | `prefix` | `format` |
| `suffix` | `format` | | `suffix` | `format` |
**Changes to the Default Configuration** **Cambios a la configuración por defecto**
```diff ```diff
[custom.example] [custom.example]

6
docs/es-ES/presets/README.md
View File

@ -2,11 +2,11 @@
Aqui hay una colección de ajustes predeterminados creados por la comunidad de Starship. ¡Si quieres compartir un ajuste predeterminado, por favor, [envía un PR](https://github.com/starship/starship/edit/master/docs/presets/README.md) actualizando este archivo! 😊 Aqui hay una colección de ajustes predeterminados creados por la comunidad de Starship. ¡Si quieres compartir un ajuste predeterminado, por favor, [envía un PR](https://github.com/starship/starship/edit/master/docs/presets/README.md) actualizando este archivo! 😊
## Símbolos Nerd Font ## Símbolos de Nerd Font
Este ajuste predeterminado no modifica nada excepto los símbolos usados para cada módulo. Si los emojis no son lo tuyo, ¡esto podría llamar tu atención! Este ajuste predeterminado no modifica nada excepto los símbolos usados para cada módulo. Si los emojis no son lo tuyo, ¡esto podría llamar tu atención!
![Captura de pantalla de los ajustes predeterminados de los Símbolos Nerd Font](/presets/nerd-font-symbols.png) ![Captura de pantalla de los ajustes predeterminados de los Símbolos de Nerd Font](/presets/nerd-font-symbols.png)
### Prerequisitos ### Prerequisitos
@ -84,7 +84,7 @@ symbol = " "
symbol = " " symbol = " "
[rust] [rust]
symbol = " " symbol = " "
[swift] [swift]
symbol = "ﯣ " symbol = "ﯣ "

4
docs/fr-FR/README.md
View File

@ -94,11 +94,9 @@ description: Starship est un invite minimaliste, ultra-rapide et hautement perso
#### Powershell #### Powershell
Ajouter ce qui suit à la fin de `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` (ou `~/.config/powershell/Microsoft.PowerShell_profile.ps1` sur -Nix): Ajoutez ce qui suit à la fin de `Microsoft.PowerShell_profile.ps1`. Vous pouvez vérifier l'emplacement de ce fichier en regardant la variable `$PROFILE` dans PowerShell. Typically the path is `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` or `~/.config/powershell/Microsoft.PowerShell_profile.ps1` on -Nix.
```sh ```sh
# ~\Documents\PowerShell\Profile.ps1
Invoke-Expression (&starship init powershell) Invoke-Expression (&starship init powershell)
``` ```

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

@ -33,9 +33,9 @@ De manière équivalente, pour Powershell (Windows), ajoutez la ligne suivante
$ENV:STARSHIP_CONFIG = "$HOME\.starship" $ENV:STARSHIP_CONFIG = "$HOME\.starship"
``` ```
### Logging ### Journalisation
By default starship logs warnings and errors into a file named `~/.cache/starship/session_${STARSHIP_SESSION_KEY}.log`, where the session key is corresponding to a instance of your terminal. This, however can be changed using the `STARSHIP_CACHE` environment variable: Par défaut, Starship enregistre les avertissements et les erreurs dans un fichier nommé `~/.cache/starship/session_${STARSHIP_SESSION_KEY}.log`, où la clé de session correspond à une instance de votre terminal. Ceci, peut cependant être modifié en utilisant la variable d'environnement `STARSHIP_CACHE`:
```sh ```sh
export STARSHIP_CACHE=~/.starship/cache export STARSHIP_CACHE=~/.starship/cache
@ -173,7 +173,7 @@ Le `format` par défaut est utilisé pour définir le format de l'invite, si il
```toml ```toml
format = "$all" format = "$all"
# Which is equivalent to # Ce qui est equivalent a:
format = """ format = """
$username\ $username\
$hostname\ $hostname\
@ -214,11 +214,13 @@ $conda\
$memory_usage\ $memory_usage\
$aws\ $aws\
$gcloud\ $gcloud\
$openstack\
$env_var\ $env_var\
$crystal\ $crystal\
$cmd_duration\ $cmd_duration\
$custom\ $custom\
$line_break\ $line_break\
$lua\
$jobs\ $jobs\
$battery\ $battery\
$time\ $time\
@ -426,16 +428,17 @@ vicmd_symbol = "[V](bold green) "
## CMake ## CMake
Le module `cmake` affiche la version actuellement installée de CMake si : Le module `cmake` affiche la version actuellement installée de CMake si l'une des conditions suivantes est remplie :
- Le répertoire actuel contient un fichier `CMakeLists.txt` - Le répertoire actuel contient un fichier `CMakeLists.txt`
- Le répertoire actuel contient un fichier ` CMakeCache.txt`
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ---------------------------------- | --------------------------------------------- | | ---------- | ---------------------------------- | --------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | Format du module. | | `format` | `"via [$symbol$version]($style) "` | Format du module. |
| `symbol` | `"🛆 "` | Le symbole utilisé avant la version de cmake. | | `symbol` | `"喝 "` | Le symbole utilisé avant la version de cmake. |
| `style` | `"bold blue"` | Le style du module. | | `style` | `"bold blue"` | Le style du module. |
| `disabled` | `false` | Désactive le module `cmake`. | | `disabled` | `false` | Désactive le module `cmake`. |
@ -463,13 +466,21 @@ Les utilisateurs de Bash qui ont besoin de fonctionnalité pré-exec peuvent uti
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------------- | ----------------------------- | ----------------------------------------------------------------- | | -------------------- | ----------------------------- | ---------------------------------------------------------------------- |
| `min_time` | `2_000` | Durée la plus courte quand afficher le temps (en millisecondes). | | `min_time` | `2_000` | Durée la plus courte quand afficher le temps (en millisecondes). |
| `show_milliseconds` | `false` | Afficher les millisecondes en plus des secondes pendant la durée. | | `show_milliseconds` | `false` | Afficher les millisecondes en plus des secondes pendant la durée. |
| `format` | `"took [$duration]($style) "` | Format du module. | | `format` | `"took [$duration]($style) "` | Format du module. |
| `style` | `"bold yellow"` | Le style du module. | | `style` | `"bold yellow"` | Le style du module. |
| `disabled` | `false` | Désactive le module `cmd_duration`. | | `disabled` | `false` | Désactive le module `cmd_duration`. |
| `show_notifications` | `false` | Afficher les notifications du bureau lorsque la commande est terminée. |
| `min_time_to_notify` | `45_000` | Shortest duration for notification (in milliseconds). |
::: tip
Showing desktop notifications requires starship to be built with `rust-notify` support. You check if your starship supports notifications by running `STARSHIP_LOG=debug starship module cmd_duration -d 60000` when `show_notifications` is set to `true`.
:::
### Variables ### Variables
@ -492,32 +503,32 @@ format = "underwent [$duration](bold yellow)"
## Conda ## Conda
Le module `conda` affiche l'environnement conda actuel, si `$CONDA_DEFAULT_ENV` est défini. The `conda` module shows the current conda environment, if `$CONDA_DEFAULT_ENV` is set.
::: tip ::: tip
Cela ne supprime pas le modificateur d'invite de conda, vous pouvez exécuter `conda config --set changeps1 False`. This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`.
::: :::
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------------- | ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------- | ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `truncation_length` | `1` | The number of directories the environment path should be truncated to, if the environment was created via `conda create -p [path]`. `0` means no truncation. Also see the [`directory`](#directory) module. | | `truncation_length` | `1` | Le nombre de répertoires dans lesquels le chemin d'environnement (Path) doit être tronqué, si l'environnement a été créé via `conda create -p [path]`. `0` ne signifie pas de troncature. Regardez aussi le module [`directory`](#directory). |
| `symbol` | `"🅒 "` | The symbol used before the environment name. | | `symbol` | `"🅒 "` | Le symbole utilisé avant le nom d'environnement. |
| `style` | `"bold green"` | Le style du module. | | `style` | `"bold green"` | Le style du module. |
| `format` | `"[$symbol$environment]($style) "` | Format du module. | | `format` | `"[$symbol$environment]($style) "` | Format du module. |
| `ignore_base` | `true` | Ignores `base` environment when activated. | | `ignore_base` | `true` | Ignore l'environnement `base` lorsqu'il est activé. |
| `disabled` | `false` | Disables the `conda` module. | | `disabled` | `false` | Désactive le module `conda`. |
### Variables ### Variables
| Variable | Exemple | Description | | Variable | Exemple | Description |
| ----------- | ------------ | -------------------------------------- | | ------------- | ------------ | -------------------------------------- |
| environment | `astronauts` | The current conda environment | | environnement | `astronauts` | La version courante de conda |
| symbol | | Reflète la valeur de l'option `symbol` | | symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` | | style\* | | Reflète la valeur de l'option `style` |
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style \* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
@ -532,26 +543,26 @@ format = "[$symbol$environment](dimmed green) "
## Crystal ## Crystal
The `crystal` module shows the currently installed version of Crystal. Le module est affiché si l'une des ces conditions est remplie : The `crystal` module shows the currently installed version of Crystal. The module will be shown if any of the following conditions are met:
- The current directory contains a `shard.yml` file - Le répertoire courant contient un fichier `shard.yml`
- The current directory contains a `.cr` file - Le répertoire courant contient un fichier `.cr`
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ---------------------------------- | --------------------------------------------------------- | | ---------- | ---------------------------------- | ---------------------------------------------------------- |
| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | | `symbol` | `"🔮 "` | Le symbole utilisé avant d'afficher la version de crystal. |
| `style` | `"bold green"` | Le style du module. | | `style` | `"bold green"` | Le style du module. |
| `format` | `"via [$symbol$version]($style) "` | Format du module. | | `format` | `"via [$symbol$version]($style) "` | Format du module. |
| `disabled` | `false` | Disables the `crystal` module. | | `disabled` | `false` | Désactive le module `crystal`. |
### Variables ### Variables
| Variable | Exemple | Description | | Variable | Exemple | Description |
| --------- | --------- | -------------------------------------- | | --------- | --------- | -------------------------------------- |
| version | `v0.32.1` | The version of `crystal` | | version | `v0.32.1` | La version de `cristal` |
| symbol | | Reflète la valeur de l'option `symbol` | | symbole | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` | | style\* | | Reflète la valeur de l'option `style` |
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style \* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
@ -567,26 +578,26 @@ format = "via [✨ $version](bold blue) "
## Dart ## Dart
The `dart` module shows the currently installed version of Dart. Le module est affiché si l'une des ces conditions est remplie : The `dart` module shows the currently installed version of Dart. The module will be shown if any of the following conditions are met:
- The current directory contains a file with `.dart` extension - Le répertoire courant contient un fichier `.dart`
- The current directory contains a `.dart_tool` directory - Le répertoire courant contient un répertoire `.dart_tool`
- The current directory contains a `pubspec.yaml` or `pubspec.lock` file - Le répertoire courant contient un fichier `pubspec.yaml` ou `pubspec.lock`
### Options ### Options
| Option | Default | Description | | Option | Défaut | Description |
| ---------- | ---------------------------------- | ----------------------------------------------- | | ---------- | ---------------------------------- | -------------------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | Format du module. | | `format` | `"via [$symbol$version]($style) "` | Format du module. |
| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | | `symbol` | `"🎯 "` | Une chaîne de caractères représentant le symbole de Dart |
| `style` | `"bold blue"` | Le style du module. | | `style` | `"bold blue"` | Le style du module. |
| `disabled` | `false` | Disables the `dart` module. | | `disabled` | `false` | Désactive le module `dart`. |
### Variables ### Variables
| Variable | Exemple | Description | | Variable | Exemple | Description |
| --------- | -------- | -------------------------------------- | | --------- | -------- | -------------------------------------- |
| version | `v2.8.4` | The version of `dart` | | version | `v2.8.4` | La version de `dart` |
| symbol | | Reflète la valeur de l'option `symbol` | | symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` | | style\* | | Reflète la valeur de l'option `style` |
@ -601,7 +612,7 @@ The `dart` module shows the currently installed version of Dart. Le module est a
format = "via [🔰 $version](bold red) " format = "via [🔰 $version](bold red) "
``` ```
## Directory ## Dossier
The `directory` module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in. The `directory` module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in.
@ -611,23 +622,23 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| ------------------- | -------------------------------------------------- | -------------------------------------------------------------------------------- | | ------------------- | -------------------------------------------------- | ------------------------------------------------------------------------------------- |
| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. | | `truncation_length` | `3` | Le nombre de dossiers parents selon lesquels le répertoire courant doit être tronqué. |
| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. | | `truncate_to_repo` | `true` | Si oui ou non tronquer à la racine du repo git dans lequel vous vous trouvez. |
| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | Format du module. | | `format` | `"[$path]($style)[$read_only]($read_only_style) "` | Format du module. |
| `style` | `"bold cyan"` | Le style du module. | | `style` | `"bold cyan"` | Le style du module. |
| `disabled` | `false` | Disables the `directory` module. | | `disabled` | `false` | Désactive le module `directory`. |
| `read_only` | `"🔒"` | The symbol indicating current directory is read only. | | `read_only` | `"🔒"` | Le symbole indiquant que le répertoire courant est en lecture seule. |
| `read_only_style` | `"red"` | The style for the read only symbol. | | `read_only_style` | `"red"` | Le style du symbole en lecture seule. |
| `truncation_symbol` | `""` | The symbol to prefix to truncated paths. eg: "…/" | | `truncation_symbol` | `""` | Le symbole en préfixe aux chemins tronqués. eg: "…/" |
<details> <details>
<summary>This module has a few advanced configuration options that control how the directory is displayed.</summary> <summary>This module has a few advanced configuration options that control how the directory is displayed.</summary>
| Advanced Option | Default | Description | | Options avancées | Default | Description |
| --------------------------- | ------- | ---------------------------------------------------------------------------------------- | | --------------------------- | ------- | ---------------------------------------------------------------------------------------- |
| `substitutions` | | A table of substitutions to be made to the path. | | `substitutions` | | Table de substitutions à faire au chemin. |
| `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. | | `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. | | `use_logical_path` | `true` | Displays the logical path provided by the shell (`PWD`) instead of the path from the OS. |
@ -647,7 +658,7 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
| Variable | Exemple | Description | | Variable | Exemple | Description |
| --------- | --------------------- | ------------------------------------- | | --------- | --------------------- | ------------------------------------- |
| path | `"D:/Projects"` | The current directory path | | path | `"D:/Projects"` | Le chemin du répertoire courant |
| style\* | `"black bold dimmed"` | Reflète la valeur de l'option `style` | | style\* | `"black bold dimmed"` | Reflète la valeur de l'option `style` |
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style \* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
@ -674,7 +685,7 @@ The `docker_context` module shows the currently active [Docker context](https://
| `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. | | `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. |
| `style` | `"blue bold"` | Le style du module. | | `style` | `"blue bold"` | Le style du module. |
| `only_with_files` | `false` | Only show when there's a `docker-compose.yml` or `Dockerfile` in the current directory. | | `only_with_files` | `false` | Only show when there's a `docker-compose.yml` or `Dockerfile` in the current directory. |
| `disabled` | `true` | Disables the `docker_context` module. | | `disabled` | `true` | Désactive le module `docker_context`. |
### Variables ### Variables
@ -725,13 +736,13 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
| `symbol` | `"•NET "` | The symbol used before displaying the version of dotnet. | | `symbol` | `"•NET "` | The symbol used before displaying the version of dotnet. |
| `heuristic` | `true` | Use faster version detection to keep starship snappy. | | `heuristic` | `true` | Use faster version detection to keep starship snappy. |
| `style` | `"bold blue"` | Le style du module. | | `style` | `"bold blue"` | Le style du module. |
| `disabled` | `false` | Disables the `dotnet` module. | | `disabled` | `false` | Désactive le module `dotnet`. |
### Variables ### Variables
| Variable | Exemple | Description | | Variable | Exemple | Description |
| --------- | ---------------- | ------------------------------------------------------------------ | | --------- | ---------------- | ------------------------------------------------------------------ |
| version | `v3.1.201` | The version of `dotnet` sdk | | version | `v3.1.201` | La version du sdk `dotnet` |
| tfm | `netstandard2.0` | The Target Framework Moniker that the current project is targeting | | tfm | `netstandard2.0` | The Target Framework Moniker that the current project is targeting |
| symbol | | Reflète la valeur de l'option `symbol` | | symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` | | style\* | | Reflète la valeur de l'option `style` |
@ -751,7 +762,7 @@ heuristic = false
## Elixir ## Elixir
The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. Le module est affiché si l'une des ces conditions est remplie : The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. The module will be shown if any of the following conditions are met:
- The current directory contains a `mix.exs` file. - The current directory contains a `mix.exs` file.
@ -786,7 +797,7 @@ symbol = "🔮 "
## Elm ## Elm
The `elm` module shows the currently installed version of Elm. Le module est affiché si l'une des ces conditions est remplie : The `elm` module shows the currently installed version of Elm. The module will be shown if any of the following conditions are met:
- The current directory contains a `elm.json` file - The current directory contains a `elm.json` file
- The current directory contains a `elm-package.json` file - The current directory contains a `elm-package.json` file
@ -861,7 +872,7 @@ default = "unknown shell"
## Erlang ## Erlang
The `erlang` module shows the currently installed version of Erlang/OTP. Le module est affiché si l'une des ces conditions est remplie : The `erlang` module shows the currently installed version of Erlang/OTP. The module will be shown if any of the following conditions are met:
- The current directory contains a `rebar.config` file. - The current directory contains a `rebar.config` file.
- The current directory contains a `erlang.mk` file. - The current directory contains a `erlang.mk` file.
@ -870,7 +881,7 @@ The `erlang` module shows the currently installed version of Erlang/OTP. Le modu
| Option | Default | Description | | Option | Default | Description |
| ---------- | ---------------------------------- | -------------------------------------------------------- | | ---------- | ---------------------------------- | -------------------------------------------------------- |
| `symbol` | `"🖧 "` | The symbol used before displaying the version of erlang. | | `symbol` | `" "` | The symbol used before displaying the version of erlang. |
| `style` | `"bold green"` | Le style du module. | | `style` | `"bold green"` | Le style du module. |
| `format` | `"via [$symbol$version]($style) "` | Format du module. | | `format` | `"via [$symbol$version]($style) "` | Format du module. |
| `disabled` | `false` | Disables the `erlang` module. | | `disabled` | `false` | Disables the `erlang` module. |
@ -960,20 +971,23 @@ The `git_branch` module shows the active branch of the repo in your current dire
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | | -------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- |
| `format` | `"on [$symbol$branch]($style) "` | Format du module. Use `"$branch"` to refer to the current branch name. | | `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. |
| `symbol` | `" "` | A format string representing the symbol of git branch. | | `format` | `"on [$symbol$branch]($style) "` | Format du module. Use `"$branch"` to refer to the current branch name. |
| `style` | `"bold purple"` | Le style du module. | | `symbol` | `" "` | A format string representing the symbol of git branch. |
| `truncation_length` | `2^63 - 1` | Truncates a git branch to X graphemes. | | `style` | `"bold purple"` | Le style du module. |
| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. | | `truncation_length` | `2^63 - 1` | Truncates a git branch to X graphemes. |
| `disabled` | `false` | Disables the `git_branch` module. | | `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. |
| `only_attached` | `false` | Only show the branch name when not in a detached HEAD state. |
| `disabled` | `false` | Disables the `git_branch` module. |
### Variables ### Variables
| Variable | Exemple | Description | | Variable | Exemple | Description |
| --------- | -------- | ---------------------------------------------------------------------------------------------------- | | --------- | -------- | ---------------------------------------------------------------------------------------------------- |
| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached HEAD). | | branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached HEAD). |
| remote | `master` | The remote branch name. |
| symbol | | Reflète la valeur de l'option `symbol` | | symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` | | style\* | | Reflète la valeur de l'option `style` |
@ -992,17 +1006,19 @@ truncation_symbol = ""
## Git Commit ## Git Commit
The `git_commit` module shows the current commit hash of the repo in your current directory. The `git_commit` module shows the current commit hash and also the tag (if any) of the repo in your current directory.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| -------------------- | -------------------------- | ----------------------------------------------------- | | -------------------- | ------------------------------------------------------ | ----------------------------------------------------- |
| `commit_hash_length` | `7` | The length of the displayed git commit hash. | | `commit_hash_length` | `7` | The length of the displayed git commit hash. |
| `format` | `'[\($hash\)]($style) '` | Format du module. | | `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | Format du module. |
| `style` | `"bold green"` | Le style du module. | | `style` | `"bold green"` | Le style du module. |
| `only_detached` | `true` | Only show git commit hash when in detached HEAD state | | `only_detached` | `true` | Only show git commit hash when in detached HEAD state |
| `disabled` | `false` | Disables the `git_commit` module. | | `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown |
| `disabled` | `false` | Disables the `git_commit` module. |
### Variables ### Variables
@ -1020,6 +1036,7 @@ The `git_commit` module shows the current commit hash of the repo in your curren
[git_commit] [git_commit]
commit_hash_length = 4 commit_hash_length = 4
tag_symbol = "🔖 "
``` ```
## Git State ## Git State
@ -1147,7 +1164,7 @@ behind = "⇣${count}"
## Golang ## Golang
The `golang` module shows the currently installed version of Golang. Le module est affiché si l'une des ces conditions est remplie : The `golang` module shows the currently installed version of Golang. The module will be shown if any of the following conditions are met:
- The current directory contains a `go.mod` file - The current directory contains a `go.mod` file
- The current directory contains a `go.sum` file - The current directory contains a `go.sum` file
@ -1188,7 +1205,7 @@ format = "via [🏎💨 $version](bold cyan) "
## Helm ## Helm
The `helm` module shows the currently installed version of Helm. Le module est affiché si l'une des ces conditions est remplie : The `helm` module shows the currently installed version of Helm. The module will be shown if any of the following conditions are met:
- The current directory contains a `helmfile.yaml` file - The current directory contains a `helmfile.yaml` file
- The current directory contains a `Chart.yaml` file - The current directory contains a `Chart.yaml` file
@ -1258,7 +1275,7 @@ disabled = false
## Java ## Java
The `java` module shows the currently installed version of Java. Le module est affiché si l'une des ces conditions est remplie : The `java` module shows the currently installed version of Java. The module will be shown if any of the following conditions are met:
- The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt` or `.java-version` file - The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt` or `.java-version` file
- The current directory contains a file with the `.java`, `.class`, `.gradle` or `.jar` extension - The current directory contains a file with the `.java`, `.class`, `.gradle` or `.jar` extension
@ -1327,7 +1344,7 @@ threshold = 4
## Julia ## Julia
The `julia` module shows the currently installed version of Julia. Le module est affiché si l'une des ces conditions est remplie : The `julia` module shows the currently installed version of Julia. The module will be shown if any of the following conditions are met:
- The current directory contains a `Project.toml` file - The current directory contains a `Project.toml` file
- The current directory contains a `Manifest.toml` file - The current directory contains a `Manifest.toml` file
@ -1367,7 +1384,7 @@ Displays the current Kubernetes context name and, if set, the namespace from the
::: tip ::: tip
Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
::: :::
@ -1423,6 +1440,43 @@ The `line_break` module separates the prompt into two lines.
disabled = true disabled = true
``` ```
## Lua
The `lua` module shows the currently installed version of Lua. The module will be shown if any of the following conditions are met:
- The current directory contains a `.lua-version` file
- The current directory contains a `lua` directory
- The current directory contains a file with the `.lua` extension
### Options
| Option | Default | Description |
| ------------ | ---------------------------------- | -------------------------------------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | Format du module. |
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
| `style` | `"bold blue"` | Le style du module. |
| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. |
| `disabled` | `false` | Disables the `lua` module. |
### Variables
| Variable | Exemple | Description |
| --------- | -------- | -------------------------------------- |
| version | `v5.4.0` | The version of `lua` |
| symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` |
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Exemple
```toml
# ~/.config/starship.toml
[lua]
format = "via [🌕 $version](bold blue) "
```
## Memory Usage ## Memory Usage
The `memory_usage` module shows current system memory and swap usage. The `memory_usage` module shows current system memory and swap usage.
@ -1431,7 +1485,7 @@ By default the swap usage is displayed if the total system swap is non-zero.
::: tip ::: tip
Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
::: :::
@ -1465,11 +1519,8 @@ Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur
[memory_usage] [memory_usage]
disabled = false disabled = false
show_percentage = true
show_swap = true
threshold = -1 threshold = -1
symbol = " " symbol = " "
separator = "/"
style = "bold dimmed green" style = "bold dimmed green"
``` ```
@ -1511,7 +1562,7 @@ truncation_symbol = ""
## Nim ## Nim
The `nim` module shows the currently installed version of Nim. Le module est affiché si l'une des ces conditions est remplie : The `nim` module shows the currently installed version of Nim. The module will be shown if any of the following conditions are met:
- The current directory contains a `nim.cfg` file - The current directory contains a `nim.cfg` file
- The current directory contains a file with the `.nim` extension - The current directory contains a file with the `.nim` extension
@ -1522,7 +1573,7 @@ The `nim` module shows the currently installed version of Nim. Le module est aff
| Option | Default | Description | | Option | Default | Description |
| ---------- | ---------------------------------- | ----------------------------------------------------- | | ---------- | ---------------------------------- | ----------------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | Format du module | | `format` | `"via [$symbol$version]($style) "` | The format for the module |
| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. | | `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. |
| `style` | `"bold yellow"` | Le style du module. | | `style` | `"bold yellow"` | Le style du module. |
| `disabled` | `false` | Disables the `nim` module. | | `disabled` | `false` | Disables the `nim` module. |
@ -1587,7 +1638,7 @@ format = 'via [☃️ $state( \($name\))](bold blue) '
## NodeJS ## NodeJS
The `nodejs` module shows the currently installed version of NodeJS. Le module est affiché si l'une des ces conditions est remplie : The `nodejs` module shows the currently installed version of NodeJS. The module will be shown if any of the following conditions are met:
- The current directory contains a `package.json` file - The current directory contains a `package.json` file
- The current directory contains a `.node-version` file - The current directory contains a `.node-version` file
@ -1623,54 +1674,9 @@ The `nodejs` module shows the currently installed version of NodeJS. Le module e
format = "via [🤖 $version](bold green) " format = "via [🤖 $version](bold green) "
``` ```
## Package Version
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages.
- **npm** – The `npm` package version is extracted from the `package.json` present in the current directory
- **cargo** – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
- **poetry** – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
- **composer** – The `composer` package version is extracted from the `composer.json` present in the current directory
- **gradle** – The `gradle` package version is extracted from the `build.gradle` present
- **julia** - The package version is extracted from the `Project.toml` present
- **mix** - The `mix` package version is extracted from the `mix.exs` present
- **helm** - The `helm` chart version is extracted from the `Chart.yaml` present
- **maven** - The `maven` package version is extracted from the `pom.xml` present
> ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager.
### Options
| Option | Default | Description |
| ----------------- | ---------------------------------- | ---------------------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | Format du module. |
| `symbol` | `"📦 "` | The symbol used before displaying the version the package. |
| `style` | `"bold 208"` | Le style du module. |
| `display_private` | `false` | Enable displaying version for packages marked as private. |
| `disabled` | `false` | Disables the `package` module. |
### Variables
| Variable | Exemple | Description |
| --------- | -------- | -------------------------------------- |
| version | `v1.0.0` | The version of your package |
| symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` |
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Exemple
```toml
# ~/.config/starship.toml
[package]
format = "via [🎁 $version](208 bold) "
```
## OCaml ## OCaml
The `ocaml` module shows the currently installed version of OCaml. Le module est affiché si l'une des ces conditions est remplie : The `ocaml` module shows the currently installed version of OCaml. The module will be shown if any of the following conditions are met:
- The current directory contains a file with `.opam` extension or `_opam` directory - The current directory contains a file with `.opam` extension or `_opam` directory
- The current directory contains a `esy.lock` directory - The current directory contains a `esy.lock` directory
@ -1707,9 +1713,89 @@ The `ocaml` module shows the currently installed version of OCaml. Le module est
format = "via [🐪 $version]($style) " format = "via [🐪 $version]($style) "
``` ```
## OpenStack
The `openstack` module shows the current OpenStack cloud and project. The module only active when the `OS_CLOUD` env var is set, in which case it will read `clouds.yaml` file from any of the [default locations](https://docs.openstack.org/python-openstackclient/latest/configuration/index.html#configuration-files). to fetch the current project in use.
### Options
| Option | Default | Description |
| ---------- | --------------------------------------------------- | -------------------------------------------------------------- |
| `format` | `"on [$symbol$cloud(\\($project\\))]($style) "` | Format du module. |
| `symbol` | `"☁️ "` | The symbol used before displaying the current OpenStack cloud. |
| `style` | `"bold yellow"` | Le style du module. |
| `disabled` | `false` | Disables the `OpenStack` module. |
### Variables
| Variable | Exemple | Description |
| --------- | ------- | -------------------------------------- |
| cloud | `corp` | The current OpenStack cloud |
| project | `dev` | The current OpenStack project |
| symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` |
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Exemple
```toml
# ~/.config/starship.toml
[openstack]
format = "on [$symbol$cloud(\\($project\\))]($style) "
style = "bold yellow"
symbol = "☁️ "
```
## Package Version
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages.
- **npm** – The `npm` package version is extracted from the `package.json` present in the current directory
- **cargo** – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
- **poetry** – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
- **composer** – The `composer` package version is extracted from the `composer.json` present in the current directory
- **gradle** – The `gradle` package version is extracted from the `build.gradle` present
- **julia** - The package version is extracted from the `Project.toml` present
- **mix** - The `mix` package version is extracted from the `mix.exs` present
- **helm** - The `helm` chart version is extracted from the `Chart.yaml` present
- **maven** - The `maven` package version is extracted from the `pom.xml` present
> ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager.
### Options
| Option | Défaut | Description |
| ----------------- | ---------------------------------- | ---------------------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | Format du module. |
| `symbol` | `"📦 "` | The symbol used before displaying the version the package. |
| `style` | `"bold 208"` | Le style du module. |
| `display_private` | `false` | Enable displaying version for packages marked as private. |
| `disabled` | `false` | Disables the `package` module. |
### Variables
| Variable | Exemple | Description |
| --------- | -------- | -------------------------------------- |
| version | `v1.0.0` | The version of your package |
| symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` |
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Exemple
```toml
# ~/.config/starship.toml
[package]
format = "via [🎁 $version](208 bold) "
```
## Perl ## Perl
The `perl` module shows the currently installed version of Perl. Le module est affiché si l'une des ces conditions est remplie : The `perl` module shows the currently installed version of Perl. The module will be shown if any of the following conditions are met:
- The current directory contains a `Makefile.PL` or `Build.PL` file - The current directory contains a `Makefile.PL` or `Build.PL` file
- The current directory contains a `cpanfile` or `cpanfile.snapshot` file - The current directory contains a `cpanfile` or `cpanfile.snapshot` file
@ -1719,7 +1805,7 @@ The `perl` module shows the currently installed version of Perl. Le module est a
### Options ### Options
| Option | Default | Description | | Option | Défaut | Description |
| ---------- | ---------------------------------- | ----------------------------------------------------- | | ---------- | ---------------------------------- | ----------------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | The format string for the module. | | `format` | `"via [$symbol$version]($style) "` | The format string for the module. |
| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | | `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl |
@ -1745,7 +1831,7 @@ format = "via [🦪 $version]($style) "
## PHP ## PHP
The `php` module shows the currently installed version of PHP. Le module est affiché si l'une des ces conditions est remplie : The `php` module shows the currently installed version of PHP. The module will be shown if any of the following conditions are met:
- The current directory contains a `composer.json` file - The current directory contains a `composer.json` file
- The current directory contains a `.php-version` file - The current directory contains a `.php-version` file
@ -1779,13 +1865,48 @@ The `php` module shows the currently installed version of PHP. Le module est aff
format = "via [🔹 $version](147 bold) " format = "via [🔹 $version](147 bold) "
``` ```
## PureScript
The `purescript` module shows the currently installed version of PureScript version. The module will be shown if any of the following conditions are met:
- The current directory contains a `spago.dhall` file
- The current directory contains a \*.purs files
### Options
| Option | Défaut | Description |
| ---------- | ---------------------------------- | ------------------------------------------------------------ |
| `format` | `"via [$symbol$version]($style) "` | Format du module. |
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
| `style` | `"bold white"` | Le style du module. |
| `disabled` | `false` | Disables the `purescript` module. |
### Variables
| Variable | Exemple | Description |
| --------- | -------- | -------------------------------------- |
| version | `0.13.5` | The version of `purescript` |
| symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` |
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Exemple
```toml
# ~/.config/starship.toml
[purescript]
format = "via [$symbol$version](bold white)"
```
## Python ## Python
The `python` module shows the currently installed version of Python and the current Python virtual environment if one is activated. The `python` module shows the currently installed version of Python and the current Python virtual environment if one is activated.
If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. 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`.
Le module est affiché si l'une des ces conditions est remplie : The module will be shown if any of the following conditions are met:
- The current directory contains a `.python-version` file - The current directory contains a `.python-version` file
- The current directory contains a `requirements.txt` file - The current directory contains a `requirements.txt` file
@ -1844,7 +1965,7 @@ python_binary = "python3"
## Ruby ## Ruby
The `ruby` module shows the currently installed version of Ruby. Le module est affiché si l'une des ces conditions est remplie : The `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met:
- The current directory contains a `Gemfile` file - The current directory contains a `Gemfile` file
- The current directory contains a `.ruby-version` file - The current directory contains a `.ruby-version` file
@ -1880,7 +2001,7 @@ symbol = "🔺 "
## Rust ## Rust
The `rust` module shows the currently installed version of Rust. Le module est affiché si l'une des ces conditions est remplie : The `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met:
- The current directory contains a `Cargo.toml` file - The current directory contains a `Cargo.toml` file
- The current directory contains a file with the `.rs` extension - The current directory contains a file with the `.rs` extension
@ -1980,48 +2101,13 @@ The `singularity` module shows the current singularity image, if inside a contai
format = '[📦 \[$env\]]($style) ' format = '[📦 \[$env\]]($style) '
``` ```
## Swift
The `swift` module shows the currently installed version of Swift. Le module est affiché si l'une des ces conditions est remplie :
- The current directory contains a `Package.swift` file
- The current directory contains a file with the `.swift` extension
### Options
| Option | Défaut | Description |
| ---------- | ---------------------------------- | ------------------------------------------------ |
| `format` | `"via [$symbol$version]($style) "` | Format du module. |
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
| `style` | `"bold 202"` | Le style du module. |
| `disabled` | `false` | Disables the `swift` module. |
### Variables
| Variable | Exemple | Description |
| --------- | -------- | -------------------------------------- |
| version | `v5.2.4` | The version of `swift` |
| symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` |
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Exemple
```toml
# ~/.config/starship.toml
[swift]
format = "via [🏎 $version](red bold)"
```
## Status ## Status
The `status` module displays the exit code of the previous command. The module will be shown only if the exit code is not `0`. The `status` module displays the exit code of the previous command. The module will be shown only if the exit code is not `0`.
::: tip ::: tip
Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. ::: This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. :::
### Options ### Options
@ -2056,12 +2142,47 @@ disabled = false
``` ```
## Swift
The `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met:
- The current directory contains a `Package.swift` file
- The current directory contains a file with the `.swift` extension
### Options
| Option | Défaut | Description |
| ---------- | ---------------------------------- | ------------------------------------------------ |
| `format` | `"via [$symbol$version]($style) "` | Format du module. |
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
| `style` | `"bold 202"` | Le style du module. |
| `disabled` | `false` | Disables the `swift` module. |
### Variables
| Variable | Exemple | Description |
| --------- | -------- | -------------------------------------- |
| version | `v5.2.4` | The version of `swift` |
| symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` |
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Exemple
```toml
# ~/.config/starship.toml
[swift]
format = "via [🏎 $version](red bold)"
```
## Terraform ## Terraform
The `terraform` module shows the currently selected terraform workspace and version. By default the terraform version is not shown, since this is slow on current versions of terraform when a lot of plugins are in use. If you still want to enable it, [follow the example shown below](#with-version). Le module est affiché si l'une des ces conditions est remplie : The `terraform` module shows the currently selected terraform workspace and version. By default the terraform version is not shown, since this is slow on current versions of terraform when a lot of plugins are in use. If you still want to enable it, [follow the example shown below](#with-version). The module will be shown if any of the following conditions are met:
- The current directory contains a `.terraform` folder - The current directory contains a `.terraform` folder
- Current directory contains a file with the `.tf` extension - Current directory contains a file with the `.tf` or `.hcl` extensions
### Options ### Options
@ -2105,33 +2226,33 @@ format = "[🏎💨 $workspace]($style) "
## Temps ## Temps
Le module `time` affiche l'heure actuelle **localement**. La valeur de `format` est utilisée par le package [`chrono`](https://crates.io/crates/chrono) pour contrôler la façon dont l'heure est affichée. Consultez la [doc de chrono strftime](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) pour découvrir les options disponibles. 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 ::: tip
Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
::: :::
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| ----------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `format` | `"at [$time]($style) "` | The format string for the module. | | `format` | `"at [$time]($style) "` | The format string for the module. |
| `use_12hr` | `false` | Activer le format 12h | | `use_12hr` | `false` | Enables 12 hour formatting |
| `time_format` | voir plus bas | Le [format chrono](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) utilisé pour formater l'heure. | | `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. |
| `style` | `"bold yellow"` | Le style utilisé par le module | | `style` | `"bold yellow"` | The style for the module time |
| `utc_time_offset` | `"local"` | Définir le décalage horaire UTC à utiliser. Range from -24 &lt; x &lt; 24. Accepte des nombres décimaux pour s'adapter aux décalages de 30/45 minutes. | | `utc_time_offset` | `"local"` | Sets the UTC offset to use. Range from -24 &lt; x &lt; 24. Allows floats to accommodate 30/45 minute timezone offsets. |
| `disabled` | `true` | Désactiver le module `time`. | | `disabled` | `true` | Disables the `time` module. |
| `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | | `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format |
If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Sinon, il est défini comme `"%T"`. Manually setting `time_format` will override the `use_12hr` setting. If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Otherwise, it defaults to `"%T"`. Manually setting `time_format` will override the `use_12hr` setting.
### Variables ### Variables
| Variable | Exemple | Description | | Variable | Exemple | Description |
| --------- | ---------- | ------------------------------------- | | --------- | ---------- | ------------------------------------- |
| temps | `13:08:10` | The current time. | | time | `13:08:10` | The current time. |
| style\* | | Reflète la valeur de l'option `style` | | style\* | | Reflète la valeur de l'option `style` |
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style \* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
@ -2149,24 +2270,24 @@ utc_time_offset = "-5"
time_range = "10:00:00-14:00:00" time_range = "10:00:00-14:00:00"
``` ```
## Nom d'utilisateur ## Username
Le module `username` affiche le nom d'utilisateur de l'utilisateur actif. Le module est affiché si l'une des ces conditions est remplie : The `username` module shows active user's username. The module will be shown if any of the following conditions are met:
- L'utilisateur courant est root - The current user is root
- L'utilisateur courant est différent de celui connecté - The current user isn't the same as the one that is logged in
- L'utilisateur est actuellement connecté à une session SSH - The user is currently connected as an SSH session
- La variable `show_always` a comme valeur true - The variable `show_always` is set to true
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| ------------- | ----------------------- | ------------------------------------------------ | | ------------- | ----------------------- | ------------------------------------- |
| `style_root` | `"bold green"` | Le style utilisé quand l'utilisateur est root. | | `style_root` | `"bold green"` | The style used when the user is root. |
| `style_user` | `"bold yellow"` | Le style utilisé pour les utilisateurs non-root. | | `style_user` | `"bold yellow"` | The style used for non-root users. |
| `format` | `"[$user]($style) in "` | Format du module. | | `format` | `"[$user]($style) in "` | Format du module. |
| `show_always` | `false` | Toujours afficher le module `username`. | | `show_always` | `false` | Always shows the `username` module. |
| `disabled` | `false` | Désactiver le module `username`. | | `disabled` | `false` | Disables the `username` module. |
### Variables ### Variables
@ -2190,7 +2311,7 @@ show_always = true
## Zig ## Zig
The `zig` module shows the currently installed version of Zig. Le module est affiché si l'une des ces conditions est remplie : The `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met:
- The current directory contains a `.zig` file - The current directory contains a `.zig` file
@ -2277,11 +2398,11 @@ The order in which custom modules are shown can be individually set by including
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style \* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
#### Custom command shell #### Commandes shell personnalisées
`shell` accepts a non-empty list of strings, where: `shell` accepte une liste de chaînes non vide, où:
- The first string is the path to the shell to use to execute the command. - La première chaîne est le chemin vers le shell à utiliser pour exécuter la commande.
- Other following arguments are passed to the shell. - Other following arguments are passed to the shell.
If unset, it will fallback to STARSHIP_SHELL and then to "sh" on Linux, and "cmd /C" on Windows. If unset, it will fallback to STARSHIP_SHELL and then to "sh" on Linux, and "cmd /C" on Windows.
@ -2322,38 +2443,3 @@ command = "time /T"
files = ["*.pst"] files = ["*.pst"]
shell = ["pwsh.exe", "-NoProfile", "-Command", "-"] shell = ["pwsh.exe", "-NoProfile", "-Command", "-"]
``` ```
## PureScript
Le module `purescript` affiche la version courante de Purescript installée. Le module est affiché si l'une des ces conditions est remplie :
- The current directory contains a `spago.dhall` file
- The current directory contains a \*.purs files
### Options
| Option | Défaut | Description |
| ---------- | ---------------------------------- | ------------------------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | Format du module. |
| `symbol` | `"<=> "` | Le symbole utilisé avant d'afficher la version de PureScript. |
| `style` | `"bold white"` | Le style du module. |
| `disabled` | `false` | Désactive le module `purescript`. |
### Variables
| Variable | Exemple | Description |
| --------- | -------- | -------------------------------------- |
| version | `0.13.5` | The version of `purescript` |
| symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` |
\* : Cette variable ne peut être utilisée que comme partie d'une chaîne de style
### Exemple
```toml
# ~/.config/starship.toml
[purescript]
format = "via [$symbol$version](bold white)"
```

2
docs/fr-FR/guide/README.md
View File

@ -199,7 +199,7 @@
#### PowerShell #### PowerShell
Ajouter ce qui suit à la fin de `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` (ou `~/.config/powershell/Microsoft.PowerShell_profile.ps1` sur -Nix): Ajoutez ce qui suit à la fin de `Microsoft.PowerShell_profile.ps1`. Vous pouvez vérifier l'emplacement de ce fichier en regardant la variable `$PROFILE` dans PowerShell. Typically the path is `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` or `~/.config/powershell/Microsoft.PowerShell_profile.ps1` on -Nix.
```sh ```sh
Invoke-Expression (&starship init powershell) Invoke-Expression (&starship init powershell)

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

@ -125,7 +125,7 @@ error_symbol = "[✖](bold red)"
++ format = "took [$duration]($style) " ++ format = "took [$duration]($style) "
``` ```
#### Directory #### Dossier
| Removed Property | Replacement | | Removed Property | Replacement |
| ---------------- | ----------- | | ---------------- | ----------- |

2
docs/fr-FR/presets/README.md
View File

@ -84,7 +84,7 @@ symbol = " "
symbol = " " symbol = " "
[rust] [rust]
symbol = " " symbol = " "
[swift] [swift]
symbol = "ﯣ " symbol = "ﯣ "

4
docs/ja-JP/README.md
View File

@ -94,11 +94,9 @@ description: Starship はミニマルで、非常に高速で、カスタマイ
#### Powershell #### Powershell
`~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` (それか Nix上の `~/.config/powershell/Microsoft.PowerShell_profile.ps1` )の末尾に以下を追加してください。 Add the following to the end of `Microsoft.PowerShell_profile.ps1`. You can check the location of this file by querying the `$PROFILE` variable in PowerShell. Typically the path is `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` or `~/.config/powershell/Microsoft.PowerShell_profile.ps1` on -Nix.
```sh ```sh
# ~\Documents\PowerShell\Profile.ps1
Invoke-Expression (&starship init powershell) Invoke-Expression (&starship init powershell)
``` ```

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

File diff suppressed because it is too large Load Diff

2
docs/ja-JP/guide/README.md
View File

@ -199,7 +199,7 @@
#### PowerShell #### PowerShell
`~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` (それか Nix上の `~/.config/powershell/Microsoft.PowerShell_profile.ps1` )の末尾に以下を追加してください。 Add the following to the end of `Microsoft.PowerShell_profile.ps1`. You can check the location of this file by querying the `$PROFILE` variable in PowerShell. Typically the path is `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` or `~/.config/powershell/Microsoft.PowerShell_profile.ps1` on -Nix.
```sh ```sh
Invoke-Expression (&starship init powershell) Invoke-Expression (&starship init powershell)

2
docs/ja-JP/presets/README.md
View File

@ -84,7 +84,7 @@ symbol = " "
symbol = " " symbol = " "
[rust] [rust]
symbol = " " symbol = " "
[swift] [swift]
symbol = "ﯣ " symbol = "ﯣ "

4
docs/pt-BR/README.md
View File

@ -94,11 +94,9 @@ description: O Starship é o prompt minimalista, extremamente rápido e extremam
#### Powershell #### Powershell
Adicione o seguinte comando no final do arquivo `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` (ou `~/.config/powershell/Microsoft.PowerShell_profile.ps1` em -Nix): Add the following to the end of `Microsoft.PowerShell_profile.ps1`. You can check the location of this file by querying the `$PROFILE` variable in PowerShell. Typically the path is `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` or `~/.config/powershell/Microsoft.PowerShell_profile.ps1` on -Nix.
```sh ```sh
# ~\Documents\PowerShell\Profile.ps1
Invoke-Expression (&starship init powershell) Invoke-Expression (&starship init powershell)
``` ```

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

@ -214,11 +214,13 @@ $conda\
$memory_usage\ $memory_usage\
$aws\ $aws\
$gcloud\ $gcloud\
$openstack\
$env_var\ $env_var\
$crystal\ $crystal\
$cmd_duration\ $cmd_duration\
$custom\ $custom\
$line_break\ $line_break\
$lua\
$jobs\ $jobs\
$battery\ $battery\
$time\ $time\
@ -426,16 +428,17 @@ vicmd_symbol = "[V](bold green) "
## CMake ## CMake
The `cmake` module shows the currently installed version of CMake if: The `cmake` module shows the currently installed version of CMake if any of the following conditions are met:
- The current directory contains a `CMakeLists.txt` file - The current directory contains a `CMakeLists.txt` file
- The current directory contains a `CMakeCache.txt` file
### Opções ### Opções
| Option | Padrão | Descrição | | Option | Padrão | Descrição |
| ---------- | ---------------------------------- | -------------------------------------------- | | ---------- | ---------------------------------- | -------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. | | `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"🛆 "` | The symbol used before the version of cmake. | | `symbol` | `"喝 "` | The symbol used before the version of cmake. |
| `style` | `"bold blue"` | O estilo do módulo. | | `style` | `"bold blue"` | O estilo do módulo. |
| `disabled` | `false` | Disables the `cmake` module. | | `disabled` | `false` | Disables the `cmake` module. |
@ -463,13 +466,21 @@ Bash users who need preexec-like functionality can use [rcaloras's bash_preexec
### Opções ### Opções
| Option | Padrão | Descrição | | Option | Padrão | Descrição |
| ------------------- | ----------------------------- | ---------------------------------------------------------- | | -------------------- | ----------------------------- | ---------------------------------------------------------- |
| `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). | | `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). |
| `show_milliseconds` | `false` | Show milliseconds in addition to seconds for the duration. | | `show_milliseconds` | `false` | Show milliseconds in addition to seconds for the duration. |
| `format` | `"took [$duration]($style) "` | The format for the module. | | `format` | `"took [$duration]($style) "` | The format for the module. |
| `style` | `"bold yellow"` | O estilo do módulo. | | `style` | `"bold yellow"` | O estilo do módulo. |
| `disabled` | `false` | Disables the `cmd_duration` module. | | `disabled` | `false` | Disables the `cmd_duration` module. |
| `show_notifications` | `false` | Show desktop notifications when command completes. |
| `min_time_to_notify` | `45_000` | Shortest duration for notification (in milliseconds). |
::: tip
Showing desktop notifications requires starship to be built with `rust-notify` support. You check if your starship supports notifications by running `STARSHIP_LOG=debug starship module cmd_duration -d 60000` when `show_notifications` is set to `true`.
:::
### Variables ### Variables
@ -870,7 +881,7 @@ The `erlang` module shows the currently installed version of Erlang/OTP. The mod
| Option | Padrão | Descrição | | Option | Padrão | Descrição |
| ---------- | ---------------------------------- | -------------------------------------------------------- | | ---------- | ---------------------------------- | -------------------------------------------------------- |
| `symbol` | `"🖧 "` | The symbol used before displaying the version of erlang. | | `symbol` | `" "` | The symbol used before displaying the version of erlang. |
| `style` | `"bold red"` | O estilo do módulo. | | `style` | `"bold red"` | O estilo do módulo. |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. | | `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `disabled` | `false` | Disables the `erlang` module. | | `disabled` | `false` | Disables the `erlang` module. |
@ -960,20 +971,23 @@ The `git_branch` module shows the active branch of the repo in your current dire
### Opções ### Opções
| Option | Padrão | Descrição | | Option | Padrão | Descrição |
| ------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | | -------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- |
| `format` | `"on [$symbol$branch]($style) "` | The format for the module. Use `"$branch"` to refer to the current branch name. | | `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. |
| `symbol` | `" "` | A format string representing the symbol of git branch. | | `format` | `"on [$symbol$branch]($style) "` | The format for the module. Use `"$branch"` to refer to the current branch name. |
| `style` | `"bold purple"` | O estilo do módulo. | | `symbol` | `" "` | A format string representing the symbol of git branch. |
| `truncation_length` | `2^63 - 1` | Truncates a git branch to X graphemes. | | `style` | `"bold purple"` | O estilo do módulo. |
| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. | | `truncation_length` | `2^63 - 1` | Truncates a git branch to X graphemes. |
| `disabled` | `false` | Disables the `git_branch` module. | | `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. |
| `only_attached` | `false` | Only show the branch name when not in a detached HEAD state. |
| `disabled` | `false` | Disables the `git_branch` module. |
### Variables ### Variables
| Variável | Exemplo | Descrição | | Variável | Exemplo | Descrição |
| --------- | -------- | ---------------------------------------------------------------------------------------------------- | | --------- | -------- | ---------------------------------------------------------------------------------------------------- |
| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached HEAD). | | branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached HEAD). |
| remote | `master` | The remote branch name. |
| symbol | | Mirrors the value of option `symbol` | | symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` | | style\* | | Mirrors the value of option `style` |
@ -992,17 +1006,19 @@ truncation_symbol = ""
## Git commit ## Git commit
The `git_commit` module shows the current commit hash of the repo in your current directory. The `git_commit` module shows the current commit hash and also the tag (if any) of the repo in your current directory.
### Opções ### Opções
| Option | Padrão | Descrição | | Option | Padrão | Descrição |
| -------------------- | -------------------------- | ----------------------------------------------------- | | -------------------- | ------------------------------------------------------ | ----------------------------------------------------- |
| `commit_hash_length` | `7` | The length of the displayed git commit hash. | | `commit_hash_length` | `7` | The length of the displayed git commit hash. |
| `format` | `'[\($hash\)]($style) '` | The format for the module. | | `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | The format for the module. |
| `style` | `"bold green"` | O estilo do módulo. | | `style` | `"bold green"` | O estilo do módulo. |
| `only_detached` | `true` | Only show git commit hash when in detached HEAD state | | `only_detached` | `true` | Only show git commit hash when in detached HEAD state |
| `disabled` | `false` | Disables the `git_commit` module. | | `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown |
| `disabled` | `false` | Disables the `git_commit` module. |
### Variables ### Variables
@ -1020,6 +1036,7 @@ The `git_commit` module shows the current commit hash of the repo in your curren
[git_commit] [git_commit]
commit_hash_length = 4 commit_hash_length = 4
tag_symbol = "🔖 "
``` ```
## Git State ## Git State
@ -1423,7 +1440,44 @@ The `line_break` module separates the prompt into two lines.
disabled = true disabled = true
``` ```
## Uso de memória ## Lua
The `lua` module shows the currently installed version of Lua. The module will be shown if any of the following conditions are met:
- The current directory contains a `.lua-version` file
- The current directory contains a `lua` directory
- The current directory contains a file with the `.lua` extension
### Opções
| Option | Padrão | Descrição |
| ------------ | ---------------------------------- | -------------------------------------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
| `style` | `"bold blue"` | O estilo do módulo. |
| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. |
| `disabled` | `false` | Disables the `lua` module. |
### Variables
| Variável | Exemplo | Descrição |
| --------- | -------- | ------------------------------------ |
| version | `v5.4.0` | The version of `lua` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### Exemplo
```toml
# ~/.config/starship.toml
[lua]
format = "via [🌕 $version](bold blue) "
```
## Memory Usage
The `memory_usage` module shows current system memory and swap usage. The `memory_usage` module shows current system memory and swap usage.
@ -1465,11 +1519,8 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
[memory_usage] [memory_usage]
disabled = false disabled = false
show_percentage = true
show_swap = true
threshold = -1 threshold = -1
symbol = " " symbol = " "
separator = "/"
style = "bold dimmed green" style = "bold dimmed green"
``` ```
@ -1623,6 +1674,80 @@ The `nodejs` module shows the currently installed version of NodeJS. The module
format = "via [🤖 $version](bold green) " format = "via [🤖 $version](bold green) "
``` ```
## OCaml
The `ocaml` module shows the currently installed version of OCaml. The module will be shown if any of the following conditions are met:
- The current directory contains a file with `.opam` extension or `_opam` directory
- The current directory contains a `esy.lock` directory
- The current directory contains a `dune` or `dune-project` file
- The current directory contains a `jbuild` or `jbuild-ignore` file
- The current directory contains a `.merlin` file
- The current directory contains a file with `.ml`, `.mli`, `.re` or `.rei` extension
### Opções
| Option | Padrão | Descrição |
| ---------- | ---------------------------------- | ------------------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | The format string for the module. |
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
| `style` | `"bold yellow"` | O estilo do módulo. |
| `disabled` | `false` | Disables the `ocaml` module. |
### Variables
| Variável | Exemplo | Descrição |
| --------- | --------- | ------------------------------------ |
| version | `v4.10.0` | The version of `ocaml` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### Exemplo
```toml
# ~/.config/starship.toml
[ocaml]
format = "via [🐪 $version]($style) "
```
## OpenStack
The `openstack` module shows the current OpenStack cloud and project. The module only active when the `OS_CLOUD` env var is set, in which case it will read `clouds.yaml` file from any of the [default locations](https://docs.openstack.org/python-openstackclient/latest/configuration/index.html#configuration-files). to fetch the current project in use.
### Opções
| Option | Padrão | Descrição |
| ---------- | --------------------------------------------------- | -------------------------------------------------------------- |
| `format` | `"on [$symbol$cloud(\\($project\\))]($style) "` | The format for the module. |
| `symbol` | `"☁️ "` | The symbol used before displaying the current OpenStack cloud. |
| `style` | `"bold yellow"` | O estilo do módulo. |
| `disabled` | `false` | Disables the `OpenStack` module. |
### Variables
| Variável | Exemplo | Descrição |
| --------- | ------- | ------------------------------------ |
| cloud | `corp` | The current OpenStack cloud |
| project | `dev` | The current OpenStack project |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### Exemplo
```toml
# ~/.config/starship.toml
[openstack]
format = "on [$symbol$cloud(\\($project\\))]($style) "
style = "bold yellow"
symbol = "☁️ "
```
## Package Version ## Package Version
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages. The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages.
@ -1668,45 +1793,6 @@ The `package` module is shown when the current directory is the repository for a
format = "via [🎁 $version](208 bold) " format = "via [🎁 $version](208 bold) "
``` ```
## OCaml
The `ocaml` module shows the currently installed version of OCaml. The module will be shown if any of the following conditions are met:
- The current directory contains a file with `.opam` extension or `_opam` directory
- The current directory contains a `esy.lock` directory
- The current directory contains a `dune` or `dune-project` file
- The current directory contains a `jbuild` or `jbuild-ignore` file
- The current directory contains a `.merlin` file
- The current directory contains a file with `.ml`, `.mli`, `.re` or `.rei` extension
### Opções
| Option | Padrão | Descrição |
| ---------- | ---------------------------------- | ------------------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | The format string for the module. |
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
| `style` | `"bold yellow"` | O estilo do módulo. |
| `disabled` | `false` | Disables the `ocaml` module. |
### Variables
| Variável | Exemplo | Descrição |
| --------- | --------- | ------------------------------------ |
| version | `v4.10.0` | The version of `ocaml` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### Exemplo
```toml
# ~/.config/starship.toml
[ocaml]
format = "via [🐪 $version]($style) "
```
## Perl ## Perl
The `perl` module shows the currently installed version of Perl. The module will be shown if any of the following conditions are met: The `perl` module shows the currently installed version of Perl. The module will be shown if any of the following conditions are met:
@ -1779,6 +1865,41 @@ The `php` module shows the currently installed version of PHP. The module will b
format = "via [🔹 $version](147 bold) " format = "via [🔹 $version](147 bold) "
``` ```
## PureScript
The `purescript` module shows the currently installed version of PureScript version. The module will be shown if any of the following conditions are met:
- The current directory contains a `spago.dhall` file
- The current directory contains a \*.purs files
### Opções
| Option | Padrão | Descrição |
| ---------- | ---------------------------------- | ------------------------------------------------------------ |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
| `style` | `"bold white"` | O estilo do módulo. |
| `disabled` | `false` | Disables the `purescript` module. |
### Variables
| Variável | Exemplo | Descrição |
| --------- | -------- | ------------------------------------ |
| version | `0.13.5` | The version of `purescript` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### Exemplo
```toml
# ~/.config/starship.toml
[purescript]
format = "via [$symbol$version](bold white)"
```
## Python ## Python
The `python` module shows the currently installed version of Python and the current Python virtual environment if one is activated. The `python` module shows the currently installed version of Python and the current Python virtual environment if one is activated.
@ -1980,41 +2101,6 @@ The `singularity` module shows the current singularity image, if inside a contai
format = '[📦 \[$env\]]($style) ' format = '[📦 \[$env\]]($style) '
``` ```
## Swift
The `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met:
- The current directory contains a `Package.swift` file
- The current directory contains a file with the `.swift` extension
### Opções
| Option | Padrão | Descrição |
| ---------- | ---------------------------------- | ------------------------------------------------ |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
| `style` | `"bold 202"` | O estilo do módulo. |
| `disabled` | `false` | Disables the `swift` module. |
### Variables
| Variável | Exemplo | Descrição |
| --------- | -------- | ------------------------------------ |
| version | `v5.2.4` | The version of `swift` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### Exemplo
```toml
# ~/.config/starship.toml
[swift]
format = "via [🏎 $version](red bold)"
```
## Status ## Status
The `status` module displays the exit code of the previous command. The module will be shown only if the exit code is not `0`. The `status` module displays the exit code of the previous command. The module will be shown only if the exit code is not `0`.
@ -2056,12 +2142,47 @@ disabled = false
``` ```
## Swift
The `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met:
- The current directory contains a `Package.swift` file
- The current directory contains a file with the `.swift` extension
### Opções
| Option | Padrão | Descrição |
| ---------- | ---------------------------------- | ------------------------------------------------ |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
| `style` | `"bold 202"` | O estilo do módulo. |
| `disabled` | `false` | Disables the `swift` module. |
### Variables
| Variável | Exemplo | Descrição |
| --------- | -------- | ------------------------------------ |
| version | `v5.2.4` | The version of `swift` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### Exemplo
```toml
# ~/.config/starship.toml
[swift]
format = "via [🏎 $version](red bold)"
```
## Terraform ## Terraform
The `terraform` module shows the currently selected terraform workspace and version. By default the terraform version is not shown, since this is slow on current versions of terraform when a lot of plugins are in use. If you still want to enable it, [follow the example shown below](#with-version). The module will be shown if any of the following conditions are met: The `terraform` module shows the currently selected terraform workspace and version. By default the terraform version is not shown, since this is slow on current versions of terraform when a lot of plugins are in use. If you still want to enable it, [follow the example shown below](#with-version). The module will be shown if any of the following conditions are met:
- The current directory contains a `.terraform` folder - The current directory contains a `.terraform` folder
- Current directory contains a file with the `.tf` extension - Current directory contains a file with the `.tf` or `.hcl` extensions
### Opções ### Opções
@ -2258,7 +2379,7 @@ The order in which custom modules are shown can be individually set by including
| `command` | | The command whose output should be printed. The command will be passed on stdin to the shell. | | `command` | | The command whose output should be printed. The command will be passed on stdin to the shell. |
| `when` | | A shell command used as a condition to show the module. The module will be shown if the command returns a `0` status code. | | `when` | | A shell command used as a condition to show the module. The module will be shown if the command returns a `0` status code. |
| `shell` | | [See below](#custom-command-shell) | | `shell` | | [See below](#custom-command-shell) |
| `descrição` | `"<custom module>"` | The description of the module that is shown when running `starship explain`. | | `description` | `"<custom module>"` | The description of the module that is shown when running `starship explain`. |
| `files` | `[]` | The files that will be searched in the working directory for a match. | | `files` | `[]` | The files that will be searched in the working directory for a match. |
| `directories` | `[]` | The directories that will be searched in the working directory for a match. | | `directories` | `[]` | The directories that will be searched in the working directory for a match. |
| `extensions` | `[]` | The extensions that will be searched in the working directory for a match. | | `extensions` | `[]` | The extensions that will be searched in the working directory for a match. |
@ -2322,38 +2443,3 @@ command = "time /T"
files = ["*.pst"] files = ["*.pst"]
shell = ["pwsh.exe", "-NoProfile", "-Command", "-"] shell = ["pwsh.exe", "-NoProfile", "-Command", "-"]
``` ```
## PureScript
The `purescript` module shows the currently installed version of PureScript version. The module will be shown if any of the following conditions are met:
- The current directory contains a `spago.dhall` file
- The current directory contains a \*.purs files
### Opções
| Option | Padrão | Descrição |
| ---------- | ---------------------------------- | ------------------------------------------------------------ |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
| `style` | `"bold white"` | O estilo do módulo. |
| `disabled` | `false` | Disables the `purescript` module. |
### Variables
| Variável | Exemplo | Descrição |
| --------- | -------- | ------------------------------------ |
| version | `0.13.5` | The version of `purescript` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### Exemplo
```toml
# ~/.config/starship.toml
[purescript]
format = "via [$symbol$version](bold white)"
```

2
docs/pt-BR/guide/README.md
View File

@ -199,7 +199,7 @@
#### PowerShell #### PowerShell
Adicione o seguinte comando no final do arquivo `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` (ou `~/.config/powershell/Microsoft.PowerShell_profile.ps1` em -Nix): Add the following to the end of `Microsoft.PowerShell_profile.ps1`. You can check the location of this file by querying the `$PROFILE` variable in PowerShell. Typically the path is `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` or `~/.config/powershell/Microsoft.PowerShell_profile.ps1` on -Nix.
```sh ```sh
Invoke-Expression (&starship init powershell) Invoke-Expression (&starship init powershell)

2
docs/pt-BR/presets/README.md
View File

@ -84,7 +84,7 @@ symbol = " "
symbol = " " symbol = " "
[rust] [rust]
symbol = " " symbol = " "
[swift] [swift]
symbol = "ﯣ " symbol = "ﯣ "

4
docs/pt-PT/README.md
View File

@ -94,11 +94,9 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
#### Powershell #### Powershell
Add the following to the end of `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` (or `~/.config/powershell/Microsoft.PowerShell_profile.ps1` on -Nix): Add the following to the end of `Microsoft.PowerShell_profile.ps1`. You can check the location of this file by querying the `$PROFILE` variable in PowerShell. Typically the path is `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` or `~/.config/powershell/Microsoft.PowerShell_profile.ps1` on -Nix.
```sh ```sh
# ~\Documents\PowerShell\Profile.ps1
Invoke-Expression (&starship init powershell) Invoke-Expression (&starship init powershell)
``` ```

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

@ -214,11 +214,13 @@ $conda\
$memory_usage\ $memory_usage\
$aws\ $aws\
$gcloud\ $gcloud\
$openstack\
$env_var\ $env_var\
$crystal\ $crystal\
$cmd_duration\ $cmd_duration\
$custom\ $custom\
$line_break\ $line_break\
$lua\
$jobs\ $jobs\
$battery\ $battery\
$time\ $time\
@ -426,16 +428,17 @@ vicmd_symbol = "[V](bold green) "
## CMake ## CMake
The `cmake` module shows the currently installed version of CMake if: The `cmake` module shows the currently installed version of CMake if any of the following conditions are met:
- The current directory contains a `CMakeLists.txt` file - The current directory contains a `CMakeLists.txt` file
- The current directory contains a `CMakeCache.txt` file
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | ---------------------------------- | -------------------------------------------- | | ---------- | ---------------------------------- | -------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. | | `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"🛆 "` | The symbol used before the version of cmake. | | `symbol` | `"喝 "` | The symbol used before the version of cmake. |
| `style` | `"bold blue"` | The style for the module. | | `style` | `"bold blue"` | The style for the module. |
| `disabled` | `false` | Disables the `cmake` module. | | `disabled` | `false` | Disables the `cmake` module. |
@ -463,13 +466,21 @@ Bash users who need preexec-like functionality can use [rcaloras's bash_preexec
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------------- | ----------------------------- | ---------------------------------------------------------- | | -------------------- | ----------------------------- | ---------------------------------------------------------- |
| `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). | | `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). |
| `show_milliseconds` | `false` | Show milliseconds in addition to seconds for the duration. | | `show_milliseconds` | `false` | Show milliseconds in addition to seconds for the duration. |
| `format` | `"took [$duration]($style) "` | The format for the module. | | `format` | `"took [$duration]($style) "` | The format for the module. |
| `style` | `"bold yellow"` | The style for the module. | | `style` | `"bold yellow"` | The style for the module. |
| `disabled` | `false` | Disables the `cmd_duration` module. | | `disabled` | `false` | Disables the `cmd_duration` module. |
| `show_notifications` | `false` | Show desktop notifications when command completes. |
| `min_time_to_notify` | `45_000` | Shortest duration for notification (in milliseconds). |
::: tip
Showing desktop notifications requires starship to be built with `rust-notify` support. You check if your starship supports notifications by running `STARSHIP_LOG=debug starship module cmd_duration -d 60000` when `show_notifications` is set to `true`.
:::
### Variables ### Variables
@ -870,7 +881,7 @@ The `erlang` module shows the currently installed version of Erlang/OTP. The mod
| Option | Default | Description | | Option | Default | Description |
| ---------- | ---------------------------------- | -------------------------------------------------------- | | ---------- | ---------------------------------- | -------------------------------------------------------- |
| `symbol` | `"🖧 "` | The symbol used before displaying the version of erlang. | | `symbol` | `" "` | The symbol used before displaying the version of erlang. |
| `style` | `"bold red"` | The style for the module. | | `style` | `"bold red"` | The style for the module. |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. | | `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `disabled` | `false` | Disables the `erlang` module. | | `disabled` | `false` | Disables the `erlang` module. |
@ -960,20 +971,23 @@ The `git_branch` module shows the active branch of the repo in your current dire
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | | -------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- |
| `format` | `"on [$symbol$branch]($style) "` | The format for the module. Use `"$branch"` to refer to the current branch name. | | `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. |
| `symbol` | `" "` | A format string representing the symbol of git branch. | | `format` | `"on [$symbol$branch]($style) "` | The format for the module. Use `"$branch"` to refer to the current branch name. |
| `style` | `"bold purple"` | The style for the module. | | `symbol` | `" "` | A format string representing the symbol of git branch. |
| `truncation_length` | `2^63 - 1` | Truncates a git branch to X graphemes. | | `style` | `"bold purple"` | The style for the module. |
| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. | | `truncation_length` | `2^63 - 1` | Truncates a git branch to X graphemes. |
| `disabled` | `false` | Disables the `git_branch` module. | | `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. |
| `only_attached` | `false` | Only show the branch name when not in a detached HEAD state. |
| `disabled` | `false` | Disables the `git_branch` module. |
### Variables ### Variables
| Variable | Example | Description | | Variable | Example | Description |
| --------- | -------- | ---------------------------------------------------------------------------------------------------- | | --------- | -------- | ---------------------------------------------------------------------------------------------------- |
| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached HEAD). | | branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached HEAD). |
| remote | `master` | The remote branch name. |
| symbol | | Mirrors the value of option `symbol` | | symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` | | style\* | | Mirrors the value of option `style` |
@ -992,17 +1006,19 @@ truncation_symbol = ""
## Git Commit ## Git Commit
The `git_commit` module shows the current commit hash of the repo in your current directory. The `git_commit` module shows the current commit hash and also the tag (if any) of the repo in your current directory.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| -------------------- | -------------------------- | ----------------------------------------------------- | | -------------------- | ------------------------------------------------------ | ----------------------------------------------------- |
| `commit_hash_length` | `7` | The length of the displayed git commit hash. | | `commit_hash_length` | `7` | The length of the displayed git commit hash. |
| `format` | `'[\($hash\)]($style) '` | The format for the module. | | `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | The format for the module. |
| `style` | `"bold green"` | The style for the module. | | `style` | `"bold green"` | The style for the module. |
| `only_detached` | `true` | Only show git commit hash when in detached HEAD state | | `only_detached` | `true` | Only show git commit hash when in detached HEAD state |
| `disabled` | `false` | Disables the `git_commit` module. | | `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown |
| `disabled` | `false` | Disables the `git_commit` module. |
### Variables ### Variables
@ -1020,6 +1036,7 @@ The `git_commit` module shows the current commit hash of the repo in your curren
[git_commit] [git_commit]
commit_hash_length = 4 commit_hash_length = 4
tag_symbol = "🔖 "
``` ```
## Git State ## Git State
@ -1423,6 +1440,43 @@ The `line_break` module separates the prompt into two lines.
disabled = true disabled = true
``` ```
## Lua
The `lua` module shows the currently installed version of Lua. The module will be shown if any of the following conditions are met:
- The current directory contains a `.lua-version` file
- The current directory contains a `lua` directory
- The current directory contains a file with the `.lua` extension
### Options
| Option | Default | Description |
| ------------ | ---------------------------------- | -------------------------------------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
| `style` | `"bold blue"` | The style for the module. |
| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. |
| `disabled` | `false` | Disables the `lua` module. |
### Variables
| Variable | Example | Description |
| --------- | -------- | ------------------------------------ |
| version | `v5.4.0` | The version of `lua` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### Example
```toml
# ~/.config/starship.toml
[lua]
format = "via [🌕 $version](bold blue) "
```
## Memory Usage ## Memory Usage
The `memory_usage` module shows current system memory and swap usage. The `memory_usage` module shows current system memory and swap usage.
@ -1465,11 +1519,8 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
[memory_usage] [memory_usage]
disabled = false disabled = false
show_percentage = true
show_swap = true
threshold = -1 threshold = -1
symbol = " " symbol = " "
separator = "/"
style = "bold dimmed green" style = "bold dimmed green"
``` ```
@ -1623,6 +1674,80 @@ The `nodejs` module shows the currently installed version of NodeJS. The module
format = "via [🤖 $version](bold green) " format = "via [🤖 $version](bold green) "
``` ```
## OCaml
The `ocaml` module shows the currently installed version of OCaml. The module will be shown if any of the following conditions are met:
- The current directory contains a file with `.opam` extension or `_opam` directory
- The current directory contains a `esy.lock` directory
- The current directory contains a `dune` or `dune-project` file
- The current directory contains a `jbuild` or `jbuild-ignore` file
- The current directory contains a `.merlin` file
- The current directory contains a file with `.ml`, `.mli`, `.re` or `.rei` extension
### Options
| Option | Default | Description |
| ---------- | ---------------------------------- | ------------------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | The format string for the module. |
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
| `style` | `"bold yellow"` | The style for the module. |
| `disabled` | `false` | Disables the `ocaml` module. |
### Variables
| Variable | Example | Description |
| --------- | --------- | ------------------------------------ |
| version | `v4.10.0` | The version of `ocaml` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### Example
```toml
# ~/.config/starship.toml
[ocaml]
format = "via [🐪 $version]($style) "
```
## OpenStack
The `openstack` module shows the current OpenStack cloud and project. The module only active when the `OS_CLOUD` env var is set, in which case it will read `clouds.yaml` file from any of the [default locations](https://docs.openstack.org/python-openstackclient/latest/configuration/index.html#configuration-files). to fetch the current project in use.
### Options
| Option | Default | Description |
| ---------- | --------------------------------------------------- | -------------------------------------------------------------- |
| `format` | `"on [$symbol$cloud(\\($project\\))]($style) "` | The format for the module. |
| `symbol` | `"☁️ "` | The symbol used before displaying the current OpenStack cloud. |
| `style` | `"bold yellow"` | The style for the module. |
| `disabled` | `false` | Disables the `OpenStack` module. |
### Variables
| Variable | Example | Description |
| --------- | ------- | ------------------------------------ |
| cloud | `corp` | The current OpenStack cloud |
| project | `dev` | The current OpenStack project |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### Example
```toml
# ~/.config/starship.toml
[openstack]
format = "on [$symbol$cloud(\\($project\\))]($style) "
style = "bold yellow"
symbol = "☁️ "
```
## Package Version ## Package Version
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages. The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages.
@ -1668,45 +1793,6 @@ The `package` module is shown when the current directory is the repository for a
format = "via [🎁 $version](208 bold) " format = "via [🎁 $version](208 bold) "
``` ```
## OCaml
The `ocaml` module shows the currently installed version of OCaml. The module will be shown if any of the following conditions are met:
- The current directory contains a file with `.opam` extension or `_opam` directory
- The current directory contains a `esy.lock` directory
- The current directory contains a `dune` or `dune-project` file
- The current directory contains a `jbuild` or `jbuild-ignore` file
- The current directory contains a `.merlin` file
- The current directory contains a file with `.ml`, `.mli`, `.re` or `.rei` extension
### Options
| Option | Default | Description |
| ---------- | ---------------------------------- | ------------------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | The format string for the module. |
| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. |
| `style` | `"bold yellow"` | The style for the module. |
| `disabled` | `false` | Disables the `ocaml` module. |
### Variables
| Variable | Example | Description |
| --------- | --------- | ------------------------------------ |
| version | `v4.10.0` | The version of `ocaml` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### Example
```toml
# ~/.config/starship.toml
[ocaml]
format = "via [🐪 $version]($style) "
```
## Perl ## Perl
The `perl` module shows the currently installed version of Perl. The module will be shown if any of the following conditions are met: The `perl` module shows the currently installed version of Perl. The module will be shown if any of the following conditions are met:
@ -1779,6 +1865,41 @@ The `php` module shows the currently installed version of PHP. The module will b
format = "via [🔹 $version](147 bold) " format = "via [🔹 $version](147 bold) "
``` ```
## PureScript
The `purescript` module shows the currently installed version of PureScript version. The module will be shown if any of the following conditions are met:
- The current directory contains a `spago.dhall` file
- The current directory contains a \*.purs files
### Options
| Option | Default | Description |
| ---------- | ---------------------------------- | ------------------------------------------------------------ |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
| `style` | `"bold white"` | The style for the module. |
| `disabled` | `false` | Disables the `purescript` module. |
### Variables
| Variable | Example | Description |
| --------- | -------- | ------------------------------------ |
| version | `0.13.5` | The version of `purescript` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### Example
```toml
# ~/.config/starship.toml
[purescript]
format = "via [$symbol$version](bold white)"
```
## Python ## Python
The `python` module shows the currently installed version of Python and the current Python virtual environment if one is activated. The `python` module shows the currently installed version of Python and the current Python virtual environment if one is activated.
@ -1980,41 +2101,6 @@ The `singularity` module shows the current singularity image, if inside a contai
format = '[📦 \[$env\]]($style) ' format = '[📦 \[$env\]]($style) '
``` ```
## Swift
The `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met:
- The current directory contains a `Package.swift` file
- The current directory contains a file with the `.swift` extension
### Options
| Option | Default | Description |
| ---------- | ---------------------------------- | ------------------------------------------------ |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
| `style` | `"bold 202"` | The style for the module. |
| `disabled` | `false` | Disables the `swift` module. |
### Variables
| Variable | Example | Description |
| --------- | -------- | ------------------------------------ |
| version | `v5.2.4` | The version of `swift` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### Example
```toml
# ~/.config/starship.toml
[swift]
format = "via [🏎 $version](red bold)"
```
## Status ## Status
The `status` module displays the exit code of the previous command. The module will be shown only if the exit code is not `0`. The `status` module displays the exit code of the previous command. The module will be shown only if the exit code is not `0`.
@ -2056,12 +2142,47 @@ disabled = false
``` ```
## Swift
The `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met:
- The current directory contains a `Package.swift` file
- The current directory contains a file with the `.swift` extension
### Options
| Option | Default | Description |
| ---------- | ---------------------------------- | ------------------------------------------------ |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
| `style` | `"bold 202"` | The style for the module. |
| `disabled` | `false` | Disables the `swift` module. |
### Variables
| Variable | Example | Description |
| --------- | -------- | ------------------------------------ |
| version | `v5.2.4` | The version of `swift` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### Example
```toml
# ~/.config/starship.toml
[swift]
format = "via [🏎 $version](red bold)"
```
## Terraform ## Terraform
The `terraform` module shows the currently selected terraform workspace and version. By default the terraform version is not shown, since this is slow on current versions of terraform when a lot of plugins are in use. If you still want to enable it, [follow the example shown below](#with-version). The module will be shown if any of the following conditions are met: The `terraform` module shows the currently selected terraform workspace and version. By default the terraform version is not shown, since this is slow on current versions of terraform when a lot of plugins are in use. If you still want to enable it, [follow the example shown below](#with-version). The module will be shown if any of the following conditions are met:
- The current directory contains a `.terraform` folder - The current directory contains a `.terraform` folder
- Current directory contains a file with the `.tf` extension - Current directory contains a file with the `.tf` or `.hcl` extensions
### Options ### Options
@ -2322,38 +2443,3 @@ command = "time /T"
files = ["*.pst"] files = ["*.pst"]
shell = ["pwsh.exe", "-NoProfile", "-Command", "-"] shell = ["pwsh.exe", "-NoProfile", "-Command", "-"]
``` ```
## PureScript
The `purescript` module shows the currently installed version of PureScript version. The module will be shown if any of the following conditions are met:
- The current directory contains a `spago.dhall` file
- The current directory contains a \*.purs files
### Options
| Option | Default | Description |
| ---------- | ---------------------------------- | ------------------------------------------------------------ |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
| `style` | `"bold white"` | The style for the module. |
| `disabled` | `false` | Disables the `purescript` module. |
### Variables
| Variable | Example | Description |
| --------- | -------- | ------------------------------------ |
| version | `0.13.5` | The version of `purescript` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### Example
```toml
# ~/.config/starship.toml
[purescript]
format = "via [$symbol$version](bold white)"
```

2
docs/pt-PT/guide/README.md
View File

@ -199,7 +199,7 @@
#### PowerShell #### PowerShell
Add the following to the end of `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` (or `~/.config/powershell/Microsoft.PowerShell_profile.ps1` on -Nix): Add the following to the end of `Microsoft.PowerShell_profile.ps1`. You can check the location of this file by querying the `$PROFILE` variable in PowerShell. Typically the path is `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` or `~/.config/powershell/Microsoft.PowerShell_profile.ps1` on -Nix.
```sh ```sh
Invoke-Expression (&starship init powershell) Invoke-Expression (&starship init powershell)

2
docs/pt-PT/presets/README.md
View File

@ -84,7 +84,7 @@ symbol = " "
symbol = " " symbol = " "
[rust] [rust]
symbol = " " symbol = " "
[swift] [swift]
symbol = "ﯣ " symbol = "ﯣ "

10
docs/ru-RU/README.md
View File

@ -2,7 +2,7 @@
home: true home: true
heroImage: /logo.svg heroImage: /logo.svg
heroText: heroText:
tagline: Минимальная, быстрая и бесконечная настраиваемая командная строка для любой оболочки! tagline: Минималистичная, быстрая и бесконечно настраиваемая командная строка для любой оболочки!
actionText: Начало работы → actionText: Начало работы →
actionLink: ./guide/ actionLink: ./guide/
features: features:
@ -11,10 +11,10 @@ features:
details: Работает на большинстве распространенных оболочек и наиболее распространенных операционных системах. Используйте везде! details: Работает на большинстве распространенных оболочек и наиболее распространенных операционных системах. Используйте везде!
- -
title: Основана на Rust title: Основана на Rust
details: Приносит наилучшую в своем классе скорость и безопасность Rust, чтобы сделать вашу подсказку как можно быстрее и надежнее. details: Приносит наилучшую в своем классе скорость и безопасность Rust, чтобы сделать вашу оболочку как можно быстрее и надежнее.
- -
title: Настраиваемая title: Настраиваемая
details: Каждая маленькая деталь настраивается по вашему вкусу, чтобы сделать эту подсказку минимальной или функциональной, как вы захотите. details: Каждая маленькая деталь настраивается по вашему вкусу, чтобы сделать эту оболочку минималистичной или функциональной, как вы захотите.
footer: Под лицензией ISC | Авторское право © 2019-настоящее Starship Contributors footer: Под лицензией ISC | Авторское право © 2019-настоящее Starship Contributors
#Used for the description meta tag, for SEO #Used for the description meta tag, for SEO
metaTitle: "Starship: Cross-Shell Prompt" metaTitle: "Starship: Cross-Shell Prompt"
@ -94,11 +94,9 @@ description: Starship - минимальная, быстрая и бесконе
#### PowerShell #### PowerShell
Добавьте следующее в конец `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` (или `~/.config/powershell/Microsoft.PowerShell_profile.ps1` на -Nix): Добавьте следующее в конец `Microsoft.PowerShell_profile.ps1`. Вы можете проверить местоположение этого файла, запросив переменную `$PROFILE` в PowerShell. Обычно он находится в `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` или `~/.config/powershell/Microsoft.PowerShell_profile.ps1` на -Nix.
```sh ```sh
# ~\Documents\PowerShell\Profile.ps1
Invoke-Expression (&starship init powershell) Invoke-Expression (&starship init powershell)
``` ```

6
docs/ru-RU/advanced-config/README.md
View File

@ -57,9 +57,9 @@ starship_precmd_user_func="set_win_title"
precmd_functions+=(set_win_title) precmd_functions+=(set_win_title)
``` ```
If you like the result, add these lines to your shell configuration file (`~/.bashrc` or `~/.zshrc`) to make it permanent. Если вам нравится результат, добавьте эти строки в конфигурационный файл оболочки (`~/.bashrc` или `~/.zsrhc`), чтобы оставить это навсегда.
For example, if you want to display your current directory in your terminal tab title, add the following snippet to your `~/.bashrc` or `~/.zshrc`: Например, если вы хотите отобразить ваш текущий каталог в заголовке вкладки терминала, добавьте следующие строки в `~/. bashrc` или `~/.zshrc`:
```bash ```bash
function set_win_title(){ function set_win_title(){
@ -86,7 +86,7 @@ starship_precmd_user_func="set_win_title"
Цветовой спецификатор может быть одним из следующих: Цветовой спецификатор может быть одним из следующих:
- Один из стандартных цветов терминалов: `black`, `red`, `green`, `blue`, `gellow`, `purple`, `cyan`, `white`. Вы можете по желанию добавить префикс `bright-`, чтобы получить яркую версию (например, `bright-white`). - Некоторые из стандартных цветов терминалов: `black`, `red`, `green`, `blue`, `gellow`, `purple`, `cyan`, `white`. Вы можете по желанию добавить префикс `bright-`, чтобы получить яркую версию (например, `bright-white`).
- `#`, за которой следует шестизначное шестнадцатеричное число. Это определяет [шестнадцатеричный код цвета RGB](https://www.w3schools.com/colors/colors_hexadecimal.asp). - `#`, за которой следует шестизначное шестнадцатеричное число. Это определяет [шестнадцатеричный код цвета RGB](https://www.w3schools.com/colors/colors_hexadecimal.asp).
- Число от 0 до 255. Это определяет [8-битный код цвета ANSI](https://i.stack.imgur.com/KTSQa.png). - Число от 0 до 255. Это определяет [8-битный код цвета ANSI](https://i.stack.imgur.com/KTSQa.png).

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

File diff suppressed because it is too large Load Diff

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

@ -101,7 +101,7 @@
align="right" /> align="right" />
**Минимальная, быстрая и бесконечная настраиваемая командная строка для любой оболочки!** **Минималистичная, быстрая и бесконечно настраиваемая командная строка для любой оболочки!**
- **Быстрая:** она быстрая – _очень-очень_ быстрая! 🚀 - **Быстрая:** она быстрая – _очень-очень_ быстрая! 🚀
@ -121,7 +121,7 @@
### Требования ### Требования
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (for example, try the [Fira Code Nerd Font](https://www.nerdfonts.com/font-downloads)). - Установленный и включённый [шрифт Powerline](https://www.nerdfonts.com/) (например, [Fira Code Nerd Font](https://www.nerdfonts.com/font-downloads)).
### Начало работы ### Начало работы
@ -199,7 +199,7 @@
#### PowerShell #### PowerShell
Добавьте следующее в конец `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` (или `~/.config/powershell/Microsoft.PowerShell_profile.ps1` на -Nix): Добавьте следующее в конец `Microsoft.PowerShell_profile.ps1`. Вы можете проверить местоположение этого файла, запросив переменную `$PROFILE` в PowerShell. Обычно он находится в `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` или `~/.config/powershell/Microsoft.PowerShell_profile.ps1` на -Nix.
```sh ```sh
Invoke-Expression (&starship init powershell) Invoke-Expression (&starship init powershell)

4
docs/ru-RU/presets/README.md
View File

@ -4,7 +4,7 @@
## Символы Шрифта Nerd Font ## Символы Шрифта Nerd Font
Эта предустановка не меняет ничего кроме символов, используемых для каждого модуля. Если эмодзи вам не по душе, это может порадовать ваш глаз! Эта предустановка не меняет ничего кроме символов, используемых для каждого модуля. Если эмодзи вам не по душе, это может бросаться вам в глаза!
![Скриншот предустановки Nerd Font Symbols](/presets/nerd-font-symbols.png) ![Скриншот предустановки Nerd Font Symbols](/presets/nerd-font-symbols.png)
@ -84,7 +84,7 @@ symbol = " "
symbol = " " symbol = " "
[rust] [rust]
symbol = " " symbol = " "
[swift] [swift]
symbol = "ﯣ " symbol = "ﯣ "

6
docs/zh-CN/README.md
View File

@ -2,7 +2,7 @@
home: true home: true
heroImage: /logo.svg heroImage: /logo.svg
heroText: heroText:
tagline: The minimal, blazing-fast, and infinitely customizable prompt for any shell! tagline: 轻量级、反应迅速，可定制的高颜值终端！
actionText: 入门 → actionText: 入门 →
actionLink: ./guide/ actionLink: ./guide/
features: features:
@ -94,11 +94,9 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
#### Powershell #### Powershell
在 `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` （对于 *nix 系统是`~/.config/powershell/Microsoft.PowerShell_profile.ps1`）的最后，添加以下内容： Add the following to the end of `Microsoft.PowerShell_profile.ps1`. You can check the location of this file by querying the `$PROFILE` variable in PowerShell. 对于 -Nix 来说，通常文件路径是 `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` 或 `~/.config/powershell/Microsoft.PowerShell_profile.ps1`。
```sh ```sh
# ~\Documents\PowerShell\Profile.ps1
Invoke-Expression (&starship init powershell) Invoke-Expression (&starship init powershell)
``` ```

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

File diff suppressed because it is too large Load Diff

34
docs/zh-CN/guide/README.md
View File

@ -101,15 +101,15 @@
align="right" /> align="right" />
**The minimal, blazing-fast, and infinitely customizable prompt for any shell!** **轻量级、反应迅速，可定制的高颜值终端！**
- **Fast:** it's fast – _really really_ fast! 🚀 - **快：** 很快 —— 真的真的非常快！ 🚀
- **Customizable:** configure every aspect of your prompt. - **定制化：** 可定制各种各样的提示符。
- **Universal:** works on any shell, on any operating system. - **通用：** 适用于任何 Shell、任何操作系统。
- **Intelligent:** shows relevant information at a glance. - **智能：** 一目了然地显示相关信息。
- **Feature rich:** support for all your favorite tools. - **功能丰富：** 支持所有你喜欢的工具。
- **Easy:** quick to install – start using it in minutes. - **易用：** 安装快速 —— 几分钟就可上手。
<p align="center"> <p align="center">
<a href="https://starship.rs/config/"><strong>Explore the Starship docs&nbsp;&nbsp;▶</strong></a> <a href="https://starship.rs/config/"><strong>Explore the Starship docs&nbsp;&nbsp;▶</strong></a>
@ -121,7 +121,7 @@
### 前置要求 ### 前置要求
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (for example, try the [Fira Code Nerd Font](https://www.nerdfonts.com/font-downloads)). - 安装一个 [Nerd Font](https://www.nerdfonts.com/) 的字体，并在终端启用（例如，可以尝试使用 [Fira Code Nerd Font](https://www.nerdfonts.com/font-downloads) 字体）。
### 开始安装 ### 开始安装
@ -199,7 +199,7 @@
#### PowerShell #### PowerShell
将以下内容添加到`~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` (或`~/.config/powershell/Microsoft.PowerShell_profile.ps1`，对于 *nix 系统)： 将以下内容添加到 `Microsoft.PowerShell_profile.ps1`。 你可以在 PowerShell 通过 `$PROFILE` 变量来查询文件的位置。 对于 -Nix 来说，通常文件路径是 `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` 或 `~/.config/powershell/Microsoft.PowerShell_profile.ps1`。
```sh ```sh
Invoke-Expression (&starship init powershell) Invoke-Expression (&starship init powershell)
@ -218,26 +218,26 @@
## 🤝 贡献 ## 🤝 贡献
我们一直在寻找贡献者！你都可以参与贡献 ** 不论你的技能如何 **。 如果您希望快速为项目作出贡献，请尝试解决 [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue)。 我们一直在寻找贡献者！你都可以参与贡献 **不论你的技能如何**。 如果您希望快速为项目作出贡献，请尝试解决 [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue)。
如果您有兴趣贡献于 Starship，请查看我们的[贡献指南](https://github.com/starship/starship/blob/master/CONTRIBUTING.md)。 另外，你可以自由加入我们的 [Discord 服务器](https://discord.gg/8Jzqu3T) 。 👋 如果您有兴趣贡献于 Starship，请查看我们的[贡献指南](https://github.com/starship/starship/blob/master/CONTRIBUTING.md)。 另外，你可以自由加入我们的 [Discord 服务器](https://discord.gg/8Jzqu3T) 。 👋
### Code Contributors ### 代码贡献者
This project exists thanks to all the people who contribute. [[Contribute](https://github.com/starship/starship/blob/master/CONTRIBUTING.md)]. 这个项目的存在要感谢所有贡献者。 [[贡献说明](https://github.com/starship/starship/blob/master/CONTRIBUTING.md)]
<a href="https://github.com/starship/starship/graphs/contributors"><img src="https://opencollective.com/starship/contributors.svg?width=890&button=false" /></a> <a href="https://github.com/starship/starship/graphs/contributors"><img src="https://opencollective.com/starship/contributors.svg?width=890&button=false" /></a>
### Financial Contributors ### 项目资助者
Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/starship/contribute)] 成为项目资助者，并帮助我们维持我们的社区。 [[成为项目资助者](https://opencollective.com/starship/contribute)]
#### Individuals #### 资助人
<a href="https://opencollective.com/starship"><img src="https://opencollective.com/starship/individuals.svg?width=890"></a> <a href="https://opencollective.com/starship"><img src="https://opencollective.com/starship/individuals.svg?width=890"></a>
#### Organizations #### 资助组织
Support this project with your organization. Your logo will show up here with a link to your website. [[Contribute](https://opencollective.com/starship/contribute)] 与您的组织一起支持该项目。 您的组织的徽标将显示在此处，并带有指向您的组织的网站的链接。 [[成为项目资助者](https://opencollective.com/starship/contribute)]
<a href="https://opencollective.com/starship/organization/0/website"><img src="https://opencollective.com/starship/organization/0/avatar.svg"></a> <a href="https://opencollective.com/starship/organization/0/website"><img src="https://opencollective.com/starship/organization/0/avatar.svg"></a>
<a href="https://opencollective.com/starship/organization/1/website"><img src="https://opencollective.com/starship/organization/1/avatar.svg"></a> <a href="https://opencollective.com/starship/organization/1/website"><img src="https://opencollective.com/starship/organization/1/avatar.svg"></a>

2
docs/zh-CN/presets/README.md
View File

@ -84,7 +84,7 @@ symbol = " "
symbol = " " symbol = " "
[rust] [rust]
symbol = " " symbol = " "
[swift] [swift]
symbol = "ﯣ " symbol = "ﯣ "

4
docs/zh-TW/README.md
View File

@ -94,11 +94,9 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
#### Powershell #### Powershell
將以下內容放到 `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` 的結尾 (或是在 -Nix 上的 `~/.config/powershell/Microsoft.PowerShell_profile.ps1`)： Add the following to the end of `Microsoft.PowerShell_profile.ps1`. You can check the location of this file by querying the `$PROFILE` variable in PowerShell. Typically the path is `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` or `~/.config/powershell/Microsoft.PowerShell_profile.ps1` on -Nix.
```sh ```sh
# ~\Documents\PowerShell\Profile.ps1
Invoke-Expression (&starship init powershell) Invoke-Expression (&starship init powershell)
``` ```

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

@ -214,11 +214,13 @@ $conda\
$memory_usage\ $memory_usage\
$aws\ $aws\
$gcloud\ $gcloud\
$openstack\
$env_var\ $env_var\
$crystal\ $crystal\
$cmd_duration\ $cmd_duration\
$custom\ $custom\
$line_break\ $line_break\
$lua\
$jobs\ $jobs\
$battery\ $battery\
$time\ $time\
@ -426,16 +428,17 @@ vicmd_symbol = "[V](bold green) "
## CMake ## CMake
The `cmake` module shows the currently installed version of CMake if: The `cmake` module shows the currently installed version of CMake if any of the following conditions are met:
- The current directory contains a `CMakeLists.txt` file - The current directory contains a `CMakeLists.txt` file
- The current directory contains a `CMakeCache.txt` file
### 選項 ### 選項
| Option | 預設 | 說明 | | Option | 預設 | 說明 |
| ---------- | ---------------------------------- | -------------------------------------------- | | ---------- | ---------------------------------- | -------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. | | `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"🛆 "` | The symbol used before the version of cmake. | | `symbol` | `"喝 "` | The symbol used before the version of cmake. |
| `style` | `"bold blue"` | 這個模組的風格。 | | `style` | `"bold blue"` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `cmake` module. | | `disabled` | `false` | Disables the `cmake` module. |
@ -463,13 +466,21 @@ The `cmake` module shows the currently installed version of CMake if:
### 選項 ### 選項
| Option | 預設 | 說明 | | Option | 預設 | 說明 |
| ------------------- | ----------------------------- | ----------------------------------------------------- | | -------------------- | ----------------------------- | ----------------------------------------------------- |
| `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). | | `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). |
| `show_milliseconds` | `false` | 顯示時間除了以秒為單位外，亦以毫秒顯示 | | `show_milliseconds` | `false` | 顯示時間除了以秒為單位外，亦以毫秒顯示 |
| `format` | `"took [$duration]($style) "` | The format for the module. | | `format` | `"took [$duration]($style) "` | The format for the module. |
| `style` | `"bold yellow"` | 這個模組的風格。 | | `style` | `"bold yellow"` | 這個模組的風格。 |
| `disabled` | `false` | 停用 `cmd_duration` 模組。 | | `disabled` | `false` | 停用 `cmd_duration` 模組。 |
| `show_notifications` | `false` | Show desktop notifications when command completes. |
| `min_time_to_notify` | `45_000` | Shortest duration for notification (in milliseconds). |
::: tip
Showing desktop notifications requires starship to be built with `rust-notify` support. You check if your starship supports notifications by running `STARSHIP_LOG=debug starship module cmd_duration -d 60000` when `show_notifications` is set to `true`.
:::
### Variables ### Variables
@ -492,7 +503,7 @@ format = "underwent [$duration](bold yellow)"
## Conda ## Conda
如果有設定 `$CONDA_DEFAULT_ENV` 時，`conda` 模組顯示現在 conda 的環境。 The `conda` module shows the current conda environment, if `$CONDA_DEFAULT_ENV` is set.
::: tip ::: tip
@ -532,7 +543,7 @@ format = "[$symbol$environment](dimmed green) "
## Crystal ## Crystal
`crystal` 模組顯示現在所安裝的Crystal版本 這個模組在下列其中一個條件達成時顯示： The `crystal` module shows the currently installed version of Crystal. The module will be shown if any of the following conditions are met:
- 現在資料夾中含有一個 `shard.yml` 檔案 - 現在資料夾中含有一個 `shard.yml` 檔案
- 現在資料夾中含有一個`.cr`檔案 - 現在資料夾中含有一個`.cr`檔案
@ -567,7 +578,7 @@ format = "via [✨ $version](bold blue) "
## Dart ## Dart
The `dart` module shows the currently installed version of Dart. 這個模組在下列其中一個條件達成時顯示： The `dart` module shows the currently installed version of Dart. The module will be shown if any of the following conditions are met:
- The current directory contains a file with `.dart` extension - The current directory contains a file with `.dart` extension
- The current directory contains a `.dart_tool` directory - The current directory contains a `.dart_tool` directory
@ -603,11 +614,11 @@ format = "via [🔰 $version](bold red) "
## 資料夾 ## 資料夾
`directory` 模組顯示到現在資料夾的路徑，並裁減到前三層資料夾。 你的資料夾也會被裁減到你所在的 git 儲存庫的根目錄。 The `directory` module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in.
如果正在使用 fish 風格的 pwd 選項，將不會隱藏被裁減的資料夾，而是會根據你在選項中設定的數字看到每一層資料夾的縮寫。 When using the fish style pwd option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option.
例如，給定一個右列的路徑 `~/Dev/Nix/nixpkgs/pkgs` 其中 `nixpkgs` 是儲存庫的根目錄，而且該選項被設定為 `1`。 你會看到 `~/D/N/nixpkgs/pkgs`，而在這個設定之前則是 `nixpkgs/pkgs`。 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`.
### 選項 ### 選項
@ -623,7 +634,7 @@ format = "via [🔰 $version](bold red) "
| `truncation_symbol` | `""` | The symbol to prefix to truncated paths. eg: "…/" | | `truncation_symbol` | `""` | The symbol to prefix to truncated paths. eg: "…/" |
<details> <details>
<summary>這個模組有些進階設定選項可以控制顯示資料夾。</summary> <summary>This module has a few advanced configuration options that control how the directory is displayed.</summary>
| Advanced Option | 預設 | 說明 | | Advanced Option | 預設 | 說明 |
| --------------------------- | ------ | ------------------------------------------------ | | --------------------------- | ------ | ------------------------------------------------ |
@ -697,7 +708,7 @@ format = "via [🐋 $context](blue bold)"
## Dotnet ## Dotnet
`dotnet` 模組顯示現在資料夾使用的 .NET Core SDK 的版本。 如果這個資料夾已經選定一個 SDK，則顯示這個 SDK 的版本。 如果沒有的話，則顯示最新安裝的 SDK 版本。 The `dotnet` module shows the relevant version of the .NET Core SDK for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK.
This module will only be shown in your prompt when one or more of the following files are present in the current directory: This module will only be shown in your prompt when one or more of the following files are present in the current directory:
@ -713,7 +724,7 @@ This module will only be shown in your prompt when one or more of the following
You'll also need the .NET Core SDK installed in order to use it correctly. You'll also need the .NET Core SDK installed in order to use it correctly.
這個模組內部是使用它自己的機制來偵測版本。 一般來說這個模組有 `dotnet --version` 的兩倍快，但是它可能會在你的 .NET 專案有不尋常的資料夾結構時顯示不正確的版本。 如果精確度比速度更重要的話，你可以藉由設定模組中的 `heuristic = false` 選項來停用這個功能。 Internally, this module uses its own mechanism for version detection. Typically it is twice as fast as running `dotnet --version`, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting `heuristic = false` in the module options.
The module will also show the Target Framework Moniker (<https://docs.microsoft.com/en-us/dotnet/standard/frameworks#supported-target-framework-versions>) when there is a csproj file in the current directory. The module will also show the Target Framework Moniker (<https://docs.microsoft.com/en-us/dotnet/standard/frameworks#supported-target-framework-versions>) when there is a csproj file in the current directory.
@ -751,7 +762,7 @@ heuristic = false
## Elixir ## Elixir
The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. 這個模組在下列其中一個條件達成時顯示： The `elixir` module shows the currently installed version of Elixir and Erlang/OTP. The module will be shown if any of the following conditions are met:
- 現在資料夾中包含一個 `mix.exs` 檔案. - 現在資料夾中包含一個 `mix.exs` 檔案.
@ -786,7 +797,7 @@ symbol = "🔮 "
## Elm ## Elm
The `elm` module shows the currently installed version of Elm. 這個模組在下列其中一個條件達成時顯示： The `elm` module shows the currently installed version of Elm. The module will be shown if any of the following conditions are met:
- 現在資料夾中包含一個 `elm.json` 檔案 - 現在資料夾中包含一個 `elm.json` 檔案
- 現在資料夾中包含一個 `elm-package.json` 檔案 - 現在資料夾中包含一個 `elm-package.json` 檔案
@ -824,7 +835,7 @@ format = "via [ $version](cyan bold) "
## 環境變數 ## 環境變數
`env_var`模組顯示一個選擇的環境變數的現在數值。 這個模組只在下列條件其中之一達到時顯示： The `env_var` module displays the current value of a selected environment variable. The module will be shown only if any of the following conditions are met:
- `variable` 設定選項符合一個存在的環境變數。 - `variable` 設定選項符合一個存在的環境變數。
- 沒有設定 `variable` 選項，但是有設定 `default` 選項。 - 沒有設定 `variable` 選項，但是有設定 `default` 選項。
@ -861,7 +872,7 @@ default = "unknown shell"
## Erlang ## Erlang
The `erlang` module shows the currently installed version of Erlang/OTP. 這個模組在下列其中一個條件達成時顯示： The `erlang` module shows the currently installed version of Erlang/OTP. The module will be shown if any of the following conditions are met:
- 現在資料夾中包含一個 `rebar.config` 檔案. - 現在資料夾中包含一個 `rebar.config` 檔案.
- 現在資料夾中包含一個 `erlang.mk` 檔案. - 現在資料夾中包含一個 `erlang.mk` 檔案.
@ -870,7 +881,7 @@ The `erlang` module shows the currently installed version of Erlang/OTP. 這個
| Option | 預設 | 說明 | | Option | 預設 | 說明 |
| ---------- | ---------------------------------- | -------------------------------------------------------- | | ---------- | ---------------------------------- | -------------------------------------------------------- |
| `symbol` | `"🖧 "` | The symbol used before displaying the version of erlang. | | `symbol` | `" "` | The symbol used before displaying the version of erlang. |
| `style` | `"bold red"` | 這個模組的風格。 | | `style` | `"bold red"` | 這個模組的風格。 |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. | | `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `disabled` | `false` | Disables the `erlang` module. | | `disabled` | `false` | Disables the `erlang` module. |
@ -956,24 +967,27 @@ asia-northeast1 = "an1"
## Git 分支 ## Git 分支
`git_branch` 模組顯示現在的資料夾中使用中的儲存庫的分支。 The `git_branch` module shows the active branch of the repo in your current directory.
### 選項 ### 選項
| Option | 預設 | 說明 | | Option | 預設 | 說明 |
| ------------------- | -------------------------------- | ------------------------------------------------------------------------------- | | -------------------- | -------------------------------- | ------------------------------------------------------------------------------------ |
| `format` | `"on [$symbol$branch]($style) "` | The format for the module. Use `"$branch"` to refer to the current branch name. | | `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. |
| `symbol` | `" "` | A format string representing the symbol of git branch. | | `format` | `"on [$symbol$branch]($style) "` | The format for the module. Use `"$branch"` to refer to the current branch name. |
| `style` | `"bold purple"` | 這個模組的風格。 | | `symbol` | `" "` | A format string representing the symbol of git branch. |
| `truncation_length` | `2^63 - 1` | Truncates a git branch to X graphemes. | | `style` | `"bold purple"` | 這個模組的風格。 |
| `truncation_symbol` | `"…"` | 用來指示分支名稱被縮減的符號。 You can use `""` for no symbol. | | `truncation_length` | `2^63 - 1` | Truncates a git branch to X graphemes. |
| `disabled` | `false` | 停用 `git_branch` 模組。 | | `truncation_symbol` | `"…"` | 用來指示分支名稱被縮減的符號。 You can use `""` for no symbol. |
| `only_attached` | `false` | Only show the branch name when not in a detached HEAD state. |
| `disabled` | `false` | Disables the `git_branch` module. |
### Variables ### Variables
| 變數 | 範例 | 說明 | | 變數 | 範例 | 說明 |
| --------- | -------- | ---------------------------------------------------------------------------------------------------- | | --------- | -------- | ---------------------------------------------------------------------------------------------------- |
| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached HEAD). | | branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached HEAD). |
| remote | `master` | The remote branch name. |
| symbol | | Mirrors the value of option `symbol` | | symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` | | style\* | | Mirrors the value of option `style` |
@ -992,17 +1006,19 @@ truncation_symbol = ""
## Git Commit ## Git Commit
The `git_commit` module shows the current commit hash of the repo in your current directory. The `git_commit` module shows the current commit hash and also the tag (if any) of the repo in your current directory.
### 選項 ### 選項
| Option | 預設 | 說明 | | Option | 預設 | 說明 |
| -------------------- | -------------------------- | ----------------------------------------------------- | | -------------------- | ------------------------------------------------------ | ----------------------------------------------------- |
| `commit_hash_length` | `7` | The length of the displayed git commit hash. | | `commit_hash_length` | `7` | The length of the displayed git commit hash. |
| `format` | `'[\($hash\)]($style) '` | The format for the module. | | `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | The format for the module. |
| `style` | `"bold green"` | 這個模組的風格。 | | `style` | `"bold green"` | 這個模組的風格。 |
| `only_detached` | `true` | Only show git commit hash when in detached HEAD state | | `only_detached` | `true` | Only show git commit hash when in detached HEAD state |
| `disabled` | `false` | Disables the `git_commit` module. | | `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown |
| `disabled` | `false` | Disables the `git_commit` module. |
### Variables ### Variables
@ -1020,11 +1036,12 @@ The `git_commit` module shows the current commit hash of the repo in your curren
[git_commit] [git_commit]
commit_hash_length = 4 commit_hash_length = 4
tag_symbol = "🔖 "
``` ```
## Git State ## Git State
`git_state` 模組會顯示在 git 儲存庫中的資料夾內，以及會在有作業正在進行時顯示，像是：_REBASING_、_BISECTING_ 等等。 如果有進展的資訊 (像是 REBASING 3/10)，也會一併顯示出來。 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.
### 選項 ### 選項
@ -1064,7 +1081,7 @@ cherry_pick = "[🍒 PICKING](bold red)"
## Git Status ## Git Status
`git_status` 模組顯示用來表示現在資料夾之中儲存庫狀態的符號。 The `git_status` module shows symbols representing the state of the repo in your current directory.
### 選項 ### 選項
@ -1147,7 +1164,7 @@ behind = "⇣${count}"
## Golang ## Golang
`golang` 模組顯示現在安裝的 Golang 版本。 這個模組在下列其中一個條件達成時顯示： The `golang` module shows the currently installed version of Golang. The module will be shown if any of the following conditions are met:
- 現在資料夾中含有一個 `go.mod` 檔案 - 現在資料夾中含有一個 `go.mod` 檔案
- 現在資料夾中含有一個 `go.sum` 檔案 - 現在資料夾中含有一個 `go.sum` 檔案
@ -1188,7 +1205,7 @@ format = "via [🏎💨 $version](bold cyan) "
## Helm ## Helm
The `helm` module shows the currently installed version of Helm. 這個模組在下列其中一個條件達成時顯示： The `helm` module shows the currently installed version of Helm. The module will be shown if any of the following conditions are met:
- 現在資料夾中包含一個 `helmfile.yaml` 檔案 - 現在資料夾中包含一個 `helmfile.yaml` 檔案
- The current directory contains a `Chart.yaml` file - The current directory contains a `Chart.yaml` file
@ -1223,7 +1240,7 @@ format = "via [⎈ $version](bold white) "
## 主機名稱 ## 主機名稱
`hostname` 模組顯示系統的主機名稱。 The `hostname` module shows the system hostname.
### 選項 ### 選項
@ -1258,7 +1275,7 @@ disabled = false
## Java ## Java
`java` 模組顯示現在安裝的 Java 版本。 這個模組在下列其中一個條件達成時顯示： The `java` module shows the currently installed version of Java. The module will be shown if any of the following conditions are met:
- The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt` or `.java-version` file - The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt` or `.java-version` file
- The current directory contains a file with the `.java`, `.class`, `.gradle` or `.jar` extension - The current directory contains a file with the `.java`, `.class`, `.gradle` or `.jar` extension
@ -1293,7 +1310,7 @@ symbol = "🌟 "
## 工作 ## 工作
`jobs` 模組顯示現在正在執行中的工作。 這個模組只會在有背景工作正在執行時顯示。 這個模組會在工作數量超過一個，或者有設定 `threshold` 時且數量超過設定值時，顯示工作的數量。 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.
### 選項 ### 選項
@ -1327,7 +1344,7 @@ threshold = 4
## Julia ## Julia
The `julia` module shows the currently installed version of Julia. 這個模組在下列其中一個條件達成時顯示： The `julia` module shows the currently installed version of Julia. The module will be shown if any of the following conditions are met:
- The current directory contains a `Project.toml` file - The current directory contains a `Project.toml` file
- The current directory contains a `Manifest.toml` file - The current directory contains a `Manifest.toml` file
@ -1367,7 +1384,7 @@ Displays the current Kubernetes context name and, if set, the namespace from the
::: tip ::: tip
這個模組預設是停用的。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
::: :::
@ -1406,7 +1423,7 @@ disabled = false
## 換行 ## 換行
`line_break` 模組將提示字元分成兩行。 The `line_break` module separates the prompt into two lines.
### 選項 ### 選項
@ -1423,27 +1440,64 @@ disabled = false
disabled = true disabled = true
``` ```
## 記憶體使用量 ## Lua
`memory_usage` 模組顯示現在系統記憶體與 swap 的使用量。 The `lua` module shows the currently installed version of Lua. The module will be shown if any of the following conditions are met:
預設 swap 使用量會在系統總 swap 使用量不為 0 時顯示出來。 - The current directory contains a `.lua-version` file
- The current directory contains a `lua` directory
- The current directory contains a file with the `.lua` extension
### 選項
| Option | 預設 | 說明 |
| ------------ | ---------------------------------- | -------------------------------------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. |
| `style` | `"bold blue"` | 這個模組的風格。 |
| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. |
| `disabled` | `false` | Disables the `lua` module. |
### Variables
| 變數 | 範例 | 說明 |
| --------- | -------- | ------------------------------------ |
| version | `v5.4.0` | The version of `lua` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### 範例
```toml
# ~/.config/starship.toml
[lua]
format = "via [🌕 $version](bold blue) "
```
## Memory Usage
The `memory_usage` module shows current system memory and swap usage.
By default the swap usage is displayed if the total system swap is non-zero.
::: tip ::: tip
這個模組預設是停用的。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
::: :::
### 選項 ### 選項
| Option | 預設 | 說明 | | Option | 預設 | 說明 |
| ----------- | --------------------------------------------- | -------------------------- | | ----------- | --------------------------------------------- | -------------------------------------------------------- |
| `threshold` | `75` | 將記憶體使用量隱藏，除非使用量超過指定值。 | | `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. |
| `format` | `"via $symbol [${ram}( | ${swap})]($style) "` | The format for the module. | | `format` | `"via $symbol [${ram}( | ${swap})]($style) "` | The format for the module. |
| `symbol` | `"🐏"` | 顯示在記憶體使用量之前的符號。 | | `symbol` | `"🐏"` | The symbol used before displaying the memory usage. |
| `style` | `"bold dimmed white"` | 這個模組的風格。 | | `style` | `"bold dimmed white"` | 這個模組的風格。 |
| `disabled` | `true` | 停用 `memory_usage` 模組。 | | `disabled` | `true` | Disables the `memory_usage` module. |
### Variables ### Variables
@ -1465,11 +1519,8 @@ disabled = true
[memory_usage] [memory_usage]
disabled = false disabled = false
show_percentage = true
show_swap = true
threshold = -1 threshold = -1
symbol = " " symbol = " "
separator = "/"
style = "bold dimmed green" style = "bold dimmed green"
``` ```
@ -1511,9 +1562,9 @@ truncation_symbol = ""
## Nim ## Nim
The `nim` module shows the currently installed version of Nim. 這個模組在下列其中一個條件達成時顯示： The `nim` module shows the currently installed version of Nim. The module will be shown if any of the following conditions are met:
- 現在資料夾中包含一個 `nim.cfg` 檔案 - The current directory contains a `nim.cfg` file
- The current directory contains a file with the `.nim` extension - The current directory contains a file with the `.nim` extension
- The current directory contains a file with the `.nims` extension - The current directory contains a file with the `.nims` extension
- The current directory contains a file with the `.nimble` extension - The current directory contains a file with the `.nimble` extension
@ -1549,7 +1600,7 @@ symbol = "🎣 "
## Nix-shell ## Nix-shell
`nix_shell` 模組顯示 nix-shell 環境。 這個模組會在 nix-shell 環境中顯示。 The `nix_shell` module shows the nix-shell environment. The module will be shown when inside a nix-shell environment.
### 選項 ### 選項
@ -1560,7 +1611,7 @@ symbol = "🎣 "
| `style` | `"bold blue"` | 這個模組的風格。 | | `style` | `"bold blue"` | 這個模組的風格。 |
| `impure_msg` | `"impure"` | A format string shown when the shell is impure. | | `impure_msg` | `"impure"` | A format string shown when the shell is impure. |
| `pure_msg` | `"pure"` | A format string shown when the shell is pure. | | `pure_msg` | `"pure"` | A format string shown when the shell is pure. |
| `disabled` | `false` | 停用 `nix_shell` 模組。 | | `disabled` | `false` | Disables the `nix_shell` module. |
### Variables ### Variables
@ -1587,11 +1638,11 @@ format = 'via [☃️ $state( \($name\))](bold blue) '
## NodeJS ## NodeJS
`nodejs` 模組顯示現在安裝的 NodeJS 版本。 這個模組在下列其中一個條件達成時顯示： The `nodejs` module shows the currently installed version of NodeJS. The module will be shown if any of the following conditions are met:
- 現在資料夾中包含一個 `package.json` 檔案 - The current directory contains a `package.json` file
- The current directory contains a `.node-version` file - The current directory contains a `.node-version` file
- 現在資料夾中包含一個 `node_modules` 資料夾 - The current directory contains a `node_modules` directory
- The current directory contains a file with the `.js`, `.mjs` or `.cjs` extension - The current directory contains a file with the `.js`, `.mjs` or `.cjs` extension
- The current directory contains a file with the `.ts` extension - The current directory contains a file with the `.ts` extension
@ -1602,7 +1653,7 @@ format = 'via [☃️ $state( \($name\))](bold blue) '
| `format` | `"via [$symbol$version]($style) "` | The format for the module. | | `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"⬢ "` | A format string representing the symbol of NodeJS. | | `symbol` | `"⬢ "` | A format string representing the symbol of NodeJS. |
| `style` | `"bold green"` | 這個模組的風格。 | | `style` | `"bold green"` | 這個模組的風格。 |
| `disabled` | `false` | 停用 `nodejs` 模組。 | | `disabled` | `false` | Disables the `nodejs` module. |
###  Variables ###  Variables
@ -1623,54 +1674,9 @@ format = 'via [☃️ $state( \($name\))](bold blue) '
format = "via [🤖 $version](bold green) " format = "via [🤖 $version](bold green) "
``` ```
## 套件版本
The `package` 模組在現在資料夾是一個套件的儲藏庫時出現，並顯示他的現在版本。 The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages.
- **npm** – `npm` 套件的版本是從現在資料夾中的 `package.json` 之中擷取出來的
- **cargo** – `cargo` 套件的版本是從現在資料夾中的 `Cargo.toml` 之中擷取出來的
- **poetry** – `poetry` 套件的版本是從現在資料夾中的 `pyproject.toml` 之中擷取出來的
- **composer** – The `composer` package version is extracted from the `composer.json` present in the current directory
- **gradle** – The `gradle` package version is extracted from the `build.gradle` present
- **julia** - The package version is extracted from the `Project.toml` present
- **mix** - The `mix` package version is extracted from the `mix.exs` present
- **helm** - The `helm` chart version is extracted from the `Chart.yaml` present
- **maven** - The `maven` package version is extracted from the `pom.xml` present
> ⚠️ 顯示出來的版本是從你的現在資料夾之中擷取出來的，並非從套件管理員取得。
### 選項
| Option | 預設 | 說明 |
| ----------------- | ---------------------------------- | --------------------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"📦 "` | 顯示在套件的版本之前的符號。 |
| `style` | `"bold 208"` | 這個模組的風格。 |
| `display_private` | `false` | Enable displaying version for packages marked as private. |
| `disabled` | `false` | 停用 `package` 模組。 |
### Variables
| 變數 | 範例 | 說明 |
| --------- | -------- | ------------------------------------ |
| version | `v1.0.0` | The version of your package |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### 範例
```toml
# ~/.config/starship.toml
[package]
format = "via [🎁 $version](208 bold) "
```
## OCaml ## OCaml
The `ocaml` module shows the currently installed version of OCaml. 這個模組在下列其中一個條件達成時顯示： The `ocaml` module shows the currently installed version of OCaml. The module will be shown if any of the following conditions are met:
- The current directory contains a file with `.opam` extension or `_opam` directory - The current directory contains a file with `.opam` extension or `_opam` directory
- The current directory contains a `esy.lock` directory - The current directory contains a `esy.lock` directory
@ -1707,9 +1713,89 @@ The `ocaml` module shows the currently installed version of OCaml. 這個模組
format = "via [🐪 $version]($style) " format = "via [🐪 $version]($style) "
``` ```
## OpenStack
The `openstack` module shows the current OpenStack cloud and project. The module only active when the `OS_CLOUD` env var is set, in which case it will read `clouds.yaml` file from any of the [default locations](https://docs.openstack.org/python-openstackclient/latest/configuration/index.html#configuration-files). to fetch the current project in use.
### 選項
| Option | 預設 | 說明 |
| ---------- | --------------------------------------------------- | -------------------------------------------------------------- |
| `format` | `"on [$symbol$cloud(\\($project\\))]($style) "` | The format for the module. |
| `symbol` | `"☁️ "` | The symbol used before displaying the current OpenStack cloud. |
| `style` | `"bold yellow"` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `OpenStack` module. |
### Variables
| 變數 | 範例 | 說明 |
| --------- | ------ | ------------------------------------ |
| cloud | `corp` | The current OpenStack cloud |
| project | `dev` | The current OpenStack project |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### 範例
```toml
# ~/.config/starship.toml
[openstack]
format = "on [$symbol$cloud(\\($project\\))]($style) "
style = "bold yellow"
symbol = "☁️ "
```
## Package Version
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages.
- **npm** – The `npm` package version is extracted from the `package.json` present in the current directory
- **cargo** – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
- **poetry** – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
- **composer** – The `composer` package version is extracted from the `composer.json` present in the current directory
- **gradle** – The `gradle` package version is extracted from the `build.gradle` present
- **julia** - The package version is extracted from the `Project.toml` present
- **mix** - The `mix` package version is extracted from the `mix.exs` present
- **helm** - The `helm` chart version is extracted from the `Chart.yaml` present
- **maven** - The `maven` package version is extracted from the `pom.xml` present
> ⚠️ 顯示出來的版本是從你的現在資料夾之中擷取出來的，並非從套件管理員取得。
### 選項
| Option | 預設 | 說明 |
| ----------------- | ---------------------------------- | ---------------------------------------------------------- |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"📦 "` | The symbol used before displaying the version the package. |
| `style` | `"bold 208"` | 這個模組的風格。 |
| `display_private` | `false` | Enable displaying version for packages marked as private. |
| `disabled` | `false` | Disables the `package` module. |
### Variables
| 變數 | 範例 | 說明 |
| --------- | -------- | ------------------------------------ |
| version | `v1.0.0` | The version of your package |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### 範例
```toml
# ~/.config/starship.toml
[package]
format = "via [🎁 $version](208 bold) "
```
## Perl ## Perl
The `perl` module shows the currently installed version of Perl. 這個模組在下列其中一個條件達成時顯示： The `perl` module shows the currently installed version of Perl. The module will be shown if any of the following conditions are met:
- The current directory contains a `Makefile.PL` or `Build.PL` file - The current directory contains a `Makefile.PL` or `Build.PL` file
- The current directory contains a `cpanfile` or `cpanfile.snapshot` file - The current directory contains a `cpanfile` or `cpanfile.snapshot` file
@ -1745,9 +1831,9 @@ format = "via [🦪 $version]($style) "
## PHP ## PHP
The `php` module shows the currently installed version of PHP. 這個模組在下列其中一個條件達成時顯示： The `php` module shows the currently installed version of PHP. The module will be shown if any of the following conditions are met:
- 現在資料夾中包含一個 `composer.json` 檔案 - The current directory contains a `composer.json` file
- The current directory contains a `.php-version` file - The current directory contains a `.php-version` file
- The current directory contains a `.php` file - The current directory contains a `.php` file
@ -1779,21 +1865,56 @@ The `php` module shows the currently installed version of PHP. 這個模組在
format = "via [🔹 $version](147 bold) " format = "via [🔹 $version](147 bold) "
``` ```
## PureScript
The `purescript` module shows the currently installed version of PureScript version. The module will be shown if any of the following conditions are met:
- The current directory contains a `spago.dhall` file
- The current directory contains a \*.purs files
### 選項
| Option | 預設 | 說明 |
| ---------- | ---------------------------------- | ------------------------------------------------------------ |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
| `style` | `"bold white"` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `purescript` module. |
### Variables
| 變數 | 範例 | 說明 |
| --------- | -------- | ------------------------------------ |
| version | `0.13.5` | The version of `purescript` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### 範例
```toml
# ~/.config/starship.toml
[purescript]
format = "via [$symbol$version](bold white)"
```
## Python ## Python
The `python` module shows the currently installed version of Python and the current Python virtual environment if one is activated. The `python` module shows the currently installed version of Python and the current Python virtual environment if one is activated.
If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. 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`.
這個模組在下列其中一個條件達成時顯示： The module will be shown if any of the following conditions are met:
- 目前資料夾中有一個 `.python-version` 檔案 - The current directory contains a `.python-version` file
- 目前資料夾中有一個 `requirements.txt` 檔案 - The current directory contains a `requirements.txt` file
- 目前資料夾中有一個 `pyproject.toml` 檔案 - The current directory contains a `pyproject.toml` file
- The current directory contains a file with the `.py` extension (and `scan_for_pyfiles` is true) - The current directory contains a file with the `.py` extension (and `scan_for_pyfiles` is true)
- 目前資料夾中有一個 `Pipfile` 檔案 - The current directory contains a `Pipfile` file
- 目前資料夾中有一個 `tox.ini` 檔案 - The current directory contains a `tox.ini` file
- 現在資料夾中包含一個 `setup.py` 檔案 - The current directory contains a `setup.py` file
- The current directory contains a `__init__.py` file - The current directory contains a `__init__.py` file
- A virtual environment is currently activated - A virtual environment is currently activated
@ -1804,11 +1925,11 @@ If `pyenv_version_name` is set to `true`, it will display the pyenv version name
| `format` | `'via [${symbol}${pyenv_prefix}${version}( \($virtualenv\))]($style) '` | The format for the module. | | `format` | `'via [${symbol}${pyenv_prefix}${version}( \($virtualenv\))]($style) '` | The format for the module. |
| `symbol` | `"🐍 "` | A format string representing the symbol of Python | | `symbol` | `"🐍 "` | A format string representing the symbol of Python |
| `style` | `"yellow bold"` | 這個模組的風格。 | | `style` | `"yellow bold"` | 這個模組的風格。 |
| `pyenv_version_name` | `false` | 使用 pyenv 取得 Python 的版本。 | | `pyenv_version_name` | `false` | Use pyenv to get Python version |
| `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used |
| `scan_for_pyfiles` | `true` | If false, Python files in the current directory will not show this module. | | `scan_for_pyfiles` | `true` | If false, Python files in the current directory will not show this module. |
| `python_binary` | `python` | Configures the python binary that Starship executes when getting the version. | | `python_binary` | `python` | Configures the python binary that Starship executes when getting the version. |
| `disabled` | `false` | 停用 `python` 模組。 | | `disabled` | `false` | Disables the `python` module. |
### Variables ### Variables
@ -1844,11 +1965,11 @@ python_binary = "python3"
## Ruby ## Ruby
`ruby` 模組顯示現在安裝的 Ruby 版本。 這個模組在下列其中一個條件達成時顯示： The `ruby` module shows the currently installed version of Ruby. The module will be shown if any of the following conditions are met:
- 目前資料夾中有一個 `Gemfile` 檔案 - The current directory contains a `Gemfile` file
- The current directory contains a `.ruby-version` file - The current directory contains a `.ruby-version` file
- 目前資料夾中有一個 `.rb` 檔案 - The current directory contains a `.rb` file
### 選項 ### 選項
@ -1857,7 +1978,7 @@ python_binary = "python3"
| `format` | `"via [$symbol$version]($style) "` | The format for the module. | | `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"💎 "` | A format string representing the symbol of Ruby. | | `symbol` | `"💎 "` | A format string representing the symbol of Ruby. |
| `style` | `"bold red"` | 這個模組的風格。 | | `style` | `"bold red"` | 這個模組的風格。 |
| `disabled` | `false` | 停用 `ruby` 模組。 | | `disabled` | `false` | Disables the `ruby` module. |
### Variables ### Variables
@ -1880,10 +2001,10 @@ symbol = "🔺 "
## Rust ## Rust
`rust` 模組顯示現在安裝的 Rust 版本。 這個模組在下列其中一個條件達成時顯示： The `rust` module shows the currently installed version of Rust. The module will be shown if any of the following conditions are met:
- 目前資料夾中有一個 `Cargo.toml` 檔案 - The current directory contains a `Cargo.toml` file
- 現在資料夾中包含一個檔案具有 `.rs` 副檔名 - The current directory contains a file with the `.rs` extension
### 選項 ### 選項
@ -1892,7 +2013,7 @@ symbol = "🔺 "
| `format` | `"via [$symbol$version]($style) "` | The format for the module. | | `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"🦀 "` | A format string representing the symbol of Rust | | `symbol` | `"🦀 "` | A format string representing the symbol of Rust |
| `style` | `"bold red"` | 這個模組的風格。 | | `style` | `"bold red"` | 這個模組的風格。 |
| `disabled` | `false` | 停用 `rust` 模組。 | | `disabled` | `false` | Disables the `rust` module. |
### Variables ### Variables
@ -1980,48 +2101,13 @@ The `singularity` module shows the current singularity image, if inside a contai
format = '[📦 \[$env\]]($style) ' format = '[📦 \[$env\]]($style) '
``` ```
## Swift
The `swift` module shows the currently installed version of Swift. 這個模組在下列其中一個條件達成時顯示：
- The current directory contains a `Package.swift` file
- The current directory contains a file with the `.swift` extension
### 選項
| Option | 預設 | 說明 |
| ---------- | ---------------------------------- | ------------------------------------------------ |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
| `style` | `"bold 202"` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `swift` module. |
### Variables
| 變數 | 範例 | 說明 |
| --------- | -------- | ------------------------------------ |
| version | `v5.2.4` | The version of `swift` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### 範例
```toml
# ~/.config/starship.toml
[swift]
format = "via [🏎 $version](red bold)"
```
## Status ## Status
The `status` module displays the exit code of the previous command. The module will be shown only if the exit code is not `0`. The `status` module displays the exit code of the previous command. The module will be shown only if the exit code is not `0`.
::: tip ::: tip
這個模組預設是停用的。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 ::: This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. :::
### 選項 ### 選項
@ -2056,12 +2142,47 @@ disabled = false
``` ```
## Swift
The `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met:
- The current directory contains a `Package.swift` file
- The current directory contains a file with the `.swift` extension
### 選項
| Option | 預設 | 說明 |
| ---------- | ---------------------------------- | ------------------------------------------------ |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
| `style` | `"bold 202"` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `swift` module. |
### Variables
| 變數 | 範例 | 說明 |
| --------- | -------- | ------------------------------------ |
| version | `v5.2.4` | The version of `swift` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### 範例
```toml
# ~/.config/starship.toml
[swift]
format = "via [🏎 $version](red bold)"
```
## Terraform ## Terraform
The `terraform` module shows the currently selected terraform workspace and version. By default the terraform version is not shown, since this is slow on current versions of terraform when a lot of plugins are in use. If you still want to enable it, [follow the example shown below](#with-version). 這個模組在下列其中一個條件達成時顯示： The `terraform` module shows the currently selected terraform workspace and version. By default the terraform version is not shown, since this is slow on current versions of terraform when a lot of plugins are in use. If you still want to enable it, [follow the example shown below](#with-version). The module will be shown if any of the following conditions are met:
- The current directory contains a `.terraform` folder - The current directory contains a `.terraform` folder
- Current directory contains a file with the `.tf` extension - Current directory contains a file with the `.tf` or `.hcl` extensions
### 選項 ### 選項
@ -2105,33 +2226,33 @@ format = "[🏎💨 $workspace]($style) "
## 時間 ## 時間
`time` 模組顯示目前的**當地**時間. `format` 設定值被 [`chrono`](https://crates.io/crates/chrono) crate 用來控制時間如何顯示。 請看 [chrono 的 strftime 文件](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html)來了解有那些選項可以使用。 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 ::: tip
這個模組預設是停用的。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file.
::: :::
### 選項 ### 選項
| Option | 預設 | 說明 | | Option | 預設 | 說明 |
| ----------------- | ----------------------- | ----------------------------------------------------------------------------------------------------- | | ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `format` | `"at [$time]($style) "` | The format string for the module. | | `format` | `"at [$time]($style) "` | The format string for the module. |
| `use_12hr` | `false` | 啟用 12 小時格式。 | | `use_12hr` | `false` | Enables 12 hour formatting |
| `time_format` | 請看下列 | 用來顯示時間的 [chrono 格式字串](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html)。 | | `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. |
| `style` | `"bold yellow"` | 這個模組的時間的風格。 | | `style` | `"bold yellow"` | The style for the module time |
| `utc_time_offset` | `"local"` | 設定相對於 UTC 的時差。 Range from -24 &lt; x &lt; 24. 允許使用浮點數來表示 30/45 分鐘時差的時區。 | | `utc_time_offset` | `"local"` | Sets the UTC offset to use. Range from -24 &lt; x &lt; 24. Allows floats to accommodate 30/45 minute timezone offsets. |
| `disabled` | `true` | 停用 `time` 模組。 | | `disabled` | `true` | Disables the `time` module. |
| `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | | `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format |
If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. 不然的話，它會被預設為 `"%T"`。 Manually setting `time_format` will override the `use_12hr` setting. If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Otherwise, it defaults to `"%T"`. Manually setting `time_format` will override the `use_12hr` setting.
### Variables ### Variables
| 變數 | 範例 | 說明 | | 變數 | 範例 | 說明 |
| --------- | ---------- | ----------------------------------- | | --------- | ---------- | ----------------------------------- |
| 時間 | `13:08:10` | The current time. | | time | `13:08:10` | The current time. |
| style\* | | Mirrors the value of option `style` | | style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string \*: This variable can only be used as a part of a style string
@ -2149,24 +2270,24 @@ utc_time_offset = "-5"
time_range = "10:00:00-14:00:00" time_range = "10:00:00-14:00:00"
``` ```
## 使用者名稱 ## Username
`username` 模組顯示現在使用中的使用者名稱。 這個模組在下列其中一個條件達成時顯示： The `username` module shows active user's username. The module will be shown if any of the following conditions are met:
- 目前使用者為 root - The current user is root
- 目前使用者並非登入時的使用者 - The current user isn't the same as the one that is logged in
- 使用者透過 SSH session 進行連線 - The user is currently connected as an SSH session
- 變數 `show_always` 被設為 true - The variable `show_always` is set to true
### 選項 ### 選項
| Option | 預設 | 說明 | | Option | 預設 | 說明 |
| ------------- | ----------------------- | -------------------------- | | ------------- | ----------------------- | ------------------------------------- |
| `style_root` | `"bold red"` | 使用者為 root 時使用的風格。 | | `style_root` | `"bold red"` | The style used when the user is root. |
| `style_user` | `"bold yellow"` | 非 root 使用者時使用的風格。 | | `style_user` | `"bold yellow"` | The style used for non-root users. |
| `format` | `"[$user]($style) in "` | The format for the module. | | `format` | `"[$user]($style) in "` | The format for the module. |
| `show_always` | `false` | 總是顯示 `username` 模組。 | | `show_always` | `false` | Always shows the `username` module. |
| `disabled` | `false` | 停用 `username` 模組。 | | `disabled` | `false` | Disables the `username` module. |
### Variables ### Variables
@ -2190,7 +2311,7 @@ show_always = true
## Zig ## Zig
The `zig` module shows the currently installed version of Zig. 這個模組在下列其中一個條件達成時顯示： The `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met:
- The current directory contains a `.zig` file - The current directory contains a `.zig` file
@ -2258,7 +2379,7 @@ The order in which custom modules are shown can be individually set by including
| `command` | | The command whose output should be printed. The command will be passed on stdin to the shell. | | `command` | | The command whose output should be printed. The command will be passed on stdin to the shell. |
| `when` | | A shell command used as a condition to show the module. The module will be shown if the command returns a `0` status code. | | `when` | | A shell command used as a condition to show the module. The module will be shown if the command returns a `0` status code. |
| `shell` | | [See below](#custom-command-shell) | | `shell` | | [See below](#custom-command-shell) |
| `說明` | `"<custom module>"` | The description of the module that is shown when running `starship explain`. | | `description` | `"<custom module>"` | The description of the module that is shown when running `starship explain`. |
| `files` | `[]` | The files that will be searched in the working directory for a match. | | `files` | `[]` | The files that will be searched in the working directory for a match. |
| `directories` | `[]` | The directories that will be searched in the working directory for a match. | | `directories` | `[]` | The directories that will be searched in the working directory for a match. |
| `extensions` | `[]` | The extensions that will be searched in the working directory for a match. | | `extensions` | `[]` | The extensions that will be searched in the working directory for a match. |
@ -2322,38 +2443,3 @@ command = "time /T"
files = ["*.pst"] files = ["*.pst"]
shell = ["pwsh.exe", "-NoProfile", "-Command", "-"] shell = ["pwsh.exe", "-NoProfile", "-Command", "-"]
``` ```
## PureScript
The `purescript` module shows the currently installed version of PureScript version. 這個模組在下列其中一個條件達成時顯示：
- 現在資料夾中包含一個 `spago.dhall` 檔案
- The current directory contains a \*.purs files
### 選項
| Option | 預設 | 說明 |
| ---------- | ---------------------------------- | ------------------------------------------------------------ |
| `format` | `"via [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. |
| `style` | `"bold white"` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `purescript` module. |
### Variables
| 變數 | 範例 | 說明 |
| --------- | -------- | ------------------------------------ |
| version | `0.13.5` | The version of `purescript` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
\*: This variable can only be used as a part of a style string
### 範例
```toml
# ~/.config/starship.toml
[purescript]
format = "via [$symbol$version](bold white)"
```

2
docs/zh-TW/guide/README.md
View File

@ -199,7 +199,7 @@
#### PowerShell #### PowerShell
將以下內容放到 `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` 的結尾 (或是在 -Nix 上的 `~/.config/powershell/Microsoft.PowerShell_profile.ps1`)： Add the following to the end of `Microsoft.PowerShell_profile.ps1`. You can check the location of this file by querying the `$PROFILE` variable in PowerShell. Typically the path is `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` or `~/.config/powershell/Microsoft.PowerShell_profile.ps1` on -Nix.
```sh ```sh
Invoke-Expression (&starship init powershell) Invoke-Expression (&starship init powershell)

2
docs/zh-TW/presets/README.md
View File

@ -84,7 +84,7 @@ symbol = " "
symbol = " " symbol = " "
[rust] [rust]
symbol = " " symbol = " "
[swift] [swift]
symbol = "ﯣ " symbol = "ﯣ "