From ea6f5e429cb83c7cf690493c9c42901ea63b5838 Mon Sep 17 00:00:00 2001 From: Matan Kushner Date: Sat, 28 Nov 2020 23:45:59 -0500 Subject: [PATCH] docs(i18n): New Crowdin updates (#1788) --- docs/de-DE/README.md | 4 +- docs/de-DE/config/README.md | 596 +++--- docs/de-DE/guide/README.md | 2 +- docs/de-DE/presets/README.md | 2 +- docs/es-ES/README.md | 8 +- docs/es-ES/advanced-config/README.md | 32 +- docs/es-ES/config/README.md | 2094 +++++++++++----------- docs/es-ES/faq/README.md | 40 +- docs/es-ES/guide/README.md | 28 +- docs/es-ES/migrating-to-0.45.0/README.md | 146 +- docs/es-ES/presets/README.md | 6 +- docs/fr-FR/README.md | 4 +- docs/fr-FR/config/README.md | 592 +++--- docs/fr-FR/guide/README.md | 2 +- docs/fr-FR/migrating-to-0.45.0/README.md | 2 +- docs/fr-FR/presets/README.md | 2 +- docs/ja-JP/README.md | 4 +- docs/ja-JP/config/README.md | 607 ++++--- docs/ja-JP/guide/README.md | 2 +- docs/ja-JP/presets/README.md | 2 +- docs/pt-BR/README.md | 4 +- docs/pt-BR/config/README.md | 368 ++-- docs/pt-BR/guide/README.md | 2 +- docs/pt-BR/presets/README.md | 2 +- docs/pt-PT/README.md | 4 +- docs/pt-PT/config/README.md | 364 ++-- docs/pt-PT/guide/README.md | 2 +- docs/pt-PT/presets/README.md | 2 +- docs/ru-RU/README.md | 10 +- docs/ru-RU/advanced-config/README.md | 6 +- docs/ru-RU/config/README.md | 884 ++++----- docs/ru-RU/guide/README.md | 6 +- docs/ru-RU/presets/README.md | 4 +- docs/zh-CN/README.md | 6 +- docs/zh-CN/config/README.md | 638 ++++--- docs/zh-CN/guide/README.md | 34 +- docs/zh-CN/presets/README.md | 2 +- docs/zh-TW/README.md | 4 +- docs/zh-TW/config/README.md | 564 +++--- docs/zh-TW/guide/README.md | 2 +- docs/zh-TW/presets/README.md | 2 +- 41 files changed, 3920 insertions(+), 3165 deletions(-) diff --git a/docs/de-DE/README.md b/docs/de-DE/README.md index 108b31577..e98d28513 100644 --- a/docs/de-DE/README.md +++ b/docs/de-DE/README.md @@ -94,11 +94,9 @@ description: Starship is the minimal, blazing fast, and extremely customizable p #### 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 - # ~\Documents\PowerShell\Profile.ps1 - Invoke-Expression (&starship init powershell) ``` diff --git a/docs/de-DE/config/README.md b/docs/de-DE/config/README.md index a2a20a191..046d7aaba 100644 --- a/docs/de-DE/config/README.md +++ b/docs/de-DE/config/README.md @@ -214,11 +214,13 @@ $conda\ $memory_usage\ $aws\ $gcloud\ +$openstack\ $env_var\ $crystal\ $cmd_duration\ $custom\ $line_break\ +$lua\ $jobs\ $battery\ $time\ @@ -426,16 +428,17 @@ vicmd_symbol = "[V](bold green) " ## 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 `CMakeCache.txt` file ### Optionen | Option | Standardwert | Beschreibung | | ---------- | ---------------------------------- | -------------------------------------------- | | `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. | | `disabled` | `false` | Disables the `cmake` module. | @@ -463,13 +466,21 @@ Bash Nutzer, die eine "preexec" ähnliche Funktion benötigen, können [rcaloras ### Optionen -| Option | Standardwert | Beschreibung | -| ------------------- | ----------------------------- | ------------------------------------------------------------------ | -| `min_time` | `2_000` | Schwellwert für kleinste anzuzeigende Laufzeit (in Millisekunden). | -| `show_milliseconds` | `false` | Zeige Millisekunden zusätzlich zu Sekunden. | -| `format` | `"took [$duration]($style) "` | The format for the module. | -| `style` | `"bold yellow"` | Stil für dieses Modul. | -| `disabled` | `false` | Deaktiviert das `cmd_duration`-Modul. | +| Option | Standardwert | Beschreibung | +| -------------------- | ----------------------------- | ------------------------------------------------------------------ | +| `min_time` | `2_000` | Schwellwert für kleinste anzuzeigende Laufzeit (in Millisekunden). | +| `show_milliseconds` | `false` | Zeige Millisekunden zusätzlich zu Sekunden. | +| `format` | `"took [$duration]($style) "` | The format for the module. | +| `style` | `"bold yellow"` | Stil für dieses Modul. | +| `disabled` | `false` | Deaktiviert das `cmd_duration`-Modul. | +| `show_notifications` | `false` | Show desktop notifications when command completes. | +| `min_time_to_notify` | `45_000` | Shortest duration for notification (in milliseconds). | + +::: Tipp + +Showing desktop notifications requires starship to be built with `rust-notify` support. You check if your starship supports notifications by running `STARSHIP_LOG=debug starship module cmd_duration -d 60000` when `show_notifications` is set to `true`. + +::: ### Variables @@ -492,11 +503,11 @@ format = "underwent [$duration](bold yellow)" ## 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 -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 -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 - The current directory contains a `.cr` file @@ -567,7 +578,7 @@ format = "via [✨ $version](bold blue) " ## 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 `.dart_tool` directory @@ -603,7 +614,7 @@ format = "via [🔰 $version](bold red) " ## 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. @@ -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: "…/" |
-Dieses Modul hat einige erweiterte Konfigurationsoptionen, welche die Darstellung von Verzeichnissen steuern. +This module has a few advanced configuration options that control how the directory is displayed. | Advanced Option | Standardwert | Beschreibung | | --------------------------- | ------------ | ---------------------------------------------------------------------------------------- | @@ -751,7 +762,7 @@ heuristic = false ## 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. @@ -786,7 +797,7 @@ symbol = "🔮 " ## 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-package.json`-Datei @@ -861,7 +872,7 @@ default = "unknown shell" ## 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 `erlang.mk`-Datei. @@ -870,7 +881,7 @@ The `erlang` module shows the currently installed version of Erlang/OTP. Das Mod | 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. | | `format` | `"via [$symbol$version]($style) "` | The format for the module. | | `disabled` | `false` | Disables the `erlang` module. | @@ -956,24 +967,27 @@ asia-northeast1 = "an1" ## 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 -| Option | Standardwert | Beschreibung | -| ------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | -| `format` | `"on [$symbol$branch]($style) "` | The format for the module. Use `"$branch"` to refer to the current branch name. | -| `symbol` | `" "` | A format string representing the symbol of git branch. | -| `style` | `"bold purple"` | Stil für dieses Modul. | -| `truncation_length` | `2^63 - 1` | Truncates a git branch to X graphemes. | -| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. | -| `disabled` | `false` | Deaktiviert das `git_branch`-Modul. | +| Option | Standardwert | Beschreibung | +| -------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | +| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | +| `format` | `"on [$symbol$branch]($style) "` | The format for the module. Use `"$branch"` to refer to the current branch name. | +| `symbol` | `" "` | A format string representing the symbol of git branch. | +| `style` | `"bold purple"` | Stil für dieses Modul. | +| `truncation_length` | `2^63 - 1` | Truncates a git branch to X graphemes. | +| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. | +| `only_attached` | `false` | Only show the branch name when not in a detached HEAD state. | +| `disabled` | `false` | Disables the `git_branch` module. | ### Variables | Variable | Beispiel | Beschreibung | | --------- | -------- | ---------------------------------------------------------------------------------------------------- | | branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached HEAD). | +| remote | `master` | The remote branch name. | | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | @@ -992,17 +1006,19 @@ truncation_symbol = "" ## 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 -| Option | Standartwert | Beschreibung | -| -------------------- | -------------------------- | ----------------------------------------------------- | -| `commit_hash_length` | `7` | The length of the displayed git commit hash. | -| `format` | `'[\($hash\)]($style) '` | The format for the module. | -| `style` | `"bold green"` | Stil für dieses Modul. | -| `only_detached` | `true` | Only show git commit hash when in detached HEAD state | -| `disabled` | `false` | Disables the `git_commit` module. | +| Option | Standartwert | Beschreibung | +| -------------------- | ------------------------------------------------------ | ----------------------------------------------------- | +| `commit_hash_length` | `7` | The length of the displayed git commit hash. | +| `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | The format for the module. | +| `style` | `"bold green"` | Stil für dieses Modul. | +| `only_detached` | `true` | Only show git commit hash when in detached HEAD state | +| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. | +| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown | +| `disabled` | `false` | Disables the `git_commit` module. | ### Variables @@ -1020,6 +1036,7 @@ The `git_commit` module shows the current commit hash of the repo in your curren [git_commit] commit_hash_length = 4 +tag_symbol = "🔖 " ``` ## Git-Zustand @@ -1147,7 +1164,7 @@ behind = "⇣${count}" ## 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.sum`-Datei @@ -1188,7 +1205,7 @@ format = "via [🏎💨 $version](bold cyan) " ## 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 - The current directory contains a `Chart.yaml` file @@ -1223,7 +1240,7 @@ format = "via [⎈ $version](bold white) " ## Hostname -Das `hostname`-Modul zeigt den Hostnamen des Systems an. +The `hostname` module shows the system hostname. ### Optionen @@ -1258,7 +1275,7 @@ disabled = false ## 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 file with the `.java`, `.class`, `.gradle` or `.jar` extension @@ -1327,7 +1344,7 @@ threshold = 4 ## 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 `Manifest.toml` file @@ -1367,7 +1384,7 @@ Displays the current Kubernetes context name and, if set, the namespace from the ::: 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 -Das `line_break`-Modul unterteilt den Prompt in zwei Zeilen. +The `line_break` module separates the prompt into two lines. ### Optionen @@ -1423,27 +1440,64 @@ Das `line_break`-Modul unterteilt den Prompt in zwei Zeilen. 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 -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 -| Option | Standartwert | Beschreibung | -| ----------- | --------------------------------------------- | --------------------------------------------------------------------- | -| `threshold` | `75` | Speicherauslastung ausblenden, wenn sie unter diesem Prozentsatz ist. | -| `format` | `"via $symbol [${ram}( | ${swap})]($style) "` | The format for the module. | -| `symbol` | `"🐏"` | Symbol das vor der Speicherauslastung angezeigt wird. | -| `style` | `"bold dimmed white"` | Stil für dieses Modul. | -| `disabled` | `true` | Deaktiviert das `memory_usage`-Modul. | +| Option | Standartwert | Beschreibung | +| ----------- | --------------------------------------------- | -------------------------------------------------------- | +| `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. | +| `format` | `"via $symbol [${ram}( | ${swap})]($style) "` | The format for the module. | +| `symbol` | `"🐏"` | The symbol used before displaying the memory usage. | +| `style` | `"bold dimmed white"` | Stil für dieses Modul. | +| `disabled` | `true` | Disables the `memory_usage` module. | ### Variables @@ -1465,11 +1519,8 @@ Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `dis [memory_usage] disabled = false -show_percentage = true -show_swap = true threshold = -1 symbol = " " -separator = "/" style = "bold dimmed green" ``` @@ -1511,9 +1562,9 @@ truncation_symbol = "" ## 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 `.nims` extension - The current directory contains a file with the `.nimble` extension @@ -1547,9 +1598,9 @@ style = "yellow" 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 @@ -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. | | `impure_msg` | `"impure"` | A format string shown when the shell is impure. | | `pure_msg` | `"pure"` | A format string shown when the shell is pure. | -| `disabled` | `false` | Deaktiviert das `nix_shell`-Modul. | +| `disabled` | `false` | Disables the `nix_shell` module. | ### Variables @@ -1587,11 +1638,11 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' ## 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 -- 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 `.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. | | `symbol` | `"⬢ "` | A format string representing the symbol of NodeJS. | | `style` | `"bold green"` | Stil für dieses Modul. | -| `disabled` | `false` | Deaktiviert das `nodejs`-Modul. | +| `disabled` | `false` | Disables the `nodejs` module. | ###  Variables @@ -1623,54 +1674,9 @@ Das `nodejs`-Modul zeigt die aktuell installierte Version von NodeJS. Das Modul 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 -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 `esy.lock` directory @@ -1707,9 +1713,89 @@ The `ocaml` module shows the currently installed version of OCaml. Das Modul wir 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 -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 `cpanfile` or `cpanfile.snapshot` file @@ -1719,7 +1805,7 @@ The `perl` module shows the currently installed version of Perl. Das Modul wird ### Optionen -| Option | Standartwert | Beschreibung | +| Option | Standardwert | Beschreibung | | ---------- | ---------------------------------- | ----------------------------------------------------- | | `format` | `"via [$symbol$version]($style) "` | The format string for the module. | | `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | @@ -1745,20 +1831,20 @@ format = "via [🦪 $version]($style) " ## 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 -- Das aktuelle Verzeichnis enthält eine `.php`-Datei +- The current directory contains a `.php` file ### Optionen -| Option | Standardwert | Beschreibung | -| ---------- | ---------------------------------- | ---------------------------------------------- | -| `format` | `"via [$symbol$version]($style) "` | The format for the module. | -| `symbol` | `"🐘 "` | Symbol das vor der PHP-Version angezeigt wird. | -| `style` | `"147 bold"` | Stil für dieses Modul. | -| `disabled` | `false` | Deaktiviert das `php`-Modul. | +| Option | Standardwert | Beschreibung | +| ---------- | ---------------------------------- | ----------------------------------------------------- | +| `format` | `"via [$symbol$version]($style) "` | The format for the module. | +| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | +| `style` | `"147 bold"` | Stil für dieses Modul. | +| `disabled` | `false` | Disables the `php` module. | ### Variables @@ -1779,23 +1865,58 @@ Das `php`-Modul zeigt die aktuell installierte Version von PHP. Das Modul wird g 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 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`. -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 -- Das aktuelle Verzeichnis enthält eine `requirements.txt`-Datei -- Das aktuelle Verzeichnis enthält eine `pyproject.toml`-Datei +- The current directory contains a `.python-version` file +- The current directory contains a `requirements.txt` file +- The current directory contains a `pyproject.toml` file - The current directory contains a file with the `.py` extension (and `scan_for_pyfiles` is true) -- Das aktuelle Verzeichnis enthält eine `Pipfile`-Datei -- Das aktuelle Verzeichnis enthält eine `tox.ini`-Datei -- Das aktuelle Verzeichnis enthält eine `setup.py`-Datei +- The current directory contains a `Pipfile` file +- The current directory contains a `tox.ini` file +- The current directory contains a `setup.py` file - The current directory contains a `__init__.py` file -- Ein virtualenv ist momentan aktiv +- A virtual environment is currently activated ### 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. | | `symbol` | `"🐍 "` | A format string representing the symbol of Python | | `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 | | `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. | -| `disabled` | `false` | Deaktiviert das `python`-Modul. | +| `disabled` | `false` | Disables the `python` module. | ### Variables @@ -1844,11 +1965,11 @@ python_binary = "python3" ## 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 -- Das aktuelle Verzeichnis enthält eine `.rb`-Datei +- The current directory contains a `.rb` file ### 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. | | `symbol` | `"💎 "` | A format string representing the symbol of Ruby. | | `style` | `"bold red"` | Stil für dieses Modul. | -| `disabled` | `false` | Deaktiviert das `ruby`-Modul. | +| `disabled` | `false` | Disables the `ruby` module. | ### Variables @@ -1880,10 +2001,10 @@ symbol = "🔺 " ## 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 -- Das aktuelle Verzeichnis enthält eine Datei mit der `.rs`-Erweiterung +- The current directory contains a `Cargo.toml` file +- The current directory contains a file with the `.rs` extension ### 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. | | `symbol` | `"🦀 "` | A format string representing the symbol of Rust | | `style` | `"bold red"` | Stil für dieses Modul. | -| `disabled` | `false` | Deaktiviert das `rust`-Modul. | +| `disabled` | `false` | Disables the `rust` module. | ### Variables @@ -1980,48 +2101,13 @@ The `singularity` module shows the current singularity image, if inside a contai 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 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 -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 @@ -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 -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 -- Das aktuelle Verzeichnis enthält eine Datei mit der `.tf`-Erweiterung +- The current directory contains a `.terraform` folder +- Current directory contains a file with the `.tf` or `.hcl` extensions ### 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. | | `symbol` | `"💠 "` | A format string shown before the terraform workspace. | | `style` | `"bold 105"` | Stil für dieses Modul. | -| `disabled` | `false` | Deaktiviert das `terraform` Modul. | +| `disabled` | `false` | Disables the `terraform` module. | ### Variables @@ -2105,33 +2226,33 @@ format = "[🏎💨 $workspace]($style) " ## 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 -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 -| Option | Standardwert | Beschreibung | -| ----------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | -| `format` | `"at [$time]($style) "` | The format string for the module. | -| `use_12hr` | `false` | Aktiviert 12-Stunden-Format | -| `time_format` | siehe unten | Das Format zum Anzeigen der Uhrzeit in [chrono-Formatierung](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html). | -| `style` | `"bold yellow"` | Stil für dieses Modul | -| `utc_time_offset` | `"local"` | Verwendetes Zeitzonen-Offset. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. | -| `disabled` | `true` | Deaktiviert das `time`-Modul. | -| `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | +| Option | Standardwert | Beschreibung | +| ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | +| `format` | `"at [$time]($style) "` | The format string for the module. | +| `use_12hr` | `false` | Enables 12 hour formatting | +| `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. | +| `style` | `"bold yellow"` | The style for the module time | +| `utc_time_offset` | `"local"` | Sets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. | +| `disabled` | `true` | Disables the `time` module. | +| `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | -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 | Variable | Beispiel | Beschreibung | | --------- | ---------- | ----------------------------------- | -| zeit | `13:08:10` | The current time. | +| time | `13:08:10` | The current time. | | style\* | | Mirrors the value of option `style` | \*: This variable can only be used as a part of a style string @@ -2151,22 +2272,22 @@ time_range = "10:00:00-14:00:00" ## 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 -- Der aktuelle Benutzer ist nicht der eingeloggte Benutzer -- Der Benutzer ist aktuell via SSH verbunden -- Die Variable `show_always` ist auf true gesetzt +- The current user is root +- The current user isn't the same as the one that is logged in +- The user is currently connected as an SSH session +- The variable `show_always` is set to true ### Optionen -| Option | Standardwert | Beschreibung | -| ------------- | ----------------------- | ---------------------------------------------- | -| `style_root` | `"bold red"` | Stil wenn der Benutzer unter root läuft. | -| `style_user` | `"bold yellow"` | Stil wenn der Benutzer nicht unter root läuft. | -| `format` | `"[$user]($style) in "` | The format for the module. | -| `show_always` | `false` | Immer das `username` Modul anzeigen. | -| `disabled` | `false` | Deavktiviert das `username` Modul. | +| Option | Standardwert | Beschreibung | +| ------------- | ----------------------- | ------------------------------------- | +| `style_root` | `"bold red"` | The style used when the user is root. | +| `style_user` | `"bold yellow"` | The style used for non-root users. | +| `format` | `"[$user]($style) in "` | The format for the module. | +| `show_always` | `false` | Always shows the `username` module. | +| `disabled` | `false` | Disables the `username` module. | ### Variables @@ -2190,7 +2311,7 @@ show_always = true ## 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 @@ -2253,19 +2374,19 @@ The order in which custom modules are shown can be individually set by including ### Optionen -| Option | Standardwert | Beschreibung | -| -------------- | ----------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `command` | | The command whose output should be printed. The command will be passed on stdin to the shell. | -| `when` | | A shell command used as a condition to show the module. The module will be shown if the command returns a `0` status code. | -| `shell` | | [See below](#custom-command-shell) | -| `beschreibung` | `""` | The description of the module that is shown when running `starship explain`. | -| `files` | `[]` | The files that will be searched in the working directory for a match. | -| `directories` | `[]` | The directories that will be searched in the working directory for a match. | -| `extensions` | `[]` | The extensions that will be searched in the working directory for a match. | -| `symbol` | `""` | The symbol used before displaying the command output. | -| `style` | `"bold green"` | Stil für dieses Modul. | -| `format` | `"[$symbol$output]($style) "` | The format for the module. | -| `disabled` | `false` | Disables this `custom` module. | +| Option | Standardwert | Beschreibung | +| ------------- | ----------------------------- | -------------------------------------------------------------------------------------------------------------------------- | +| `command` | | The command whose output should be printed. The command will be passed on stdin to the shell. | +| `when` | | A shell command used as a condition to show the module. The module will be shown if the command returns a `0` status code. | +| `shell` | | [See below](#custom-command-shell) | +| `description` | `""` | The description of the module that is shown when running `starship explain`. | +| `files` | `[]` | The files that will be searched in the working directory for a match. | +| `directories` | `[]` | The directories that will be searched in the working directory for a match. | +| `extensions` | `[]` | The extensions that will be searched in the working directory for a match. | +| `symbol` | `""` | The symbol used before displaying the command output. | +| `style` | `"bold green"` | Stil für dieses Modul. | +| `format` | `"[$symbol$output]($style) "` | The format for the module. | +| `disabled` | `false` | Disables this `custom` module. | ### Variables @@ -2322,38 +2443,3 @@ command = "time /T" files = ["*.pst"] 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)" -``` diff --git a/docs/de-DE/guide/README.md b/docs/de-DE/guide/README.md index 0d6aab758..f9f5e2dd8 100644 --- a/docs/de-DE/guide/README.md +++ b/docs/de-DE/guide/README.md @@ -199,7 +199,7 @@ #### 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 Invoke-Expression (&starship init powershell) diff --git a/docs/de-DE/presets/README.md b/docs/de-DE/presets/README.md index 56cdb0c0b..660d396ab 100644 --- a/docs/de-DE/presets/README.md +++ b/docs/de-DE/presets/README.md @@ -84,7 +84,7 @@ symbol = " " symbol = " " [rust] -symbol = " " +symbol = " " [swift] symbol = "ﯣ " diff --git a/docs/es-ES/README.md b/docs/es-ES/README.md index b38b0ff30..3a91a166f 100644 --- a/docs/es-ES/README.md +++ b/docs/es-ES/README.md @@ -2,7 +2,7 @@ home: true heroImage: /logo.svg 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 → actionLink: ./guide/ features: @@ -30,7 +30,7 @@ description: Starship es el símbolo de sistema minimalista, ultrarápido e infi ### Instalación rápida -1. Instalar el binario de **starship**: +1. Instalar el binario de **Starship**: #### Instalar la última versión @@ -94,11 +94,9 @@ description: Starship es el símbolo de sistema minimalista, ultrarápido e infi #### 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 - # ~\Documentos\PowerShell\Profile.ps1 - Invoke-Expression (&starship init powershell) ``` diff --git a/docs/es-ES/advanced-config/README.md b/docs/es-ES/advanced-config/README.md index 08ee7b379..e6ee2e85d 100644 --- a/docs/es-ES/advanced-config/README.md +++ b/docs/es-ES/advanced-config/README.md @@ -1,6 +1,6 @@ # 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 @@ -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 function blastoff(){ @@ -21,21 +21,21 @@ function 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 function blastoff(){ 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) ``` -## 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 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 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) ``` -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 function set_win_title(){ @@ -68,9 +68,9 @@ function 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` - `underline` @@ -82,7 +82,7 @@ Los estilos de cadenas de texto son una lista de palabras, separadas por espacio donde `` es un especificador de color (discutido a continuación). `fg:` y `` 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: diff --git a/docs/es-ES/config/README.md b/docs/es-ES/config/README.md index af59d628b..4b262cd4f 100644 --- a/docs/es-ES/config/README.md +++ b/docs/es-ES/config/README.md @@ -1,15 +1,15 @@ # Configuración -Para comenzar a configurar starship, crea el siguiente archivo: `~/.config/starship.toml`. +Para comenzar a configurar Starship, crea el siguiente archivo: `~/.config/starship.toml`. ```sh mkdir -p ~/.config && touch ~/.config/starship.toml ``` -Toda la configuración de starship se realiza en este archivo [TOML](https://github.com/toml-lang/toml): +Toda la configuración de Starship se realiza en este archivo [TOML](https://github.com/toml-lang/toml): ```toml -# Evita imprimir una nueva linea al inicio del prompt +# Evita imprimir una nueva línea al inicio del prompt add_newline = false # Reemplaza el símbolo "❯" por "➜" del prompt @@ -34,9 +34,9 @@ El equivalente en PowerShell (Windows) es añadir esta línea a tu `$PROFILE`: $ENV:STARSHIP_CONFIG = "$HOME\.starship" ``` -### Logging +### Registros -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: +Starship registra por defecto los mensajes de advertencia y error en un fichero con nombre `~/.cache/starship/session_${STARSHIP_SESSION_KEY}.log`, en el que la clave de sesión corresponde con una instancia de tu terminal. Esto, sin embargo, puede ser cambiado usando la variable de entorno `STARSHIP_CACHE`: ```sh export STARSHIP_CACHE=~/.starship/cache @@ -50,13 +50,13 @@ $ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp" ### Terminología -**Módulo**: un componente en el símbolo de sistema que provee de información basada en información contextual de tu sistema operativo. Por ejemplo, el módulo "nodejs" muestra la versión de NodeJS que tienes actualmente instalada en tu ordenador, si el directorio actual es un proyecto NodeJS. +**Módulo**: un componente en el promt que provee información basada en información contextual de tu sistema operativo. Por ejemplo, el módulo "nodejs" muestra la versión de NodeJS que tienes actualmente instalada en tu ordenador, si el directorio actual es un proyecto NodeJS. **Variable**: subcomponentes más pequeños que contienen información proporcionada por el módulo. Por ejemplo, la variable "version" en el módulo "nodejs" contiene la versión actual de NodeJS. Por convención, la mayoría de los módulos tienen un prefijo del color predeterminado de la terminal (por ejemplo, `vía` en "nodejs") y un espacio vacío como sufijo. -### Formato de cadenas de texto +### Cadenas de Formato Es el formato con el que un módulo imprime todas sus variables. La mayoría de los módulos tienen una entrada llamada `format` que configura el formato de visualización del módulo. Se puede utilizar textos, variables y grupos de texto. @@ -66,27 +66,27 @@ Una variable contiene un símbolo `$` seguido por el nombre de la variable. El n Por ejemplo: -- `$version` es un formato de cadena de texto con una variable llamada `version`. +- `$version` es una cadena de formato con una variable llamada `version`. - `$git_branch$git_commit` es un formato de cadena de texto con dos variables nombradas `git_branch` y `git_commit`. - `$git_branch $git_commit` tiene las dos variables separadas por un espacio. -#### Grupo de texto +#### Grupo de Texto Un grupo de texto se compone de dos partes diferentes. -La primera parte, que está encerrada en un `[]`, es un [formato de cadena de texto](#format-strings). Se puede agregar textos, variables, o incluso grupos de texto anidados. +La primera parte, que está encerrada en un `[]`, es una [cadena de formato](#format-strings). Se puede agregar textos, variables, o incluso grupos de texto anidados. -En la segunda parte, que está encerrada en un `()`, es un [formato de cadena de texto](#style-strings). Se puede utilizar el estilo de la primera parte. +En la segunda parte, que está encerrada entre `()`, es una [cadena de estilo](#style-strings). Se puede utilizar el estilo de la primera parte. Por ejemplo: -- `[on](bold red)` imprimirá una cadena `en` con texto en negrita color rojo. +- `[en](bold red)` imprimirá una cadena `en` con texto en negrita color rojo. - `[⬢ $version](bold green)` imprimirá un símbolo `⬢` seguido por el contenido de la variable `version`, con texto en negrita color verde. -- `[a [b](red) c](green)` imprimirá `a b c` con `b` rojo. y `a` y `c` verde. +- `[a [b](red) c](green)` imprimirá `a b c` con `b` en rojo, `a` y `c` en verde. #### Cadenas de estilo -La mayoría de los módulos de starship permiten configurar los estilos de su cadenas texto. Esto se consigue con una entrada (normalmente llamada `style` - estilo) que no es más que un texto donde se especifica la configuración. A continuación mostramos algunos ejemplos de textos estilados junto con su funcionalidad. Para más detalles sobre la sintaxis completa, consulta [la guía de configuración avanzada](/advanced-config/). +La mayoría de los módulos de starship permiten configurar los estilos de su cadenas texto. Esto se consigue con una entrada (normalmente llamada `style` - estilo) que no es más que un texto donde se especifica la configuración. A continuación mostramos algunos ejemplos de cadenas de estilo junto con su funcionalidad. Para más detalles sobre la sintaxis completa, consulta [la guía de configuración avanzada](/advanced-config/). - `"fg:green bg:blue"` pone texto verde sobre un fondo azul - `"bg:blue fg:bright-green"` pone texto verde claro sobre un fondo azul @@ -97,7 +97,7 @@ La mayoría de los módulos de starship permiten configurar los estilos de su ca Nótese que el estilo es similar a como se controlaría por el emulador de su terminal. Por ejemplo, algunos emuladores de terminal harán los colores más brillantes en lugar de más gruesos, y algunos temas usan los mismos valores para texto normal y colores brillantes. Además, para mostrar textos en cursiva tu terminal debe tener soporte para hacerlo. -#### Cadenas de formato condicionales +#### Cadenas de Formato Condicional Una cadena de formato condicional envuelto en `(` y `)` no se renderizará si todas las variables dentro están vacías. @@ -105,9 +105,9 @@ Por ejemplo: - `(@$region)` no mostrará nada si la variable `region` es `None`, de lo contrario `@` seguido por el valor de la región. - `(algún texto)` siempre mostrará nada ya que no hay variables envueltas entre llaves. -- Cuando `$all` es un atajo de teclado para `\[$a$b\]`, `($all)` no mostrará nada solo si `$a` y `$b` ambos son `None`. Esto funciona igual que `(\[$a$b\] )`. +- Cuando `$all` es un atajo para `\[$a$b\]`, `($all)` no mostrará nada solo si `$a` y `$b` ambos son `None`. Esto funciona igual que `(\[$a$b\] )`. -#### Carácteres de escape +#### Caracteres de escape Los siguientes símbolos tienen un uso especial en una cadena de formato. Si se quiere imprimir los siguientes símbolos, se tienen que escapar con una barra invertida (`\`). @@ -118,9 +118,9 @@ Los siguientes símbolos tienen un uso especial en una cadena de formato. Si se - ( - ) -Se debe tener en cuenta que `toml` tiene [su propia sintaxis de escape](https://github.com/toml-lang/toml#user-content-string). Se recomienda usar una cadena literal (`''`) en la configuración. Si se desea utilizar una cadena básica (`""`), prestar atención para escapar la barra inversa `\`. +Se debe tener en cuenta que `toml` tiene [su propia sintaxis de escape](https://github.com/toml-lang/toml#user-content-string). Se recomienda usar una cadena literal (`''`) en la configuración. Si se desea utilizar una cadena básica (`""`), prestar atención para escapar la barra invertida `\`. -Por ejemplo, cuando se desea imprimir un símbolo `$` en una nueva línea, las siguientes configuraciones para el `format` son equivalentes: +Por ejemplo, cuando se desea imprimir un símbolo `$` en una nueva línea, las siguientes configuraciones para la variable `format` son equivalentes: ```toml # con cadena básica @@ -143,11 +143,11 @@ Esta es la lista de opciones de configuración. ### Opciones -| Opción | Por defecto | Descripción | -| -------------- | ------------------------------ | ----------------------------------------------------------------------------- | -| `format` | [link](#default-prompt-format) | Configura el formato del prompt. | -| `scan_timeout` | `30` | Tiempo de espera tras el que starship escanea los archivos (en milisegundos). | -| `add_newline` | `true` | Añade una nueva línea antes del prompt. | +| Opción | Por defecto | Descripción | +| -------------- | ---------------------------------- | ----------------------------------------------------------------------------- | +| `format` | [ver aquí](#default-prompt-format) | Configura el formato del prompt. | +| `scan_timeout` | `30` | Tiempo de espera tras el que Starship escanea los archivos (en milisegundos). | +| `add_newline` | `true` | Añade una nueva línea antes del prompt. | ### Ejemplo @@ -167,14 +167,14 @@ scan_timeout = 10 add_newline = false ``` -### Formato predeterminado del Prompt +### Formato por Defecto del Prompt -El `format` predeterminado se utiliza para definir el formato del prompt, si está vacío o no `format` se proporciona. El valor por defecto es el siguiente: +La varieble `format` por defecto se utiliza para definir el formato del prompt, si está vacía o `format` no se proporciona. El valor por defecto es el siguiente: ```toml format = "$all" -# Which is equivalent to +# Que es equivalente a format = """ $username\ $hostname\ @@ -215,11 +215,13 @@ $conda\ $memory_usage\ $aws\ $gcloud\ +$openstack\ $env_var\ $crystal\ $cmd_duration\ $custom\ $line_break\ +$lua\ $jobs\ $battery\ $time\ @@ -229,7 +231,7 @@ $character""" ## AWS -El módulo `aws` muestra la región actual de AWS y el perfil. Éste se basa en las variables de entorno `AWS_REGION`, `AWS_DEFAULT_REGION`, y `AWS_PROFILE` del fichero `~/.aws/config`. +El módulo `aws` muestra la región y el perfil actual de AWS. Éste se basa en las variables de entorno `AWS_REGION`, `AWS_DEFAULT_REGION`, y `AWS_PROFILE` del fichero `~/.aws/config`. Cuando uses [aws-vault](https://github.com/99designs/aws-vault) el perfil se obtiene de la variable de entorno `AWS_VAULT`. @@ -262,7 +264,7 @@ Cuando uses [aws-vault](https://github.com/99designs/aws-vault) el perfil se obt # ~/.config/starship.toml [aws] -format = 'on [$symbol$profile(\($region\))]($style) ' +format = 'en [$symbol$profile(\($region\))]($style) ' style = "bold blue" symbol = "🅰 " [aws.region_aliases] @@ -276,7 +278,7 @@ us-east-1 = "va" # ~/.config/starship.toml [aws] -format = "on [$symbol$region]($style) " +format = "en [$symbol$region]($style) " style = "bold blue" symbol = "🅰 " [aws.region_aliases] @@ -290,35 +292,35 @@ us-east-1 = "va" # ~/.config/starship.toml [aws] -format = "on [$symbol$profile]($style) " +format = "en [$symbol$profile]($style) " style = "bold blue" symbol = "🅰 " ``` ## Battery -El módulo `battery` muestra la cantidad de batería y si está cargando o no. El módulo es solo visible cuando la batería está por debajo del 10%. +El módulo `battery` muestra la cantidad de batería y si se está cargando o no. El módulo es solo visible cuando la batería está por debajo del 10%. ### Opciones | Opción | Por defecto | Descripción | | -------------------- | --------------------------------- | ------------------------------------------------- | | `full_symbol` | `"•"` | Se muestra cuando la batería está cargada. | -| `charging_symbol` | `"⇡"` | Se muestra cuando la batería está cargando. | +| `charging_symbol` | `"⇡"` | Se muestra cuando la batería se está cargando. | | `discharging_symbol` | `"⇣"` | Se muestra cuando la batería se está descargando. | | `format` | `"[$symbol$percentage]($style) "` | El formato del módulo. | -| `display` | [link](#battery-display) | Define cuándo mostrar el indicador y el estilo. | +| `display` | [ver aquí](#battery-display) | Define cuándo mostrar el indicador y el estilo. | | `disabled` | `false` | Desactiva el módulo `battery`. |
Hay otras opciones para algunos estados de la batería menos comunes. -| Variable | Descripción | -| ---------------- | --------------------------------------------------- | -| `unknown_symbol` | The symbol shown when the battery state is unknown. | -| `empty_symbol` | The symbol shown when the battery state is empty. | +| Variable | Descripción | +| ---------------- | ------------------------------------------------------------------------ | +| `unknown_symbol` | El símbolo que se muestra cuando el estado de la batería es desconocido. | +| `empty_symbol` | El símbolo que se muestra cuando el estado de la batería está vacío. | -Note: Battery indicator will be hidden if the status is `unknown` or `empty` unless you specify the option in the config. +Nota: El indicador de batería se ocultará si el estado es `desconocido` o `vacío` a menos que se especifique la opción en la configuración.
@@ -335,7 +337,7 @@ discharging_symbol = "💀" ### Indicador de batería -La configuración de la opción `display` es usada para definir cuándo se debe mostrar el indicador de batería y cómo debe mostrarse. Si no se provee ningún valor para `display` El valor por defecto es el siguiente: +La configuración de la opción `display` es usada para definir cuándo se debe mostrar el indicador de batería y cómo debe mostrarse. Si no se provee ningún valor para `display`, el valor por defecto es el siguiente: ```toml [[battery.display]] @@ -369,24 +371,24 @@ style = "bold yellow" ## Character -El módulo `character` muestra un carater (normalmente una flecha) tras el texto que introduces en el terminal. +El módulo `character` muestra un carácter (normalmente una flecha) tras el texto que introduces en el terminal. El carácter te dirá si el último comando funcionó o no. Se puede hacer de dos maneras: -- cambiando el color (`red`/`green`) -- cambiando la forma (`.`/`✖`) +- Cambiando el color (`red`/`green`) +- Cambiando la forma (`.`/`✖`) Por defecto sólo cambia el color. Si también se quiere cambiar su forma, ver [este ejemplo](#with-custom-error-shape). ### Opciones -| Opción | Por defecto | Descripción | -| ---------------- | ------------------- | ------------------------------------------------------------------------------------------ | -| `format` | `"$symbol "` | La cadena de formato usada antes de la entrada de texto. | -| `success_symbol` | `"[❯](bold green)"` | La cadena de formato usada antes de la entrada de texto si el comando anterior tuvo éxito. | -| `error_symbol` | `"[❯](bold red)"` | La cadena de formato usada antes de la entrada de texto si el comando anterior falló. | -| `vicmd_symbol` | `"[❮](bold green)"` | El cadena de formato antes de la entrada de texto si la shell está en modo vim normal. | -| `disabled` | `false` | Desactiva el módulo `character`. | +| Opción | Por defecto | Descripción | +| ---------------- | ------------------- | ------------------------------------------------------------------------------------------------------- | +| `format` | `"$symbol "` | La cadena de formato usada antes de la entrada de texto. | +| `success_symbol` | `"[❯](bold green)"` | La cadena de formato usada antes de la entrada de texto si el comando anterior tuvo éxito. | +| `error_symbol` | `"[❯](bold red)"` | La cadena de formato usada antes de la entrada de texto si el comando anterior falló. | +| `vicmd_symbol` | `"[❮](bold green)"` | El cadena de formato antes de la entrada de texto si el intérprete de comandos está en modo vim normal. | +| `disabled` | `false` | Desactiva el módulo `character`. | ### Variables @@ -396,7 +398,7 @@ Por defecto sólo cambia el color. Si también se quiere cambiar su forma, ver [ ### Ejemplos -#### Con forma de error personalizada +#### Con formato de error personalizado ```toml # ~/.config/starship.toml @@ -406,7 +408,7 @@ success_symbol = "[➜](bold green) " error_symbol = "[✗](bold red) " ``` -#### Sin forma de error personalizada +#### Sin formato de error personalizado ```toml # ~/.config/starship.toml @@ -416,7 +418,7 @@ success_symbol = "[➜](bold green) " error_symbol = "[➜](bold red) " ``` -#### Con forma vim personalizada +#### Con formato de vim personalizado ```toml # ~/.config/starship.toml @@ -427,18 +429,19 @@ vicmd_symbol = "[V](bold green) " ## CMake -El módulo `cmake` muestra la versión actualmente instalada de CMake si: +El módulo `cmake` muestra la versión instalada de CMake si se cumple alguna de las siguientes condiciones: - El directorio actual contiene un archivo `CMakeLists.txt` +- El directorio actual contiene un archivo `CMakeCache.txt` ### Opciones | Opción | Por defecto | Descripción | | ---------- | ---------------------------------- | ---------------------------------------------- | | `format` | `"via [$symbol$version]($style) "` | El formato del módulo. | -| `symbol` | `"🛆 "` | El símbolo usado antes de la versión de cmake. | +| `symbol` | `"喝 "` | El símbolo usado antes de la versión de cmake. | | `style` | `"bold blue"` | El estilo del módulo. | -| `disabled` | `false` | Deshabilita el módulo `cmake`. | +| `disabled` | `false` | Desactiva el módulo `cmake`. | ### Variables @@ -450,27 +453,35 @@ El módulo `cmake` muestra la versión actualmente instalada de CMake si: \*: Esta variable sólo puede ser usada como parte de una cadena de estilo -## Tiempo de ejecución +## Tiempo de Ejecución -El módulo `cmd_duration` muestra cuánto tiempo tardó el último comando en ejecutarse. El módulo se mostrará solo si el comando llevó dos segundos o más, o el valor de `min_time`, si existe. +El módulo `cmd_duration` muestra cuánto tiempo tardó el último comando en ejecutarse. El módulo se mostrará solo si el comando llevó dos segundos o más, o el valor de `min_time` si existe. -::: warning No utilizar DEBUG en Bash +::: aviso No utilizar DEBUG en Bash -Si estás usando Starship con `bash`, no uses `DEBUG` después de ejecutar `eval $(starship init $0)`, o el módulo **se romperá**. +Si estás usando Starship con `Bash`, no uses `DEBUG` después de ejecutar `eval $(starship init $0)`, o el módulo **se romperá**. ::: -Los usuarios de bash que necesiten la funcionalidad preexec-like pueden usar el framework rcaloras's bash_preexec. Simplemente define los arrays preexec_functions y precmd_functions antes de ejecutar eval $(starship init $0), y continúa con normalidad. Basta con definir los arrays `preexec_functions` y `precmd_functions` antes de ejecutar `eval $(starship init $0)`, y luego proceder como siempre. +Los usuarios de bash que necesiten la funcionalidad como preexec pueden usar el [framework bash_preexec de rcaloras](https://github.com/rcaloras/bash-preexec). Basta con definir los arrays `preexec_functions` y `precmd_functions` antes de ejecutar `eval $(starship init $0)`, y luego proceder como siempre. ### Opciones -| Opción | Por defecto | Descripción | -| ------------------- | ----------------------------- | --------------------------------------------------------------------- | -| `min_time` | `2_000` | Duración mínima para mostrar el tiempo de ejecución (en milisegundos) | -| `show_milliseconds` | `false` | Muestra la duración con precisión en milisegundos. | -| `format` | `"took [$duration]($style) "` | El formato del módulo. | -| `style` | `"bold yellow"` | El estilo del módulo. | -| `disabled` | `false` | Desactiva el módulo `cmd_duration`. | +| Opción | Por defecto | Descripción | +| -------------------- | ----------------------------- | --------------------------------------------------------------------- | +| `min_time` | `2_000` | Duración mínima para mostrar el tiempo de ejecución (en milisegundos) | +| `show_milliseconds` | `false` | Muestra la duración con precisión en milisegundos. | +| `format` | `"took [$duration]($style) "` | El formato del módulo. | +| `style` | `"bold yellow"` | El estilo del módulo. | +| `disabled` | `false` | Desactiva el módulo `cmd_duration`. | +| `show_notifications` | `false` | Muestra notificaciones de escritorio cuando se complete el comando. | +| `min_time_to_notify` | `45_000` | Duración más corta para la notificación (en milisegundos). | + +::: tip + +Mostrar notificaciones de escritorio requiere que se construya starship con soporte de `rust-notify`. Comprueba si tu Starship soporta notificaciones ejecutando `STARSHIP_LOG=debug starship module cmd_duration -d 60000` cuando `show_notifications` está establecido en `true`. + +::: ### Variables @@ -493,11 +504,11 @@ format = "underwent [$duration](bold yellow)" ## Conda -El módulo `conda` muestra el actual entorno conda, si la variable `$CONDA_DEFAULT_ENV` existe. +El módulo `conda` muestra el entorno conda actual, si `$CONDA_DEFAULT_ENV` está configurado. ::: tip -Esto no modifica el propio símbolo de sistema de conda. En caso de querer suprimirlo, ejecuta `conda config --set changeps1 False`. +Esto no modifica el propio prompt de conda. En caso de querer suprimirlo, ejecuta `conda config --set changeps1 False`. ::: @@ -510,7 +521,7 @@ Esto no modifica el propio símbolo de sistema de conda. En caso de querer supri | `style` | `"bold green"` | El estilo del módulo. | | `format` | `"[$symbol$environment]($style) "` | El formato del módulo. | | `ignore_base` | `true` | Ignora el entorno `base` cuando se activa. | -| `disabled` | `false` | Deshabilita el módulo `conda`. | +| `disabled` | `false` | Desactiva el módulo `conda`. | ### Variables @@ -533,7 +544,7 @@ format = "[$symbol$environment](dimmed green) " ## Crystal -El módulo `crystal` muestra la versión actual de Crystal. El módulo se muestra si algunas de las siguientes condiciones se cumplen: +El módulo `crystal` muestra la versión actual instalada de Crystal. El módulo se muestra si algunas de las siguientes condiciones se cumplen: - El directorio actual contiene un fichero `shard.yml` - El directorio actual contiene un fichero `.cr` @@ -581,7 +592,7 @@ El módulo `dart` muestra la versión actualmente instalada de Dart. El módulo | `format` | `"via [$symbol$version]($style) "` | El formato del módulo. | | `symbol` | `"🎯 "` | Una cadena de formato que representa el símbolo de Dart | | `style` | `"bold blue"` | El estilo del módulo. | -| `disabled` | `false` | Deshabilita el módulo `dart`. | +| `disabled` | `false` | Desactiva el módulo `dart`. | ### Variables @@ -604,11 +615,11 @@ format = "via [🔰 $version](bold red) " ## Directory -El módulo `directory` muestra la ruta hasta el directorio actual, mostrando tres directorios padre como máximo. Tu directorio se truncará a la raíz del repositorio git en el que estés. +El módulo `directory` muestra la ruta hasta el directorio actual, mostrando tres directorios padre como máximo. Tu directorio se truncará a la raíz del repositorio git en el que te encuentres. -Cuando usas el estilo fish de la opción pwd, en lugar de ocultar la ruta truncada, verás una versión acortada del nombre de cada directorio basada en el número que activa la opción. +Cuando usas el estilo fish de la opción pwd, en lugar de ocultar la ruta truncada, verás una versión acortada del nombre de cada directorio basada en el número que activaste para la opción. -Por ejemplo, dado `~/Dev/Nix/nixpkgs/pkgs` donde `nixpkgs` es la raíz del repositorio y el valor de la opción es `1`. En ese caso, verás `~/D/N/nixpkgs/pkgs`, cuando antes hubiera sido `nixpkgs/pkgs`. +Por ejemplo, dado `~/Dev/Nix/nixpkgs/pkgs` donde `nixpkgs` es la raíz del repositorio y la opción establecida a `1`. Ahora verás `~/D/N/nixpkgs/pkgs`, mientras que antes habría sido `nixpkgs/pkgs`. ### Opciones @@ -618,21 +629,21 @@ Por ejemplo, dado `~/Dev/Nix/nixpkgs/pkgs` donde `nixpkgs` es la raíz del repos | `truncate_to_repo` | `true` | Truncar o no hasta la raíz del repositorio git en el que se esté. | | `format` | `"[$path]($style)[$read_only]($read_only_style) "` | El formato del módulo. | | `style` | `"bold cyan"` | El estilo del módulo. | -| `disabled` | `false` | Deshabilita el módulo `directory`. | +| `disabled` | `false` | Desactiva el módulo `directory`. | | `read_only` | `"🔒"` | El símbolo que indica si el directorio actual es de sólo lectura. | | `read_only_style` | `"red"` | El estilo para el símbolo de sólo lectura. | -| `truncation_symbol` | `""` | The symbol to prefix to truncated paths. eg: "…/" | +| `truncation_symbol` | `""` | El símbolo a prefijar a las rutas truncadas. ej: "…/" |
Este módulo tiene algunas opciones avanzadas de configuración que controlan cómo se muestra el directorio. -| Advanced Option | Por defecto | Descripción | -| --------------------------- | ----------- | ---------------------------------------------------------------------------------------- | -| `substitutions` | | A table of substitutions to be made to the path. | -| `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. | -| `use_logical_path` | `true` | Displays the logical path provided by the shell (`PWD`) instead of the path from the OS. | +| Opciones avanzadas | Por defecto | Descripción | +| --------------------------- | ----------- | --------------------------------------------------------------------------------------------------------------------- | +| `substitutions` | | Una tabla de sustituciones que se deben hacer a la ruta. | +| `fish_style_pwd_dir_length` | `0` | El número de caracteres a usar al aplicar la lógica de ruta pwd de la shell de fish. | +| `use_logical_path` | `true` | Muestra la ruta lógica proporcionada por el intérprete de comandos (`PWD`) en lugar de la ruta del sistema operativo. | -`substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD. +`substitutions` permite definir reemplazos arbitrarios para cadenas literales que ocurren en la ruta, por ejemplo prefijos largos de red o directorios de desarrollo (p. ej. Java). Ten en cuenta que esto desactivará el estilo PWD de fish. ```toml [directory.substitutions] @@ -640,7 +651,7 @@ Por ejemplo, dado `~/Dev/Nix/nixpkgs/pkgs` donde `nixpkgs` es la raíz del repos "src/com/long/java/path" = "mypath" ``` -`fish_style_pwd_dir_length` interacts with the standard truncation options in a way that can be surprising at first: if it's non-zero, the components of the path that would normally be truncated are instead displayed with that many characters. For example, the path `/built/this/city/on/rock/and/roll`, which would normally be displayed as as `rock/and/roll`, would be displayed as `/b/t/c/o/rock/and/roll` with `fish_style_pwd_dir_length = 1`--the path components that would normally be removed are displayed with a single character. For `fish_style_pwd_dir_length = 2`, it would be `/bu/th/ci/on/rock/and/roll`. +`fish_style_pwd_dir_length` interactúa con las opciones de truncamiento estándar de una manera que puede sorprenderse primero: si no es cero, los componentes de la ruta que normalmente se truncarían se muestran con esa cantidad de caracteres. Por ejemplo, la ruta `/built/this/city/on/rock/and/roll`, que normalmente se mostraría como `rock/and/roll`, se mostraría como `/b/t/c/o/rock/and/roll` con `fish_style_pwd_dir_length = 1`--los componentes de ruta que normalmente se eliminarían se muestran con un solo carácter. Para `fish_style_pwd_dir_length = 2`, sería `/bu/th/ci/on/rock/and/roll`.
@@ -665,7 +676,7 @@ truncation_symbol = "…/" ## Docker Context -El módulo `docker_context` muestra el [Docker context](https://docs.docker.com/engine/context/working-with-contexts/) activo si no está a `default`. +El módulo `docker_context` muestra el [contexto de Docker](https://docs.docker.com/engine/context/working-with-contexts/) actualmente activo si no está establecido en `default`. ### Opciones @@ -675,7 +686,7 @@ El módulo `docker_context` muestra el [Docker context](https://docs.docker.com/ | `symbol` | `"🐳 "` | El símbolo usado antes de mostrar el contexto de Docker. | | `style` | `"blue bold"` | El estilo del módulo. | | `only_with_files` | `false` | Mostrar solo cuando hay un `docker-compose.yml` o `Dockerfile` en el directorio actual. | -| `disabled` | `true` | Deshabilita el módulo `docker_context`. | +| `disabled` | `true` | Desactiva el módulo `docker_context`. | ### Variables @@ -698,23 +709,23 @@ format = "via [🐋 $context](blue bold)" ## Dotnet -El módulo `dotnet` muestra la versión usada de .NET Core SDK para el directorio actual. Si el SDK ha sido anclado en el directorio actual, se mostrará la versión fijada. De lo contrario, el módulo muestra la última versión instalada del SDK. +El módulo `dotnet` muestra la versión relevante de .NET Core SDK para el directorio actual. Si el SDK ha sido anclado en el directorio actual, se mostrará la versión fijada. De lo contrario, el módulo muestra la última versión instalada del SDK. -Este módulo solo se mostrará en tu mensaje cuando uno o más de los siguientes archivos estén presentes en el directorio actual: +Este módulo solo se mostrará en tu prompt cuando uno o más de los siguientes archivos estén presentes en el directorio actual: - `global.json` - `project.json` -- `Directoria.Build.props` -- `Directorio.Build.targets` +- `Directory.Build.props` +- `Directory.Build.targets` - `Packages.props` - `*.sln` - `*.csproj` - `*.fsproj` - `*.xproj` -También necesitará tener instalado .NET Core SDK para poder usarlo correctamente. +También necesitarás tener instalado .NET Core SDK para poder usarlo correctamente. -Internamente, este módulo utiliza su propio mecanismo para la detección de versiones. Normalmente es el doble de rápido que ejecutar `dotnet --version`, pero puede mostrar una versión incorrecta si tu proyecto .NET tiene un diseño de directorio inusual. Si la precisión es más importante que la velocidad, puede desactivar el mecanismo estableciendo `heuristic = false` en las opciones del módulo. +Internamente, este módulo utiliza su propio mecanismo para la detección de versiones. Normalmente es el doble de rápido que ejecutar `dotnet --version`, pero puede mostrar una versión incorrecta si tu proyecto .NET tiene un diseño de directorio inusual. Si la precisión es más importante que la velocidad, puede desactivar el mecanismo estableciendo `heurístico = false` en las opciones del módulo. El módulo también mostrará el Target Framework Moniker ([https://docs.microsoft. om/es/dotnet/standard/frameworks#supported-target-framework-versions](https://docs.microsoft.com/en-us/dotnet/standard/frameworks#supported-target-framework-versions)) cuando exista un archivo csproj en el directorio actual. @@ -726,7 +737,7 @@ El módulo también mostrará el Target Framework Moniker ([https://docs.microso | `symbol` | `"•NET "` | El símbolo usado antes de mostrar la version de dotnet. | | `heuristic` | `true` | Usa una detección de versiones más rápida para mantener a starship veloz. | | `style` | `"bold blue"` | El estilo del módulo. | -| `disabled` | `false` | Deshabilita el módulo `dotnet`. | +| `disabled` | `false` | Desactiva el módulo `dotnet`. | ### Variables @@ -763,7 +774,7 @@ El módulo `elixir` muestra la version instalada actualmente de Elixir y Erlang/ | `symbol` | `"💧 "` | El símbolo usado antes de mostrar la version de Elixir/Erlang. | | `style` | `"bold purple"` | El estilo del módulo. | | `format` | `'via [$symbol$version \(OTP $otp_version\)]($style) '` | El formato para el módulo elixir. | -| `disabled` | `false` | Deshabilita el módulo `elixir`. | +| `disabled` | `false` | Desactiva el módulo `elixir`. | ### Variables @@ -787,28 +798,28 @@ symbol = "🔮 " ## Elm -The `elm` module shows the currently installed version of Elm. El módulo se muestra si algunas de las siguientes condiciones se cumplen: +El módulo `elm` muestra la versión actualmente instalada de Elm. El módulo se muestra si algunas de las siguientes condiciones se cumplen: - El directorio actual contiene un fichero `elm.json` - El directorio actual contiene un fichero `elm-package.json` -- The current directory contains a `.elm-version` file -- The current directory contains a `elm-stuff` folder -- The current directory contains a `*.elm` files +- El directorio actual contiene un archivo `.elm-version` +- El directorio actual contiene una carpeta `elm-stuff` +- El directorio actual contiene archivos `*.elm` ### Opciones -| Opción | Por defecto | Descripción | -| ---------- | ---------------------------------- | ----------------------------------------------- | -| `format` | `"via [$symbol$version]($style) "` | El formato del módulo. | -| `symbol` | `"🌳 "` | A format string representing the symbol of Elm. | -| `style` | `"cyan bold"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `elm` module. | +| Opción | Por defecto | Descripción | +| ---------- | ---------------------------------- | ------------------------------------------------------- | +| `format` | `"via [$symbol$version]($style) "` | El formato del módulo. | +| `symbol` | `"🌳 "` | Una cadena de formato que representa el símbolo de Elm. | +| `style` | `"cyan bold"` | El estilo del módulo. | +| `disabled` | `false` | Desactiva el módulo `elm`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | --------- | -------------------------------------- | -| version | `v0.19.1` | The version of `elm` | +| version | `v0.19.1` | La versión de `elm` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -825,28 +836,28 @@ format = "via [ $version](cyan bold) " ## Variable de entorno -The `env_var` module displays the current value of a selected environment variable. The module will be shown only if any of the following conditions are met: +El módulo `env_var` muestra el valor actual de una variable de entorno seleccionada. El módulo se mostrará sólo si se cumplen cualquiera de las siguientes condiciones: -- The `variable` configuration option matches an existing environment variable -- The `variable` configuration option is not defined, but the `default` configuration option is +- La opción de configuración de `variable` coincide con una variable de entorno existente +- La opción de configuración de `variable` no está definida, pero la opción de configuración `predeterminada` se encuentra ### Opciones -| Opción | Por defecto | Descripción | -| ------------- | ------------------------------ | ---------------------------------------------------------------------------- | -| `symbol` | | The symbol used before displaying the variable value. | -| `variable` | | The environment variable to be displayed. | -| `por defecto` | | The default value to be displayed when the selected variable is not defined. | -| `format` | `"with [$env_value]($style) "` | El formato del módulo. | -| `disabled` | `false` | Disables the `env_var` module. | +| Opción | Por defecto | Descripción | +| ------------- | ------------------------------ | -------------------------------------------------------------------------------------- | +| `symbol` | | El símbolo usado antes de mostrar el valor de la variable. | +| `variable` | | La variable de entorno a mostrar. | +| `por defecto` | | El valor por defecto que se mostrará cuando la variable seleccionada no está definida. | +| `format` | `"with [$env_value]($style) "` | El formato del módulo. | +| `disabled` | `false` | Desactiva el módulo `env_var`. | ### Variables -| Variable | Ejemplo | Descripción | -| --------- | ------------------------------------------- | ------------------------------------------ | -| env_value | `Windows NT` (if _variable_ would be `$OS`) | The environment value of option `variable` | -| symbol | | Refleja el valor de la opción `symbol` | -| style\* | `black bold dimmed` | Refleja el valor de la opción `style` | +| Variable | Ejemplo | Descripción | +| --------- | ------------------------------------- | ------------------------------------------- | +| env_value | `Windows NT` (si _variable_ es `$OS`) | El valor de entorno de la opción `variable` | +| symbol | | Refleja el valor de la opción `symbol` | +| style\* | `black bold dimmed` | Refleja el valor de la opción `style` | \*: Esta variable sólo puede ser usada como parte de una cadena de estilo @@ -862,25 +873,25 @@ default = "unknown shell" ## Erlang -The `erlang` module shows the currently installed version of Erlang/OTP. El módulo se muestra si algunas de las siguientes condiciones se cumplen: +El módulo `erlang` muestra la versión instalada de Erlang/OTP. El módulo se muestra si algunas de las siguientes condiciones se cumplen: - El directorio actual contiene un fichero `rebar.config`. - El directorio actual contiene un fichero `erlang.mk`. ### Opciones -| Opción | Por defecto | Descripción | -| ---------- | ---------------------------------- | -------------------------------------------------------- | -| `symbol` | `"🖧 "` | The symbol used before displaying the version of erlang. | -| `style` | `"bold red"` | El estilo del módulo. | -| `format` | `"via [$symbol$version]($style) "` | El formato del módulo. | -| `disabled` | `false` | Disables the `erlang` module. | +| Opción | Por defecto | Descripción | +| ---------- | ---------------------------------- | ------------------------------------------------------- | +| `symbol` | `" "` | El símbolo usado antes de mostrar la versión de Erlang. | +| `style` | `"bold red"` | El estilo del módulo. | +| `format` | `"via [$symbol$version]($style) "` | El formato del módulo. | +| `disabled` | `false` | Desactiva el módulo `erlang`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | --------- | -------------------------------------- | -| version | `v22.1.3` | The version of `erlang` | +| version | `v22.1.3` | La versión de `erlang` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -897,34 +908,34 @@ format = "via [e $version](bold red) " ## Gcloud -The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var. +El módulo `gcloud` muestra la configuración actual para el CLI de [`gcloud`](https://cloud.google.com/sdk/gcloud). Esto se basa en el archivo `~/.config/gcloud/active_config`, el archivo `~/.config/gcloud/configurations/config_{CONFIG NAME}` y la varieble de entorno `CLOUDSDK_CONFIG`. ### Opciones -| Opción | Por defecto | Descripción | -| ---------------- | ------------------------------------------------ | --------------------------------------------------------------- | -| `format` | `'on [$symbol$account(\($region\))]($style) '` | El formato del módulo. | -| `symbol` | `"☁️ "` | The symbol used before displaying the current GCP profile. | -| `region_aliases` | | Table of region aliases to display in addition to the GCP name. | -| `style` | `"bold blue"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `gcloud` module. | +| Opción | Por defecto | Descripción | +| ---------------- | ------------------------------------------------ | ---------------------------------------------------------- | +| `format` | `'on [$symbol$account(\($region\))]($style) '` | El formato del módulo. | +| `symbol` | `"☁️ "` | El símbolo usado antes de mostrar el perfil actual de GCP. | +| `region_aliases` | | Tabla de alias de región a mostrar además del nombre GCP. | +| `style` | `"bold blue"` | El estilo del módulo. | +| `disabled` | `false` | Desactiva el módulo `gcloud`. | ### Variables -| Variable | Ejemplo | Descripción | -| --------- | ----------------- | ------------------------------------------------------------------ | -| region | `us-central1` | The current GCP region | -| account | `foo@example.com` | The current GCP profile | -| project | | The current GCP project | -| active | `por defecto` | The active config name written in `~/.config/gcloud/active_config` | -| symbol | | Refleja el valor de la opción `symbol` | -| style\* | | Refleja el valor de la opción `style` | +| Variable | Ejemplo | Descripción | +| --------- | ----------------- | ----------------------------------------------------------------------------- | +| region | `us-central1` | La región GCP actual | +| account | `foo@example.com` | El perfil actual de GCP | +| project | | El proyecto GCP actual | +| active | `por defecto` | El nombre de configuración activo escrito en `~/.config/gcloud/active_config` | +| symbol | | Refleja el valor de la opción `symbol` | +| style\* | | Refleja el valor de la opción `style` | \*: Esta variable sólo puede ser usada como parte de una cadena de estilo ### Ejemplos -#### Display account and project +#### Mostrar cuenta y proyecto ```toml # ~/.config/starship.toml @@ -933,7 +944,7 @@ The `gcloud` module shows the current configuration for [`gcloud`](https://cloud format = 'on [$symbol$account(\($project\))]($style) ' ``` -#### Display active config name only +#### Mostrar solo el nombre de la configuración activa ```toml # ~/.config/starship.toml @@ -943,7 +954,7 @@ format = "[$symbol$active]($style) " style = "bold yellow" ``` -#### Display account and aliased region +#### Mostrar los alias de cuenta y región ```toml # ~/.config/starship.toml @@ -957,26 +968,29 @@ asia-northeast1 = "an1" ## Git Branch -The `git_branch` module shows the active branch of the repo in your current directory. +El módulo `git_branch` muestra la rama activa del repositorio en su directorio actual. ### Opciones -| Opción | Por defecto | Descripción | -| ------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | -| `format` | `"on [$symbol$branch]($style) "` | El formato del módulo. Use `"$branch"` to refer to the current branch name. | -| `symbol` | `" "` | A format string representing the symbol of git branch. | -| `style` | `"bold purple"` | El estilo del módulo. | -| `truncation_length` | `2^63 - 1` | Truncates a git branch to X graphemes. | -| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. | -| `disabled` | `false` | Disables the `git_branch` module. | +| Opción | Por defecto | Descripción | +| -------------------- | -------------------------------- | ------------------------------------------------------------------------------------------------- | +| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | +| `format` | `"on [$symbol$branch]($style) "` | El formato del módulo. Use `"$branch"` to refer to the current branch name. | +| `symbol` | `" "` | A format string representing the symbol of git branch. | +| `style` | `"bold purple"` | El estilo del módulo. | +| `truncation_length` | `2^63 - 1` | Truncates a git branch to X graphemes. | +| `truncation_symbol` | `"…"` | El símbolo usado para indicar que un nombre de rama fue truncado. 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 -| Variable | Ejemplo | Descripción | -| --------- | -------- | ---------------------------------------------------------------------------------------------------- | -| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached HEAD). | -| symbol | | Refleja el valor de la opción `symbol` | -| style\* | | Refleja el valor de la opción `style` | +| Variable | Ejemplo | Descripción | +| --------- | -------- | ------------------------------------------------------------------------------------------------------------- | +| branch | `master` | El nombre de la rama actual, regresa a `HEAD` si no hay ninguna rama actual (por ejemplo, git detached HEAD). | +| remote | `master` | The remote branch name. | +| symbol | | Refleja el valor de la opción `symbol` | +| style\* | | Refleja el valor de la opción `style` | \*: Esta variable sólo puede ser usada como parte de una cadena de estilo @@ -993,23 +1007,25 @@ truncation_symbol = "" ## Git commit -The `git_commit` module shows the current commit hash of the repo in your current directory. +El módulo `git_commit` muestra el hash de commit actual y también la etiqueta (si existe) del repositorio en su directorio actual. ### Opciones -| Opción | Por defecto | Descripción | -| -------------------- | -------------------------- | ----------------------------------------------------- | -| `commit_hash_length` | `7` | The length of the displayed git commit hash. | -| `format` | `'[\($hash\)]($style) '` | El formato del módulo. | -| `style` | `"bold green"` | El estilo del módulo. | -| `only_detached` | `true` | Only show git commit hash when in detached HEAD state | -| `disabled` | `false` | Disables the `git_commit` module. | +| Opción | Por defecto | Descripción | +| -------------------- | ------------------------------------------------------ | ---------------------------------------------------------------------------- | +| `commit_hash_length` | `7` | La longitud del hash del commit de git mostrado. | +| `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | El formato del módulo. | +| `style` | `"bold green"` | El estilo del módulo. | +| `only_detached` | `true` | Mostrar solo el hash del commit de git cuando esté en estado "detached HEAD" | +| `tag_disabled` | `true` | Deshabilita mostrar información de etiquetas en el módulo `git_commit`. | +| `tag_symbol` | `"🏷 "` | Símbolo de etiqueta prefijando la información mostrada | +| `disabled` | `false` | Desactiva el módulo `git_commit`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | --------- | ------------------------------------- | -| hash | `b703eb3` | The current git commit hash | +| hash | `b703eb3` | El hash actual del commit de git | | style\* | | Refleja el valor de la opción `style` | \*: Esta variable sólo puede ser usada como parte de una cadena de estilo @@ -1021,34 +1037,35 @@ The `git_commit` module shows the current commit hash of the repo in your curren [git_commit] commit_hash_length = 4 +tag_symbol = "🔖 " ``` ## Git state -The `git_state` module will show in directories which are part of a git repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. If there is progress information (e.g., REBASING 3/10), that information will be shown too. +El módulo `git_state` se mostrará en directorios que son parte de un repositorio git, y donde hay una operación en curso, tales como: _REBASING_, _BISECTING_, etc. Si hay información de progreso (por ejemplo, REBASING 3/10), esa información será mostrada también. ### Opciones -| Opción | Por defecto | Descripción | -| -------------- | --------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `rebase` | `"REBASING"` | A format string displayed when a `rebase` is in progress. | -| `merge` | `"MERGING"` | A format string displayed when a `merge` is in progress. | -| `revert` | `"REVERTING"` | A format string displayed when a `revert` is in progress. | -| `cherry_pick` | `"CHERRY-PICKING"` | A format string displayed when a `cherry-pick` is in progress. | -| `bisect` | `"BISECTING"` | A format string displayed when a `bisect` is in progress. | -| `am` | `"AM"` | A format string displayed when an `apply-mailbox` (`git am`) is in progress. | -| `am_or_rebase` | `"AM/REBASE"` | A format string displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. | -| `style` | `"bold yellow"` | El estilo del módulo. | -| `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | El formato del módulo. | -| `disabled` | `false` | Disables the `git_state` module. | +| Opción | Por defecto | Descripción | +| -------------- | --------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | +| `rebase` | `"REBASING"` | Una cadena de formato que se muestra cuando un `rebase` está en progreso. | +| `merge` | `"MERGING"` | Una cadena de formato que se muestra cuando un `merge` está en progreso. | +| `revert` | `"REVERTING"` | Una cadena de formato mostrada cuando un `revert` está en progreso. | +| `cherry_pick` | `"CHERRY-PICKING"` | Una cadena de formato que se muestra cuando un `cherry-pick` está en progreso. | +| `bisect` | `"BISECTING"` | Una cadena de formato que se muestra cuando un `bisect` está en progreso. | +| `am` | `"AM"` | Una cadena de formato que se muestra cuando un `apply-mailbox` (`git am`) está en progeso. | +| `am_or_rebase` | `"AM/REBASE"` | Una cadena de formato que se muestra cuando un ambiguo `apply-builbox` o `rebase` está en progreso. | +| `style` | `"bold yellow"` | El estilo del módulo. | +| `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | El formato del módulo. | +| `disabled` | `false` | Desactiva el módulo `git_state`. | ### Variables | Variable | Ejemplo | Descripción | | ---------------- | ---------- | ------------------------------------- | -| state | `REBASING` | The current state of the repo | -| progress_current | `1` | The current operation progress | -| progress_total | `2` | The total operation progress | +| state | `REBASING` | El estado actual del repositorio | +| progress_current | `1` | El progreso de la operación actual | +| progress_total | `2` | El progreso total de la operación | | style\* | | Refleja el valor de la opción `style` | \*: Esta variable sólo puede ser usada como parte de una cadena de estilo @@ -1065,57 +1082,57 @@ cherry_pick = "[🍒 PICKING](bold red)" ## Git status -The `git_status` module shows symbols representing the state of the repo in your current directory. +El módulo `git_status` muestra símbolos que representan el estado del repositorio en su directorio actual. ### Opciones -| Opción | Por defecto | Descripción | -| ------------ | ----------------------------------------------- | ----------------------------------- | -| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | The default format for `git_status` | -| `conflicted` | `"="` | This branch has merge conflicts. | -| `ahead` | `"⇡"` | The format of `ahead` | -| `behind` | `"⇣"` | The format of `behind` | -| `diverged` | `"⇕"` | The format of `diverged` | -| `untracked` | `"?"` | The format of `untracked` | -| `stashed` | `"$"` | The format of `stashed` | -| `modified` | `"!"` | The format of `modified` | -| `staged` | `"+"` | The format of `staged` | -| `renamed` | `"»"` | The format of `renamed` | -| `deleted` | `"✘"` | The format of `deleted` | -| `style` | `"bold red"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `git_status` module. | +| Opción | Por defecto | Descripción | +| ------------ | ----------------------------------------------- | ---------------------------------------- | +| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | El formato por defecto para `git_status` | +| `conflicted` | `"="` | Esta rama tiene conflictos de fusión. | +| `ahead` | `"⇡"` | El formato de `ahead` | +| `behind` | `"⇣"` | El formato de `behind` | +| `diverged` | `"⇕"` | El formato de `diverged` | +| `untracked` | `"?"` | El formato de `untracked` | +| `stashed` | `"$"` | El formato de `stashed` | +| `modified` | `"!"` | El formato de `modified` | +| `staged` | `"+"` | El formato de `staged` | +| `renamed` | `"»"` | El formato de `renamed` | +| `deleted` | `"✘"` | El formato de `deleted` | +| `style` | `"bold red"` | El estilo del módulo. | +| `disabled` | `false` | Desactiva el módulo `git_status`. | ### Variables -The following variables can be used in `format`: +Las siguientes variables se pueden utilizar en `format`: -| Variable | Descripción | -| -------------- | --------------------------------------------------------------------------------------------- | -| `all_status` | Shortcut for`$conflicted$stashed$deleted$renamed$modified$staged$untracked` | -| `ahead_behind` | Displays `diverged` `ahead` or `behind` format string based on the current status of the repo | -| `conflicted` | Displays `conflicted` when this branch has merge conflicts. | -| `untracked` | Displays `untracked` when there are untracked files in the working directory. | -| `stashed` | Displays `stashed` when a stash exists for the local repository. | -| `modified` | Displays `modified` when there are file modifications in the working directory. | -| `staged` | Displays `staged` when a new file has been added to the staging area. | -| `renamed` | Displays `renamed` when a renamed file has been added to the staging area. | -| `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. | -| style\* | Refleja el valor de la opción `style` | +| Variable | Descripción | +| -------------- | -------------------------------------------------------------------------------------------------------- | +| `all_status` | Atajo para `$conflicted$stashed$deleted$renamed$modified$staged$untracked` | +| `ahead_behind` | Muestra la cadena de formato de `diverged` `ahead` o `behind` basado en el estado actual del repositorio | +| `conflicted` | Muestra `conflicted` cuando esta rama tiene conflictos de fusión. | +| `untracked` | Muestra `untracked` cuando hay archivos sin rastrear en el directorio de trabajo. | +| `stashed` | Muestra `stashed` cuando existe un "stash" para el repositorio local. | +| `modified` | Muestra `modified` cuando hay modificaciones de archivo en el directorio de trabajo. | +| `staged` | Muestra `staged` cuando se ha añadido un nuevo archivo al área de "stash". | +| `renamed` | Muestra `renamed` cuando un archivo renombrado ha sido añadido al área de "stash". | +| `deleted` | Muestra `deleted` cuando un archivo ha sido añadido al área de "stash". | +| style\* | Refleja el valor de la opción `style` | \*: Esta variable sólo puede ser usada como parte de una cadena de estilo -The following variables can be used in `diverged`: +Las siguientes variables pueden ser usadas en `diverged`: -| Variable | Descripción | -| -------------- | ---------------------------------------------- | -| `ahead_count` | Number of commits ahead of the tracking branch | -| `behind_count` | Number of commits behind the tracking branch | +| Variable | Descripción | +| -------------- | ------------------------------------------------------- | +| `ahead_count` | Número de commits por delante de la rama de seguimiento | +| `behind_count` | Número de commits detrás de la rama de seguimiento | -The following variables can be used in `conflicted`, `ahead`, `behind`, `untracked`, `stashed`, `modified`, `staged`, `renamed` and `deleted`: +Las siguientes variales pueden ser usadas en `conflicted`, `ahead`, `behind`, `untracked`, `stashed`, `modified`, `staged`, `renamed` and `deleted`: -| Variable | Descripción | -| -------- | ------------------------ | -| `count` | Show the number of files | +| Variable | Descripción | +| -------- | ----------------------------- | +| `count` | Muestra el número de archivos | ### Ejemplo @@ -1135,7 +1152,7 @@ renamed = "👅" deleted = "🗑" ``` -Show ahead/behind count of the branch being tracked +Mostrar el recuento delante/detrás de la rama que está siendo rastreada ```toml # ~/.config/starship.toml @@ -1148,31 +1165,31 @@ behind = "⇣${count}" ## Golang -The `golang` module shows the currently installed version of Golang. El módulo se muestra si algunas de las siguientes condiciones se cumplen: +El módulo `golang` muestra la versión actualmente instalada de Golang. El módulo se muestra si algunas de las siguientes condiciones se cumplen: - El directorio actual contiene un fichero `go.mod` - El directorio actual contiene un fichero `go.sum` - El directorio actual contiene un fichero `glide.yaml` -- The current directory contains a `Gopkg.yml` file -- The current directory contains a `Gopkg.lock` file -- The current directory contains a `.go-version` file -- The current directory contains a `Godeps` directory -- The current directory contains a file with the `.go` extension +- El directorio actual contiene un archivo `Gopkg.yml` +- El directorio actual contiene un archivo `Gopkg.lock` +- El directorio actual contiene un archivo `.go-version` +- El directorio actual contiene un directorio `Godeps` +- El directorio actual contiene un archivo con la extensión `.go` ### Opciones -| Opción | Por defecto | Descripción | -| ---------- | ---------------------------------- | ---------------------------------------------- | -| `format` | `"via [$symbol$version]($style) "` | El formato del módulo. | -| `symbol` | `"🐹 "` | A format string representing the symbol of Go. | -| `style` | `"bold cyan"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `golang` module. | +| Opción | Por defecto | Descripción | +| ---------- | ---------------------------------- | ------------------------------------------------------ | +| `format` | `"via [$symbol$version]($style) "` | El formato del módulo. | +| `symbol` | `"🐹 "` | Una cadena de formato que representa el símbolo de Go. | +| `style` | `"bold cyan"` | El estilo del módulo. | +| `disabled` | `false` | Desactiva el módulo de `golang`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | --------- | -------------------------------------- | -| version | `v1.12.1` | The version of `go` | +| version | `v1.12.1` | La versión de `go` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -1189,25 +1206,25 @@ format = "via [🏎💨 $version](bold cyan) " ## Helm -The `helm` module shows the currently installed version of Helm. El módulo se muestra si algunas de las siguientes condiciones se cumplen: +El módulo `helm` muestra la versión instalada de Helm. El módulo se muestra si algunas de las siguientes condiciones se cumplen: - El directorio actual contiene un fichero `helmfile.yaml` -- The current directory contains a `Chart.yaml` file +- El directorio actual contiene un archivo `Chart.yaml` ### Opciones -| Opción | Por defecto | Descripción | -| ---------- | ---------------------------------- | ------------------------------------------------ | -| `format` | `"via [$symbol$version]($style) "` | El formato del módulo. | -| `symbol` | `"⎈ "` | A format string representing the symbol of Helm. | -| `style` | `"bold white"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `helm` module. | +| Opción | Por defecto | Descripción | +| ---------- | ---------------------------------- | -------------------------------------------------------- | +| `format` | `"via [$symbol$version]($style) "` | El formato del módulo. | +| `symbol` | `"⎈ "` | Una cadena de formato que representa el símbolo de Helm. | +| `style` | `"bold white"` | El estilo del módulo. | +| `disabled` | `false` | Desactiva el módulo `helm`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `v3.1.1` | The version of `helm` | +| version | `v3.1.1` | La versión de `helm` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -1224,17 +1241,17 @@ format = "via [⎈ $version](bold white) " ## Hostname -The `hostname` module shows the system hostname. +El módulo `hostname` muestra el nombre de host del sistema. ### Opciones -| Opción | Por defecto | Descripción | -| ---------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | -| `ssh_only` | `true` | Only show hostname when connected to an SSH session. | -| `trim_at` | `"."` | String that the hostname is cut off at, after the first match. `"."` will stop after the first dot. `""` will disable any truncation | -| `format` | `"[$hostname]($style) in "` | El formato del módulo. | -| `style` | `"bold dimmed green"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `hostname` module. | +| Opción | Por defecto | Descripción | +| ---------- | --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `ssh_only` | `true` | Mostrar sólo el nombre de host cuando esté conectado a una sesión SSH. | +| `trim_at` | `"."` | Cadena en la que el nombre de host se corta, después de la primera partida. `"."` se detendrá después del primer punto. `""` deshabilitará cualquier truncamiento | +| `format` | `"[$hostname]($style) in "` | El formato del módulo. | +| `style` | `"bold dimmed green"` | El estilo del módulo. | +| `disabled` | `false` | Desactiva el módulo `hostname`. | ### Variables @@ -1259,25 +1276,25 @@ disabled = false ## Java -The `java` module shows the currently installed version of Java. El módulo se muestra si algunas de las siguientes condiciones se cumplen: +El módulo `java` muestra la versión actualmente instalada de Java. El módulo se muestra si algunas de las siguientes condiciones se cumplen: -- 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 +- El directorio actual contiene un archivo `pom.xml`, `build.gradle.kts`, `build.sbt` o `.java-version` +- El directorio actual contiene un archivo con la extensión `.java`, `.class`, `.gradle` o `.jar` ### Opciones -| Opción | Por defecto | Descripción | -| ---------- | -------------------------------------- | ----------------------------------------------- | -| `format` | `"via [${symbol}${version}]($style) "` | El formato del módulo. | -| `symbol` | `"☕ "` | A format string representing the symbol of Java | -| `style` | `"red dimmed"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `java` module. | +| Opción | Por defecto | Descripción | +| ---------- | -------------------------------------- | ------------------------------------------------------- | +| `format` | `"via [${symbol}${version}]($style) "` | El formato del módulo. | +| `symbol` | `"☕ "` | Una cadena de formato que representa el símbolo de Java | +| `style` | `"red dimmed"` | El estilo del módulo. | +| `disabled` | `false` | Desactiva el módulo `java`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | ------- | -------------------------------------- | -| version | `v14` | The version of `java` | +| version | `v14` | La versión de `java` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -1294,23 +1311,23 @@ symbol = "🌟 " ## Jobs -The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. +El módulo `jobs` muestra el número actual de tareas en ejecución. El módulo se mostrará sólo si hay tareas en segundo plano ejecutándose. El módulo mostrará el número de tareas en ejecución si hay más de 1 tarea o más que el valor configurado de `threshold`, si existe. ### Opciones -| Opción | Por defecto | Descripción | -| ----------- | ----------------------------- | ------------------------------------------------ | -| `threshold` | `1` | Show number of jobs if exceeded. | -| `format` | `"[$symbol$number]($style) "` | El formato del módulo. | -| `symbol` | `"✦"` | A format string representing the number of jobs. | -| `style` | `"bold blue"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `jobs` module. | +| Opción | Por defecto | Descripción | +| ----------- | ----------------------------- | --------------------------------------------------------- | +| `threshold` | `1` | Muestra el número de tareas si se exceden. | +| `format` | `"[$symbol$number]($style) "` | El formato del módulo. | +| `symbol` | `"✦"` | Una cadena de formato que representa el número de tareas. | +| `style` | `"bold blue"` | El estilo del módulo. | +| `disabled` | `false` | Desactiva el módulo `jobs`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | ------- | -------------------------------------- | -| number | `1` | The number of jobs | +| number | `1` | El número de tareas | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -1328,26 +1345,26 @@ threshold = 4 ## Julia -The `julia` module shows the currently installed version of Julia. El módulo se muestra si algunas de las siguientes condiciones se cumplen: +El módulo `Julia` muestra la versión actualmente instalada de Julia. El módulo se muestra si algunas de las siguientes condiciones se cumplen: -- The current directory contains a `Project.toml` file -- The current directory contains a `Manifest.toml` file -- The current directory contains a file with the `.jl` extension +- El directorio actual contiene un archivo `Project.toml` +- El directorio actual contiene un archivo `Manifest.toml` +- El directorio actual contiene un archivo con la extensión `.jl` ### Opciones -| Opción | Por defecto | Descripción | -| ---------- | ---------------------------------- | ------------------------------------------------- | -| `format` | `"via [$symbol$version]($style) "` | El formato del módulo. | -| `symbol` | `"ஃ "` | A format string representing the symbol of Julia. | -| `style` | `"bold purple"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `julia` module. | +| Opción | Por defecto | Descripción | +| ---------- | ---------------------------------- | --------------------------------------------------------- | +| `format` | `"via [$symbol$version]($style) "` | El formato del módulo. | +| `symbol` | `"ஃ "` | Una cadena de formato que representa el símbolo de Julia. | +| `style` | `"bold purple"` | El estilo del módulo. | +| `disabled` | `false` | Desactiva el módulo `julia`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `v1.4.0` | The version of `julia` | +| version | `v1.4.0` | La versión de `julia` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -1364,32 +1381,32 @@ symbol = "∴ " ## Kubernetes -Displays the current Kubernetes context name and, if set, the namespace from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via `kubectl config set-context starship-cluster --namespace astronaut`. If the `$KUBECONFIG` env var is set the module will use that if not it will use the `~/.kube/config`. +Muestra el nombre del contexto actual de Kubernetes y, si se establece, el espacio de nombres del archivo kubeconfig. El espacio de nombres necesita establecerse en el archivo kubeconfig, esto puede hacerse mediante `kubectl config set-context starship-cluster --namespace astronaut`. Si se establece la variable de entorno `$KUBECONFIG`, el módulo usará eso si no usará el `~/.kube/config`. ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` a `false` en tu archivo de configuración. ::: ### Opciones -| Opción | Por defecto | Descripción | -| ----------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | -| `symbol` | `"☸ "` | A format string representing the symbol displayed before the Cluster. | -| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | El formato del módulo. | -| `style` | `"cyan bold"` | El estilo del módulo. | -| `context_aliases` | | Table of context aliases to display. | -| `disabled` | `true` | Disables the `kubernetes` module. | +| Opción | Por defecto | Descripción | +| ----------------- | ---------------------------------------------------- | --------------------------------------------------------------------------- | +| `symbol` | `"☸ "` | Una cadena de formato que representa el símbolo mostrado antes del Cluster. | +| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | El formato del módulo. | +| `style` | `"cyan bold"` | El estilo del módulo. | +| `context_aliases` | | Tabla de alias de contexto a mostrar. | +| `disabled` | `true` | Desactiva el módulo `kubernetes`. | ### Variables -| Variable | Ejemplo | Descripción | -| --------- | -------------------- | ---------------------------------------- | -| context | `starship-cluster` | The current kubernetes context | -| namespace | `starship-namespace` | If set, the current kubernetes namespace | -| symbol | | Refleja el valor de la opción `symbol` | -| style\* | | Refleja el valor de la opción `style` | +| Variable | Ejemplo | Descripción | +| --------- | -------------------- | ----------------------------------------------------------- | +| context | `starship-cluster` | El contexto actual de kubernetes | +| namespace | `starship-namespace` | Si se establece, el espacio de nombres actual de kubernetes | +| symbol | | Refleja el valor de la opción `symbol` | +| style\* | | Refleja el valor de la opción `style` | \*: Esta variable sólo puede ser usada como parte de una cadena de estilo @@ -1407,13 +1424,13 @@ disabled = false ## Salto de línea -The `line_break` module separates the prompt into two lines. +El módulo `line_break` separa el indicador en dos líneas. ### Opciones -| Opción | Por defecto | Descripción | -| ---------- | ----------- | ------------------------------------------------------------------ | -| `disabled` | `false` | Disables the `line_break` module, making the prompt a single line. | +| Opción | Por defecto | Descripción | +| ---------- | ----------- | ------------------------------------------------------------------------------- | +| `disabled` | `false` | Deshabilita el módulo `line_break`, haciendo que el mensaje sea una sola línea. | ### Ejemplo @@ -1424,40 +1441,77 @@ The `line_break` module separates the prompt into two lines. disabled = true ``` -## Memoria utilizada +## Lua -The `memory_usage` module shows current system memory and swap usage. +El módulo `lua` muestra la versión instalada de Lua. El módulo se muestra si algunas de las siguientes condiciones se cumplen: -By default the swap usage is displayed if the total system swap is non-zero. +- El directorio actual contiene un archivo `.lua-version` +- El directorio actual contiene un directorio `lua` +- El directorio actual contiene un archivo con la extensión `.lua` + +### Opciones + +| Opción | Por defecto | Descripción | +| ------------ | ---------------------------------- | ----------------------------------------------------------------------- | +| `format` | `"via [$symbol$version]($style) "` | El formato del módulo. | +| `symbol` | `"🌙 "` | Una cadena de formato que representa el símbolo de Lua. | +| `style` | `"bold blue"` | El estilo del módulo. | +| `lua_binary` | `"lua"` | Configura el binario de lua que Starship ejecuta al obtener la versión. | +| `disabled` | `false` | Desactiva el módulo `lua`. | + +### Variables + +| Variable | Ejemplo | Descripción | +| --------- | -------- | -------------------------------------- | +| version | `v5.4.0` | La versión de `lua` | +| symbol | | Refleja el valor de la opción `symbol` | +| style\* | | Refleja el valor de la opción `style` | + +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo + +### Ejemplo + +```toml +# ~/.config/starship.toml + +[lua] +format = "via [🌕 $version](bold blue) " +``` + +## Memory Usage + +El módulo `memory_usage` muestra la memoria del sistema actual y el uso de memoria de intercambio. + +Por defecto, el uso de swap se muestra si el intercambio total del sistema no es cero. ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` a `false` en tu archivo de configuración. ::: ### Opciones -| Opción | Por defecto | Descripción | -| ----------- | --------------------------------------------- | -------------------------------------------------------- | -| `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. | -| `format` | `"via $symbol [${ram}( | ${swap})]($style) "` | El formato del módulo. | -| `symbol` | `"🐏"` | The symbol used before displaying the memory usage. | -| `style` | `"bold dimmed white"` | El estilo del módulo. | -| `disabled` | `true` | Disables the `memory_usage` module. | +| Opción | Por defecto | Descripción | +| ----------- | --------------------------------------------- | ------------------------------------------------------------- | +| `threshold` | `75` | Ocultar el uso de memoria a menos que supere este porcentaje. | +| `format` | `"via $symbol [${ram}( | ${swap})]($style) "` | El formato del módulo. | +| `symbol` | `"🐏"` | El símbolo usado antes de mostrar el uso de memoria. | +| `style` | `"bold dimmed white"` | El estilo del módulo. | +| `disabled` | `true` | Desactiva el módulo `memory_usage`. | ### Variables -| Variable | Ejemplo | Descripción | -| ---------------- | ------------- | ------------------------------------------------------------------ | -| ram | `31GiB/65GiB` | The usage/total RAM of the current system memory. | -| ram_pct | `48%` | The percentage of the current system memory. | -| swap\*\* | `1GiB/4GiB` | The swap memory size of the current system swap memory file. | -| swap_pct\*\* | `77%` | The swap memory percentage of the current system swap memory file. | -| symbol | `🐏` | Refleja el valor de la opción `symbol` | -| style\* | | Refleja el valor de la opción `style` | +| Variable | Ejemplo | Descripción | +| ---------------- | ------------- | ---------------------------------------------------------------------------------- | +| ram | `31GiB/65GiB` | La memoria RAM usada/total del sistema actual. | +| ram_pct | `48%` | El porcentaje de la memoria actual del sistema. | +| swap\*\* | `1GiB/4GiB` | El tamaño de la memoria de intercambio del archivo de memoria del sistema actual. | +| swap_pct\*\* | `77%` | El porcentaje de memoria de intercambio del archivo de memoria del sistema actual. | +| symbol | `🐏` | Refleja el valor de la opción `symbol` | +| style\* | | Refleja el valor de la opción `style` | -\*: This variable can only be used as a part of a style string \*\*: The SWAP file information is only displayed if detected on the current system +\*: Esta variable sólo puede utilizarse como parte de una cadena de estilo \*\*: La información del archivo SWAP sólo se muestra si se detecta en el sistema actual ### Ejemplo @@ -1466,34 +1520,31 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y [memory_usage] disabled = false -show_percentage = true -show_swap = true threshold = -1 symbol = " " -separator = "/" style = "bold dimmed green" ``` ## Mercurial Branch -The `hg_branch` module shows the active branch of the repo in your current directory. +El módulo `hg_branch` muestra la rama activa del repositorio en su directorio actual. ### Opciones -| Opción | Por defecto | Descripción | -| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------- | -| `symbol` | `" "` | The symbol used before the hg bookmark or branch name of the repo in your current directory. | -| `style` | `"bold purple"` | El estilo del módulo. | -| `format` | `"on [$symbol$branch]($style) "` | El formato del módulo. | -| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to X graphemes | -| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. | -| `disabled` | `true` | Disables the `hg_branch` module. | +| Opción | Por defecto | Descripción | +| ------------------- | -------------------------------- | --------------------------------------------------------------------------------------------------- | +| `symbol` | `" "` | El símbolo usado antes del marcador hg o nombre de la rama del repositorio en su directorio actual. | +| `style` | `"bold purple"` | El estilo del módulo. | +| `format` | `"on [$symbol$branch]($style) "` | El formato del módulo. | +| `truncation_length` | `2^63 - 1` | Trunca el nombre de la rama hg a X grafemas | +| `truncation_symbol` | `"…"` | El símbolo usado para indicar que un nombre de rama fue truncado. | +| `disabled` | `true` | Desactiva el módulo `hg_branch`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| branch | `master` | The active mercurial branch | +| branch | `master` | La rama de mercurial activa | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -1512,27 +1563,27 @@ truncation_symbol = "" ## Nim -The `nim` module shows the currently installed version of Nim. El módulo se muestra si algunas de las siguientes condiciones se cumplen: +El módulo `nim` muestra la versión instalada de Nim. El módulo se muestra si algunas de las siguientes condiciones se cumplen: -- El directorio actual contiene un fichero `nim.cfg` -- The current directory contains a file with the `.nim` extension -- The current directory contains a file with the `.nims` extension -- The current directory contains a file with the `.nimble` extension +- El directorio actual contiene un archivo `nim.cfg` +- El directorio actual contiene un archivo con la extensión `.nim` +- El directorio actual contiene un archivo con la extensión `.nims` +- El directorio actual contiene un archivo con la extensión `.nimble` ### Opciones -| Opción | Por defecto | Descripción | -| ---------- | ---------------------------------- | ----------------------------------------------------- | -| `format` | `"via [$symbol$version]($style) "` | El formato del módulo | -| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. | -| `style` | `"bold yellow"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `nim` module. | +| Opción | Por defecto | Descripción | +| ---------- | ---------------------------------- | ---------------------------------------------------- | +| `format` | `"via [$symbol$version]($style) "` | El formato del módulo | +| `symbol` | `"👑 "` | El símbolo usado antes de mostrar la versión de Nim. | +| `style` | `"bold yellow"` | El estilo del módulo. | +| `disabled` | `false` | Desactiva el módulo `nim`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `v1.2.0` | The version of `nimc` | +| version | `v1.2.0` | La versión de `nimc` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -1550,25 +1601,25 @@ symbol = "🎣 " ## Nix-shell -The `nix_shell` module shows the nix-shell environment. The module will be shown when inside a nix-shell environment. +El módulo `nix_shell` muestra el entorno nix-shell. El módulo se mostrará dentro de un entorno nix-shell. ### Opciones -| Opción | Por defecto | Descripción | -| ------------ | ---------------------------------------------- | ----------------------------------------------------- | -| `format` | `'via [$symbol$state( \($name\))]($style) '` | El formato del módulo. | -| `symbol` | `"❄️ "` | A format string representing the symbol of nix-shell. | -| `style` | `"bold blue"` | El estilo del módulo. | -| `impure_msg` | `"impure"` | A format string shown when the shell is impure. | -| `pure_msg` | `"pure"` | A format string shown when the shell is pure. | -| `disabled` | `false` | Disables the `nix_shell` module. | +| Opción | Por defecto | Descripción | +| ------------ | ---------------------------------------------- | -------------------------------------------------------------------------------- | +| `format` | `'via [$symbol$state( \($name\))]($style) '` | El formato del módulo. | +| `symbol` | `"❄️ "` | Una cadena de formato que representa el símbolo de nix-shell. | +| `style` | `"bold blue"` | El estilo del módulo. | +| `impure_msg` | `"impure"` | Una cadena de formato que se muestra cuando el intérprete de comandos es impuro. | +| `pure_msg` | `"pure"` | Una cadena de formato que se muestra cuando el intérprete de comandos es puro. | +| `disabled` | `false` | Desactiva el módulo `nix_shell`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | ------- | -------------------------------------- | -| state | `pure` | The state of the nix-shell | -| name | `lorri` | The name of the nix-shell | +| state | `pure` | El estado de nix-shell | +| name | `lorri` | El nombre de nix-shell | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -1588,28 +1639,28 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' ## NodeJS -The `nodejs` module shows the currently installed version of NodeJS. El módulo se muestra si algunas de las siguientes condiciones se cumplen: +El módulo `nodejs` muestra la versión instalada de NodeJS. El módulo se muestra si algunas de las siguientes condiciones se cumplen: -- El directorio actual contiene un fichero `package.json` -- The current directory contains a `.node-version` file -- The current directory contains a `node_modules` directory -- The current directory contains a file with the `.js`, `.mjs` or `.cjs` extension -- The current directory contains a file with the `.ts` extension +- El directorio actual contiene un archivo `package.json` +- El directorio actual contiene un archivo `.node-version` +- El directorio actual contiene un directorio `node_modules` +- El directorio actual contiene un archivo con la extensión `.js`, `.mjs` o `.cjs` +- El directorio actual contiene un archivo con la extensión `.ts` ### Opciones -| Opción | Por defecto | Descripción | -| ---------- | ---------------------------------- | -------------------------------------------------- | -| `format` | `"via [$symbol$version]($style) "` | El formato del módulo. | -| `symbol` | `"⬢ "` | A format string representing the symbol of NodeJS. | -| `style` | `"bold green"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `nodejs` module. | +| Opción | Por defecto | Descripción | +| ---------- | ---------------------------------- | ---------------------------------------------------------- | +| `format` | `"via [$symbol$version]($style) "` | El formato del módulo. | +| `symbol` | `"⬢ "` | Una cadena de formato que representa el símbolo de NodeJS. | +| `style` | `"bold green"` | El estilo del módulo. | +| `disabled` | `false` | Desactiva el módulo `nodejs`. | ###  Variables | Variable | Ejemplo | Descripción | | --------- | ---------- | -------------------------------------- | -| version | `v13.12.0` | The version of `node` | +| version | `v13.12.0` | La versión de `node` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -1624,76 +1675,31 @@ The `nodejs` module shows the currently installed version of NodeJS. El módulo format = "via [🤖 $version](bold green) " ``` -## Versión del paquete - -The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` and `helm` packages. - -- **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. - -### Opciones - -| Opción | Por defecto | Descripción | -| ----------------- | ---------------------------------- | ---------------------------------------------------------- | -| `format` | `"via [$symbol$version]($style) "` | El formato del módulo. | -| `symbol` | `"📦 "` | The symbol used before displaying the version the package. | -| `style` | `"bold 208"` | El estilo del módulo. | -| `display_private` | `false` | Enable displaying version for packages marked as private. | -| `disabled` | `false` | Disables the `package` module. | - -### Variables - -| Variable | Ejemplo | Descripción | -| --------- | -------- | -------------------------------------- | -| version | `v1.0.0` | The version of your package | -| symbol | | Refleja el valor de la opción `symbol` | -| style\* | | Refleja el valor de la opción `style` | - -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo - -### Ejemplo - -```toml -# ~/.config/starship.toml - -[package] -format = "via [🎁 $version](208 bold) " -``` - ## OCaml -The `ocaml` module shows the currently installed version of OCaml. El módulo se muestra si algunas de las siguientes condiciones se cumplen: +El módulo `ocaml` muestra la versión actualmente instalada de OCaml. El módulo se muestra si algunas de las siguientes condiciones se cumplen: -- 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 +- El directorio actual contiene un archivo con extensión `.opam` o directorio `_opam` +- El directorio actual contiene un directorio `esy.lock` +- El directorio actual contiene un archivo `dune` o `dune-project` +- El directorio actual contiene un archivo `jbuild` o `jbuild-ignore` +- El directorio actual contiene un archivo `.merlin` +- El directorio actual contiene un archivo con la extensión `.ml`, `.mli`, `.re` o `.rei` ### Opciones -| Opción | Por defecto | Descripción | -| ---------- | ---------------------------------- | ------------------------------------------------------- | -| `format` | `"via [$symbol$version]($style) "` | The format string for the module. | -| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. | -| `style` | `"bold yellow"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `ocaml` module. | +| Opción | Por defecto | Descripción | +| ---------- | ---------------------------------- | ------------------------------------------------------ | +| `format` | `"via [$symbol$version]($style) "` | La cadena de formato para el módulo. | +| `symbol` | `"🐫 "` | El símbolo usado antes de mostrar la versión de OCaml. | +| `style` | `"bold yellow"` | El estilo del módulo. | +| `disabled` | `false` | Desactiva el módulo `ocaml`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | --------- | -------------------------------------- | -| version | `v4.10.0` | The version of `ocaml` | +| version | `v4.10.0` | La versión de `ocaml` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -1708,30 +1714,110 @@ The `ocaml` module shows the currently installed version of OCaml. El módulo se format = "via [🐪 $version]($style) " ``` -## Perl +## OpenStack -The `perl` module shows the currently installed version of Perl. El módulo se muestra si algunas de las siguientes condiciones se cumplen: - -- The current directory contains a `Makefile.PL` or `Build.PL` file -- The current directory contains a `cpanfile` or `cpanfile.snapshot` file -- The current directory contains a `META.json` file or `META.yml` file -- The current directory contains a `.perl-version` file -- The current directory contains a `.pl`, `.pm` or `.pod` +El módulo `openstack` muestra la nube OpenStack actual y el proyecto. El módulo solo está activo cuando la variable env `OS_CLOUD` está definida en cuyo caso leerá el archivo `nubes. aml` desde cualquiera de las [ubicaciones por defecto](https://docs.openstack.org/python-openstackclient/latest/configuration/index.html#configuration-files) para obtener el proyecto actual en uso. ### Opciones -| Opción | Por defecto | Descripción | -| ---------- | ---------------------------------- | ----------------------------------------------------- | -| `format` | `"via [$symbol$version]($style) "` | The format string for the module. | -| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | -| `style` | `"bold 149"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `perl` module. | +| Opción | Por defecto | Descripción | +| ---------- | --------------------------------------------------- | ----------------------------------------------------------- | +| `format` | `"on [$symbol$cloud(\\($project\\))]($style) "` | El formato del módulo. | +| `symbol` | `"☁️ "` | El símbolo usado antes de mostrar la nube OpenStack actual. | +| `style` | `"bold yellow"` | El estilo del módulo. | +| `disabled` | `false` | Desactiva el módulo `OpenStack`. | + +### Variables + +| Variable | Ejemplo | Descripción | +| --------- | ------- | -------------------------------------- | +| cloud | `corp` | La nube OpenStack actual | +| project | `dev` | El proyecto OpenStack actual | +| symbol | | Refleja el valor de la opción `symbol` | +| style\* | | Refleja el valor de la opción `style` | + +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo + +### Ejemplo + +```toml +# ~/.config/starship.toml + +[openstack] +format = "on [$symbol$cloud(\\($project\\))]($style) " +style = "bold yellow" +symbol = "☁️ " +``` + +## Package Version + +El módulo `package` se muestra cuando el directorio actual es el repositorio de un paquete, y muestra su versión actual. El módulo soporta actualmente los paquetes `npm`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix` y `helm`. + +- **npm** – La versión del paquete `npm` se extrae del `package.json` presente en el directorio actual +- **cargo** – La versión del paquete `cargo` se extrae del `Cargo.toml` presente en el directorio actual +- **poetry** – La versión del paquete `poetry` es extraída del `pyproject.toml` presente en el directorio actual +- **composer** - La versión del paquete `composer` se extrae del `composer.json` presente en el directorio actual +- **gradle** – La versión del paquete `gradle` es extraída del `build.gradle` presente +- **julia** - La versión del paquete se extrae del `Project.toml` presente +- **mix** - La versión del paquete `mix` se extrae del `mix.exs` presente +- **helm** - La versión del gráfico `helm` se extrae del `Chart.yaml` presente +- **maven** - La versión del paquete `maven` es extraída del `pom.xml` presente + +> ⚠️ La versión que se muestra es la del paquete cuyo código fuente está en tu directorio actual, no en tu gestor de paquetes. + +### Opciones + +| Opción | Por defecto | Descripción | +| ----------------- | ---------------------------------- | -------------------------------------------------------------------------------- | +| `format` | `"via [$symbol$version]($style) "` | El formato del módulo. | +| `symbol` | `"📦 "` | El símbolo usado antes de mostrar la versión del paquete. | +| `style` | `"bold 208"` | El estilo del módulo. | +| `display_private` | `false` | Activar la visualización de la versión para los paquetes marcados como privados. | +| `disabled` | `false` | Desactiva el módulo `package`. | + +### Variables + +| Variable | Ejemplo | Descripción | +| --------- | -------- | -------------------------------------- | +| version | `v1.0.0` | La versión de su paquete | +| symbol | | Refleja el valor de la opción `symbol` | +| style\* | | Refleja el valor de la opción `style` | + +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo + +### Ejemplo + +```toml +# ~/.config/starship.toml + +[package] +format = "via [🎁 $version](208 bold) " +``` + +## Perl + +El módulo `perl` muestra la versión actualmente instalada de Perl. El módulo se muestra si algunas de las siguientes condiciones se cumplen: + +- El directorio actual contiene un archivo `Makefile.PL` o `Build.PL` +- El directorio actual contiene un archivo `cpanfile` o `cpanfile.snapshot` +- El directorio actual contiene un archivo `META.json` o `META.yml` +- El directorio actual contiene un archivo `.perl-version` +- El directorio actual contiene un `.pl`, `.pm` o `.pod` + +### Opciones + +| Opción | Por defecto | Descripción | +| ---------- | ---------------------------------- | ---------------------------------------------------- | +| `format` | `"via [$symbol$version]($style) "` | La cadena de formato para el módulo. | +| `symbol` | `"🐪 "` | El símbolo usado antes de mostrar la versión de Perl | +| `style` | `"bold 149"` | El estilo del módulo. | +| `disabled` | `false` | Desactiva el módulo `perl`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | --------- | -------------------------------------- | -| version | `v5.26.1` | The version of `perl` | +| version | `v5.26.1` | La versión de `perl` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -1746,26 +1832,26 @@ format = "via [🦪 $version]($style) " ## PHP -The `php` module shows the currently installed version of PHP. El módulo se muestra si algunas de las siguientes condiciones se cumplen: +El módulo `php` muestra la versión instalada de PHP. El módulo se muestra si algunas de las siguientes condiciones se cumplen: -- El directorio actual contiene un fichero `composer.json` -- The current directory contains a `.php-version` file -- The current directory contains a `.php` file +- El directorio actual contiene un archivo `composer.json` +- El directorio actual contiene un archivo `.php-version` +- El directorio actual contiene un archivo `.php` ### Opciones -| Opción | Por defecto | Descripción | -| ---------- | ---------------------------------- | ----------------------------------------------------- | -| `format` | `"via [$symbol$version]($style) "` | El formato del módulo. | -| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | -| `style` | `"147 bold"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `php` module. | +| Opción | Por defecto | Descripción | +| ---------- | ---------------------------------- | ---------------------------------------------------- | +| `format` | `"via [$symbol$version]($style) "` | El formato del módulo. | +| `symbol` | `"🐘 "` | El símbolo usado antes de mostrar la versión de PHP. | +| `style` | `"147 bold"` | El estilo del módulo. | +| `disabled` | `false` | Desactiva el módulo `php`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `v7.3.8` | The version of `php` | +| version | `v7.3.8` | La versión de `php` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -1780,550 +1866,6 @@ The `php` module shows the currently installed version of PHP. El módulo se mue format = "via [🔹 $version](147 bold) " ``` -## Python - -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`. - -El módulo se muestra si algunas de las siguientes condiciones se cumplen: - -- The current directory contains a `.python-version` file -- El directorio actual contiene un fichero `requirements.txt` -- El directorio actual contiene un fichero `pyproject.toml` -- The current directory contains a file with the `.py` extension (and `scan_for_pyfiles` is true) -- The current directory contains a `Pipfile` file -- El directorio actual contiene un fichero `tox.ini` -- El directorio actual contiene un fichero `setup.py` -- The current directory contains a `__init__.py` file -- A virtual environment is currently activated - -### Opciones - -| Opción | Por defecto | Descripción | -| -------------------- | ------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | -| `format` | `'via [${symbol}${pyenv_prefix}${version}( \($virtualenv\))]($style) '` | El formato del módulo. | -| `symbol` | `"🐍 "` | A format string representing the symbol of Python | -| `style` | `"yellow bold"` | El estilo del módulo. | -| `pyenv_version_name` | `false` | Use pyenv to get Python version | -| `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | -| `scan_for_pyfiles` | `true` | If false, Python files in the current directory will not show this module. | -| `python_binary` | `python` | Configures the python binary that Starship executes when getting the version. | -| `disabled` | `false` | Disables the `python` module. | - -### Variables - -| Variable | Ejemplo | Descripción | -| ------------ | --------------- | ------------------------------------------ | -| version | `"v3.8.1"` | The version of `python` | -| symbol | `"🐍 "` | Refleja el valor de la opción `symbol` | -| style | `"yellow bold"` | Refleja el valor de la opción `style` | -| pyenv_prefix | `"pyenv "` | Mirrors the value of option `pyenv_prefix` | -| virtualenv | `"venv"` | The current `virtualenv` name | - - -### Ejemplo - -```toml -# ~/.config/starship.toml - -[python] -symbol = "👾 " -pyenv_version_name = true -``` - -Using the `python3` binary to get the version. - -Note - The `python_binary` variable changes the binary that Starship executes to get the version of Python, it doesn't change the arguments that are used. - -```toml -# ~/.config/starship.toml - -[python] -python_binary = "python3" -``` - -## Ruby - -The `ruby` module shows the currently installed version of Ruby. El módulo se muestra si algunas de las siguientes condiciones se cumplen: - -- The current directory contains a `Gemfile` file -- The current directory contains a `.ruby-version` file -- The current directory contains a `.rb` file - -### Opciones - -| Opción | Por defecto | Descripción | -| ---------- | ---------------------------------- | ------------------------------------------------ | -| `format` | `"via [$symbol$version]($style) "` | El formato del módulo. | -| `symbol` | `"💎 "` | A format string representing the symbol of Ruby. | -| `style` | `"bold red"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `ruby` module. | - -### Variables - -| Variable | Ejemplo | Descripción | -| --------- | -------- | -------------------------------------- | -| version | `v2.5.1` | The version of `ruby` | -| symbol | | Refleja el valor de la opción `symbol` | -| style\* | | Refleja el valor de la opción `style` | - -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo - -### Ejemplo - -```toml -# ~/.config/starship.toml - -[ruby] -symbol = "🔺 " -``` - -## Rust - -The `rust` module shows the currently installed version of Rust. El módulo se muestra si algunas de las siguientes condiciones se cumplen: - -- The current directory contains a `Cargo.toml` file -- The current directory contains a file with the `.rs` extension - -### Opciones - -| Opción | Por defecto | Descripción | -| ---------- | ---------------------------------- | ----------------------------------------------- | -| `format` | `"via [$symbol$version]($style) "` | El formato del módulo. | -| `symbol` | `"🦀 "` | A format string representing the symbol of Rust | -| `style` | `"bold red"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `rust` module. | - -### Variables - -| Variable | Ejemplo | Descripción | -| --------- | ----------------- | -------------------------------------- | -| version | `v1.43.0-nightly` | The version of `rustc` | -| symbol | | Refleja el valor de la opción `symbol` | -| style\* | | Refleja el valor de la opción `style` | - -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo - -### Ejemplo - -```toml -# ~/.config/starship.toml - -[rust] -format = "via [⚙️ $version](red bold)" -``` - -## SHLVL - -The `shlvl` module shows the current SHLVL ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold. - -### Opciones - -| Opción | Por defecto | Descripción | -| ----------- | ---------------------------- | --------------------------------------- | -| `threshold` | `2` | Display threshold. | -| `format` | `"[$symbol$shlvl]($style) "` | El formato del módulo. | -| `symbol` | `"↕️ "` | The symbol used to represent the SHLVL. | -| `style` | `"bold yellow"` | El estilo del módulo. | -| `disabled` | `true` | Disables the `shlvl` module. | - -### Variables - -| Variable | Ejemplo | Descripción | -| --------- | ------- | -------------------------------------- | -| shlvl | `3` | The current value of SHLVL | -| symbol | | Refleja el valor de la opción `symbol` | -| style\* | | Refleja el valor de la opción `style` | - -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo - -### Ejemplo - -```toml -# ~/.config/starship.toml - -[shlvl] -disabled = false -format = "$shlvl level(s) down" -threshold = 3 -``` - -## Singularity - -The `singularity` module shows the current singularity image, if inside a container and `$SINGULARITY_NAME` is set. - -### Opciones - -| Opción | Por defecto | Descripción | -| ---------- | -------------------------------- | ------------------------------------------------ | -| `format` | `'[$symbol\[$env\]]($style) '` | El formato del módulo. | -| `symbol` | `""` | A format string displayed before the image name. | -| `style` | `"bold dimmed blue"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `singularity` module. | - -### Variables - -| Variable | Ejemplo | Descripción | -| --------- | ------------ | -------------------------------------- | -| env | `centos.img` | The current singularity image | -| symbol | | Refleja el valor de la opción `symbol` | -| style\* | | Refleja el valor de la opción `style` | - -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo - -### Ejemplo - -```toml -# ~/.config/starship.toml - -[singularity] -format = '[📦 \[$env\]]($style) ' -``` - -## Swift - -The `swift` module shows the currently installed version of Swift. El módulo se muestra si algunas de las siguientes condiciones se cumplen: - -- The current directory contains a `Package.swift` file -- The current directory contains a file with the `.swift` extension - -### Opciones - -| Opción | Por defecto | Descripción | -| ---------- | ---------------------------------- | ------------------------------------------------ | -| `format` | `"via [$symbol$version]($style) "` | El formato del módulo. | -| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | -| `style` | `"bold 202"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `swift` module. | - -### Variables - -| Variable | Ejemplo | Descripción | -| --------- | -------- | -------------------------------------- | -| version | `v5.2.4` | The version of `swift` | -| symbol | | Refleja el valor de la opción `symbol` | -| style\* | | Refleja el valor de la opción `style` | - -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo - -### Ejemplo - -```toml -# ~/.config/starship.toml - -[swift] -format = "via [🏎 $version](red bold)" -``` - -## 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`. - -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: - -### Opciones - -| Opción | Por defecto | Descripción | -| ---------- | -------------------------- | ------------------------------------------------------ | -| `format` | `[$symbol$status]($style)` | The format of the module | -| `symbol` | `"✖"` | A format string representing the symbol for the status | -| `style` | `"bold red"` | El estilo del módulo. | -| `disabled` | `true` | Disables the `status` module. | - -### Variables - -| Variable | Ejemplo | Descripción | -| --------- | ------- | -------------------------------------- | -| status | `127` | The exit code of the last command | -| symbol | | Refleja el valor de la opción `symbol` | -| style\* | | Refleja el valor de la opción `style` | - -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo - -### Ejemplo - -```toml - -# ~/.config/starship.toml - -[status] -style = "bg:blue" -symbol = "💣 " -format = '[\[$symbol$status\]]($style) ' -disabled = false - -``` - -## Terraform - -The `terraform` module shows the currently selected terraform workspace and version. By default the terraform version is not shown, since this is slow on current versions of terraform when a lot of plugins are in use. If you still want to enable it, [follow the example shown below](#with-version). El módulo se muestra si algunas de las siguientes condiciones se cumplen: - -- The current directory contains a `.terraform` folder -- Current directory contains a file with the `.tf` extension - -### Opciones - -| Opción | Por defecto | Descripción | -| ---------- | ------------------------------------ | ----------------------------------------------------- | -| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | -| `symbol` | `"💠 "` | A format string shown before the terraform workspace. | -| `style` | `"bold 105"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `terraform` module. | - -### Variables - -| Variable | Ejemplo | Descripción | -| --------- | ------------- | -------------------------------------- | -| version | `v0.12.24` | The version of `terraform` | -| workspace | `por defecto` | The current terraform workspace | -| symbol | | Refleja el valor de la opción `symbol` | -| style\* | | Refleja el valor de la opción `style` | - -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo - -### Ejemplo - -#### With Version - -```toml -# ~/.config/starship.toml - -[terraform] -format = "[🏎💨 $version$workspace]($style) " -``` - -#### Without version - -```toml -# ~/.config/starship.toml - -[terraform] -format = "[🏎💨 $workspace]($style) " -``` - -## Hora - -The `time` module shows the current **local** time. The `format` configuration value is used by the [`chrono`](https://crates.io/crates/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) to see what options are available. - -::: tip - -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. - -::: - -### Opciones - -| Opción | Por defecto | Descripción | -| ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `format` | `"at [$time]($style) "` | The format string for the module. | -| `use_12hr` | `false` | Activa el formato de 12 horas | -| `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. | -| `style` | `"bold yellow"` | El estilo del módulo de la hora | -| `utc_time_offset` | `"local"` | Sets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. | -| `disabled` | `true` | Disables the `time` module. | -| `time_range` | `"-"` | Establece el intervalo de tiempo durante el cual el módulo se mostrará. La hora debe ser especificada en formato de 24 horas | - -If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Otherwise, it defaults to `"%T"`. Manually setting `time_format` will override the `use_12hr` setting. - -### Variables - -| Variable | Ejemplo | Descripción | -| --------- | ---------- | ------------------------------------- | -| hora | `13:08:10` | The current time. | -| style\* | | Refleja el valor de la opción `style` | - -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo - -### Ejemplo - -```toml -# ~/.config/starship.toml - -[time] -disabled = false -format = '🕙[\[ $time \]]($style) ' -time_format = "%T" -utc_time_offset = "-5" -time_range = "10:00:00-14:00:00" -``` - -## Nombre de usuario - -The `username` module shows active user's username. El módulo se muestra si algunas de las siguientes condiciones se cumplen: - -- The current user is root -- The current user isn't the same as the one that is logged in -- The user is currently connected as an SSH session -- The variable `show_always` is set to true - -### Opciones - -| Opción | Por defecto | Descripción | -| ------------- | ----------------------- | ------------------------------------- | -| `style_root` | `"bold red"` | The style used when the user is root. | -| `style_user` | `"bold yellow"` | The style used for non-root users. | -| `format` | `"[$user]($style) in "` | El formato del módulo. | -| `show_always` | `false` | Always shows the `username` module. | -| `disabled` | `false` | Disables the `username` module. | - -### Variables - -| Variable | Ejemplo | Descripción | -| -------- | ------------ | ------------------------------------------------------------------------------------------- | -| `style` | `"red bold"` | Mirrors the value of option `style_root` when root is logged in and `style_user` otherwise. | -| `user` | `"matchai"` | The currently logged-in user ID. | - -### Ejemplo - -```toml -# ~/.config/starship.toml - -[username] -style_user = "white bold" -style_root = "black bold" -format = "user: [$user]($style) " -disabled = false -show_always = true -``` - -## Zig - -The `zig` module shows the currently installed version of Zig. El módulo se muestra si algunas de las siguientes condiciones se cumplen: - -- The current directory contains a `.zig` file - -### Opciones - -| Opción | Por defecto | Descripción | -| ---------- | ---------------------------------- | ----------------------------------------------------- | -| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | -| `style` | `"bold yellow"` | El estilo del módulo. | -| `format` | `"via [$symbol$version]($style) "` | El formato del módulo. | -| `disabled` | `false` | Disables the `zig` module. | - -### Variables - -| Variable | Ejemplo | Descripción | -| --------- | -------- | -------------------------------------- | -| version | `v0.6.0` | The version of `zig` | -| symbol | | Refleja el valor de la opción `symbol` | -| style\* | | Refleja el valor de la opción `style` | - -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo - -### Ejemplo - -```toml -# ~/.config/starship.toml - -[zig] -symbol = "⚡️ " -``` - -## Comandos personalizados - -The `custom` modules show the output of some arbitrary commands. - -These modules will be shown if any of the following conditions are met: - -- The current directory contains a file whose name is in `files` -- The current directory contains a directory whose name is in `directories` -- The current directory contains a file whose extension is in `extensions` -- The `when` command returns 0 - -::: tip - -Multiple custom modules can be defined by using a `.`. - -::: - -::: tip - -The order in which custom modules are shown can be individually set by including `${custom.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `custom` module will simply show all custom modules in the order they were defined. - -::: - -::: tip - -[Issue #1252](https://github.com/starship/starship/discussions/1252) contains examples of custom modules. If you have an interesting example not covered there, feel free to share it there! - -::: - -### Opciones - -| Opción | Por defecto | Descripción | -| ------------- | ----------------------------- | -------------------------------------------------------------------------------------------------------------------------- | -| `command` | | The command whose output should be printed. The command will be passed on stdin to the shell. | -| `when` | | A shell command used as a condition to show the module. The module will be shown if the command returns a `0` status code. | -| `shell` | | [See below](#custom-command-shell) | -| `descripción` | `""` | The description of the module that is shown when running `starship explain`. | -| `files` | `[]` | The files that will be searched in the working directory for a match. | -| `directories` | `[]` | The directories that will be searched in the working directory for a match. | -| `extensions` | `[]` | The extensions that will be searched in the working directory for a match. | -| `symbol` | `""` | The symbol used before displaying the command output. | -| `style` | `"bold green"` | El estilo del módulo. | -| `format` | `"[$symbol$output]($style) "` | El formato del módulo. | -| `disabled` | `false` | Disables this `custom` module. | - -### Variables - -| Variable | Descripción | -| --------- | ----------------------------------------- | -| output | La salida del comando de shell en `shell` | -| symbol | Refleja el valor de la opción `symbol` | -| style\* | Refleja el valor de la opción `style` | - -\*: Esta variable sólo puede ser usada como parte de una cadena de estilo - -#### Comando personalizado de shell - -`shell` acepta una lista no vacía de cadenas, donde: - -- La primera cadena es la ruta al intérprete de comandos a usar para ejecutar el comando. -- Otros argumentos siguientes son pasados al shell. - -If unset, it will fallback to STARSHIP_SHELL and then to "sh" on Linux, and "cmd /C" on Windows. - -The `command` will be passed in on stdin. - -If `shell` is not given or only contains one element and Starship detects PowerShell will be used, the following arguments will automatically be added: `-NoProfile -Command -`. This behavior can be avoided by explicitly passing arguments to the shell, e.g. - -```toml -shell = ["pwsh", "-Command", "-"] -``` - -::: warning Make sure your custom shell configuration exits gracefully - -If you set a custom command, make sure that the default Shell used by starship will properly execute the command with a graceful exit (via the `shell` option). - -For example, PowerShell requires the `-Command` parameter to execute a one liner. Omitting this parameter might throw starship into a recursive loop where the shell might try to load a full profile environment with starship itself again and hence re-execute the custom command, getting into a never ending loop. - -Parameters similar to `-NoProfile` in PowerShell are recommended for other shells as well to avoid extra loading time of a custom profile on every starship invocation. - -Automatic detection of shells and proper parameters addition are currently implemented, but it's possible that not all shells are covered. [Please open an issue](https://github.com/starship/starship/issues/new/choose) with shell details and starship configuration if you hit such scenario. - -::: - -### Ejemplo - -```toml -# ~/.config/starship.toml - -[custom.foo] -command = "echo foo" # shows output of command -files = ["foo"] # can specify filters -when = """ test "$HOME" == "$PWD" """ -format = " transcending [$output]($style)" - -[custom.time] -command = "time /T" -files = ["*.pst"] -shell = ["pwsh.exe", "-NoProfile", "-Command", "-"] -``` - ## PureScript El módulo `purescript` muestra la versión actualmente instalada de PureScript. El módulo se muestra si algunas de las siguientes condiciones se cumplen: @@ -2338,7 +1880,7 @@ El módulo `purescript` muestra la versión actualmente instalada de PureScript. | `format` | `"via [$symbol$version]($style) "` | El formato del módulo. | | `symbol` | `"<=> "` | El símbolo usado antes de mostrar la versión de PureScript. | | `style` | `"bold white"` | El estilo del módulo. | -| `disabled` | `false` | Deshabilita el módulo `purescript`. | +| `disabled` | `false` | Desactiva el módulo `purescript`. | ### Variables @@ -2358,3 +1900,547 @@ El módulo `purescript` muestra la versión actualmente instalada de PureScript. [purescript] format = "via [$symbol$version](bold white)" ``` + +## Python + +El módulo `python` muestra la versión actualmente instalada de Python y el actual entorno virtual de Python si uno está activado. + +Si `pyenv_version_name` se establece en `true`, mostrará el nombre de la versión de pyenv. De lo contrario, se mostrará el número de versión de `python --version`. + +El módulo se muestra si algunas de las siguientes condiciones se cumplen: + +- El directorio actual contiene un archivo `.python-version` +- El directorio actual contiene un archivo `requirements.txt` +- El directorio actual contiene un archivo `pyproject.toml` +- El directorio actual contiene un archivo con la extensión `.py` (y `scan_for_pyfiles` es verdadero) +- El directorio actual contiene un archivo `Pipfile` +- El directorio actual contiene un archivo `tox.ini` +- El directorio actual contiene un archivo `setup.py` +- El directorio actual contiene un archivo `__init__.py` +- Un entorno virtual está activado actualmente + +### Opciones + +| Opción | Por defecto | Descripción | +| -------------------- | ------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | +| `format` | `'via [${symbol}${pyenv_prefix}${version}( \($virtualenv\))]($style) '` | El formato del módulo. | +| `symbol` | `"🐍 "` | Una cadena de formato que representa el símbolo de Python | +| `style` | `"yellow bold"` | El estilo del módulo. | +| `pyenv_version_name` | `false` | Usar pyenv para obtener la versión de Python | +| `pyenv_prefix` | `pyenv` | Prefijo antes de mostrar la versión de pyenv sólo se utiliza si se utiliza pyenv | +| `scan_for_pyfiles` | `true` | Si es falso, los archivos Python en el directorio actual no mostrarán este módulo. | +| `python_binary` | `python` | Configura el binario de python que Starship ejecuta al obtener la versión. | +| `disabled` | `false` | Desactiva el módulo `python`. | + +### Variables + +| Variable | Ejemplo | Descripción | +| ------------ | --------------- | ------------------------------------------- | +| version | `"v3.8.1"` | La versión de `python` | +| symbol | `"🐍 "` | Refleja el valor de la opción `symbol` | +| style | `"yellow bold"` | Refleja el valor de la opción `style` | +| pyenv_prefix | `"pyenv "` | Ordena el valor de la opción `pyenv_prefix` | +| virtualenv | `"venv"` | El nombre actual del `virtualenv` | + + +### Ejemplo + +```toml +# ~/.config/starship.toml + +[python] +symbol = "👾 " +pyenv_version_name = true +``` + +Usando el binario de `python3` para obtener la versión. + +Nota - La variable `python_binary` cambia el binario que Starship ejecuta para obtener la versión de Python, no cambia los argumentos que se utilizan. + +```toml +# ~/.config/starship.toml + +[python] +python_binary = "python3" +``` + +## Ruby + +El módulo `ruby` muestra la versión actualmente instalada de Ruby. El módulo se muestra si algunas de las siguientes condiciones se cumplen: + +- El directorio actual contiene un archivo `Gemfile` +- El directorio actual contiene un archivo `.ruby-version` +- El directorio actual contiene un archivo `.rb` + +### Opciones + +| Opción | Por defecto | Descripción | +| ---------- | ---------------------------------- | -------------------------------------------------------- | +| `format` | `"via [$symbol$version]($style) "` | El formato del módulo. | +| `symbol` | `"💎 "` | Una cadena de formato que representa el símbolo de Ruby. | +| `style` | `"bold red"` | El estilo del módulo. | +| `disabled` | `false` | Desactiva el módulo `ruby`. | + +### Variables + +| Variable | Ejemplo | Descripción | +| --------- | -------- | -------------------------------------- | +| version | `v2.5.1` | La versión de `ruby` | +| symbol | | Refleja el valor de la opción `symbol` | +| style\* | | Refleja el valor de la opción `style` | + +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo + +### Ejemplo + +```toml +# ~/.config/starship.toml + +[ruby] +symbol = "🔺 " +``` + +## Rust + +El módulo `rust` muestra la versión instalada de Rust. El módulo se muestra si algunas de las siguientes condiciones se cumplen: + +- El directorio actual contiene un archivo `Cargo.toml` +- El directorio actual contiene un archivo con la extensión `.rs` + +### Opciones + +| Opción | Por defecto | Descripción | +| ---------- | ---------------------------------- | ------------------------------------------------------- | +| `format` | `"via [$symbol$version]($style) "` | El formato del módulo. | +| `symbol` | `"🦀 "` | Una cadena de formato que representa el símbolo de Rust | +| `style` | `"bold red"` | El estilo del módulo. | +| `disabled` | `false` | Desactiva el módulo `rust`. | + +### Variables + +| Variable | Ejemplo | Descripción | +| --------- | ----------------- | -------------------------------------- | +| version | `v1.43.0-nightly` | La versión de `rustc` | +| symbol | | Refleja el valor de la opción `symbol` | +| style\* | | Refleja el valor de la opción `style` | + +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo + +### Ejemplo + +```toml +# ~/.config/starship.toml + +[rust] +format = "via [⚙️ $version](red bold)" +``` + +## SHLVL + +El módulo `shlvl` muestra la variable de entorno actual SHLVL ("nivel de shell"), si está establecido en un número y conoce o supera el umbral especificado. + +### Opciones + +| Opción | Por defecto | Descripción | +| ----------- | ---------------------------- | ------------------------------------------- | +| `threshold` | `2` | Mostrar umbral. | +| `format` | `"[$symbol$shlvl]($style) "` | El formato del módulo. | +| `symbol` | `"↕️ "` | El símbolo usado para representar el SHLVL. | +| `style` | `"bold yellow"` | El estilo del módulo. | +| `disabled` | `true` | Desactiva el módulo `shlvl`. | + +### Variables + +| Variable | Ejemplo | Descripción | +| --------- | ------- | -------------------------------------- | +| shlvl | `3` | El valor actual de SHLVL | +| symbol | | Refleja el valor de la opción `symbol` | +| style\* | | Refleja el valor de la opción `style` | + +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo + +### Ejemplo + +```toml +# ~/.config/starship.toml + +[shlvl] +disabled = false +format = "$shlvl level(s) down" +threshold = 3 +``` + +## Singularity + +El módulo `singularity` muestra la imagen de singularity actual, si se encuentra dentro de un contenedor y `$SINGULARITY_NAME` está establecido. + +### Opciones + +| Opción | Por defecto | Descripción | +| ---------- | -------------------------------- | ------------------------------------------------------------------- | +| `format` | `'[$symbol\[$env\]]($style) '` | El formato del módulo. | +| `symbol` | `""` | Una cadena de formato que se muestra antes del nombre de la imagen. | +| `style` | `"bold dimmed blue"` | El estilo del módulo. | +| `disabled` | `false` | Desactiva el módulo `singularity`. | + +### Variables + +| Variable | Ejemplo | Descripción | +| --------- | ------------ | -------------------------------------- | +| env | `centos.img` | La imagen de singularity actual | +| symbol | | Refleja el valor de la opción `symbol` | +| style\* | | Refleja el valor de la opción `style` | + +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo + +### Ejemplo + +```toml +# ~/.config/starship.toml + +[singularity] +format = '[📦 \[$env\]]($style) ' +``` + +## Status + +El módulo `status` muestra el código de salida del comando anterior. El módulo se mostrará sólo si el código de salida no es `0`. + +::: tip + +Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` a `false` en tu archivo de configuración. ::: + +### Opciones + +| Opción | Por defecto | Descripción | +| ---------- | -------------------------- | ---------------------------------------------------------- | +| `format` | `[$symbol$status]($style)` | El formato del módulo | +| `symbol` | `"✖"` | Una cadena de formato que representa el símbolo del estado | +| `style` | `"bold red"` | El estilo del módulo. | +| `disabled` | `true` | Desactiva el módulo `status`. | + +### Variables + +| Variable | Ejemplo | Descripción | +| --------- | ------- | -------------------------------------- | +| status | `127` | El código de salida del último comando | +| symbol | | Refleja el valor de la opción `symbol` | +| style\* | | Refleja el valor de la opción `style` | + +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo + +### Ejemplo + +```toml + +# ~/.config/starship.toml + +[status] +style = "bg:blue" +symbol = "💣 " +format = '[\[$symbol$status\]]($style) ' +disabled = false + +``` + +## Swift + +El módulo `swift` muestra la versión actualmente instalada de Swift. El módulo se muestra si algunas de las siguientes condiciones se cumplen: + +- El directorio actual contiene un archivo `Package.swift` +- El directorio actual contiene un archivo con la extensión `.swift` + +### Opciones + +| Opción | Por defecto | Descripción | +| ---------- | ---------------------------------- | -------------------------------------------------------- | +| `format` | `"via [$symbol$version]($style) "` | El formato del módulo. | +| `symbol` | `"🐦 "` | Una cadena de formato que representa el símbolo de Swift | +| `style` | `"bold 202"` | El estilo del módulo. | +| `disabled` | `false` | Desactiva el módulo `swift`. | + +### Variables + +| Variable | Ejemplo | Descripción | +| --------- | -------- | -------------------------------------- | +| version | `v5.2.4` | La versión de `swift` | +| symbol | | Refleja el valor de la opción `symbol` | +| style\* | | Refleja el valor de la opción `style` | + +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo + +### Ejemplo + +```toml +# ~/.config/starship.toml + +[swift] +format = "via [🏎 $version](red bold)" +``` + +## Terraform + +El módulo `terraform` muestra el espacio de trabajo y la versión actual de terraform. Por defecto la versión de terraform no se muestra, ya que esto es lento en las versiones actuales de terraform cuando muchos plugins están en uso. Si aún deseas activarlo, [sigue el ejemplo que se muestra a continuación](#with-version). El módulo se muestra si algunas de las siguientes condiciones se cumplen: + +- El directorio actual contiene una carpeta `.terraform` +- El directorio actual contiene un archivo con las extensiones `.tf` o `.hcl` + +### Opciones + +| Opción | Por defecto | Descripción | +| ---------- | ------------------------------------ | ------------------------------------------------------------------------------- | +| `format` | `"via [$symbol$workspace]($style) "` | La cadena de formato para el módulo. | +| `symbol` | `"💠 "` | Una cadena de formato que se muestra antes del espacio de trabajo de terraform. | +| `style` | `"bold 105"` | El estilo del módulo. | +| `disabled` | `false` | Desactiva el módulo `terraform`. | + +### Variables + +| Variable | Ejemplo | Descripción | +| --------- | ------------- | ----------------------------------------- | +| version | `v0.12.24` | La versión de `terraform` | +| workspace | `por defecto` | El espacio de trabajo actual de terraform | +| symbol | | Refleja el valor de la opción `symbol` | +| style\* | | Refleja el valor de la opción `style` | + +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo + +### Ejemplo + +#### Con la versión + +```toml +# ~/.config/starship.toml + +[terraform] +format = "[🏎💨 $version$workspace]($style) " +``` + +#### Sin la versión + +```toml +# ~/.config/starship.toml + +[terraform] +format = "[🏎💨 $workspace]($style) " +``` + +## Time + +El módulo `time` muestra la hora **local** actual. El valor de configuración de `format` es usado por la caja de [`chrono`](https://crates.io/crates/chrono) para controlar cómo se muestra la hora. Echa un vistazo a [los documentos de chrono strftime](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) para ver qué opciones están disponibles. + +::: tip + +Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` a `false` en tu archivo de configuración. + +::: + +### Opciones + +| Opción | Por defecto | Descripción | +| ----------------- | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `format` | `"at [$time]($style) "` | La cadena de formato para el módulo. | +| `use_12hr` | `false` | Activa el formato de 12 horas | +| `time_format` | see below | La [cadena de formato de chrono](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) utilizada para formatear la hora. | +| `style` | `"bold yellow"` | El estilo para la hora del módulo | +| `utc_time_offset` | `"local"` | Establece el desplazamiento UTC a utilizar. Rango de -24 < x < 24. Permite a los flotantes acomodar los desplazamientos de zona horaria de 30/45 minutos. | +| `disabled` | `true` | Desactiva el módulo `time`. | +| `time_range` | `"-"` | Establece el intervalo de tiempo durante el cual se mostrará el módulo. Las horas deben especificarse en formato de 24 horas | + +Si `use_12hr` es `true`, entonces `time_format` por defecto `"%r"`. De lo contrario, el valor por defecto es `"%T"`. Configurar manualmente `time_format` sobrescribirá la configuración `use_12hr`. + +### Variables + +| Variable | Ejemplo | Descripción | +| --------- | ---------- | ------------------------------------- | +| time | `13:08:10` | La hora actual. | +| style\* | | Refleja el valor de la opción `style` | + +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo + +### Ejemplo + +```toml +# ~/.config/starship.toml + +[time] +disabled = false +format = '🕙[\[ $time \]]($style) ' +time_format = "%T" +utc_time_offset = "-5" +time_range = "10:00:00-14:00:00" +``` + +## Username + +El módulo `username` muestra el nombre de usuario activo. El módulo se muestra si algunas de las siguientes condiciones se cumplen: + +- El usuario actual es root +- El usuario actual no es el mismo que el que está conectado +- El usuario está actualmente conectado como una sesión SSH +- La variable `show_always` se establece en true + +### Opciones + +| Opción | Por defecto | Descripción | +| ------------- | ----------------------- | ------------------------------------------ | +| `style_root` | `"bold red"` | El estilo usado cuando el usuario es root. | +| `style_user` | `"bold yellow"` | El estilo usado para usuarios no root. | +| `format` | `"[$user]($style) in "` | El formato del módulo. | +| `show_always` | `false` | Siempre muestra el módulo `username`. | +| `disabled` | `false` | Desactiva el módulo `username`. | + +### Variables + +| Variable | Ejemplo | Descripción | +| -------- | ------------ | --------------------------------------------------------------------------------------------------- | +| `style` | `"red bold"` | Refleja el valor de la opción `style_root` cuando root inició sesión y `style_user` por otra parte. | +| `user` | `"matchai"` | El ID de usuario conectado actualmente. | + +### Ejemplo + +```toml +# ~/.config/starship.toml + +[username] +style_user = "white bold" +style_root = "black bold" +format = "user: [$user]($style) " +disabled = false +show_always = true +``` + +## Zig + +El módulo `zig` muestra la versión instalada de Zig. El módulo se muestra si algunas de las siguientes condiciones se cumplen: + +- El directorio actual contiene un archivo `.zig` + +### Opciones + +| Opción | Por defecto | Descripción | +| ---------- | ---------------------------------- | ---------------------------------------------------- | +| `symbol` | `"↯ "` | El símbolo usado antes de mostrar la versión de Zig. | +| `style` | `"bold yellow"` | El estilo del módulo. | +| `format` | `"via [$symbol$version]($style) "` | El formato del módulo. | +| `disabled` | `false` | Desactiva el módulo `zig`. | + +### Variables + +| Variable | Ejemplo | Descripción | +| --------- | -------- | -------------------------------------- | +| version | `v0.6.0` | La versión de `zig` | +| symbol | | Refleja el valor de la opción `symbol` | +| style\* | | Refleja el valor de la opción `style` | + +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo + +### Ejemplo + +```toml +# ~/.config/starship.toml + +[zig] +symbol = "⚡️ " +``` + +## Comandos personalizados + +Los módulos `personalizados` muestran la salida de algunos comandos arbitrarios. + +Estos módulos se mostrarán si se cumplen alguna de las siguientes condiciones: + +- El directorio actual contiene un archivo cuyo nombre está en `files` +- El directorio actual contiene un directorio cuyo nombre está en `directories` +- El directorio actual contiene un archivo cuya extensión está en `extensions` +- El comando `when` devuelve 0 + +::: tip + +Múltiples módulos personalizados pueden definirse usando una `.`. + +::: + +::: tip + +El orden en el que se muestran los módulos personalizados se puede establecer individualmente incluyendo `${custom.foo}` en el `format` de nivel superior (ya que incluye un punto, necesita usar `${...}`). Por defecto, el módulo `custom` simplemente mostrará todos los módulos personalizados en el orden en que fueron definidos. + +::: + +::: tip + +[El issue #1252](https://github.com/starship/starship/discussions/1252) contiene ejemplos de módulos personalizados. Si tiene un ejemplo interesante no cubierto allí, no dude en compartirlo allí! + +::: + +### Opciones + +| Opción | Por defecto | Descripción | +| ------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | +| `command` | | El comando cuya salida debe ser impresa. El comando se pasará en stdin al shell. | +| `when` | | Comando de shell usado como condición para mostrar el módulo. El módulo se mostrará si el comando devuelve un código de estado `0`. | +| `shell` | | [Ver abajo](#custom-command-shell) | +| `description` | `""` | La descripción del módulo que se muestra al ejecutar `starship explain`. | +| `files` | `[]` | Los archivos que se buscarán en el directorio de trabajo para obtener una coincidencia. | +| `directories` | `[]` | Los directorios que se buscarán en el directorio de trabajo para una coincidencia. | +| `extensions` | `[]` | Las extensiones que se buscarán en el directorio de trabajo para obtener una coincidencia. | +| `symbol` | `""` | El símbolo usado antes de mostrar la salida del comando. | +| `style` | `"bold green"` | El estilo del módulo. | +| `format` | `"[$symbol$output]($style) "` | El formato del módulo. | +| `disabled` | `false` | Desactiva este módulo `custom`. | + +### Variables + +| Variable | Descripción | +| --------- | ----------------------------------------- | +| output | La salida del comando de shell en `shell` | +| symbol | Refleja el valor de la opción `symbol` | +| style\* | Refleja el valor de la opción `style` | + +\*: Esta variable sólo puede ser usada como parte de una cadena de estilo + +#### Comando personalizado de shell + +`shell` acepta una lista no vacía de cadenas, donde: + +- La primera cadena es la ruta al intérprete de comandos a usar para ejecutar el comando. +- Otros argumentos siguientes que son pasados al shell. + +Si no está activado, se retornará a STARSHIP_SHELL y luego a "sh" en Linux, y "cmd /C" en Windows. + +El `comando` será pasado en stdin. + +Si no se da el `shell` o solo contiene un elemento y Starship detecta PowerShell los siguientes argumentos se añadirán automáticamente: `-NoProfile -Command -`. Este comportamiento puede evitarse pasando explícitamente argumentos al intérprete, p.ej. + +```toml +shell = ["pwsh", "-Command", "-"] +``` + +::: advertencia Asegúrate de que tu configuración personalizada de shell salga con éxito + +Si establece un comando personalizado, asegúrese de que el Shell por defecto usado por starship ejecutará correctamente el comando con una salida elgante (a través de la opción `shell`). + +Por ejemplo, PowerShell requiere el parámetro `-Command` para ejecutar una sola línea. Omitir este parámetro puede arrojar a starchip a un bucle recursivo donde el shell podría intentar cargar un entorno de perfil completo con starship en sí misma y volver a ejecutar el comando personalizado, entrando en un bucle infinito. + +Se recomiendan parámetros similares a `-NoProfile` en PowerShell para otros shells para evitar tiempo extra de carga de un perfil personalizado en cada invocación de starship. + +La detección automática de shells y la adición adecuada de parámetros están actualmente implementados, pero es posible que no todos los shells estén cubiertos. Por favor, [abre un issue](https://github.com/starship/starship/issues/new/choose) con los detalles del intérprete de comandos y la configuración de Starship si te encuentras en tal escenario. + +::: + +### Ejemplo + +```toml +# ~/.config/starship.toml + +[custom.foo] +command = "echo foo" # muestra la salida del comando +files = ["foo"] # se pueden especificar filtros +when = """ test "$HOME" == "$PWD" """ +format = " transcending [$output]($style)" + +[custom.time] +command = "time /T" +files = ["*.pst"] +shell = ["pwsh.exe", "-NoProfile", "-Command", "-"] +``` diff --git a/docs/es-ES/faq/README.md b/docs/es-ES/faq/README.md index 5f20cfb39..ad119ee9c 100644 --- a/docs/es-ES/faq/README.md +++ b/docs/es-ES/faq/README.md @@ -10,15 +10,15 @@ - **Configuración**: [archivos de configuración de matchai](https://github.com/matchai/dotfiles/blob/b6c6a701d0af8d145a8370288c00bb9f0648b5c2/.config/fish/config.fish) - **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 `.disabled` do the same thing? +## ¿`prompt_order` y `.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, `.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 ## 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. 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)" ``` @@ -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 ``` -## 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/). -- 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. -- You are using a [Nerd Font](https://www.nerdfonts.com/). +- 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/). +- 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. +- 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 echo -e "\xf0\x9f\x90\x8d" 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. Delete the Starship binary. +1. Elimina cualquier línea de tu configuración de shell (por ejemplo, `~/.bashrc`) usada para inicializar Starship. +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 -# Locate and delete the starship binary +# Localiza y elimina el binario de starship rm "$(which starship)" ``` diff --git a/docs/es-ES/guide/README.md b/docs/es-ES/guide/README.md index 5b30a9e5a..626ce5cf8 100644 --- a/docs/es-ES/guide/README.md +++ b/docs/es-ES/guide/README.md @@ -2,7 +2,7 @@ Starship - Prompt multi interfaz de línea de comandos + alt="Starship - Prompt multi intérprete de comandos" />

@@ -101,18 +101,18 @@ 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! 🚀 -- **Personalizable:** configura cada parte de tu intérprete de comandos. +- **Rápido:** es rápido – _realmente_ rápido! 🚀 +- **Personalizable:** configura cada parte de tu prompt. - **Universal:** funciona en cualquier intérprete de comandos, en cualquier sistema operativo. - **Inteligente:** muestra información relevante de un vistazo. - **Repleto de funciones**: con soporte para tus herramientas favoritas. - **Fácil:** rápido de instalar – empieza a usarlo en minutos.

-Explora la documentación de Starship   +Explora la documentación de Starship  ▶

@@ -125,13 +125,13 @@ ### Comenzar -1. Instala el binario de **starship**: +1. Instala el binario de **Starship**: #### Instalar la última versión - ##### Desde un binario precontruido, con Shell: + ##### Desde un binario preconstruido, con el intérprete de comandos: ```sh 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/): @@ -199,7 +199,7 @@ #### 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 Invoke-Expression (&starship init powershell) @@ -218,9 +218,9 @@ ## 🤝 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 @@ -252,13 +252,13 @@ Apoya este proyecto con tu organización. Su logo se mostrará aquí con un enla ## 💭 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/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.


diff --git a/docs/es-ES/migrating-to-0.45.0/README.md b/docs/es-ES/migrating-to-0.45.0/README.md index 7c6df24c4..23d1a4f13 100644 --- a/docs/es-ES/migrating-to-0.45.0/README.md +++ b/docs/es-ES/migrating-to-0.45.0/README.md @@ -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 prompt_order = [ @@ -31,7 +31,7 @@ prompt_order = [ ] ``` -**Example v0.45.0 configuration** +**Configuración de ejemplo v0.45.0** ```toml 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 [cmd_duration] -prefix = "took " +prefix = "tomó " ``` -**Example v0.45.0 configuration** +**Configuración de ejemplo v0.45.0** ```toml [cmd_duration] -# $duration – The command duration (e.g. "15s") -# $style – The default style of the module (e.g. "bold yellow") -format = "took [$duration]($style) " +# $duration – La duración del comando (p. ej. "15s") +# $style – El estilo predeterminado del módulo (p. ej. "bold yellow") +format = "tomó [$duration]($style) " ``` -### Affected Modules +### Módulos afectados #### Character -| Removed Property | Replacement | +| Propiedad eliminada | Reemplazo | | ----------------------- | ---------------- | | `symbol` | `success_symbol` | | `use_symbol_for_status` | `error_symbol` | | `style_success` | `success_symbol` | | `style_failure` | `error_symbol` | -**Changes to the Default Configuration** +**Cambios a la configuración por defecto** ```diff [character] @@ -98,26 +98,26 @@ format = "took [$duration]($style) " ++ 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 [character] 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 | -| ---------------- | ----------- | -| `prefix` | `format` | +| Propiedad eliminada | Reemplazo | +| ------------------- | --------- | +| `prefix` | `format` | -**Changes to the Default Configuration** +**Cambios a la configuración por defecto** ```diff [cmd_duration] @@ -127,11 +127,11 @@ error_symbol = "[✖](bold red)" #### Directory -| Removed Property | Replacement | -| ---------------- | ----------- | -| `prefix` | `format` | +| Propiedad eliminada | Reemplazo | +| ------------------- | --------- | +| `prefix` | `format` | -**Changes to the Default Configuration** +**Cambios a la configuración por defecto** ```diff [directory] @@ -141,12 +141,12 @@ error_symbol = "[✖](bold red)" #### Variable de entorno -| Removed Property | Replacement | -| ---------------- | ----------- | -| `prefix` | `format` | -| `suffix` | `format` | +| Propiedad eliminada | Reemplazo | +| ------------------- | --------- | +| `prefix` | `format` | +| `suffix` | `format` | -**Changes to the Default Configuration** +**Cambios a la configuración por defecto** ```diff [env_var] @@ -157,12 +157,12 @@ error_symbol = "[✖](bold red)" #### Git commit -| Removed Property | Replacement | -| ---------------- | ----------- | -| `prefix` | `format` | -| `suffix` | `format` | +| Propiedad eliminada | Reemplazo | +| ------------------- | --------- | +| `prefix` | `format` | +| `suffix` | `format` | -**Changes to the Default Configuration** +**Cambios a la configuración por defecto** ```diff [git_commit] @@ -173,13 +173,13 @@ error_symbol = "[✖](bold red)" #### Git status -| Removed Property | Replacement | -| ----------------- | ----------- | -| `prefix` | `format` | -| `suffix` | `format` | -| `show_sync_count` | `format` | +| Propiedad eliminada | Reemplazo | +| ------------------- | --------- | +| `prefix` | `format` | +| `suffix` | `format` | +| `show_sync_count` | `format` | -**Changes to the Default Configuration** +**Cambios a la configuración por defecto** ```diff [git_status] @@ -189,11 +189,11 @@ error_symbol = "[✖](bold red)" ++ 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 [git_status] @@ -204,12 +204,12 @@ behind = "⇣${count}" #### Hostname -| Removed Property | Replacement | -| ---------------- | ----------- | -| `prefix` | `format` | -| `suffix` | `format` | +| Propiedad eliminada | Reemplazo | +| ------------------- | --------- | +| `prefix` | `format` | +| `suffix` | `format` | -**Changes to the Default Configuration** +**Cambios a la configuración por defecto** ```diff [hostname] @@ -220,13 +220,13 @@ behind = "⇣${count}" #### Singularity -| Removed Property | Replacement | -| ---------------- | ----------- | -| `label` | `format` | -| `prefix` | `format` | -| `suffix` | `format` | +| Propiedad eliminada | Reemplazo | +| ------------------- | --------- | +| `label` | `format` | +| `prefix` | `format` | +| `suffix` | `format` | -**Changes to the Default Configuration** +**Cambios a la configuración por defecto** ```diff [singularity] @@ -237,11 +237,11 @@ behind = "⇣${count}" #### Hora -| Removed Property | Replacement | -| ---------------- | ------------- | -| `format` | `time_format` | +| Propiedad eliminada | Reemplazo | +| ------------------- | ------------- | +| `format` | `time_format` | -**Changes to the Default Configuration** +**Cambios a la configuración por defecto** ```diff [time] @@ -250,14 +250,14 @@ behind = "⇣${count}" ++ format = "at 🕙[$time]($style) " ``` -#### Custom Commands +#### Comandos Personalizados -| Removed Property | Replacement | -| ---------------- | ----------- | -| `prefix` | `format` | -| `suffix` | `format` | +| Propiedad eliminada | Reemplazo | +| ------------------- | --------- | +| `prefix` | `format` | +| `suffix` | `format` | -**Changes to the Default Configuration** +**Cambios a la configuración por defecto** ```diff [custom.example] diff --git a/docs/es-ES/presets/README.md b/docs/es-ES/presets/README.md index d470d36a6..31a5b75a5 100644 --- a/docs/es-ES/presets/README.md +++ b/docs/es-ES/presets/README.md @@ -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! 😊 -## 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! -![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 @@ -84,7 +84,7 @@ symbol = " " symbol = " " [rust] -symbol = " " +symbol = " " [swift] symbol = "ﯣ " diff --git a/docs/fr-FR/README.md b/docs/fr-FR/README.md index 25c588143..4e7f667ef 100644 --- a/docs/fr-FR/README.md +++ b/docs/fr-FR/README.md @@ -94,11 +94,9 @@ description: Starship est un invite minimaliste, ultra-rapide et hautement perso #### 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 - # ~\Documents\PowerShell\Profile.ps1 - Invoke-Expression (&starship init powershell) ``` diff --git a/docs/fr-FR/config/README.md b/docs/fr-FR/config/README.md index c105a0b53..97c3634cf 100644 --- a/docs/fr-FR/config/README.md +++ b/docs/fr-FR/config/README.md @@ -33,9 +33,9 @@ De manière équivalente, pour Powershell (Windows), ajoutez la ligne suivante $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 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 format = "$all" -# Which is equivalent to +# Ce qui est equivalent a: format = """ $username\ $hostname\ @@ -214,11 +214,13 @@ $conda\ $memory_usage\ $aws\ $gcloud\ +$openstack\ $env_var\ $crystal\ $cmd_duration\ $custom\ $line_break\ +$lua\ $jobs\ $battery\ $time\ @@ -426,16 +428,17 @@ vicmd_symbol = "[V](bold green) " ## 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 ` CMakeCache.txt` ### Options | Option | Default | Description | | ---------- | ---------------------------------- | --------------------------------------------- | | `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. | | `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 -| Option | Default | Description | -| ------------------- | ----------------------------- | ----------------------------------------------------------------- | -| `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. | -| `format` | `"took [$duration]($style) "` | Format du module. | -| `style` | `"bold yellow"` | Le style du module. | -| `disabled` | `false` | Désactive le module `cmd_duration`. | +| Option | Default | Description | +| -------------------- | ----------------------------- | ---------------------------------------------------------------------- | +| `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. | +| `format` | `"took [$duration]($style) "` | Format du module. | +| `style` | `"bold yellow"` | Le style du module. | +| `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 @@ -492,32 +503,32 @@ format = "underwent [$duration](bold yellow)" ## 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 -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 -| 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. | -| `symbol` | `"🅒 "` | The symbol used before the environment name. | -| `style` | `"bold green"` | Le style du module. | -| `format` | `"[$symbol$environment]($style) "` | Format du module. | -| `ignore_base` | `true` | Ignores `base` environment when activated. | -| `disabled` | `false` | Disables the `conda` module. | +| Option | Default | Description | +| ------------------- | ---------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `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` | `"🅒 "` | Le symbole utilisé avant le nom d'environnement. | +| `style` | `"bold green"` | Le style du module. | +| `format` | `"[$symbol$environment]($style) "` | Format du module. | +| `ignore_base` | `true` | Ignore l'environnement `base` lorsqu'il est activé. | +| `disabled` | `false` | Désactive le module `conda`. | ### Variables -| Variable | Exemple | Description | -| ----------- | ------------ | -------------------------------------- | -| environment | `astronauts` | The current conda environment | -| symbol | | Reflète la valeur de l'option `symbol` | -| style\* | | Reflète la valeur de l'option `style` | +| Variable | Exemple | Description | +| ------------- | ------------ | -------------------------------------- | +| environnement | `astronauts` | La version courante de conda | +| 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 @@ -532,26 +543,26 @@ format = "[$symbol$environment](dimmed green) " ## 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 -- The current directory contains a `.cr` file +- Le répertoire courant contient un fichier `shard.yml` +- Le répertoire courant contient un fichier `.cr` ### Options -| Option | Default | Description | -| ---------- | ---------------------------------- | --------------------------------------------------------- | -| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | -| `style` | `"bold green"` | Le style du module. | -| `format` | `"via [$symbol$version]($style) "` | Format du module. | -| `disabled` | `false` | Disables the `crystal` module. | +| Option | Default | Description | +| ---------- | ---------------------------------- | ---------------------------------------------------------- | +| `symbol` | `"🔮 "` | Le symbole utilisé avant d'afficher la version de crystal. | +| `style` | `"bold green"` | Le style du module. | +| `format` | `"via [$symbol$version]($style) "` | Format du module. | +| `disabled` | `false` | Désactive le module `crystal`. | ### Variables | Variable | Exemple | Description | | --------- | --------- | -------------------------------------- | -| version | `v0.32.1` | The version of `crystal` | -| symbol | | Reflète la valeur de l'option `symbol` | +| version | `v0.32.1` | La version de `cristal` | +| symbole | | 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 @@ -567,26 +578,26 @@ format = "via [✨ $version](bold blue) " ## 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 -- The current directory contains a `.dart_tool` directory -- The current directory contains a `pubspec.yaml` or `pubspec.lock` file +- Le répertoire courant contient un fichier `.dart` +- Le répertoire courant contient un répertoire `.dart_tool` +- Le répertoire courant contient un fichier `pubspec.yaml` ou `pubspec.lock` ### Options -| Option | Default | Description | -| ---------- | ---------------------------------- | ----------------------------------------------- | -| `format` | `"via [$symbol$version]($style) "` | Format du module. | -| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | -| `style` | `"bold blue"` | Le style du module. | -| `disabled` | `false` | Disables the `dart` module. | +| Option | Défaut | Description | +| ---------- | ---------------------------------- | -------------------------------------------------------- | +| `format` | `"via [$symbol$version]($style) "` | Format du module. | +| `symbol` | `"🎯 "` | Une chaîne de caractères représentant le symbole de Dart | +| `style` | `"bold blue"` | Le style du module. | +| `disabled` | `false` | Désactive le module `dart`. | ### Variables | 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` | | 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) " ``` -## 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. @@ -611,23 +622,23 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an ### Options -| Option | Défaut | Description | -| ------------------- | -------------------------------------------------- | -------------------------------------------------------------------------------- | -| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. | -| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. | -| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | Format du module. | -| `style` | `"bold cyan"` | Le style du module. | -| `disabled` | `false` | Disables the `directory` module. | -| `read_only` | `"🔒"` | The symbol indicating current directory is read only. | -| `read_only_style` | `"red"` | The style for the read only symbol. | -| `truncation_symbol` | `""` | The symbol to prefix to truncated paths. eg: "…/" | +| Option | Défaut | Description | +| ------------------- | -------------------------------------------------- | ------------------------------------------------------------------------------------- | +| `truncation_length` | `3` | Le nombre de dossiers parents selon lesquels le répertoire courant doit être tronqué. | +| `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. | +| `style` | `"bold cyan"` | Le style du module. | +| `disabled` | `false` | Désactive le module `directory`. | +| `read_only` | `"🔒"` | Le symbole indiquant que le répertoire courant est en lecture seule. | +| `read_only_style` | `"red"` | Le style du symbole en lecture seule. | +| `truncation_symbol` | `""` | Le symbole en préfixe aux chemins tronqués. eg: "…/" |

This module has a few advanced configuration options that control how the directory is displayed. -| 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. | | `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 | | --------- | --------------------- | ------------------------------------- | -| 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` | \* : 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. | | `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. | -| `disabled` | `true` | Disables the `docker_context` module. | +| `disabled` | `true` | Désactive le module `docker_context`. | ### Variables @@ -725,13 +736,13 @@ The module will also show the Target Framework Moniker ( ⚠️ 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 -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 `esy.lock` directory @@ -1707,9 +1713,89 @@ The `ocaml` module shows the currently installed version of OCaml. Le module est 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 -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 `cpanfile` or `cpanfile.snapshot` file @@ -1719,7 +1805,7 @@ The `perl` module shows the currently installed version of Perl. Le module est a ### Options -| Option | Default | Description | +| Option | Défaut | Description | | ---------- | ---------------------------------- | ----------------------------------------------------- | | `format` | `"via [$symbol$version]($style) "` | The format string for the module. | | `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | @@ -1745,7 +1831,7 @@ format = "via [🦪 $version]($style) " ## 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 `.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) " ``` +## 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 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`. -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 `requirements.txt` file @@ -1844,7 +1965,7 @@ python_binary = "python3" ## 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 `.ruby-version` file @@ -1880,7 +2001,7 @@ symbol = "🔺 " ## 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 file with the `.rs` extension @@ -1980,48 +2101,13 @@ The `singularity` module shows the current singularity image, if inside a contai 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 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 -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 @@ -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 -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 -- Current directory contains a file with the `.tf` extension +- Current directory contains a file with the `.tf` or `.hcl` extensions ### Options @@ -2105,33 +2226,33 @@ format = "[🏎💨 $workspace]($style) " ## 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 -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 -| Option | Défaut | Description | -| ----------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `format` | `"at [$time]($style) "` | The format string for the module. | -| `use_12hr` | `false` | Activer le format 12h | -| `time_format` | voir plus bas | Le [format chrono](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) utilisé pour formater l'heure. | -| `style` | `"bold yellow"` | Le style utilisé par le module | -| `utc_time_offset` | `"local"` | Définir le décalage horaire UTC à utiliser. Range from -24 < x < 24. Accepte des nombres décimaux pour s'adapter aux décalages de 30/45 minutes. | -| `disabled` | `true` | Désactiver le module `time`. | -| `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | +| Option | Défaut | Description | +| ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | +| `format` | `"at [$time]($style) "` | The format string for the module. | +| `use_12hr` | `false` | Enables 12 hour formatting | +| `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. | +| `style` | `"bold yellow"` | The style for the module time | +| `utc_time_offset` | `"local"` | Sets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. | +| `disabled` | `true` | Disables the `time` module. | +| `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | -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 | 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` | \* : 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" ``` -## 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 -- L'utilisateur courant est différent de celui connecté -- L'utilisateur est actuellement connecté à une session SSH -- La variable `show_always` a comme valeur true +- The current user is root +- The current user isn't the same as the one that is logged in +- The user is currently connected as an SSH session +- The variable `show_always` is set to true ### Options -| Option | Défaut | Description | -| ------------- | ----------------------- | ------------------------------------------------ | -| `style_root` | `"bold green"` | Le style utilisé quand l'utilisateur est root. | -| `style_user` | `"bold yellow"` | Le style utilisé pour les utilisateurs non-root. | -| `format` | `"[$user]($style) in "` | Format du module. | -| `show_always` | `false` | Toujours afficher le module `username`. | -| `disabled` | `false` | Désactiver le module `username`. | +| Option | Défaut | Description | +| ------------- | ----------------------- | ------------------------------------- | +| `style_root` | `"bold green"` | The style used when the user is root. | +| `style_user` | `"bold yellow"` | The style used for non-root users. | +| `format` | `"[$user]($style) in "` | Format du module. | +| `show_always` | `false` | Always shows the `username` module. | +| `disabled` | `false` | Disables the `username` module. | ### Variables @@ -2190,7 +2311,7 @@ show_always = true ## 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 @@ -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 -#### 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. 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"] 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)" -``` diff --git a/docs/fr-FR/guide/README.md b/docs/fr-FR/guide/README.md index be71605bb..fa88db879 100644 --- a/docs/fr-FR/guide/README.md +++ b/docs/fr-FR/guide/README.md @@ -199,7 +199,7 @@ #### 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 Invoke-Expression (&starship init powershell) diff --git a/docs/fr-FR/migrating-to-0.45.0/README.md b/docs/fr-FR/migrating-to-0.45.0/README.md index 68ca96659..5a49da9b6 100644 --- a/docs/fr-FR/migrating-to-0.45.0/README.md +++ b/docs/fr-FR/migrating-to-0.45.0/README.md @@ -125,7 +125,7 @@ error_symbol = "[✖](bold red)" ++ format = "took [$duration]($style) " ``` -#### Directory +#### Dossier | Removed Property | Replacement | | ---------------- | ----------- | diff --git a/docs/fr-FR/presets/README.md b/docs/fr-FR/presets/README.md index 1f019bb7b..1c85c010d 100644 --- a/docs/fr-FR/presets/README.md +++ b/docs/fr-FR/presets/README.md @@ -84,7 +84,7 @@ symbol = " " symbol = " " [rust] -symbol = " " +symbol = " " [swift] symbol = "ﯣ " diff --git a/docs/ja-JP/README.md b/docs/ja-JP/README.md index 7840f3056..756369d52 100644 --- a/docs/ja-JP/README.md +++ b/docs/ja-JP/README.md @@ -94,11 +94,9 @@ description: Starship はミニマルで、非常に高速で、カスタマイ #### 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 - # ~\Documents\PowerShell\Profile.ps1 - Invoke-Expression (&starship init powershell) ``` diff --git a/docs/ja-JP/config/README.md b/docs/ja-JP/config/README.md index e8a385ff1..ce96e2713 100644 --- a/docs/ja-JP/config/README.md +++ b/docs/ja-JP/config/README.md @@ -33,9 +33,9 @@ PowerShell (Windows) で同様に `$PROFILE`にこの行を追加します。 $ENV:STARSHIP_CONFIG = "$HOME\.starship" ``` -### Logging +### ロギング -By default starship logs warnings and errors into a file named `~/.cache/starship/session_${STARSHIP_SESSION_KEY}.log`, where the session key is corresponding to a instance of your terminal. This, however can be changed using the `STARSHIP_CACHE` environment variable: +デフォルトでは、Starship は警告やエラーログを `~/.cache/starship/session_${STARSHIP_SESSION_KEY}.log` という名前のファイルに出力します。このセッションキーはターミナルのインスタンスに相当します。しかし、これは `STARSHIP_CACHE` という環境変数を使って変更できます： しかし、これは `STARSHIP_CACHE` という環境変数を使って変更できます： ```sh export STARSHIP_CACHE=~/.starship/cache @@ -117,7 +117,7 @@ Starshipのほとんどのモジュールでは、表示スタイルを設定で - ( - ) -Note that `toml` has [its own escape syntax](https://github.com/toml-lang/toml#user-content-string). It is recommended to use a literal string (`''`) in your config. If you want to use a basic string (`""`), pay attention to escape the backslash `\`. +`toml` は [独自のエスケープ構文](https://github.com/toml-lang/toml#user-content-string) を持っていることに注意してください。 It is recommended to use a literal string (`''`) in your config. If you want to use a basic string (`""`), pay attention to escape the backslash `\`. For example, when you want to print a `$` symbol on a new line, the following configs for `format` are equivalent: @@ -215,11 +215,13 @@ $conda\ $memory_usage\ $aws\ $gcloud\ +$openstack\ $env_var\ $crystal\ $cmd_duration\ $custom\ $line_break\ +$lua\ $jobs\ $battery\ $time\ @@ -427,16 +429,17 @@ vicmd_symbol = "[V](bold green) " ## 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 `CMakeCache.txt` file ### オプション | オプション | デフォルト | 説明 | | ---------- | ---------------------------------- | -------------------------------------------- | | `format` | `"via [$symbol$version]($style) "` | moduleのフォーマットです。 | -| `symbol` | `"🛆 "` | The symbol used before the version of cmake. | +| `symbol` | `"喝 "` | The symbol used before the version of cmake. | | `style` | `"bold blue"` | モジュールのスタイルです。 | | `disabled` | `false` | Disables the `cmake` module. | @@ -464,13 +467,21 @@ preexecのような機能を必要とするBashユーザーは、 [rcalorasのba ### オプション -| オプション | デフォルト | 説明 | -| ------------------- | ----------------------------- | --------------------------- | -| `min_time` | `2_000` | 実行時間を表示する最短期間（ミリ秒単位）です。 | -| `show_milliseconds` | `false` | 実行時間の秒に加えてミリ秒を表示します。 | -| `format` | `"took [$duration]($style) "` | moduleのフォーマットです。 | -| `style` | `"bold yellow"` | モジュールのスタイルです。 | -| `disabled` | `false` | `cmd_duration`モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| -------------------- | ----------------------------- | ----------------------------------------------------- | +| `min_time` | `2_000` | 実行時間を表示する最短期間（ミリ秒単位）です。 | +| `show_milliseconds` | `false` | 実行時間の秒に加えてミリ秒を表示します。 | +| `format` | `"took [$duration]($style) "` | moduleのフォーマットです。 | +| `style` | `"bold yellow"` | モジュールのスタイルです。 | +| `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`. + +::: ### 変数 @@ -493,11 +504,11 @@ format = "underwent [$duration](bold yellow)" ## Conda -`$CONDA_DEFAULT_ENV`が設定されている場合、`conda`モジュールは現在のcondaの環境を表示します。 +The `conda` module shows the current conda environment, if `$CONDA_DEFAULT_ENV` is set. ::: tip -Note: これはconda自身の プロンプト修飾子 を抑制しません。`conda config --set changeps1 False` で実行することができます。 +This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. ::: @@ -533,7 +544,7 @@ format = "[$symbol$environment](dimmed green) " ## 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`ファイルが含まれている - カレントディレクトリに`.cr`の拡張子のファイルが含まれている @@ -568,7 +579,7 @@ format = "via [✨ $version](bold blue) " ## 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 `.dart_tool` directory @@ -604,11 +615,11 @@ format = "via [🔰 $version](bold red) " ## ディレクトリ -`directory`モジュールには、現在のディレクトリへのパスが表示され、3つの親フォルダは切り捨てられます。 ディレクトリは、現在の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`に設定されている場合を挙げます。 以前は`nixpkgs/pkgs`でしたが、`~/D/N/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`. ### オプション @@ -624,7 +635,7 @@ fishスタイルのpwdオプションを使用すると、切り捨てられた | `truncation_symbol` | `""` | The symbol to prefix to truncated paths. eg: "…/" |
-このモジュールは、どのようにディレクトリを表示するかについての高度なオプションをいくつか持っています。 +This module has a few advanced configuration options that control how the directory is displayed. | Advanced Option | デフォルト | 説明 | | --------------------------- | ------ | ------------------------------------------------ | @@ -665,7 +676,7 @@ truncation_symbol = "…/" ## Docker Context -`docker_context`モジュールは、 [Dockerコンテキスト](https://docs.docker.com/engine/context/working-with-contexts/)が`デフォルト`に設定されていない場合、現在アクティブな <1>Dockerコンテキストを表示します。 +The `docker_context` module shows the currently active [Docker context](https://docs.docker.com/engine/context/working-with-contexts/) if it's not set to `default`. ### オプション @@ -698,7 +709,7 @@ format = "via [🐋 $context](blue bold)" ## Dotnet -`dotnet` モジュールはカレントディレクトリに関係する.NET Core 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: @@ -714,7 +725,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. -内部的に、このモジュールは自身のバージョン検知のメカニズムを利用します。 `dotnet --version` を実行するより2倍速く実行できますが、.NET project一般的でないディレクトリlayoutの場合は間違ったバージョンが示されてしまうことがあります。 速度よりも精度が重要な場合は、次の方法でメカニズムを無効にできます。 モジュールオプションで`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 () when there is a csproj file in the current directory. @@ -752,7 +763,7 @@ heuristic = false ## 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`ファイルが含まれている. @@ -787,7 +798,7 @@ symbol = "🔮 " ## Elm -`elm`モジュールは、現在インストールされている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-package.json`ファイルが含まれている @@ -825,7 +836,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`オプションが定義されておらず、`default`オプションが定義されている @@ -862,7 +873,7 @@ default = "unknown shell" ## 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`ファイルが含まれている. - カレントディレクトリに`erlang.mk`ファイルが含まれている. @@ -871,7 +882,7 @@ The `erlang` module shows the currently installed version of Erlang/OTP. 次の | オプション | デフォルト | 説明 | | ---------- | ---------------------------------- | -------------------------------------------------------- | -| `symbol` | `"🖧 "` | The symbol used before displaying the version of erlang. | +| `symbol` | `" "` | The symbol used before displaying the version of erlang. | | `style` | `"bold red"` | モジュールのスタイルです。 | | `format` | `"via [$symbol$version]($style) "` | moduleのフォーマットです。 | | `disabled` | `false` | Disables the `erlang` module. | @@ -957,24 +968,27 @@ asia-northeast1 = "an1" ## Git ブランチ -`git_branch`モジュールは、現在のディレクトリにあるリポジトリのアクティブなブランチを表示します。 +The `git_branch` module shows the active branch of the repo in your current directory. ### オプション -| オプション | デフォルト | 説明 | -| ------------------- | -------------------------------- | --------------------------------------------------------------------- | -| `format` | `"on [$symbol$branch]($style) "` | moduleのフォーマットです。 Use `"$branch"` to refer to the current branch name. | -| `symbol` | `" "` | A format string representing the symbol of git branch. | -| `style` | `"bold purple"` | モジュールのスタイルです。 | -| `truncation_length` | `2^63 - 1` | Truncates a git branch to X graphemes. | -| `truncation_symbol` | `"…"` | ブランチ名切り捨てられていることを示すための記号です。 You can use `""` for no symbol. | -| `disabled` | `false` | `git_branch`モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| -------------------- | -------------------------------- | ------------------------------------------------------------------------------------ | +| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | +| `format` | `"on [$symbol$branch]($style) "` | moduleのフォーマットです。 Use `"$branch"` to refer to the current branch name. | +| `symbol` | `" "` | A format string representing the symbol of git branch. | +| `style` | `"bold purple"` | モジュールのスタイルです。 | +| `truncation_length` | `2^63 - 1` | Truncates a git branch to X graphemes. | +| `truncation_symbol` | `"…"` | ブランチ名切り捨てられていることを示すための記号です。 You can use `""` for no symbol. | +| `only_attached` | `false` | Only show the branch name when not in a detached HEAD state. | +| `disabled` | `false` | Disables the `git_branch` module. | ### 変数 | 変数 | 設定例 | 説明 | | --------- | -------- | ---------------------------------------------------------------------------------------------------- | | 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 | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | @@ -993,17 +1007,19 @@ truncation_symbol = "" ## Git コミット -`git_commit`モジュールは、現在のディレクトリにあるリポジトリの現在のコミットハッシュを表示します。 +The `git_commit` module shows the current commit hash and also the tag (if any) of the repo in your current directory. ### オプション -| オプション | デフォルト | 説明 | -| -------------------- | -------------------------- | -------------------------------------- | -| `commit_hash_length` | `7` | 表示されるgitコミットハッシュの長さです。 | -| `format` | `'[\($hash\)]($style) '` | moduleのフォーマットです。 | -| `style` | `"bold green"` | モジュールのスタイルです。 | -| `only_detached` | `true` | 切り離されたHEAD状態のときのみgit commit hashを表示します | -| `disabled` | `false` | `git_commit`モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| -------------------- | ------------------------------------------------------ | ------------------------------------------------- | +| `commit_hash_length` | `7` | 表示されるgitコミットハッシュの長さです。 | +| `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | moduleのフォーマットです。 | +| `style` | `"bold green"` | モジュールのスタイルです。 | +| `only_detached` | `true` | 切り離されたHEAD状態のときのみgit commit hashを表示します | +| `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. | ### 変数 @@ -1020,12 +1036,13 @@ truncation_symbol = "" # ~/.config/starship.toml [git_commit] -truncation_length = 4 +commit_hash_length = 4 +tag_symbol = "🔖 " ``` ## Git の進行状態 -`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. ### オプション @@ -1065,7 +1082,7 @@ cherry_pick = "[🍒 PICKING](bold red)" ## Git の状態 -`git_status`モジュールは、現在のディレクトリのリポジトリの状態を表すシンボルを表示します。 +The `git_status` module shows symbols representing the state of the repo in your current directory. ### オプション @@ -1148,7 +1165,7 @@ behind = "⇣${count}" ## 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.sum`ファイルが含まれている @@ -1189,7 +1206,7 @@ format = "via [🏎💨 $version](bold cyan) " ## 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`ファイルが含まれている - The current directory contains a `Chart.yaml` file @@ -1224,7 +1241,7 @@ format = "via [⎈ $version](bold white) " ## ホスト名 -`hostname`モジュールには、システムのホスト名が表示されます。 +The `hostname` module shows the system hostname. ### オプション @@ -1259,7 +1276,7 @@ disabled = false ## 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: - カレントディレクトリに `pom.xml`, `build.gradle.kts`, `build.sbt` ,もしくは`.java-version`が含まれている - カレントディレクトリに拡張子が`.java`, `.class`, `.gradle`, もしくは`.jar`のファイルが含まれている @@ -1294,7 +1311,7 @@ symbol = "🌟 " ## ジョブ -`jobs`モジュールには、実行中のジョブの現在の数が表示されます。 このモジュールは、実行中のバックグラウンドジョブがある場合にのみ表示されます。 1つ以上のジョブがある、または`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. ### オプション @@ -1328,7 +1345,7 @@ threshold = 4 ## Julia -`julia`モジュールは、現在インストールされているJuliaのバージョンを示します。 次の条件のいずれかが満たされると、モジュールが表示されます。 +The `julia` module shows the currently installed version of Julia. The module will be shown if any of the following conditions are met: - カレントディレクトリに`Project.toml`ファイルが含まれている - カレントディレクトリに`Manifest.toml`ファイルが含まれている @@ -1368,7 +1385,7 @@ Displays the current Kubernetes context name and, if set, the namespace from the ::: tip -このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで`disabled`を`false`に設定します。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -1407,7 +1424,7 @@ disabled = false ## 改行 -`line_break`モジュールは、プロンプトを2行に分割します。 +The `line_break` module separates the prompt into two lines. ### オプション @@ -1424,28 +1441,64 @@ disabled = false disabled = true ``` -## メモリ使用量 +## Lua -`memory_usageモジュールは、現在のシステムメモリとスワップ使用量を示します。

+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 -

::: tip

+### オプション -

このモジュールはデフォルトで無効になっています。 -有効にするには、設定ファイルでdisabled`を`false`に設定します。 +| オプション | デフォルト | 説明 | +| ------------ | ---------------------------------- | -------------------------------------------------------------------------- | +| `format` | `"via [$symbol$version]($style) "` | 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. | + +### 変数 + +| 変数 | 設定例 | 説明 | +| --------- | -------- | ---------------------- | +| version | `v5.4.0` | The version of `lua` | +| symbol | | オプション `記号` の値をミラーする | +| style\* | | オプション `style` の値をミラーする | + +\*: この変数はスタイル文字列の一部としてのみ使用できます + +### 設定例 + +```toml +# ~/.config/starship.toml + +[lua] +format = "via [🌕 $version](bold blue) " +``` + +## Memory Usage + +`memory_usage`モジュールは、現在のシステムメモリとスワップ使用量を示します。 + +デフォルトでは、システムスワップの合計がゼロ以外の場合、スワップ使用量が表示されます。 + +::: tip + +このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで`disabled`を`false`に設定します。 ::: ### オプション -| オプション | デフォルト | 説明 | -| ----------- | --------------------------------------------- | --------------------------- | -| `threshold` | `75` | この閾値を超えない限り、メモリ使用率は表示されません。 | -| `format` | `"via $symbol [${ram}( | ${swap})]($style) "` | moduleのフォーマットです。 | -| `symbol` | `"🐏"` | メモリ使用率を表示する前に使用される記号です。 | -| `style` | `"bold dimmed white"` | モジュールのスタイルです。 | -| `disabled` | `true` | `memory_usage`モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| ----------- | --------------------------------------------- | --------------------------------------------------- | +| `threshold` | `75` | この閾値を超えない限り、メモリ使用率は表示されません。 | +| `format` | `"via $symbol [${ram}( | ${swap})]($style) "` | moduleのフォーマットです。 | +| `symbol` | `"🐏"` | The symbol used before displaying the memory usage. | +| `style` | `"bold dimmed white"` | モジュールのスタイルです。 | +| `disabled` | `true` | Disables the `memory_usage` module. | ### 変数 @@ -1467,17 +1520,14 @@ disabled = true [memory_usage] disabled = false -show_percentage = true -show_swap = true threshold = -1 symbol = " " -separator = "/" style = "bold dimmed green" ``` -## Mercurial ブランチ +## Mercurial Branch -` hg_branch `モジュールは、現在のディレクトリにあるリポジトリのアクティブなブランチを示します。 +The `hg_branch` module shows the active branch of the repo in your current directory. ### オプション @@ -1513,9 +1563,9 @@ truncation_symbol = "" ## 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 `.nims` extension - The current directory contains a file with the `.nimble` extension @@ -1551,7 +1601,7 @@ symbol = "🎣 " ## Nix-shell -`nix_shell`モジュールは、nix-shell環境を示しています。 このモジュールは、nixシェル環境内にあるときに表示されます。 +The `nix_shell` module shows the nix-shell environment. The module will be shown when inside a nix-shell environment. ### オプション @@ -1562,7 +1612,7 @@ symbol = "🎣 " | `style` | `"bold blue"` | モジュールのスタイルです。 | | `impure_msg` | `"impure"` | A format string shown when the shell is impure. | | `pure_msg` | `"pure"` | A format string shown when the shell is pure. | -| `disabled` | `false` | `nix_shell`モジュールを無効にします。 | +| `disabled` | `false` | Disables the `nix_shell` module. | ### 変数 @@ -1589,11 +1639,11 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' ## 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 -- カレントディレクトリに`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 `.ts` extension @@ -1604,7 +1654,7 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' | `format` | `"via [$symbol$version]($style) "` | moduleのフォーマットです。 | | `symbol` | `"⬢ "` | A format string representing the symbol of NodeJS. | | `style` | `"bold green"` | モジュールのスタイルです。 | -| `disabled` | `false` | `nodejs`モジュールを無効にします。 | +| `disabled` | `false` | Disables the `nodejs` module. | ###  Variables @@ -1625,54 +1675,9 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' format = "via [🤖 $version](bold green) " ``` -## パッケージのバージョン - -`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** – `composer`パッケージバージョンは、現在のディレクトリにある`composer.json`から抽出されます -- **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 - -> ⚠️ 表示されるバージョンは、パッケージマネージャーではなく、ソースコードが現在のディレクトリにあるパッケージのバージョンです。 - -### オプション - -| オプション | デフォルト | 説明 | -| ----------------- | ---------------------------------- | --------------------------------------------------------- | -| `format` | `"via [$symbol$version]($style) "` | moduleのフォーマットです。 | -| `symbol` | `"📦 "` | パッケージのバージョンを表示する前に使用される記号です。 | -| `style` | `"bold 208"` | モジュールのスタイルです。 | -| `display_private` | `false` | Enable displaying version for packages marked as private. | -| `disabled` | `false` | `package` モジュールを無効にします。 | - -### 変数 - -| 変数 | 設定例 | 説明 | -| --------- | -------- | --------------------------- | -| version | `v1.0.0` | The version of your package | -| symbol | | オプション `記号` の値をミラーする | -| style\* | | オプション `style` の値をミラーする | - -\*: この変数はスタイル文字列の一部としてのみ使用できます - -### 設定例 - -```toml -# ~/.config/starship.toml - -[package] -format = "via [🎁 $version](208 bold) " -``` - ## 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 `esy.lock` directory @@ -1709,9 +1714,89 @@ The `ocaml` module shows the currently installed version of 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. + +### オプション + +| オプション | デフォルト | 説明 | +| ---------- | --------------------------------------------------- | -------------------------------------------------------------- | +| `format` | `"on [$symbol$cloud(\\($project\\))]($style) "` | moduleのフォーマットです。 | +| `symbol` | `"☁️ "` | The symbol used before displaying the current OpenStack cloud. | +| `style` | `"bold yellow"` | モジュールのスタイルです。 | +| `disabled` | `false` | Disables the `OpenStack` module. | + +### 変数 + +| 変数 | 設定例 | 説明 | +| --------- | ------ | ----------------------------- | +| cloud | `corp` | The current OpenStack cloud | +| project | `dev` | The current OpenStack project | +| symbol | | オプション `記号` の値をミラーする | +| style\* | | オプション `style` の値をミラーする | + +\*: この変数はスタイル文字列の一部としてのみ使用できます + +### 設定例 + +```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 + +> ⚠️ 表示されるバージョンは、パッケージマネージャーではなく、ソースコードが現在のディレクトリにあるパッケージのバージョンです。 + +### オプション + +| オプション | デフォルト | 説明 | +| ----------------- | ---------------------------------- | ---------------------------------------------------------- | +| `format` | `"via [$symbol$version]($style) "` | 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. | + +### 変数 + +| 変数 | 設定例 | 説明 | +| --------- | -------- | --------------------------- | +| version | `v1.0.0` | The version of your package | +| symbol | | オプション `記号` の値をミラーする | +| style\* | | オプション `style` の値をミラーする | + +\*: この変数はスタイル文字列の一部としてのみ使用できます + +### 設定例 + +```toml +# ~/.config/starship.toml + +[package] +format = "via [🎁 $version](208 bold) " +``` + ## 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 `cpanfile` or `cpanfile.snapshot` file @@ -1747,20 +1832,20 @@ format = "via [🦪 $version]($style) " ## PHP -`php`モジュールは、現在インストールされている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 -- カレントディレクトリに`.php`の拡張子のファイルが含まれている +- The current directory contains a `.php` file ### オプション -| オプション | デフォルト | 説明 | -| ---------- | ---------------------------------- | -------------------------- | -| `format` | `"via [$symbol$version]($style) "` | moduleのフォーマットです。 | -| `symbol` | `"🐘 "` | PHPのバージョンを表示する前に使用される記号です。 | -| `style` | `"147 bold"` | モジュールのスタイルです。 | -| `disabled` | `false` | `php`モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| ---------- | ---------------------------------- | ----------------------------------------------------- | +| `format` | `"via [$symbol$version]($style) "` | moduleのフォーマットです。 | +| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | +| `style` | `"147 bold"` | モジュールのスタイルです。 | +| `disabled` | `false` | Disables the `php` module. | ### 変数 @@ -1781,23 +1866,58 @@ format = "via [🦪 $version]($style) " 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 + +### オプション + +| オプション | デフォルト | 説明 | +| ---------- | ---------------------------------- | ------------------------------------------------------------ | +| `format` | `"via [$symbol$version]($style) "` | moduleのフォーマットです。 | +| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | +| `style` | `"bold white"` | モジュールのスタイルです。 | +| `disabled` | `false` | Disables the `purescript` module. | + +### 変数 + +| 変数 | 設定例 | 説明 | +| --------- | -------- | --------------------------- | +| version | `0.13.5` | The version of `purescript` | +| symbol | | オプション `記号` の値をミラーする | +| style\* | | オプション `style` の値をミラーする | + +\*: この変数はスタイル文字列の一部としてのみ使用できます + +### 設定例 + +```toml +# ~/.config/starship.toml + +[purescript] +format = "via [$symbol$version](bold white)" +``` + ## Python -The `python` module shows the currently installed version of Python and the current Python virtual environment if one is activated. +`python` モジュールは現在インストールされているPythonのバージョンと アクティブ化されている場合は現在のPython仮想環境を表示します。 If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. -次の条件のいずれかが満たされると、モジュールが表示されます。 +The module will be shown if any of the following conditions are met: -- カレントディレクトリに`.python-version`ファイルが含まれている -- カレントディレクトリに`requirements.txt`ファイルが含まれている -- カレントディレクトリに`pyproject.toml`ファイルが含まれている +- The current directory contains a `.python-version` file +- The current directory contains a `requirements.txt` file +- The current directory contains a `pyproject.toml` file - The current directory contains a file with the `.py` extension (and `scan_for_pyfiles` is true) -- カレントディレクトリに`Pipfile`ファイルが含まれている -- カレントディレクトリに`tox.ini`ファイルが含まれている -- カレントディレクトリに`setup.py`ファイルが含まれている +- The current directory contains a `Pipfile` file +- The current directory contains a `tox.ini` file +- The current directory contains a `setup.py` file - The current directory contains a `__init__.py` file -- 仮想環境がアクティブである +- A virtual environment is currently activated ### オプション @@ -1806,11 +1926,11 @@ If `pyenv_version_name` is set to `true`, it will display the pyenv version name | `format` | `'via [${symbol}${pyenv_prefix}${version}( \($virtualenv\))]($style) '` | moduleのフォーマットです。 | | `symbol` | `"🐍 "` | A format string representing the symbol of Python | | `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 | | `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. | -| `disabled` | `false` | `python`モジュールを無効にします。 | +| `disabled` | `false` | Disables the `python` module. | ### 変数 @@ -1846,11 +1966,11 @@ python_binary = "python3" ## 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 -- カレントディレクトリに`.rb`の拡張子のファイルが含まれている +- The current directory contains a `.rb` file ### オプション @@ -1859,7 +1979,7 @@ python_binary = "python3" | `format` | `"via [$symbol$version]($style) "` | moduleのフォーマットです。 | | `symbol` | `"💎 "` | A format string representing the symbol of Ruby. | | `style` | `"bold red"` | モジュールのスタイルです。 | -| `disabled` | `false` | `ruby`モジュールを無効にします。 | +| `disabled` | `false` | Disables the `ruby` module. | ### 変数 @@ -1882,10 +2002,10 @@ symbol = "🔺 " ## 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`ファイルが含まれている -- カレントディレクトリに`.rs`の拡張子のファイルが含まれている +- The current directory contains a `Cargo.toml` file +- The current directory contains a file with the `.rs` extension ### オプション @@ -1894,7 +2014,7 @@ symbol = "🔺 " | `format` | `"via [$symbol$version]($style) "` | moduleのフォーマットです。 | | `symbol` | `"🦀 "` | A format string representing the symbol of Rust | | `style` | `"bold red"` | モジュールのスタイルです。 | -| `disabled` | `false` | `rust`モジュールを無効にします。 | +| `disabled` | `false` | Disables the `rust` module. | ### 変数 @@ -1982,48 +2102,13 @@ The `singularity` module shows the current singularity image, if inside a contai 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 - -### オプション - -| オプション | デフォルト | 説明 | -| ---------- | ---------------------------------- | ------------------------------------------------ | -| `format` | `"via [$symbol$version]($style) "` | moduleのフォーマットです。 | -| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | -| `style` | `"bold 202"` | モジュールのスタイルです。 | -| `disabled` | `false` | Disables the `swift` module. | - -### 変数 - -| 変数 | 設定例 | 説明 | -| --------- | -------- | ---------------------- | -| version | `v5.2.4` | The version of `swift` | -| symbol | | オプション `記号` の値をミラーする | -| style\* | | オプション `style` の値をミラーする | - -\*: この変数はスタイル文字列の一部としてのみ使用できます - -### 設定例 - -```toml -# ~/.config/starship.toml - -[swift] -format = "via [🏎 $version](red bold)" -``` - ## 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`. ::: tip -このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで`disabled`を`false`に設定します。 ::: +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### オプション @@ -2058,12 +2143,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 + +### オプション + +| オプション | デフォルト | 説明 | +| ---------- | ---------------------------------- | ------------------------------------------------ | +| `format` | `"via [$symbol$version]($style) "` | moduleのフォーマットです。 | +| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | +| `style` | `"bold 202"` | モジュールのスタイルです。 | +| `disabled` | `false` | Disables the `swift` module. | + +### 変数 + +| 変数 | 設定例 | 説明 | +| --------- | -------- | ---------------------- | +| version | `v5.2.4` | The version of `swift` | +| symbol | | オプション `記号` の値をミラーする | +| style\* | | オプション `style` の値をミラーする | + +\*: この変数はスタイル文字列の一部としてのみ使用できます + +### 設定例 + +```toml +# ~/.config/starship.toml + +[swift] +format = "via [🏎 $version](red bold)" +``` + ## Terraform -`terraform`モジュールには、現在選択されているterraformワークスペースとバージョンが表示されます。 デフォルトでは、Terraformのバージョンは表示されません。これは、多くのプラグインが使用されている場合、Terraformの現在のバージョンでは遅いためです。 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: -- カレントディレクトリに`.terraform`フォルダが含まれている -- カレントディレクトリに`.tf`の拡張子のファイルが含まれている +- The current directory contains a `.terraform` folder +- Current directory contains a file with the `.tf` or `.hcl` extensions ### オプション @@ -2072,7 +2192,7 @@ disabled = false | `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | | `symbol` | `"💠 "` | A format string shown before the terraform workspace. | | `style` | `"bold 105"` | モジュールのスタイルです。 | -| `disabled` | `false` | `terraform`モジュールを無効にします。 | +| `disabled` | `false` | Disables the `terraform` module. | ### 変数 @@ -2107,33 +2227,33 @@ format = "[🏎💨 $workspace]($style) " ## Time -`time`モジュールは、現在の**現地**時間を示します。 `format`設定は、時間の表示方法を制御するために[`chrono`](https://crates.io/crates/chrono)クレートによって使用されます。 使用可能なオプションを確認するには、[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 -このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで`disabled`を`false`に設定します。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### オプション -| オプション | デフォルト | 説明 | -| ----------------- | ----------------------- | ----------------------------------------------------------------------------------------------------- | -| `format` | `"at [$time]($style) "` | The format string for the module. | -| `use_12hr` | `false` | 12時間のフォーマットを有効にします。 | -| `time_format` | この表の下を参照してください | 時刻のフォーマットに使用される[クロノフォーマット文字列](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) です。 | -| `style` | `"bold yellow"` | モジュールのスタイルです。 | -| `utc_time_offset` | `"local"` | 使用するUTCオフセットを設定します。 Range from -24 < x < 24. フロートが30/45分のタイムゾーンオフセットに対応できるようにします。 | -| `disabled` | `true` | `time`モジュールを無効にします。 | -| `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | +| オプション | デフォルト | 説明 | +| ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | +| `format` | `"at [$time]($style) "` | The format string for the module. | +| `use_12hr` | `false` | Enables 12 hour formatting | +| `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. | +| `style` | `"bold yellow"` | The style for the module time | +| `utc_time_offset` | `"local"` | Sets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. | +| `disabled` | `true` | Disables the `time` module. | +| `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | -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. ### 変数 | 変数 | 設定例 | 説明 | | --------- | ---------- | ---------------------- | -| 時刻 | `13:08:10` | The current time. | +| time | `13:08:10` | The current time. | | style\* | | オプション `style` の値をミラーする | \*: この変数はスタイル文字列の一部としてのみ使用できます @@ -2151,24 +2271,24 @@ utc_time_offset = "-5" 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 -- カレントユーザーが、ログインしているユーザーとは異なる -- ユーザーがSSHセッションとして接続されている -- `show_always`変数がtrueに設定されている +- The current user is root +- The current user isn't the same as the one that is logged in +- The user is currently connected as an SSH session +- The variable `show_always` is set to true ### オプション -| オプション | デフォルト | 説明 | -| ------------- | ----------------------- | ------------------------- | -| `style_root` | `"bold red"` | ユーザーがrootのときに使用されるスタイルです。 | -| `style_user` | `"bold yellow"` | 非rootユーザーに使用されるスタイルです。 | -| `format` | `"[$user]($style) in "` | moduleのフォーマットです。 | -| `show_always` | `false` | `username` モジュールを常に表示します。 | -| `disabled` | `false` | `username` モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| ------------- | ----------------------- | ------------------------------------- | +| `style_root` | `"bold red"` | The style used when the user is root. | +| `style_user` | `"bold yellow"` | The style used for non-root users. | +| `format` | `"[$user]($style) in "` | moduleのフォーマットです。 | +| `show_always` | `false` | Always shows the `username` module. | +| `disabled` | `false` | Disables the `username` module. | ### 変数 @@ -2192,7 +2312,7 @@ show_always = true ## 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 @@ -2259,8 +2379,8 @@ The order in which custom modules are shown can be individually set by including | ------------- | ----------------------------- | -------------------------------------------------------------------------------------------------------------------------- | | `command` | | The command whose output should be printed. The command will be passed on stdin to the shell. | | `when` | | A shell command used as a condition to show the module. The module will be shown if the command returns a `0` status code. | -| `shell` | | [この表の下を参照してください](#custom-command-shell) | -| `説明` | `""` | The description of the module that is shown when running `starship explain`. | +| `shell` | | [See below](#custom-command-shell) | +| `description` | `""` | The description of the module that is shown when running `starship explain`. | | `files` | `[]` | The files that will be searched in the working directory for a match. | | `directories` | `[]` | The directories that will be searched in the working directory for a match. | | `extensions` | `[]` | The extensions that will be searched in the working directory for a match. | @@ -2324,38 +2444,3 @@ command = "time /T" files = ["*.pst"] 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 - -### オプション - -| オプション | デフォルト | 説明 | -| ---------- | ---------------------------------- | ------------------------------------------------------------ | -| `format` | `"via [$symbol$version]($style) "` | moduleのフォーマットです。 | -| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | -| `style` | `"bold white"` | モジュールのスタイルです。 | -| `disabled` | `false` | Disables the `purescript` module. | - -### 変数 - -| 変数 | 設定例 | 説明 | -| --------- | -------- | --------------------------- | -| version | `0.13.5` | The version of `purescript` | -| symbol | | オプション `記号` の値をミラーする | -| style\* | | オプション `style` の値をミラーする | - -\*: この変数はスタイル文字列の一部としてのみ使用できます - -### 設定例 - -```toml -# ~/.config/starship.toml - -[purescript] -format = "via [$symbol$version](bold white)" -``` diff --git a/docs/ja-JP/guide/README.md b/docs/ja-JP/guide/README.md index b2077a2a0..f89793290 100644 --- a/docs/ja-JP/guide/README.md +++ b/docs/ja-JP/guide/README.md @@ -199,7 +199,7 @@ #### 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 Invoke-Expression (&starship init powershell) diff --git a/docs/ja-JP/presets/README.md b/docs/ja-JP/presets/README.md index e2543292b..1adc1d4d0 100644 --- a/docs/ja-JP/presets/README.md +++ b/docs/ja-JP/presets/README.md @@ -84,7 +84,7 @@ symbol = " " symbol = " " [rust] -symbol = " " +symbol = " " [swift] symbol = "ﯣ " diff --git a/docs/pt-BR/README.md b/docs/pt-BR/README.md index a68fa66e8..24226b348 100644 --- a/docs/pt-BR/README.md +++ b/docs/pt-BR/README.md @@ -94,11 +94,9 @@ description: O Starship é o prompt minimalista, extremamente rápido e extremam #### 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 - # ~\Documents\PowerShell\Profile.ps1 - Invoke-Expression (&starship init powershell) ``` diff --git a/docs/pt-BR/config/README.md b/docs/pt-BR/config/README.md index 57fd9c8d3..3a9e08df6 100644 --- a/docs/pt-BR/config/README.md +++ b/docs/pt-BR/config/README.md @@ -214,11 +214,13 @@ $conda\ $memory_usage\ $aws\ $gcloud\ +$openstack\ $env_var\ $crystal\ $cmd_duration\ $custom\ $line_break\ +$lua\ $jobs\ $battery\ $time\ @@ -426,16 +428,17 @@ vicmd_symbol = "[V](bold green) " ## 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 `CMakeCache.txt` file ### Opções | Option | Padrão | Descrição | | ---------- | ---------------------------------- | -------------------------------------------- | | `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. | | `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 -| Option | Padrão | Descrição | -| ------------------- | ----------------------------- | ---------------------------------------------------------- | -| `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). | -| `show_milliseconds` | `false` | Show milliseconds in addition to seconds for the duration. | -| `format` | `"took [$duration]($style) "` | The format for the module. | -| `style` | `"bold yellow"` | O estilo do módulo. | -| `disabled` | `false` | Disables the `cmd_duration` module. | +| Option | Padrão | Descrição | +| -------------------- | ----------------------------- | ---------------------------------------------------------- | +| `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). | +| `show_milliseconds` | `false` | Show milliseconds in addition to seconds for the duration. | +| `format` | `"took [$duration]($style) "` | The format for the module. | +| `style` | `"bold yellow"` | O estilo do módulo. | +| `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 @@ -870,7 +881,7 @@ The `erlang` module shows the currently installed version of Erlang/OTP. The mod | 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. | | `format` | `"via [$symbol$version]($style) "` | The format for the 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 -| Option | Padrão | Descrição | -| ------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | -| `format` | `"on [$symbol$branch]($style) "` | The format for the module. Use `"$branch"` to refer to the current branch name. | -| `symbol` | `" "` | A format string representing the symbol of git branch. | -| `style` | `"bold purple"` | O estilo do módulo. | -| `truncation_length` | `2^63 - 1` | Truncates a git branch to X graphemes. | -| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. | -| `disabled` | `false` | Disables the `git_branch` module. | +| Option | Padrão | Descrição | +| -------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | +| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | +| `format` | `"on [$symbol$branch]($style) "` | The format for the module. Use `"$branch"` to refer to the current branch name. | +| `symbol` | `" "` | A format string representing the symbol of git branch. | +| `style` | `"bold purple"` | O estilo do módulo. | +| `truncation_length` | `2^63 - 1` | Truncates a git branch to X graphemes. | +| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. | +| `only_attached` | `false` | Only show the branch name when not in a detached HEAD state. | +| `disabled` | `false` | Disables the `git_branch` module. | ### Variables | 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). | +| remote | `master` | The remote branch name. | | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | @@ -992,17 +1006,19 @@ truncation_symbol = "" ## 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 -| Option | Padrão | Descrição | -| -------------------- | -------------------------- | ----------------------------------------------------- | -| `commit_hash_length` | `7` | The length of the displayed git commit hash. | -| `format` | `'[\($hash\)]($style) '` | The format for the module. | -| `style` | `"bold green"` | O estilo do módulo. | -| `only_detached` | `true` | Only show git commit hash when in detached HEAD state | -| `disabled` | `false` | Disables the `git_commit` module. | +| Option | Padrão | Descrição | +| -------------------- | ------------------------------------------------------ | ----------------------------------------------------- | +| `commit_hash_length` | `7` | The length of the displayed git commit hash. | +| `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | The format for the module. | +| `style` | `"bold green"` | O estilo do módulo. | +| `only_detached` | `true` | Only show git commit hash when in detached HEAD state | +| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. | +| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown | +| `disabled` | `false` | Disables the `git_commit` module. | ### Variables @@ -1020,6 +1036,7 @@ The `git_commit` module shows the current commit hash of the repo in your curren [git_commit] commit_hash_length = 4 +tag_symbol = "🔖 " ``` ## Git State @@ -1423,7 +1440,44 @@ The `line_break` module separates the prompt into two lines. 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. @@ -1465,11 +1519,8 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y [memory_usage] disabled = false -show_percentage = true -show_swap = true threshold = -1 symbol = " " -separator = "/" 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) " ``` +## 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 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) " ``` -## 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 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) " ``` +## 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 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) ' ``` -## 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 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 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 -- Current directory contains a file with the `.tf` extension +- Current directory contains a file with the `.tf` or `.hcl` extensions ### 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. | | `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) | -| `descrição` | `""` | The description of the module that is shown when running `starship explain`. | +| `description` | `""` | The description of the module that is shown when running `starship explain`. | | `files` | `[]` | The files that will be searched in the working directory for a match. | | `directories` | `[]` | The directories that will be searched in the working directory for a match. | | `extensions` | `[]` | The extensions that will be searched in the working directory for a match. | @@ -2322,38 +2443,3 @@ command = "time /T" files = ["*.pst"] 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)" -``` diff --git a/docs/pt-BR/guide/README.md b/docs/pt-BR/guide/README.md index 8e8a7a5b1..cab6216c9 100644 --- a/docs/pt-BR/guide/README.md +++ b/docs/pt-BR/guide/README.md @@ -199,7 +199,7 @@ #### 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 Invoke-Expression (&starship init powershell) diff --git a/docs/pt-BR/presets/README.md b/docs/pt-BR/presets/README.md index a011494c7..94e98e602 100644 --- a/docs/pt-BR/presets/README.md +++ b/docs/pt-BR/presets/README.md @@ -84,7 +84,7 @@ symbol = " " symbol = " " [rust] -symbol = " " +symbol = " " [swift] symbol = "ﯣ " diff --git a/docs/pt-PT/README.md b/docs/pt-PT/README.md index 048607956..4767ca0b1 100644 --- a/docs/pt-PT/README.md +++ b/docs/pt-PT/README.md @@ -94,11 +94,9 @@ description: Starship is the minimal, blazing fast, and extremely customizable p #### 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 - # ~\Documents\PowerShell\Profile.ps1 - Invoke-Expression (&starship init powershell) ``` diff --git a/docs/pt-PT/config/README.md b/docs/pt-PT/config/README.md index baea1310a..03a9619bb 100644 --- a/docs/pt-PT/config/README.md +++ b/docs/pt-PT/config/README.md @@ -214,11 +214,13 @@ $conda\ $memory_usage\ $aws\ $gcloud\ +$openstack\ $env_var\ $crystal\ $cmd_duration\ $custom\ $line_break\ +$lua\ $jobs\ $battery\ $time\ @@ -426,16 +428,17 @@ vicmd_symbol = "[V](bold green) " ## 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 `CMakeCache.txt` file ### Options | Option | Default | Description | | ---------- | ---------------------------------- | -------------------------------------------- | | `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. | | `disabled` | `false` | Disables the `cmake` module. | @@ -463,13 +466,21 @@ Bash users who need preexec-like functionality can use [rcaloras's bash_preexec ### Options -| Option | Default | Description | -| ------------------- | ----------------------------- | ---------------------------------------------------------- | -| `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). | -| `show_milliseconds` | `false` | Show milliseconds in addition to seconds for the duration. | -| `format` | `"took [$duration]($style) "` | The format for the module. | -| `style` | `"bold yellow"` | The style for the module. | -| `disabled` | `false` | Disables the `cmd_duration` module. | +| Option | Default | Description | +| -------------------- | ----------------------------- | ---------------------------------------------------------- | +| `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). | +| `show_milliseconds` | `false` | Show milliseconds in addition to seconds for the duration. | +| `format` | `"took [$duration]($style) "` | The format for the module. | +| `style` | `"bold yellow"` | The style for the 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 @@ -870,7 +881,7 @@ The `erlang` module shows the currently installed version of Erlang/OTP. The mod | 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. | | `format` | `"via [$symbol$version]($style) "` | The format for the 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 -| Option | Default | Description | -| ------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | -| `format` | `"on [$symbol$branch]($style) "` | The format for the module. Use `"$branch"` to refer to the current branch name. | -| `symbol` | `" "` | A format string representing the symbol of git branch. | -| `style` | `"bold purple"` | The style for the module. | -| `truncation_length` | `2^63 - 1` | Truncates a git branch to X graphemes. | -| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. | -| `disabled` | `false` | Disables the `git_branch` module. | +| Option | Default | Description | +| -------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | +| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | +| `format` | `"on [$symbol$branch]($style) "` | The format for the module. Use `"$branch"` to refer to the current branch name. | +| `symbol` | `" "` | A format string representing the symbol of git branch. | +| `style` | `"bold purple"` | The style for the module. | +| `truncation_length` | `2^63 - 1` | Truncates a git branch to X graphemes. | +| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. | +| `only_attached` | `false` | Only show the branch name when not in a detached HEAD state. | +| `disabled` | `false` | Disables the `git_branch` module. | ### Variables | Variable | Example | Description | | --------- | -------- | ---------------------------------------------------------------------------------------------------- | | 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` | | style\* | | Mirrors the value of option `style` | @@ -992,17 +1006,19 @@ truncation_symbol = "" ## 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 -| Option | Default | Description | -| -------------------- | -------------------------- | ----------------------------------------------------- | -| `commit_hash_length` | `7` | The length of the displayed git commit hash. | -| `format` | `'[\($hash\)]($style) '` | The format for the module. | -| `style` | `"bold green"` | The style for the module. | -| `only_detached` | `true` | Only show git commit hash when in detached HEAD state | -| `disabled` | `false` | Disables the `git_commit` module. | +| Option | Default | Description | +| -------------------- | ------------------------------------------------------ | ----------------------------------------------------- | +| `commit_hash_length` | `7` | The length of the displayed git commit hash. | +| `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | The format for the module. | +| `style` | `"bold green"` | The style for the module. | +| `only_detached` | `true` | Only show git commit hash when in detached HEAD state | +| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. | +| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown | +| `disabled` | `false` | Disables the `git_commit` module. | ### Variables @@ -1020,6 +1036,7 @@ The `git_commit` module shows the current commit hash of the repo in your curren [git_commit] commit_hash_length = 4 +tag_symbol = "🔖 " ``` ## Git State @@ -1423,6 +1440,43 @@ The `line_break` module separates the prompt into two lines. 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 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] disabled = false -show_percentage = true -show_swap = true threshold = -1 symbol = " " -separator = "/" 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) " ``` +## 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 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) " ``` -## 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 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) " ``` +## 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 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) ' ``` -## 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 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 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 -- Current directory contains a file with the `.tf` extension +- Current directory contains a file with the `.tf` or `.hcl` extensions ### Options @@ -2322,38 +2443,3 @@ command = "time /T" files = ["*.pst"] 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)" -``` diff --git a/docs/pt-PT/guide/README.md b/docs/pt-PT/guide/README.md index 8b96c6804..6134aa2a9 100644 --- a/docs/pt-PT/guide/README.md +++ b/docs/pt-PT/guide/README.md @@ -199,7 +199,7 @@ #### 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 Invoke-Expression (&starship init powershell) diff --git a/docs/pt-PT/presets/README.md b/docs/pt-PT/presets/README.md index b76230197..1476c0b43 100644 --- a/docs/pt-PT/presets/README.md +++ b/docs/pt-PT/presets/README.md @@ -84,7 +84,7 @@ symbol = " " symbol = " " [rust] -symbol = " " +symbol = " " [swift] symbol = "ﯣ " diff --git a/docs/ru-RU/README.md b/docs/ru-RU/README.md index a563958c8..04a39dae0 100644 --- a/docs/ru-RU/README.md +++ b/docs/ru-RU/README.md @@ -2,7 +2,7 @@ home: true heroImage: /logo.svg heroText: -tagline: Минимальная, быстрая и бесконечная настраиваемая командная строка для любой оболочки! +tagline: Минималистичная, быстрая и бесконечно настраиваемая командная строка для любой оболочки! actionText: Начало работы → actionLink: ./guide/ features: @@ -11,10 +11,10 @@ features: details: Работает на большинстве распространенных оболочек и наиболее распространенных операционных системах. Используйте везде! - title: Основана на Rust - details: Приносит наилучшую в своем классе скорость и безопасность Rust, чтобы сделать вашу подсказку как можно быстрее и надежнее. + details: Приносит наилучшую в своем классе скорость и безопасность Rust, чтобы сделать вашу оболочку как можно быстрее и надежнее. - title: Настраиваемая - details: Каждая маленькая деталь настраивается по вашему вкусу, чтобы сделать эту подсказку минимальной или функциональной, как вы захотите. + details: Каждая маленькая деталь настраивается по вашему вкусу, чтобы сделать эту оболочку минималистичной или функциональной, как вы захотите. footer: Под лицензией ISC | Авторское право © 2019-настоящее Starship Contributors #Used for the description meta tag, for SEO metaTitle: "Starship: Cross-Shell Prompt" @@ -94,11 +94,9 @@ description: Starship - минимальная, быстрая и бесконе #### 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 - # ~\Documents\PowerShell\Profile.ps1 - Invoke-Expression (&starship init powershell) ``` diff --git a/docs/ru-RU/advanced-config/README.md b/docs/ru-RU/advanced-config/README.md index 51ee59801..5dca3d3a7 100644 --- a/docs/ru-RU/advanced-config/README.md +++ b/docs/ru-RU/advanced-config/README.md @@ -57,9 +57,9 @@ starship_precmd_user_func="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 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). - Число от 0 до 255. Это определяет [8-битный код цвета ANSI](https://i.stack.imgur.com/KTSQa.png). diff --git a/docs/ru-RU/config/README.md b/docs/ru-RU/config/README.md index 6de262a17..c43888e1b 100644 --- a/docs/ru-RU/config/README.md +++ b/docs/ru-RU/config/README.md @@ -9,14 +9,14 @@ mkdir -p ~/.config && touch ~/.config/starship.toml Вся конфигурация Starship выполняется в этом файле [TOML](https://github.com/toml-lang/toml): ```toml -# Don't print a new line at the start of the prompt +# Не добавлять пустую строку в начале ввода add_newline = false -# Replace the "❯" symbol in the prompt with "➜" -[character] # The name of the module we are configuring is "character" -success_symbol = "[➜](bold green)" # The "success_symbol" segment is being set to "➜" with the color "bold green" +# Поменять символ "❯" на символ "➜" +[character] # Имя настраемого модуля - "character" +symbol = "➜" # Сегменту "symbol" присваеваем значение "➜" -# Disable the package module, hiding it from the prompt completely +# Отключить модуль пакетов, полностью скрывая его из терминала [package] disabled = true ``` @@ -27,21 +27,21 @@ disabled = true export STARSHIP_CONFIG=~/.starship ``` -Equivalently in PowerShell (Windows) would be adding this line to your `$PROFILE`: +Аналогично в PowerShell (Windows) следует добавить эту строку в `$PROFILE`: ```ps1 $ENV:STARSHIP_CONFIG = "$HOME\.starship" ``` -### Logging +### Логгирование (Запись действий) -By default starship logs warnings and errors into a file named `~/.cache/starship/session_${STARSHIP_SESSION_KEY}.log`, where the session key is corresponding to a instance of your terminal. This, however can be changed using the `STARSHIP_CACHE` environment variable: +По умолчанию в starship записываются предупреждения и ошибки в файл с именем `~/.cache/starship/session_${STARSHIP_SESSION_KEY}.log`, где ключ сессии соответствует экземпляру терминала. Это, однако, может быть изменено с помощью переменной окружения `STARSHIP_CACHE`: ```sh export STARSHIP_CACHE=~/.starship/cache ``` -Equivalently in PowerShell (Windows) would be adding this line to your `$PROFILE`: +Аналогично в PowerShell (Windows) следует добавить эту строку в `$PROFILE`: ```ps1 $ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp" @@ -51,37 +51,37 @@ $ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp" **Модуль**: Компонент строки, дающий информацию на основе контекстной информации вашей ОС. Например, модуль "nodejs" показывает установленную версию NodeJS на вашем компьютере, если вы находитесь в директории проекта NodeJS. -**Variable**: Smaller sub-components that contains information provided by the module. For example, the "version" variable in the "nodejs" module contains the current version of NodeJS. +**Переменные**: Маленькие подкомпоненты, содержащие информацию, предоставленную модулем. Например, переменная "version" в модуле "nodejs" содержит текущую версию NodeJS. -By convention, most modules have a prefix of default terminal color (e.g. `via` in "nodejs") and an empty space as a suffix. +По традициям, большинство модулей имеют префикс цвета терминала по умолчанию (например, `через` в "узлах") и пустое пространство как суффикс. -### Format Strings +### Форматирование строк -Format strings are the format that a module prints all its variables with. Most modules have an entry called `format` that configures the display format of the module. You can use texts, variables and text groups in a format string. +Формат строк - это формат, с которым модуль печатает все переменные. Большинство модулей имеют запись `формата`, который настраивает формат отображения модуля. Вы можете использовать тексты, переменные и группы текста в строке формата. #### Переменная -A variable contains a `$` symbol followed by the name of the variable. The name of a variable only contains letters, numbers and `_`. +Переменная содержит символ `$`, за которым следует имя переменной. Имя переменной содержит только буквы, цифры и `_`. -For example: +Например: -- `$version` is a format string with a variable named `version`. -- `$git_branch$git_commit` is a format string with two variables named `git_branch` and `git_commit`. -- `$git_branch $git_commit` has the two variables separated with a space. +- `$version` это строка формата с именем `версии`. +- `$git_branch$git_commit` это строка формата с двумя переменными `git_branch` и `git_commit`. +- `$git_branch $git_commit` имеет две переменные, разделенные пробелом. -#### Text Group +#### Группа текста -A text group is made up of two different parts. +Текстовая группа состоит из двух различных частей. -The first part, which is enclosed in a `[]`, is a [format string](#format-strings). You can add texts, variables, or even nested text groups in it. +Первая часть, которая заключена в `[]`, это [формат строки](#format-strings). Вы можете добавлять в него тексты, переменные, или даже вложенные текстовые группы. -In the second part, which is enclosed in a `()`, is a [style string](#style-strings). This can be used style the first part. +Во второй части, которая заключена в `()`, это строка стиля [](#style-strings). Это может быть использовано в стиле первой части. -For example: +Например: -- `[on](red bold)` will print a string `on` with bold text colored red. -- `[⬢ $version](bold green)` will print a symbol `⬢` followed by the content of variable `version`, with bold text colored green. -- `[a [b](red) c](green)` will print `a b c` with `b` red, and `a` and `c` green. +- `[on](red bold)` будет печатать строку `on` жирным текстом красного цвета. +- `[⬢ $version](bold green)` будет печатать символ `⬢` за которым следует содержимое переменной `версии`, с жирным шрифтом зеленого цвета. +- `[a [b](red) c](green)` будет печатать `a b c` с `b` красного и `a` и `c` зеленого цвета соответсвенно. #### Строки стиля @@ -96,19 +96,19 @@ For example: Обратите внимание на то, что, вид стиля зависит от вашего эмулятора терминала. Например, некоторые эмуляторы терминала будут использовать яркие цвета вместо жирного текста, и некоторые цветовые темы используют одинаковые значение для обычных и ярких цветов. Также, чтобы получить курсивный текст, ваш терминал должен поддерживать курсив. -#### Conditional Format Strings +#### Строки условного формата -A conditional format string wrapped in `(` and `)` will not render if all variables inside are empty. +Строка условного формата, завернутая в `(` и `)` не будет отображаться, если все переменные внутри являются пустыми. -For example: +Например: -- `(@$region)` will show nothing if the variable `region` is `None`, otherwise `@` followed by the value of region. -- `(some text)` will always show nothing since there are no variables wrapped in the braces. -- When `$all` is a shortcut for `\[$a$b\]`, `($all)` will show nothing only if `$a` and `$b` are both `None`. This works the same as `(\[$a$b\] )`. +- `(@$region)` ничего не будет показывать, если переменная `регион` в значении `None`, иначе `@` будет использовать значение этой переменной. +- `(некоторый текст)` всегда не показывает ничего, поскольку в скобках нет переменных. +- Когда `$all` является ярлыком для `\[$a$b\]`, `($all)` будет показываться только если `$a` и `$b` не являются `None`. Это работает так же, как `(\[$a$b\] )`. -#### Escapable characters +#### Символ экранирования -The following symbols have special usage in a format string. If you want to print the following symbols, you have to escape them with a backslash (`\`). +Следующие символы имеют особое значение в формате. Если вы хотите напечатать следующие символы, вам нужно экранировать их обратной косой чертой (`\`). - \$ - \\ @@ -117,20 +117,20 @@ The following symbols have special usage in a format string. If you want to prin - ( - ) -Note that `toml` has [its own escape syntax](https://github.com/toml-lang/toml#user-content-string). It is recommended to use a literal string (`''`) in your config. If you want to use a basic string (`""`), pay attention to escape the backslash `\`. +Обратите внимание, что `toml` имеет [свой собственный синтаксис для экранирования](https://github.com/toml-lang/toml#user-content-string). В конфигурации рекомендуется использовать строку с знаком (`''`). Если вы хотите использовать базовую строку (`""`), обратите внимание на то, чтобы избежать обратной косой черты `\`. -For example, when you want to print a `$` symbol on a new line, the following configs for `format` are equivalent: +Например, когда вы хотите напечатать символ `$` на новой строке, следующие настройки для `формата` эквивалентны: ```toml -# with basic string +# с базовой строкой format = "\n\\$" -# with multiline basic string +# с многолинейной строкой format = """ \\$""" -# with literal string +# со строкой, состоящей из литералов format = ''' \$''' @@ -142,9 +142,9 @@ format = ''' ### Опции -| Option | По умолчанию | Описание | +| Параметр | По умолчанию | Описание | | -------------- | -------------------------------- | -------------------------------------------------------- | -| `format` | [ссылка](#default-prompt-format) | Configure the format of the prompt. | +| `format` | [ссылка](#default-prompt-format) | Настройка форматирования оболочки. | | `scan_timeout` | `30` | Тайм-аут запуска сканирования файлов (в миллисекундах). | | `add_newline` | `true` | Добавление пустой строки перед началом командной строки. | @@ -153,20 +153,20 @@ format = ''' ```toml # ~/.config/starship.toml -# Use custom format +# Собственное форматирование оболочки format = """ [┌───────────────────>](bold green) [│](bold green)$directory$rust$package [└─>](bold green) """ -# Wait 10 milliseconds for starship to check files under the current directory. +# Подождите 10 милисекунд пока starship прочитает файлы в этой директории. scan_timeout = 10 -# Disable the newline at the start of the prompt +# Выключить новую строку в начале запроса add_newline = false ``` -### Default Prompt Format +### Формат оболочки по умолчанию The default `format` is used to define the format of the prompt, if empty or no `format` is provided. Значение по умолчанию: @@ -214,11 +214,13 @@ $conda\ $memory_usage\ $aws\ $gcloud\ +$openstack\ $env_var\ $crystal\ $cmd_duration\ $custom\ $line_break\ +$lua\ $jobs\ $battery\ $time\ @@ -234,7 +236,7 @@ $character""" ### Опции -| Option | По умолчанию | Описание | +| Параметр | По умолчанию | Описание | | ---------------- | ------------------------------------------------ | -------------------------------------------------------------- | | `format` | `'on [$symbol$profile(\($region\))]($style) '` | The format for the module. | | `symbol` | `"☁️ "` | Символ перед отображением текущего профиля AWS. | @@ -242,12 +244,12 @@ $character""" | `style` | `"bold yellow"` | Стиль модуля. | | `disabled` | `false` | Отключение модуля `AWS`. | -### Variables +### Переменные | Переменная | Пример | Описание | | ---------- | ---------------- | ------------------------------------ | -| region | `ap-northeast-1` | The current AWS region | -| profile | `astronauts` | The current AWS profile | +| регион | `ap-northeast-1` | The current AWS region | +| профиль | `астронавты` | The current AWS profile | | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | @@ -300,7 +302,7 @@ symbol = "🅰 " ### Опции -| Option | По умолчанию | Описание | +| Параметр | По умолчанию | Описание | | -------------------- | --------------------------------- | ----------------------------------------------- | | `full_symbol` | `"•"` | Символ, отображаемый при полной батарее. | | `charging_symbol` | `"⇡"` | Символ, показываемый при зарядке аккумулятора. | @@ -346,7 +348,7 @@ style = "bold red" Опция `display` представляет собой массив следующей таблицы. -| Option | Описание | +| Параметр | Описание | | ----------- | -------------------------------------------------------- | | `threshold` | Верхняя граница опции отображения. | | `style` | Используемый стиль, если используется опция отображения. | @@ -379,7 +381,7 @@ By default it only changes color. If you also want to change it's shape take a l ### Опции -| Option | По умолчанию | Описание | +| Параметр | По умолчанию | Описание | | ---------------- | ------------------- | -------------------------------------------------------------------------------- | | `format` | `"$symbol "` | The format string used before the text input. | | `success_symbol` | `"[❯](bold green)"` | The format string used before the text input if the previous command succeeded. | @@ -387,7 +389,7 @@ By default it only changes color. If you also want to change it's shape take a l | `vicmd_symbol` | `"[❮](bold green)"` | The format string used before the text input if the shell is in vim normal mode. | | `disabled` | `false` | Отключает модуль `character`. | -### Variables +### Переменные | Переменная | Пример | Описание | | ---------- | ------ | --------------------------------------------------------------------- | @@ -426,20 +428,21 @@ vicmd_symbol = "[V](bold green) " ## 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 `CMakeCache.txt` file ### Опции -| Option | По умолчанию | Описание | +| Параметр | По умолчанию | Описание | | ---------- | ---------------------------------- | -------------------------------------------- | | `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"` | Стиль модуля. | | `disabled` | `false` | Disables the `cmake` module. | -### Variables +### Переменные | Переменная | Пример | Описание | | ---------- | --------- | ------------------------------------ | @@ -463,15 +466,23 @@ The `cmake` module shows the currently installed version of CMake if: ### Опции -| Option | По умолчанию | Описание | -| ------------------- | ----------------------------- | -------------------------------------------------------------------- | -| `min_time` | `2_000` | Кратчайшая продолжительность для показа времени (в миллисекундах). | -| `show_milliseconds` | `false` | Показывать миллисекунды в дополнение к секундам в продолжительности. | -| `format` | `"took [$duration]($style) "` | The format for the module. | -| `style` | `"bold yellow"` | Стиль модуля. | -| `disabled` | `false` | Отключает модуль `cmd_duration`. | +| Параметр | По умолчанию | Описание | +| -------------------- | ----------------------------- | -------------------------------------------------------------------- | +| `min_time` | `2_000` | Кратчайшая продолжительность для показа времени (в миллисекундах). | +| `show_milliseconds` | `false` | Показывать миллисекунды в дополнение к секундам в продолжительности. | +| `format` | `"took [$duration]($style) "` | The format for the module. | +| `style` | `"bold yellow"` | Стиль модуля. | +| `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). | -### Variables +::: 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`. + +::: + +### Переменные | Переменная | Пример | Описание | | ---------- | -------- | --------------------------------------- | @@ -492,17 +503,17 @@ format = "underwent [$duration](bold yellow)" ## Конда -Модуль `conda` показывает текущее окружение conda, если `$CONDA_DEFAULT_ENV` присвоено значение. +The `conda` module shows the current conda environment, if `$CONDA_DEFAULT_ENV` is set. ::: tip -Это не подавляет модификатор командной строки самой conda. Возможно, вы захотите запустить `conda config --set changeps1 False`. +This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. ::: ### Опции -| Option | По умолчанию | Описание | +| Параметр | По умолчанию | Описание | | ------------------- | ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | `truncation_length` | `1` | Количество каталогов, в которых путь к окружению должен быть усечен, если окружение было создано через `conda create -p [path]`. `0` означает без усечения. Также смотрите модуль [`directory`](#directory). | | `symbol` | `"🅒 "` | Символ перед названием окружения. | @@ -511,11 +522,11 @@ format = "underwent [$duration](bold yellow)" | `ignore_base` | `true` | Ignores `base` environment when activated. | | `disabled` | `false` | Отключает модуль `conda`. | -### Variables +### Переменные | Переменная | Пример | Описание | | ----------- | ------------ | ------------------------------------ | -| environment | `astronauts` | The current conda environment | +| environment | `астронавты` | The current conda environment | | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | @@ -532,21 +543,21 @@ format = "[$symbol$environment](dimmed green) " ## 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` - Текущий каталог содержит файл `.cr` ### Опции -| Option | По умолчанию | Описание | +| Параметр | По умолчанию | Описание | | ---------- | ---------------------------------- | ------------------------------------------------------- | | `symbol` | `"🔮 "` | Символ, используемый перед отображением версии crystal. | | `style` | `"bold red"` | Стиль модуля. | | `format` | `"via [$symbol$version]($style) "` | The format for the module. | | `disabled` | `false` | Отключает модуль `crystal`. | -### Variables +### Переменные | Переменная | Пример | Описание | | ---------- | --------- | ------------------------------------ | @@ -567,7 +578,7 @@ format = "via [✨ $version](bold blue) " ## 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 `.dart_tool` directory @@ -575,14 +586,14 @@ The `dart` module shows the currently installed version of Dart. Модуль б ### Опции -| Option | По умолчанию | Описание | +| Параметр | По умолчанию | Описание | | ---------- | ---------------------------------- | ----------------------------------------------- | | `format` | `"via [$symbol$version]($style) "` | The format for the module. | | `symbol` | `"🎯 "` | A format string representing the symbol of Dart | | `style` | `"bold blue"` | Стиль модуля. | | `disabled` | `false` | Disables the `dart` module. | -### Variables +### Переменные | Переменная | Пример | Описание | | ---------- | -------- | ------------------------------------ | @@ -603,15 +614,15 @@ 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, вместо скрытия усеченного каталога, вы увидите укороченное имя каталога, зависимое от числа символов вы установите для этой опции. +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`. ### Опции -| Option | По умолчанию | Описание | +| Параметр | По умолчанию | Описание | | ------------------- | -------------------------------------------------- | ---------------------------------------------------------------------------- | | `truncation_length` | `3` | Количество родительских папок, к которым должен быть усечен текущий каталог. | | `truncate_to_repo` | `true` | Следует или нет обрезать до корня репозитория git, в котором вы находитесь. | @@ -623,7 +634,7 @@ format = "via [🔰 $version](bold red) " | `truncation_symbol` | `""` | The symbol to prefix to truncated paths. eg: "…/" |

-Этот модуль имеет несколько расширенных опций конфигурации, которые контролируют отображение каталога. +This module has a few advanced configuration options that control how the directory is displayed. | Advanced Option | По умолчанию | Описание | | --------------------------- | ------------ | --------------------------------------------------------------------------------- | @@ -639,11 +650,11 @@ format = "via [🔰 $version](bold red) " "src/com/long/java/path" = "mypath" ``` -`fish_style_pwd_dir_length` взаимодействует со стандартными параметрами усечения, которые могут сначала показаться странными: если он не равен нулю, элементы пути, который обычно усекается, вместо этого отображаются с указанным количеством символов. For example, the path `/built/this/city/on/rock/and/roll`, which would normally be displayed as as `rock/and/roll`, would be displayed as `/b/t/c/o/rock/and/roll` with `fish_style_pwd_dir_length = 1`--the path components that would normally be removed are displayed with a single character. For `fish_style_pwd_dir_length = 2`, it would be `/bu/th/ci/on/rock/and/roll`. +`fish_style_pwd_dir_length` interacts with the standard truncation options in a way that can be surprising at first: if it's non-zero, the components of the path that would normally be truncated are instead displayed with that many characters. For example, the path `/built/this/city/on/rock/and/roll`, which would normally be displayed as as `rock/and/roll`, would be displayed as `/b/t/c/o/rock/and/roll` with `fish_style_pwd_dir_length = 1`--the path components that would normally be removed are displayed with a single character. For `fish_style_pwd_dir_length = 2`, it would be `/bu/th/ci/on/rock/and/roll`.
-### Variables +### Переменные | Переменная | Пример | Описание | | ---------- | --------------------- | ----------------------------------- | @@ -664,11 +675,11 @@ truncation_symbol = "…/" ## Контекст Docker -Модуль `docker_context` показывает текущий активный [контекст Docker](https://docs.docker.com/engine/context/working-with-contexts/), если он не установлен как `default`. +The `docker_context` module shows the currently active [Docker context](https://docs.docker.com/engine/context/working-with-contexts/) if it's not set to `default`. ### Опции -| Option | По умолчанию | Описание | +| Параметр | По умолчанию | Описание | | ----------------- | ---------------------------------- | --------------------------------------------------------------------------------------- | | `format` | `"via [$symbol$context]($style) "` | The format for the module. | | `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. | @@ -676,7 +687,7 @@ truncation_symbol = "…/" | `only_with_files` | `false` | Only show when there's a `docker-compose.yml` or `Dockerfile` in the current directory. | | `disabled` | `true` | Disables the `docker_context` module. | -### Variables +### Переменные | Переменная | Пример | Описание | | ---------- | -------------- | ------------------------------------ | @@ -697,7 +708,7 @@ format = "via [🐋 $context](blue bold)" ## Dotnet -Модуль `dotnet` показывает соответствующую версию .NET Core 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: @@ -713,13 +724,13 @@ 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. -Внутренне этот модуль использует свой собственный механизм определения версий. Обычно он в два раза быстрее, чем `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 () when there is a csproj file in the current directory. ### Опции -| Option | По умолчанию | Описание | +| Параметр | По умолчанию | Описание | | ----------- | ---------------------------------------- | ----------------------------------------------------------------- | | `format` | `"v[$symbol$version( 🎯 $tfm)]($style) "` | The format for the module. | | `symbol` | `"•NET "` | Символ перед отображением текущей версии dotnet. | @@ -727,7 +738,7 @@ The module will also show the Target Framework Moniker ( ⚠ Показана версия пакета, исходный код которого находится в текущем каталоге, а не в менеджере пакетов. - -### Опции - -| 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 -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 `esy.lock` directory @@ -1681,14 +1687,14 @@ The `ocaml` module shows the currently installed version of OCaml. Модуль ### Опции -| Option | По умолчанию | Описание | +| Параметр | По умолчанию | Описание | | ---------- | ---------------------------------- | ------------------------------------------------------- | | `format` | `"via [$symbol$version]($style) "` | The format string for the module. | | `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. | | `style` | `"bold yellow"` | Стиль модуля. | | `disabled` | `false` | Disables the `ocaml` module. | -### Variables +### Переменные | Переменная | Пример | Описание | | ---------- | --------- | ------------------------------------ | @@ -1707,9 +1713,89 @@ The `ocaml` module shows the currently installed version of 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. + +### Опции + +| Параметр | По умолчанию | Описание | +| ---------- | --------------------------------------------------- | -------------------------------------------------------------- | +| `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. | + +### Переменные + +| Переменная | Пример | Описание | +| ---------- | ------ | ------------------------------------ | +| 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 + +> ⚠ Показана версия пакета, исходный код которого находится в текущем каталоге, а не в менеджере пакетов. + +### Опции + +| Параметр | По умолчанию | Описание | +| ----------------- | ---------------------------------- | ---------------------------------------------------------- | +| `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. | + +### Переменные + +| Переменная | Пример | Описание | +| ---------- | -------- | ------------------------------------ | +| 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 -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 `cpanfile` or `cpanfile.snapshot` file @@ -1719,14 +1805,14 @@ The `perl` module shows the currently installed version of Perl. Модуль б ### Опции -| Option | По умолчанию | Описание | +| Параметр | По умолчанию | Описание | | ---------- | ---------------------------------- | ----------------------------------------------------- | | `format` | `"via [$symbol$version]($style) "` | The format string for the module. | | `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | | `style` | `"bold 149"` | Стиль модуля. | | `disabled` | `false` | Disables the `perl` module. | -### Variables +### Переменные | Переменная | Пример | Описание | | ---------- | --------- | ------------------------------------ | @@ -1745,22 +1831,22 @@ format = "via [🦪 $version]($style) " ## PHP -Модуль `php` показывает установленную версию 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` -- Текущий каталог содержит файл `.php-version` -- Текущий каталог содержит файл `.php` +- The current directory contains a `composer.json` file +- The current directory contains a `.php-version` file +- The current directory contains a `.php` file ### Опции -| Option | По умолчанию | Описание | -| ---------- | ---------------------------------- | --------------------------------------------------- | -| `format` | `"via [$symbol$version]($style) "` | The format for the module. | -| `symbol` | `"🐘 "` | Символ, используемый перед отображением версии PHP. | -| `style` | `"147 bold"` | Стиль модуля. | -| `disabled` | `false` | Отключает модуль `php`. | +| Параметр | По умолчанию | Описание | +| ---------- | ---------------------------------- | ----------------------------------------------------- | +| `format` | `"via [$symbol$version]($style) "` | The format for the module. | +| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | +| `style` | `"147 bold"` | Стиль модуля. | +| `disabled` | `false` | Disables the `php` module. | -### Variables +### Переменные | Переменная | Пример | Описание | | ---------- | -------- | ------------------------------------ | @@ -1779,38 +1865,73 @@ format = "via [🦪 $version]($style) " 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 + +### Опции + +| Параметр | По умолчанию | Описание | +| ---------- | ---------------------------------- | ------------------------------------------------------------ | +| `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. | + +### Переменные + +| Переменная | Пример | Описание | +| ---------- | -------- | ------------------------------------ | +| 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 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`. -Модуль будет показан, если любое из следующих условий соблюдено: +The module will be shown if any of the following conditions are met: -- Текущий каталог содержит файл `.python-version` -- Текущий каталог содержит файл `requirements.txt` -- Текущий каталог содержит файл `pyproject.toml` +- The current directory contains a `.python-version` file +- The current directory contains a `requirements.txt` file +- The current directory contains a `pyproject.toml` file - The current directory contains a file with the `.py` extension (and `scan_for_pyfiles` is true) -- Текущий каталог содержит файл `Pipfile` -- Текущий каталог содержит файл `tox.ini` -- Текущий каталог содержит файл `setup.py` +- The current directory contains a `Pipfile` file +- The current directory contains a `tox.ini` file +- The current directory contains a `setup.py` file - The current directory contains a `__init__.py` file -- Виртуальная среда в данный момент активирована +- A virtual environment is currently activated ### Опции -| Option | По умолчанию | Описание | +| Параметр | По умолчанию | Описание | | -------------------- | ------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | | `format` | `'via [${symbol}${pyenv_prefix}${version}( \($virtualenv\))]($style) '` | The format for the module. | | `symbol` | `"🐍 "` | A format string representing the symbol of Python | | `style` | `"yellow bold"` | Стиль модуля. | -| `pyenv_version_name` | `false` | Использовать 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 | | `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. | | `disabled` | `false` | Disables the `python` module. | -### Variables +### Переменные | Переменная | Пример | Описание | | ------------ | --------------- | ------------------------------------------ | @@ -1844,22 +1965,22 @@ python_binary = "python3" ## 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` -- Текущий каталог содержит файл `.ruby-version` -- Текущий каталог содержит файл `.rb` +- The current directory contains a `Gemfile` file +- The current directory contains a `.ruby-version` file +- The current directory contains a `.rb` file ### Опции -| Option | По умолчанию | Описание | +| Параметр | По умолчанию | Описание | | ---------- | ---------------------------------- | ------------------------------------------------ | | `format` | `"via [$symbol$version]($style) "` | The format for the module. | | `symbol` | `"💎 "` | A format string representing the symbol of Ruby. | | `style` | `"bold red"` | Стиль модуля. | -| `disabled` | `false` | Отключает модуль `ruby`. | +| `disabled` | `false` | Disables the `ruby` module. | -### Variables +### Переменные | Переменная | Пример | Описание | | ---------- | -------- | ------------------------------------ | @@ -1880,21 +2001,21 @@ symbol = "🔺 " ## 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` -- Текущий каталог содержит файл с расширением `.rs` +- The current directory contains a `Cargo.toml` file +- The current directory contains a file with the `.rs` extension ### Опции -| Option | По умолчанию | Описание | +| Параметр | По умолчанию | Описание | | ---------- | ---------------------------------- | ----------------------------------------------- | | `format` | `"via [$symbol$version]($style) "` | The format for the module. | | `symbol` | `"🦀 "` | A format string representing the symbol of Rust | | `style` | `"bold red"` | Стиль модуля. | -| `disabled` | `false` | Отключает модуль `rust`. | +| `disabled` | `false` | Disables the `rust` module. | -### Variables +### Переменные | Переменная | Пример | Описание | | ---------- | ----------------- | ------------------------------------ | @@ -1919,7 +2040,7 @@ The `shlvl` module shows the current SHLVL ("shell level") environment variable, ### Опции -| Option | По умолчанию | Описание | +| Параметр | По умолчанию | Описание | | ----------- | ---------------------------- | --------------------------------------- | | `threshold` | `2` | Display threshold. | | `format` | `"[$symbol$shlvl]($style) "` | The format for the module. | @@ -1927,7 +2048,7 @@ The `shlvl` module shows the current SHLVL ("shell level") environment variable, | `style` | `"bold yellow"` | Стиль модуля. | | `disabled` | `true` | Disables the `shlvl` module. | -### Variables +### Переменные | Переменная | Пример | Описание | | ---------- | ------ | ------------------------------------ | @@ -1950,18 +2071,18 @@ threshold = 3 ## Singularity -Модуль `singularity` показывает текущий образ singularity, если внутри контейнера и `$SINGULARITY_NAME` установлена. +The `singularity` module shows the current singularity image, if inside a container and `$SINGULARITY_NAME` is set. ### Опции -| Option | По умолчанию | Описание | +| Параметр | По умолчанию | Описание | | ---------- | -------------------------------- | ------------------------------------------------ | | `format` | `'[$symbol\[$env\]]($style) '` | The format for the module. | | `symbol` | `""` | A format string displayed before the image name. | | `style` | `"bold dimmed blue"` | Стиль модуля. | | `disabled` | `false` | Disables the `singularity` module. | -### Variables +### Переменные | Переменная | Пример | Описание | | ---------- | ------------ | ------------------------------------ | @@ -1980,59 +2101,24 @@ threshold = 3 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 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 -По умолчанию этот модуль отключен. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. ::: +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### Опции -| Option | По умолчанию | Описание | +| Параметр | По умолчанию | Описание | | ---------- | -------------------------- | ------------------------------------------------------ | | `format` | `[$symbol$status]($style)` | The format of the module | | `symbol` | `"✖"` | A format string representing the symbol for the status | | `style` | `"bold red"` | Стиль модуля. | | `disabled` | `true` | Disables the `status` module. | -### Variables +### Переменные | Переменная | Пример | Описание | | ---------- | ------ | ------------------------------------ | @@ -2056,23 +2142,58 @@ disabled = false ``` -## Terraform +## Swift -Модуль `terraform` показывает выбранную рабочую область и версию terraform. По умолчанию, версия terraform не показана, так как это медленно на текущих версиях terraform, при использовании большого количества плагинов. If you still want to enable it, [follow the example shown below](#with-version). Модуль будет показан, если любое из следующих условий соблюдено: +The `swift` module shows the currently installed version of Swift. The module will be shown if any of the following conditions are met: -- Текущий каталог содержит папку `.terraform` -- Текущий каталог содержит файл с расширением `.tf` +- 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. | + +### Переменные + +| Переменная | Пример | Описание | +| ---------- | -------- | ------------------------------------ | +| 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 + +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 +- Current directory contains a file with the `.tf` or `.hcl` extensions + +### Опции + +| Параметр | По умолчанию | Описание | | ---------- | ------------------------------------ | ----------------------------------------------------- | | `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | | `symbol` | `"💠 "` | A format string shown before the terraform workspace. | | `style` | `"bold 105"` | Стиль модуля. | -| `disabled` | `false` | Отключает модуль `terraform`. | +| `disabled` | `false` | Disables the `terraform` module. | -### Variables +### Переменные | Переменная | Пример | Описание | | ---------- | ---------- | ------------------------------------ | @@ -2105,33 +2226,33 @@ format = "[🏎💨 $workspace]($style) " ## Время -Модуль `time` показывает текущее **локальное** время. Значение конфигурации `format` используется пакетом [`chrono`](https://crates.io/crates/chrono) для контроля того, как отображается время. Ознакомьтесь с [документацией 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 -По умолчанию этот модуль отключен. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### Опции -| Option | По умолчанию | Описание | -| ----------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `format` | `"at [$time]($style) "` | The format string for the module. | -| `use_12hr` | `false` | Включить 12-часовое форматирование | -| `time_format` | см. ниже | [Строка формата chrono](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html), используемая для форматирования времени. | -| `style` | `"bold yellow"` | Стиль модуля времени | -| `utc_time_offset` | `"local"` | Устанавливает смещение UTC. Range from -24 < x < 24. Разрешает числам с плавающей точкой встраивать 30/45-минутное смещение временной зоны. | -| `disabled` | `true` | Отключает модуль `time`. | -| `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | +| Параметр | По умолчанию | Описание | +| ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | +| `format` | `"at [$time]($style) "` | The format string for the module. | +| `use_12hr` | `false` | Enables 12 hour formatting | +| `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. | +| `style` | `"bold yellow"` | The style for the module time | +| `utc_time_offset` | `"local"` | Sets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. | +| `disabled` | `true` | Disables the `time` module. | +| `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | -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 +### Переменные | Переменная | Пример | Описание | | ---------- | ---------- | ----------------------------------- | -| время | `13:08:10` | The current time. | +| time | `13:08:10` | The current time. | | style\* | | Mirrors the value of option `style` | \*: This variable can only be used as a part of a style string @@ -2149,26 +2270,26 @@ utc_time_offset = "-5" 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 -- Текущий пользователь отличается от залогиненного -- Пользователь подключен к SSH-сессии -- Переменная `show_always` равна true +- The current user is root +- The current user isn't the same as the one that is logged in +- The user is currently connected as an SSH session +- The variable `show_always` is set to true ### Опции -| Option | По умолчанию | Описание | -| ------------- | ----------------------- | ------------------------------------------------------- | -| `style_root` | `"bold red"` | Стиль, используемый для пользователя root. | -| `style_user` | `"bold yellow"` | Стиль, используемый для всех пользователей, кроме root. | -| `format` | `"[$user]($style) in "` | The format for the module. | -| `show_always` | `false` | Всегда показывать модуль `username`. | -| `disabled` | `false` | Отключает модуль `username`. | +| Параметр | По умолчанию | Описание | +| ------------- | ----------------------- | ------------------------------------- | +| `style_root` | `"bold red"` | The style used when the user is root. | +| `style_user` | `"bold yellow"` | The style used for non-root users. | +| `format` | `"[$user]($style) in "` | The format for the module. | +| `show_always` | `false` | Always shows the `username` module. | +| `disabled` | `false` | Disables the `username` module. | -### Variables +### Переменные | Переменная | Пример | Описание | | ---------- | ------------ | ------------------------------------------------------------------------------------------- | @@ -2190,20 +2311,20 @@ show_always = true ## 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 ### Опции -| Option | По умолчанию | Описание | +| Параметр | По умолчанию | Описание | | ---------- | ---------------------------------- | ----------------------------------------------------- | | `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | | `style` | `"bold yellow"` | Стиль модуля. | | `format` | `"via [$symbol$version]($style) "` | The format for the module. | | `disabled` | `false` | Disables the `zig` module. | -### Variables +### Переменные | Переменная | Пример | Описание | | ---------- | -------- | ------------------------------------ | @@ -2253,12 +2374,12 @@ The order in which custom modules are shown can be individually set by including ### Опции -| Option | По умолчанию | Описание | +| Параметр | По умолчанию | Описание | | ------------- | ----------------------------- | -------------------------------------------------------------------------------------------------------------------------- | | `command` | | The command whose output should be printed. The command will be passed on stdin to the shell. | | `when` | | A shell command used as a condition to show the module. The module will be shown if the command returns a `0` status code. | | `shell` | | [See below](#custom-command-shell) | -| `описание` | `""` | The description of the module that is shown when running `starship explain`. | +| `description` | `""` | The description of the module that is shown when running `starship explain`. | | `files` | `[]` | The files that will be searched in the working directory for a match. | | `directories` | `[]` | The directories that will be searched in the working directory for a match. | | `extensions` | `[]` | The extensions that will be searched in the working directory for a match. | @@ -2267,7 +2388,7 @@ The order in which custom modules are shown can be individually set by including | `format` | `"[$symbol$output]($style) "` | The format for the module. | | `disabled` | `false` | Disables this `custom` module. | -### Variables +### Переменные | Переменная | Описание | | ---------- | -------------------------------------- | @@ -2322,38 +2443,3 @@ command = "time /T" files = ["*.pst"] 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)" -``` diff --git a/docs/ru-RU/guide/README.md b/docs/ru-RU/guide/README.md index f820efb70..d5bc90b2d 100644 --- a/docs/ru-RU/guide/README.md +++ b/docs/ru-RU/guide/README.md @@ -101,7 +101,7 @@ 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 - Добавьте следующее в конец `~\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 Invoke-Expression (&starship init powershell) diff --git a/docs/ru-RU/presets/README.md b/docs/ru-RU/presets/README.md index 60af8f1a6..f4eef0d69 100644 --- a/docs/ru-RU/presets/README.md +++ b/docs/ru-RU/presets/README.md @@ -4,7 +4,7 @@ ## Символы Шрифта Nerd Font -Эта предустановка не меняет ничего кроме символов, используемых для каждого модуля. Если эмодзи вам не по душе, это может порадовать ваш глаз! +Эта предустановка не меняет ничего кроме символов, используемых для каждого модуля. Если эмодзи вам не по душе, это может бросаться вам в глаза! ![Скриншот предустановки Nerd Font Symbols](/presets/nerd-font-symbols.png) @@ -84,7 +84,7 @@ symbol = " " symbol = " " [rust] -symbol = " " +symbol = " " [swift] symbol = "ﯣ " diff --git a/docs/zh-CN/README.md b/docs/zh-CN/README.md index 007395299..01036fa7e 100644 --- a/docs/zh-CN/README.md +++ b/docs/zh-CN/README.md @@ -2,7 +2,7 @@ home: true heroImage: /logo.svg heroText: -tagline: The minimal, blazing-fast, and infinitely customizable prompt for any shell! +tagline: 轻量级、反应迅速，可定制的高颜值终端！ actionText: 入门 → actionLink: ./guide/ features: @@ -94,11 +94,9 @@ description: Starship is the minimal, blazing fast, and extremely customizable p #### 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 - # ~\Documents\PowerShell\Profile.ps1 - Invoke-Expression (&starship init powershell) ``` diff --git a/docs/zh-CN/config/README.md b/docs/zh-CN/config/README.md index f697106c3..8c10fe187 100644 --- a/docs/zh-CN/config/README.md +++ b/docs/zh-CN/config/README.md @@ -27,13 +27,13 @@ disabled = true export STARSHIP_CONFIG=~/.starship ``` -Equivalently in PowerShell (Windows) would be adding this line to your `$PROFILE`: +在 PowerShell (Windows) 中，在 `$PROFILE` 中添加下面的代码行能达到同样的效果： ```ps1 $ENV:STARSHIP_CONFIG = "$HOME\.starship" ``` -### Logging +### 日志 By default starship logs warnings and errors into a file named `~/.cache/starship/session_${STARSHIP_SESSION_KEY}.log`, where the session key is corresponding to a instance of your terminal. This, however can be changed using the `STARSHIP_CACHE` environment variable: @@ -41,7 +41,7 @@ By default starship logs warnings and errors into a file named `~/.cache/starshi export STARSHIP_CACHE=~/.starship/cache ``` -Equivalently in PowerShell (Windows) would be adding this line to your `$PROFILE`: +在 PowerShell (Windows) 中，在 `$PROFILE` 中添加下面的代码行能达到同样的效果： ```ps1 $ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp" @@ -214,11 +214,13 @@ $conda\ $memory_usage\ $aws\ $gcloud\ +$openstack\ $env_var\ $crystal\ $cmd_duration\ $custom\ $line_break\ +$lua\ $jobs\ $battery\ $time\ @@ -426,16 +428,17 @@ vicmd_symbol = "[V](bold green) " ## 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 `CMakeCache.txt` file ### 配置项 | Option | 默认值 | 描述 | | ---------- | ---------------------------------- | -------------------------------------------- | | `format` | `"via [$symbol$version]($style) "` | 组件格式化模板。 | -| `symbol` | `"🛆 "` | The symbol used before the version of cmake. | +| `symbol` | `"喝 "` | The symbol used before the version of cmake. | | `style` | `"bold blue"` | 此组件的样式。 | | `disabled` | `false` | Disables the `cmake` module. | @@ -463,13 +466,21 @@ The `cmake` module shows the currently installed version of CMake if: ### 配置项 -| Option | 默认值 | 描述 | -| ------------------- | ----------------------------- | ---------------------- | -| `min_time` | `2_000` | 显示此组件所需的最短执行时长（单位：毫秒）。 | -| `show_milliseconds` | `false` | 除了秒数外在执行时长中额外显示毫秒。 | -| `format` | `"took [$duration]($style) "` | 组件格式化模板。 | -| `style` | `"bold yellow"` | 此组件的样式。 | -| `disabled` | `false` | 禁用 `cmd_duration` 组件。 | +| Option | 默认值 | 描述 | +| -------------------- | ----------------------------- | ----------------------------------------------------- | +| `min_time` | `2_000` | 显示此组件所需的最短执行时长（单位：毫秒）。 | +| `show_milliseconds` | `false` | 除了秒数外在执行时长中额外显示毫秒。 | +| `format` | `"took [$duration]($style) "` | 组件格式化模板。 | +| `style` | `"bold yellow"` | 此组件的样式。 | +| `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 @@ -492,11 +503,11 @@ format = "underwent [$duration](bold yellow)" ## Conda -`conda` 组件在 `$CONDA_DEFAULT_ENV` 被设置时显示当前 conda 环境。 +The `conda` module shows the current conda environment, if `$CONDA_DEFAULT_ENV` is set. ::: tip -此组件没有禁用 conda 自带的提示符修改，您可能需要执行 `conda config --set changeps1 False`。 +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 -The `crystal` module shows the currently installed version of 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` 文件 - The current directory contains a `.cr` file @@ -567,7 +578,7 @@ format = "via [✨ $version](bold blue) " ## 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 `.dart_tool` directory @@ -603,11 +614,11 @@ format = "via [🔰 $version](bold red) " ## Directory -`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 风格的当前目录显示样式时，您会看到基于您的设置的每个上级目录的短名称，而不是隐藏被截断的上级目录。 +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` 是 git 仓库根目录，fish 风格相关选项设置为 `1`。 您将会看到 `~/D/N/nixpkgs/pkgs`，而在设置 fish 风格之前，当前路径将显示成 `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: "…/" |
-此组件有几个高级配置选项来控制当前目录路径的显示方式。 +This module has a few advanced configuration options that control how the directory is displayed. | Advanced Option | 默认值 | 描述 | | --------------------------- | ------ | ------------------------------------------------ | @@ -697,7 +708,7 @@ format = "via [🐋 $context](blue bold)" ## Dotnet -`dotnet` 模块显示与当前目录下使用的 .NET Core 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: @@ -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. -在内部，此组件使用自己的版本检测机制。 一般来说此组件是直接执行 `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 () when there is a csproj file in the current directory. @@ -751,7 +762,7 @@ heuristic = false ## 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` 文件. @@ -786,7 +797,7 @@ symbol = "🔮 " ## 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-package.json` 文件 @@ -824,7 +835,7 @@ format = "via [ $version](cyan bold) " ## Environment Variable -`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`，但定义了 `default` @@ -861,7 +872,7 @@ default = "unknown shell" ## 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` 文件. - 当前目录包含一个 `erlang.mk` 文件. @@ -870,7 +881,7 @@ The `erlang` module shows the currently installed version of Erlang/OTP. 此组 | Option | 默认值 | 描述 | | ---------- | ---------------------------------- | -------------------------------------------------------- | -| `symbol` | `"🖧 "` | The symbol used before displaying the version of erlang. | +| `symbol` | `" "` | The symbol used before displaying the version of erlang. | | `style` | `"bold red"` | 此组件的样式。 | | `format` | `"via [$symbol$version]($style) "` | 组件格式化模板。 | | `disabled` | `false` | Disables the `erlang` module. | @@ -956,24 +967,27 @@ asia-northeast1 = "an1" ## Git Branch -`git_branch` 组件显示当前目录的 git 仓库的活动分支。 +The `git_branch` module shows the active branch of the repo in your current directory. ### 配置项 -| Option | 默认值 | 描述 | -| ------------------- | -------------------------------- | ------------------------------------------------------------- | -| `format` | `"on [$symbol$branch]($style) "` | 组件格式化模板。 Use `"$branch"` to refer to the current branch name. | -| `symbol` | `" "` | A format string representing the symbol of git branch. | -| `style` | `"bold purple"` | 此组件的样式。 | -| `truncation_length` | `2^63 - 1` | Truncates a git branch to X graphemes. | -| `truncation_symbol` | `"…"` | 此字段的内容用来表示分支名称被截断。 You can use `""` for no symbol. | -| `disabled` | `false` | 禁用 `git_branch` 组件。 | +| Option | 默认值 | 描述 | +| -------------------- | -------------------------------- | ------------------------------------------------------------------------------------ | +| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | +| `format` | `"on [$symbol$branch]($style) "` | 组件格式化模板。 Use `"$branch"` to refer to the current branch name. | +| `symbol` | `" "` | A format string representing the symbol of git branch. | +| `style` | `"bold purple"` | 此组件的样式。 | +| `truncation_length` | `2^63 - 1` | Truncates a git branch to X graphemes. | +| `truncation_symbol` | `"…"` | 此字段的内容用来表示分支名称被截断。 You can use `""` for no symbol. | +| `only_attached` | `false` | Only show the branch name when not in a detached HEAD state. | +| `disabled` | `false` | Disables the `git_branch` module. | ### Variables | 字段 | 示例 | 描述 | | --------- | -------- | ---------------------------------------------------------------------------------------------------- | | 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 | | `symbol`对应值 | | style\* | | `style`对应值 | @@ -992,17 +1006,19 @@ truncation_symbol = "" ## Git Commit -`git_commit` 组件显示当前目录的 git 仓库的当前提交的哈希值。 +The `git_commit` module shows the current commit hash and also the tag (if any) of the repo in your current directory. ### 配置项 -| Option | 默认值 | 描述 | -| -------------------- | -------------------------- | ----------------------------------------------------- | -| `commit_hash_length` | `7` | 显示的 git 提交哈希值的长度。 | -| `format` | `'[\($hash\)]($style) '` | 组件格式化模板。 | -| `style` | `"bold green"` | 此组件的样式。 | -| `only_detached` | `true` | Only show git commit hash when in detached HEAD state | -| `disabled` | `false` | 禁用 `git_commit` 组件。 | +| Option | 默认值 | 描述 | +| -------------------- | ------------------------------------------------------ | ----------------------------------------------------- | +| `commit_hash_length` | `7` | 显示的 git 提交哈希值的长度。 | +| `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | 组件格式化模板。 | +| `style` | `"bold green"` | 此组件的样式。 | +| `only_detached` | `true` | Only show git commit hash when in detached HEAD state | +| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. | +| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown | +| `disabled` | `false` | Disables the `git_commit` module. | ### Variables @@ -1020,11 +1036,12 @@ truncation_symbol = "" [git_commit] commit_hash_length = 4 +tag_symbol = "🔖 " ``` ## 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 仓库的状态。 +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 版本。 此组件将在符合以下任意条件之一时显示： +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.sum` 文件 @@ -1188,7 +1205,7 @@ format = "via [🏎💨 $version](bold cyan) " ## 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` 文件 - The current directory contains a `Chart.yaml` file @@ -1223,7 +1240,7 @@ format = "via [⎈ $version](bold white) " ## Hostname -`hostname` 组件显示系统主机名。 +The `hostname` module shows the system hostname. ### 配置项 @@ -1258,7 +1275,7 @@ disabled = false ## 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 - 当前目录包含一个扩展名为 `.java`，`.class`，`.gradle` 或 `.jar` 的文件 @@ -1293,7 +1310,7 @@ symbol = "🌟 " ## Jobs -`jobs` 组件显示当前正在运行的任务数量。 仅当有后台任务运行时，此组件才会显示。 如果有超过 1 个作业，模块将显示正在运行的作业数量，如果配置了 `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 -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 `Manifest.toml` file @@ -1367,7 +1384,7 @@ Displays the current Kubernetes context name and, if set, the namespace from the ::: tip -此组件默认被禁用。 若要启用此组件，请在配置文件中设置 `disable` 字段为 `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 -`line_break` 组件将提示分隔为两行。 +The `line_break` module separates the prompt into two lines. ### 配置项 @@ -1423,27 +1440,64 @@ disabled = false 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 + +### 配置项 + +| Option | 默认值 | 描述 | +| ------------ | ---------------------------------- | -------------------------------------------------------------------------- | +| `format` | `"via [$symbol$version]($style) "` | 组件格式化模板。 | +| `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 | | `symbol`对应值 | +| style\* | | `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 -`memory_usage` 组件显示当前系统内存和交换区使用情况。 +The `memory_usage` module shows current system memory and swap usage. -默认情况下，如果系统交换区使用不为 0，则会显示交换区使用情况。 +By default the swap usage is displayed if the total system swap is non-zero. ::: tip -此组件默认被禁用。 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### 配置项 -| Option | 默认值 | 描述 | -| ----------- | --------------------------------------------- | ---------------------- | -| `threshold` | `75` | 隐藏内存使用情况，除非它超过这个百分比。 | -| `format` | `"via $symbol [${ram}( | ${swap})]($style) "` | 组件格式化模板。 | -| `symbol` | `"🐏"` | 这个字段的内容会显示在当前内存使用情况之前。 | -| `style` | `"bold dimmed white"` | 此组件的样式。 | -| `disabled` | `true` | 禁用 `memory_usage` 模块 | +| Option | 默认值 | 描述 | +| ----------- | --------------------------------------------- | -------------------------------------------------------- | +| `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. | +| `format` | `"via $symbol [${ram}( | ${swap})]($style) "` | 组件格式化模板。 | +| `symbol` | `"🐏"` | The symbol used before displaying the memory usage. | +| `style` | `"bold dimmed white"` | 此组件的样式。 | +| `disabled` | `true` | Disables the `memory_usage` module. | ### Variables @@ -1465,28 +1519,25 @@ disabled = true [memory_usage] disabled = false -show_percentage = true -show_swap = true threshold = -1 symbol = " " -separator = "/" style = "bold dimmed green" ``` ## Mercurial Branch -`hg_branch` 组件显示当前目录的 hg 仓库的活动分支。 +The `hg_branch` module shows the active branch of the repo in your current directory. ### 配置项 -| Option | 默认值 | 描述 | -| ------------------- | -------------------------------- | ------------------------------- | -| `symbol` | `" "` | 该字段的内容显示于当前仓库的 hg 书签或活动分支名之前。 | -| `style` | `"bold purple"` | 此组件的样式。 | -| `format` | `"on [$symbol$branch]($style) "` | 组件格式化模板。 | -| `truncation_length` | `2^63 - 1` | 将显示的 hg 分支名截断到该数量的字素（graphemes） | -| `truncation_symbol` | `"…"` | 此字段的内容用来表示分支名称被截断。 | -| `disabled` | `true` | 禁用 `hg_branch` 组件。 | +| Option | 默认值 | 描述 | +| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------- | +| `symbol` | `" "` | The symbol used before the hg bookmark or branch name of the repo in your current directory. | +| `style` | `"bold purple"` | 此组件的样式。 | +| `format` | `"on [$symbol$branch]($style) "` | 组件格式化模板。 | +| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to X graphemes | +| `truncation_symbol` | `"…"` | 此字段的内容用来表示分支名称被截断。 | +| `disabled` | `true` | Disables the `hg_branch` module. | ### Variables @@ -1511,9 +1562,9 @@ truncation_symbol = "" ## 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 `.nims` extension - The current directory contains a file with the `.nimble` extension @@ -1549,7 +1600,7 @@ symbol = "🎣 " ## 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"` | 此组件的样式。 | | `impure_msg` | `"impure"` | A format string shown when the shell is impure. | | `pure_msg` | `"pure"` | A format string shown when the shell is pure. | -| `disabled` | `false` | 禁用 `nix_shell` 组件。 | +| `disabled` | `false` | Disables the `nix_shell` module. | ### Variables @@ -1587,11 +1638,11 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' ## 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 -- 当前目录包含 `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 `.ts` extension @@ -1602,7 +1653,7 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' | `format` | `"via [$symbol$version]($style) "` | 组件格式化模板。 | | `symbol` | `"⬢ "` | A format string representing the symbol of NodeJS. | | `style` | `"bold green"` | 此组件的样式。 | -| `disabled` | `false` | 禁用 `nodejs` 组件。 | +| `disabled` | `false` | Disables the `nodejs` module. | ###  Variables @@ -1623,54 +1674,9 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' format = "via [🤖 $version](bold green) " ``` -## Package Version - -当前目录是软件包的代码仓库时，将显示 `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** —— `composer` 软件包版本从当前目录下的 `composer.json` 中得到 -- **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) "` | 组件格式化模板。 | -| `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 | | `symbol`对应值 | -| style\* | | `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 -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 `esy.lock` directory @@ -1707,9 +1713,89 @@ The `ocaml` module shows the currently installed version of 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. + +### 配置项 + +| Option | 默认值 | 描述 | +| ---------- | --------------------------------------------------- | -------------------------------------------------------------- | +| `format` | `"on [$symbol$cloud(\\($project\\))]($style) "` | 组件格式化模板。 | +| `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 | | `symbol`对应值 | +| style\* | | `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) "` | 组件格式化模板。 | +| `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 | | `symbol`对应值 | +| style\* | | `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 -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 `cpanfile` or `cpanfile.snapshot` file @@ -1745,20 +1831,20 @@ format = "via [🦪 $version]($style) " ## PHP -`php` 组件显示当前安装的 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 -- 当前目录包含一个 `.php` 文件 +- The current directory contains a `.php` file ### 配置项 -| Option | 默认值 | 描述 | -| ---------- | ---------------------------------- | ----------------------- | -| `format` | `"via [$symbol$version]($style) "` | 组件格式化模板。 | -| `symbol` | `"🐘 "` | 这个字段的内容会显示在当前 PHP 版本之前。 | -| `style` | `"147 bold"` | 此组件的样式。 | -| `disabled` | `false` | 禁用 `php` 组件。 | +| Option | 默认值 | 描述 | +| ---------- | ---------------------------------- | ----------------------------------------------------- | +| `format` | `"via [$symbol$version]($style) "` | 组件格式化模板。 | +| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | +| `style` | `"147 bold"` | 此组件的样式。 | +| `disabled` | `false` | Disables the `php` module. | ### Variables @@ -1779,46 +1865,81 @@ format = "via [🦪 $version]($style) " format = "via [🔹 $version](147 bold) " ``` -## Python +## PureScript -`python` 组件组件展示已经安装了的Python版本以及如果虚拟环境被激活则会显示当前Python虚拟环境 +The `purescript` module shows the currently installed version of PureScript version. The module will be shown if any of the following conditions are met: -如果`pyenv_version_name`被设置为`true`, 本组件将会展示pyenv版本名。 否则则显示通过`python --version`获得的版本号 - -此组件将在符合以下任意条件之一时显示： - -- 当前目录包含 `.python-version` 文件 -- 当前目录包含 `requirements.txt` 文件 -- 当前目录包含 `pyproject.toml` 文件 -- 当前目录包含一个扩展名名为`.py`的文件(以及`scan_for_pyfile`为true) -- 当前目录包含 `Pipfile` 文件 -- 当前目录包含一个 `tox.ini` 文件 -- 当前目录包含一个 `setup.py` 文件 -- 当前目录包含一个名为`__init__.py`的文件 -- 当前处于一个活跃的 python 虚拟环境中 +- The current directory contains a `spago.dhall` file +- The current directory contains a \*.purs files ### 配置项 -| Option | 默认值 | 描述 | -| -------------------- | ------------------------------------------------------------------------- | --------------------------------------------------------------- | -| `format` | `'via [${symbol}${pyenv_prefix}${version}( \($virtualenv\))]($style) '` | 组件格式化模板。 | -| `symbol` | `"🐍 "` | 用于表示Python的格式化字符串。 | -| `style` | `"yellow bold"` | 此组件的样式。 | -| `pyenv_version_name` | `false` | 使用 pyenv 获取 Python 版本 | -| `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | -| `scan_for_pyfiles` | `true` | 如果设置为false, 在本目录下的Python文件将不会在本组件中显示。 | -| `python_binary` | `python` | 配置在Starship运行时获取Python版本的二进制文件 | -| `disabled` | `false` | 禁用 `python` 组件。 | +| Option | 默认值 | 描述 | +| ---------- | ---------------------------------- | ------------------------------------------------------------ | +| `format` | `"via [$symbol$version]($style) "` | 组件格式化模板。 | +| `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 | | `symbol`对应值 | +| style\* | | `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 + +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`. + +The module will be shown if any of the following conditions are met: + +- The current directory contains a `.python-version` file +- The current directory contains a `requirements.txt` file +- The current directory contains a `pyproject.toml` file +- The current directory contains a file with the `.py` extension (and `scan_for_pyfiles` is true) +- The current directory contains a `Pipfile` file +- The current directory contains a `tox.ini` file +- The current directory contains a `setup.py` file +- The current directory contains a `__init__.py` file +- A virtual environment is currently activated + +### 配置项 + +| Option | 默认值 | 描述 | +| -------------------- | ------------------------------------------------------------------------- | ----------------------------------------------------------------------------- | +| `format` | `'via [${symbol}${pyenv_prefix}${version}( \($virtualenv\))]($style) '` | 组件格式化模板。 | +| `symbol` | `"🐍 "` | A format string representing the symbol of Python | +| `style` | `"yellow bold"` | 此组件的样式。 | +| `pyenv_version_name` | `false` | Use pyenv to get Python version | +| `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | +| `scan_for_pyfiles` | `true` | If false, Python files in the current directory will not show this module. | +| `python_binary` | `python` | Configures the python binary that Starship executes when getting the version. | +| `disabled` | `false` | Disables the `python` module. | ### Variables | 字段 | 示例 | 描述 | | ------------ | --------------- | ------------------------------------------ | -| version | `"v3.8.1"` | `python`版本 | +| version | `"v3.8.1"` | The version of `python` | | symbol | `"🐍 "` | `symbol`对应值 | | style | `"yellow bold"` | `style`对应值 | | pyenv_prefix | `"pyenv "` | Mirrors the value of option `pyenv_prefix` | -| virtualenv | `"venv"` | 当前`virtualenv`名称 | +| virtualenv | `"venv"` | The current `virtualenv` name | ### 示例 @@ -1844,11 +1965,11 @@ python_binary = "python3" ## 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 -- 当前目录包含 `.rb` 文件 +- The current directory contains a `.rb` file ### 配置项 @@ -1857,7 +1978,7 @@ python_binary = "python3" | `format` | `"via [$symbol$version]($style) "` | 组件格式化模板。 | | `symbol` | `"💎 "` | A format string representing the symbol of Ruby. | | `style` | `"bold red"` | 此组件的样式。 | -| `disabled` | `false` | 禁用 `ruby` 组件。 | +| `disabled` | `false` | Disables the `ruby` module. | ### Variables @@ -1880,10 +2001,10 @@ symbol = "🔺 " ## 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` 文件 -- 当前目录包含一个使用 `.rs` 扩展名的文件 +- The current directory contains a `Cargo.toml` file +- The current directory contains a file with the `.rs` extension ### 配置项 @@ -1892,7 +2013,7 @@ symbol = "🔺 " | `format` | `"via [$symbol$version]($style) "` | 组件格式化模板。 | | `symbol` | `"🦀 "` | A format string representing the symbol of Rust | | `style` | `"bold red"` | 此组件的样式。 | -| `disabled` | `false` | 禁用 `rust` 组件。 | +| `disabled` | `false` | Disables the `rust` module. | ### Variables @@ -1980,48 +2101,13 @@ The `singularity` module shows the current singularity image, if inside a contai 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) "` | 组件格式化模板。 | -| `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 | | `symbol`对应值 | -| style\* | | `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 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 -此组件默认被禁用。 若要启用此组件，请在配置文件中设置 `disable` 字段为 `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) "` | 组件格式化模板。 | +| `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 | | `symbol`对应值 | +| style\* | | `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` 组件显示当前选定的 terraform 工作区和版本。 默认情况下不会显示 terraform 版本，因为当使用大量插件时，当前版本 terraform 查询版本号很慢。 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: -- 当前目录包含 `.terraform` 目录 -- 当前目录包含一个使用 `.tf` 扩展名的文件 +- The current directory contains a `.terraform` folder +- Current directory contains a file with the `.tf` or `.hcl` extensions ### 配置项 @@ -2070,7 +2191,7 @@ disabled = false | `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | | `symbol` | `"💠 "` | A format string shown before the terraform workspace. | | `style` | `"bold 105"` | 此组件的样式。 | -| `disabled` | `false` | 禁用 `terraform` 组件。 | +| `disabled` | `false` | Disables the `terraform` module. | ### Variables @@ -2105,27 +2226,27 @@ format = "[🏎💨 $workspace]($style) " ## Time -`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 -此组件默认被禁用。 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### 配置项 -| Option | 默认值 | 描述 | -| ----------------- | ----------------------- | ----------------------------------------------------------------------------------------------------- | -| `format` | `"at [$time]($style) "` | The format string for the module. | -| `use_12hr` | `false` | 启用 12 小时格式 | -| `time_format` | 见下文解释 | 用来格式化时间显示的 [chrono 格式字符串](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) | -| `style` | `"bold yellow"` | 显示时间的样式。 | -| `utc_time_offset` | `"local"` | 设置所用 UTC 偏移量。 Range from -24 < x < 24. 允许使用浮点数来得到 30/45 分钟的时区偏移。 | -| `disabled` | `true` | 禁用 `time` 组件。 | -| `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | +| Option | 默认值 | 描述 | +| ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | +| `format` | `"at [$time]($style) "` | The format string for the module. | +| `use_12hr` | `false` | Enables 12 hour formatting | +| `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. | +| `style` | `"bold yellow"` | The style for the module time | +| `utc_time_offset` | `"local"` | Sets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. | +| `disabled` | `true` | Disables the `time` module. | +| `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | -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 @@ -2151,22 +2272,22 @@ 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 -- 当前用户与登录用户不相同 -- 用户正通过 SSH 会话连接访问 -- 字段 `show_always` 被设置为 true +- The current user is root +- The current user isn't the same as the one that is logged in +- The user is currently connected as an SSH session +- The variable `show_always` is set to true ### 配置项 -| Option | 默认值 | 描述 | -| ------------- | ----------------------- | ------------------- | -| `style_root` | `"bold red"` | 当前用户为 root 时使用的样式。 | -| `style_user` | `"bold yellow"` | 非 root 用户使用的样式。 | -| `format` | `"[$user]($style) in "` | 组件格式化模板。 | -| `show_always` | `false` | 总是显示 `username` 组件。 | -| `disabled` | `false` | 禁用 `username` 组件。 | +| Option | 默认值 | 描述 | +| ------------- | ----------------------- | ------------------------------------- | +| `style_root` | `"bold red"` | The style used when the user is root. | +| `style_user` | `"bold yellow"` | The style used for non-root users. | +| `format` | `"[$user]($style) in "` | 组件格式化模板。 | +| `show_always` | `false` | Always shows the `username` module. | +| `disabled` | `false` | Disables the `username` module. | ### Variables @@ -2190,7 +2311,7 @@ show_always = true ## 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 @@ -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. | | `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) | -| `描述` | `""` | The description of the module that is shown when running `starship explain`. | +| `description` | `""` | The description of the module that is shown when running `starship explain`. | | `files` | `[]` | The files that will be searched in the working directory for a match. | | `directories` | `[]` | The directories that will be searched in the working directory for a match. | | `extensions` | `[]` | The extensions that will be searched in the working directory for a match. | @@ -2322,38 +2443,3 @@ command = "time /T" files = ["*.pst"] 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) "` | 组件格式化模板。 | -| `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 | | `symbol`对应值 | -| style\* | | `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)" -``` diff --git a/docs/zh-CN/guide/README.md b/docs/zh-CN/guide/README.md index d99773b26..dfa0c810f 100644 --- a/docs/zh-CN/guide/README.md +++ b/docs/zh-CN/guide/README.md @@ -101,15 +101,15 @@ 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. -- **Intelligent:** shows relevant information at a glance. -- **Feature rich:** support for all your favorite tools. -- **Easy:** quick to install – start using it in minutes. +- **快：** 很快 —— 真的真的非常快！ 🚀 +- **定制化：** 可定制各种各样的提示符。 +- **通用：** 适用于任何 Shell、任何操作系统。 +- **智能：** 一目了然地显示相关信息。 +- **功能丰富：** 支持所有你喜欢的工具。 +- **易用：** 安装快速 —— 几分钟就可上手。

Explore the Starship docs  ▶ @@ -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 - 将以下内容添加到`~\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 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) 。 👋 -### 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)] -### Financial Contributors +### 项目资助者 -Become a financial contributor and help us sustain our community. [[Contribute](https://opencollective.com/starship/contribute)] +成为项目资助者，并帮助我们维持我们的社区。 [[成为项目资助者](https://opencollective.com/starship/contribute)] -#### Individuals +#### 资助人 -#### 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)] diff --git a/docs/zh-CN/presets/README.md b/docs/zh-CN/presets/README.md index 1adea8dd5..a94b46c99 100644 --- a/docs/zh-CN/presets/README.md +++ b/docs/zh-CN/presets/README.md @@ -84,7 +84,7 @@ symbol = " " symbol = " " [rust] -symbol = " " +symbol = " " [swift] symbol = "ﯣ " diff --git a/docs/zh-TW/README.md b/docs/zh-TW/README.md index 9446f2253..e49ee500b 100644 --- a/docs/zh-TW/README.md +++ b/docs/zh-TW/README.md @@ -94,11 +94,9 @@ description: Starship is the minimal, blazing fast, and extremely customizable p #### 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 - # ~\Documents\PowerShell\Profile.ps1 - Invoke-Expression (&starship init powershell) ``` diff --git a/docs/zh-TW/config/README.md b/docs/zh-TW/config/README.md index f38d1527d..3761278f8 100644 --- a/docs/zh-TW/config/README.md +++ b/docs/zh-TW/config/README.md @@ -214,11 +214,13 @@ $conda\ $memory_usage\ $aws\ $gcloud\ +$openstack\ $env_var\ $crystal\ $cmd_duration\ $custom\ $line_break\ +$lua\ $jobs\ $battery\ $time\ @@ -426,16 +428,17 @@ vicmd_symbol = "[V](bold green) " ## 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 `CMakeCache.txt` file ### 選項 | Option | 預設 | 說明 | | ---------- | ---------------------------------- | -------------------------------------------- | | `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"` | 這個模組的風格。 | | `disabled` | `false` | Disables the `cmake` module. | @@ -463,13 +466,21 @@ The `cmake` module shows the currently installed version of CMake if: ### 選項 -| Option | 預設 | 說明 | -| ------------------- | ----------------------------- | ----------------------------------------------------- | -| `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). | -| `show_milliseconds` | `false` | 顯示時間除了以秒為單位外，亦以毫秒顯示 | -| `format` | `"took [$duration]($style) "` | The format for the module. | -| `style` | `"bold yellow"` | 這個模組的風格。 | -| `disabled` | `false` | 停用 `cmd_duration` 模組。 | +| Option | 預設 | 說明 | +| -------------------- | ----------------------------- | ----------------------------------------------------- | +| `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). | +| `show_milliseconds` | `false` | 顯示時間除了以秒為單位外，亦以毫秒顯示 | +| `format` | `"took [$duration]($style) "` | The format for the module. | +| `style` | `"bold yellow"` | 這個模組的風格。 | +| `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 @@ -492,7 +503,7 @@ format = "underwent [$duration](bold yellow)" ## Conda -如果有設定 `$CONDA_DEFAULT_ENV` 時，`conda` 模組顯示現在 conda 的環境。 +The `conda` module shows the current conda environment, if `$CONDA_DEFAULT_ENV` is set. ::: tip @@ -532,7 +543,7 @@ format = "[$symbol$environment](dimmed green) " ## 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` 檔案 - 現在資料夾中含有一個`.cr`檔案 @@ -567,7 +578,7 @@ format = "via [✨ $version](bold blue) " ## 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 `.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: "…/" |

-這個模組有些進階設定選項可以控制顯示資料夾。 +This module has a few advanced configuration options that control how the directory is displayed. | Advanced Option | 預設 | 說明 | | --------------------------- | ------ | ------------------------------------------------ | @@ -697,7 +708,7 @@ format = "via [🐋 $context](blue bold)" ## 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: @@ -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. -這個模組內部是使用它自己的機制來偵測版本。 一般來說這個模組有 `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 () when there is a csproj file in the current directory. @@ -751,7 +762,7 @@ heuristic = false ## 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` 檔案. @@ -786,7 +797,7 @@ symbol = "🔮 " ## 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-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` 選項，但是有設定 `default` 選項。 @@ -861,7 +872,7 @@ default = "unknown shell" ## 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` 檔案. - 現在資料夾中包含一個 `erlang.mk` 檔案. @@ -870,7 +881,7 @@ The `erlang` module shows the currently installed version of Erlang/OTP. 這個 | Option | 預設 | 說明 | | ---------- | ---------------------------------- | -------------------------------------------------------- | -| `symbol` | `"🖧 "` | The symbol used before displaying the version of erlang. | +| `symbol` | `" "` | The symbol used before displaying the version of erlang. | | `style` | `"bold red"` | 這個模組的風格。 | | `format` | `"via [$symbol$version]($style) "` | The format for the module. | | `disabled` | `false` | Disables the `erlang` module. | @@ -956,24 +967,27 @@ asia-northeast1 = "an1" ## Git 分支 -`git_branch` 模組顯示現在的資料夾中使用中的儲存庫的分支。 +The `git_branch` module shows the active branch of the repo in your current directory. ### 選項 -| Option | 預設 | 說明 | -| ------------------- | -------------------------------- | ------------------------------------------------------------------------------- | -| `format` | `"on [$symbol$branch]($style) "` | The format for the module. Use `"$branch"` to refer to the current branch name. | -| `symbol` | `" "` | A format string representing the symbol of git branch. | -| `style` | `"bold purple"` | 這個模組的風格。 | -| `truncation_length` | `2^63 - 1` | Truncates a git branch to X graphemes. | -| `truncation_symbol` | `"…"` | 用來指示分支名稱被縮減的符號。 You can use `""` for no symbol. | -| `disabled` | `false` | 停用 `git_branch` 模組。 | +| Option | 預設 | 說明 | +| -------------------- | -------------------------------- | ------------------------------------------------------------------------------------ | +| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | +| `format` | `"on [$symbol$branch]($style) "` | The format for the module. Use `"$branch"` to refer to the current branch name. | +| `symbol` | `" "` | A format string representing the symbol of git branch. | +| `style` | `"bold purple"` | 這個模組的風格。 | +| `truncation_length` | `2^63 - 1` | Truncates a git branch to X graphemes. | +| `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 | 變數 | 範例 | 說明 | | --------- | -------- | ---------------------------------------------------------------------------------------------------- | | 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` | | style\* | | Mirrors the value of option `style` | @@ -992,17 +1006,19 @@ truncation_symbol = "" ## 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 | 預設 | 說明 | -| -------------------- | -------------------------- | ----------------------------------------------------- | -| `commit_hash_length` | `7` | The length of the displayed git commit hash. | -| `format` | `'[\($hash\)]($style) '` | The format for the module. | -| `style` | `"bold green"` | 這個模組的風格。 | -| `only_detached` | `true` | Only show git commit hash when in detached HEAD state | -| `disabled` | `false` | Disables the `git_commit` module. | +| Option | 預設 | 說明 | +| -------------------- | ------------------------------------------------------ | ----------------------------------------------------- | +| `commit_hash_length` | `7` | The length of the displayed git commit hash. | +| `format` | `"[\\($hash\\)]($style) [\\($tag\\)]($style)"` | The format for the module. | +| `style` | `"bold green"` | 這個模組的風格。 | +| `only_detached` | `true` | Only show git commit hash when in detached HEAD state | +| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. | +| `tag_symbol` | `"🏷 "` | Tag symbol prefixing the info shown | +| `disabled` | `false` | Disables the `git_commit` module. | ### Variables @@ -1020,11 +1036,12 @@ The `git_commit` module shows the current commit hash of the repo in your curren [git_commit] commit_hash_length = 4 +tag_symbol = "🔖 " ``` ## 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` 模組顯示用來表示現在資料夾之中儲存庫狀態的符號。 +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 版本。 這個模組在下列其中一個條件達成時顯示： +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.sum` 檔案 @@ -1188,7 +1205,7 @@ format = "via [🏎💨 $version](bold cyan) " ## 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` 檔案 - 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 版本。 這個模組在下列其中一個條件達成時顯示： +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 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 -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 `Manifest.toml` file @@ -1367,7 +1384,7 @@ Displays the current Kubernetes context name and, if set, the namespace from the ::: 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 ``` -## 記憶體使用量 +## 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 -這個模組預設是停用的。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### 選項 -| Option | 預設 | 說明 | -| ----------- | --------------------------------------------- | -------------------------- | -| `threshold` | `75` | 將記憶體使用量隱藏，除非使用量超過指定值。 | -| `format` | `"via $symbol [${ram}( | ${swap})]($style) "` | The format for the module. | -| `symbol` | `"🐏"` | 顯示在記憶體使用量之前的符號。 | -| `style` | `"bold dimmed white"` | 這個模組的風格。 | -| `disabled` | `true` | 停用 `memory_usage` 模組。 | +| Option | 預設 | 說明 | +| ----------- | --------------------------------------------- | -------------------------------------------------------- | +| `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. | +| `format` | `"via $symbol [${ram}( | ${swap})]($style) "` | The format for the module. | +| `symbol` | `"🐏"` | The symbol used before displaying the memory usage. | +| `style` | `"bold dimmed white"` | 這個模組的風格。 | +| `disabled` | `true` | Disables the `memory_usage` module. | ### Variables @@ -1465,11 +1519,8 @@ disabled = true [memory_usage] disabled = false -show_percentage = true -show_swap = true threshold = -1 symbol = " " -separator = "/" style = "bold dimmed green" ``` @@ -1511,9 +1562,9 @@ truncation_symbol = "" ## 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 `.nims` extension - The current directory contains a file with the `.nimble` extension @@ -1549,7 +1600,7 @@ symbol = "🎣 " ## 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"` | 這個模組的風格。 | | `impure_msg` | `"impure"` | A format string shown when the shell is impure. | | `pure_msg` | `"pure"` | A format string shown when the shell is pure. | -| `disabled` | `false` | 停用 `nix_shell` 模組。 | +| `disabled` | `false` | Disables the `nix_shell` module. | ### Variables @@ -1587,11 +1638,11 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' ## 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 -- 現在資料夾中包含一個 `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 `.ts` extension @@ -1602,7 +1653,7 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' | `format` | `"via [$symbol$version]($style) "` | The format for the module. | | `symbol` | `"⬢ "` | A format string representing the symbol of NodeJS. | | `style` | `"bold green"` | 這個模組的風格。 | -| `disabled` | `false` | 停用 `nodejs` 模組。 | +| `disabled` | `false` | Disables the `nodejs` module. | ###  Variables @@ -1623,54 +1674,9 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' 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 -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 `esy.lock` directory @@ -1707,9 +1713,89 @@ The `ocaml` module shows the currently installed version of 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. + +### 選項 + +| 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 -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 `cpanfile` or `cpanfile.snapshot` file @@ -1745,9 +1831,9 @@ format = "via [🦪 $version]($style) " ## 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` file @@ -1779,21 +1865,56 @@ The `php` module shows the currently installed version of PHP. 這個模組在 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 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`. -這個模組在下列其中一個條件達成時顯示： +The module will be shown if any of the following conditions are met: -- 目前資料夾中有一個 `.python-version` 檔案 -- 目前資料夾中有一個 `requirements.txt` 檔案 -- 目前資料夾中有一個 `pyproject.toml` 檔案 +- The current directory contains a `.python-version` file +- The current directory contains a `requirements.txt` file +- The current directory contains a `pyproject.toml` file - The current directory contains a file with the `.py` extension (and `scan_for_pyfiles` is true) -- 目前資料夾中有一個 `Pipfile` 檔案 -- 目前資料夾中有一個 `tox.ini` 檔案 -- 現在資料夾中包含一個 `setup.py` 檔案 +- The current directory contains a `Pipfile` file +- The current directory contains a `tox.ini` file +- The current directory contains a `setup.py` file - The current directory contains a `__init__.py` file - 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. | | `symbol` | `"🐍 "` | A format string representing the symbol of Python | | `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 | | `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. | -| `disabled` | `false` | 停用 `python` 模組。 | +| `disabled` | `false` | Disables the `python` module. | ### Variables @@ -1844,11 +1965,11 @@ python_binary = "python3" ## 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 -- 目前資料夾中有一個 `.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. | | `symbol` | `"💎 "` | A format string representing the symbol of Ruby. | | `style` | `"bold red"` | 這個模組的風格。 | -| `disabled` | `false` | 停用 `ruby` 模組。 | +| `disabled` | `false` | Disables the `ruby` module. | ### Variables @@ -1880,10 +2001,10 @@ symbol = "🔺 " ## 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` 檔案 -- 現在資料夾中包含一個檔案具有 `.rs` 副檔名 +- The current directory contains a `Cargo.toml` file +- 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. | | `symbol` | `"🦀 "` | A format string representing the symbol of Rust | | `style` | `"bold red"` | 這個模組的風格。 | -| `disabled` | `false` | 停用 `rust` 模組。 | +| `disabled` | `false` | Disables the `rust` module. | ### Variables @@ -1980,48 +2101,13 @@ The `singularity` module shows the current singularity image, if inside a contai 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 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 -這個模組預設是停用的。 想要啟用它的話，請在設定檔中將 `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 -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 -- 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 -這個模組預設是停用的。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### 選項 -| Option | 預設 | 說明 | -| ----------------- | ----------------------- | ----------------------------------------------------------------------------------------------------- | -| `format` | `"at [$time]($style) "` | The format string for the module. | -| `use_12hr` | `false` | 啟用 12 小時格式。 | -| `time_format` | 請看下列 | 用來顯示時間的 [chrono 格式字串](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html)。 | -| `style` | `"bold yellow"` | 這個模組的時間的風格。 | -| `utc_time_offset` | `"local"` | 設定相對於 UTC 的時差。 Range from -24 < x < 24. 允許使用浮點數來表示 30/45 分鐘時差的時區。 | -| `disabled` | `true` | 停用 `time` 模組。 | -| `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | +| Option | 預設 | 說明 | +| ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | +| `format` | `"at [$time]($style) "` | The format string for the module. | +| `use_12hr` | `false` | Enables 12 hour formatting | +| `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. | +| `style` | `"bold yellow"` | The style for the module time | +| `utc_time_offset` | `"local"` | Sets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. | +| `disabled` | `true` | Disables the `time` module. | +| `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | -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 | 變數 | 範例 | 說明 | | --------- | ---------- | ----------------------------------- | -| 時間 | `13:08:10` | The current time. | +| time | `13:08:10` | The current time. | | style\* | | Mirrors the value of option `style` | \*: This variable can only be used as a part of a style string @@ -2149,24 +2270,24 @@ utc_time_offset = "-5" 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 -- 目前使用者並非登入時的使用者 -- 使用者透過 SSH session 進行連線 -- 變數 `show_always` 被設為 true +- The current user is root +- The current user isn't the same as the one that is logged in +- The user is currently connected as an SSH session +- The variable `show_always` is set to true ### 選項 -| Option | 預設 | 說明 | -| ------------- | ----------------------- | -------------------------- | -| `style_root` | `"bold red"` | 使用者為 root 時使用的風格。 | -| `style_user` | `"bold yellow"` | 非 root 使用者時使用的風格。 | -| `format` | `"[$user]($style) in "` | The format for the module. | -| `show_always` | `false` | 總是顯示 `username` 模組。 | -| `disabled` | `false` | 停用 `username` 模組。 | +| Option | 預設 | 說明 | +| ------------- | ----------------------- | ------------------------------------- | +| `style_root` | `"bold red"` | The style used when the user is root. | +| `style_user` | `"bold yellow"` | The style used for non-root users. | +| `format` | `"[$user]($style) in "` | The format for the module. | +| `show_always` | `false` | Always shows the `username` module. | +| `disabled` | `false` | Disables the `username` module. | ### Variables @@ -2190,7 +2311,7 @@ show_always = true ## 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 @@ -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. | | `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) | -| `說明` | `""` | The description of the module that is shown when running `starship explain`. | +| `description` | `""` | The description of the module that is shown when running `starship explain`. | | `files` | `[]` | The files that will be searched in the working directory for a match. | | `directories` | `[]` | The directories that will be searched in the working directory for a match. | | `extensions` | `[]` | The extensions that will be searched in the working directory for a match. | @@ -2322,38 +2443,3 @@ command = "time /T" files = ["*.pst"] 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)" -``` diff --git a/docs/zh-TW/guide/README.md b/docs/zh-TW/guide/README.md index d6fb58f21..bd7236321 100644 --- a/docs/zh-TW/guide/README.md +++ b/docs/zh-TW/guide/README.md @@ -199,7 +199,7 @@ #### 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 Invoke-Expression (&starship init powershell) diff --git a/docs/zh-TW/presets/README.md b/docs/zh-TW/presets/README.md index 4587398b4..c634a3782 100644 --- a/docs/zh-TW/presets/README.md +++ b/docs/zh-TW/presets/README.md @@ -84,7 +84,7 @@ symbol = " " symbol = " " [rust] -symbol = " " +symbol = " " [swift] symbol = "ﯣ "