diff options
Diffstat (limited to 'docs')
51 files changed, 1309 insertions, 119 deletions
diff --git a/docs/ar-SA/README.md b/docs/ar-SA/README.md index 4767ca0b1..5887681e3 100644 --- a/docs/ar-SA/README.md +++ b/docs/ar-SA/README.md @@ -110,3 +110,16 @@ description: Starship is the minimal, blazing fast, and extremely customizable p eval $(starship init ion) ``` + + #### Elvish + + ::: warning Only elvish v0.15 or higher is supported. ::: + + Add the following to the end of `~/.elvish/rc.elv`: + + ```sh + # ~/.elvish/rc.elv + + eval (starship init elvish) + ``` + diff --git a/docs/ar-SA/config/README.md b/docs/ar-SA/config/README.md index 984ef22d4..976885f27 100644 --- a/docs/ar-SA/config/README.md +++ b/docs/ar-SA/config/README.md @@ -209,6 +209,7 @@ $ruby\ $rust\ $swift\ $terraform\ +$vagrant\ $zig\ $nix_shell\ $conda\ @@ -371,6 +372,8 @@ The character will tell you whether the last command was successful or not. It c By default it only changes color. If you also want to change it's shape take a look at [this example](#with-custom-error-shape). +::: warning `error_symbol` is not supported on elvish shell. ::: + ### Options | Option | Default | Description | @@ -2156,6 +2159,8 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y ::: +::: warning This module is not supported on elvish shell. ::: + ### Options | Option | Default | Description | @@ -2195,7 +2200,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y [status] style = "bg:blue" symbol = "🔴" -format = '[\[$symbol $status_common_meaning$status_signal_name$status_maybe_int\]]($style) ' +format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) ' map_symbol = true disabled = false @@ -2382,6 +2387,40 @@ disabled = false show_always = true ``` +## Vagrant + +The `vagrant` module shows the currently installed version of Vagrant. The module will be shown if any of the following conditions are met: + +- The current directory contains a `Vagrantfile` file + +### Options + +| Option | Default | Description | +| ---------- | ------------------------------------ | --------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | +| `style` | `"cyan bold"` | The style for the module. | +| `disabled` | `false` | Disables the `Vagrant` module. | + +### Variables + +| Variable | Example | Description | +| --------- | ---------------- | ------------------------------------ | +| version | `Vagrant 2.2.10` | The version of `Vagrant` | +| 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 + +[vagrant] +format = "via [⍱ $version](bold white) " +``` + ## Zig The `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: diff --git a/docs/ar-SA/guide/README.md b/docs/ar-SA/guide/README.md index c53391a57..319d99b68 100644 --- a/docs/ar-SA/guide/README.md +++ b/docs/ar-SA/guide/README.md @@ -92,6 +92,13 @@ height="20" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-fr.png" alt="Français" /></a> + + <a + href="https://github.com/starship/starship/blob/master/docs/vi-VN/guide/README.md" + ><img + height="20" + src="https://raw.githubusercontent.com/starship/starship/master/media/flag-vn.png" + alt="Tiếng Việt" /></a> </p> <h1></h1> @@ -211,6 +218,17 @@ eval $(starship init ion) ``` + + #### Elvish + + **Warning** Only elvish v0.15 or higher is supported. Add the following to the end of `~/.elvish/rc.elv`: + + ```sh + # ~/.elvish/rc.elv + + eval (starship init elvish) + ``` + ## 🤝 Contributing We are always looking for contributors of **all skill levels**! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). diff --git a/docs/ckb-IR/README.md b/docs/ckb-IR/README.md index 4767ca0b1..5887681e3 100644 --- a/docs/ckb-IR/README.md +++ b/docs/ckb-IR/README.md @@ -110,3 +110,16 @@ description: Starship is the minimal, blazing fast, and extremely customizable p eval $(starship init ion) ``` + + #### Elvish + + ::: warning Only elvish v0.15 or higher is supported. ::: + + Add the following to the end of `~/.elvish/rc.elv`: + + ```sh + # ~/.elvish/rc.elv + + eval (starship init elvish) + ``` + diff --git a/docs/ckb-IR/config/README.md b/docs/ckb-IR/config/README.md index 984ef22d4..976885f27 100644 --- a/docs/ckb-IR/config/README.md +++ b/docs/ckb-IR/config/README.md @@ -209,6 +209,7 @@ $ruby\ $rust\ $swift\ $terraform\ +$vagrant\ $zig\ $nix_shell\ $conda\ @@ -371,6 +372,8 @@ The character will tell you whether the last command was successful or not. It c By default it only changes color. If you also want to change it's shape take a look at [this example](#with-custom-error-shape). +::: warning `error_symbol` is not supported on elvish shell. ::: + ### Options | Option | Default | Description | @@ -2156,6 +2159,8 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y ::: +::: warning This module is not supported on elvish shell. ::: + ### Options | Option | Default | Description | @@ -2195,7 +2200,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y [status] style = "bg:blue" symbol = "🔴" -format = '[\[$symbol $status_common_meaning$status_signal_name$status_maybe_int\]]($style) ' +format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) ' map_symbol = true disabled = false @@ -2382,6 +2387,40 @@ disabled = false show_always = true ``` +## Vagrant + +The `vagrant` module shows the currently installed version of Vagrant. The module will be shown if any of the following conditions are met: + +- The current directory contains a `Vagrantfile` file + +### Options + +| Option | Default | Description | +| ---------- | ------------------------------------ | --------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | +| `style` | `"cyan bold"` | The style for the module. | +| `disabled` | `false` | Disables the `Vagrant` module. | + +### Variables + +| Variable | Example | Description | +| --------- | ---------------- | ------------------------------------ | +| version | `Vagrant 2.2.10` | The version of `Vagrant` | +| 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 + +[vagrant] +format = "via [⍱ $version](bold white) " +``` + ## Zig The `zig` module shows the currently installed version of Zig. The module will be shown if any of the following conditions are met: diff --git a/docs/ckb-IR/guide/README.md b/docs/ckb-IR/guide/README.md index c53391a57..319d99b68 100644 --- a/docs/ckb-IR/guide/README.md +++ b/docs/ckb-IR/guide/README.md @@ -92,6 +92,13 @@ height="20" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-fr.png" alt="Français" /></a> + + <a + href="https://github.com/starship/starship/blob/master/docs/vi-VN/guide/README.md" + ><img + height="20" + src="https://raw.githubusercontent.com/starship/starship/master/media/flag-vn.png" + alt="Tiếng Việt" /></a> </p> <h1></h1> @@ -211,6 +218,17 @@ eval $(starship init ion) ``` + + #### Elvish + + **Warning** Only elvish v0.15 or higher is supported. Add the following to the end of `~/.elvish/rc.elv`: + + ```sh + # ~/.elvish/rc.elv + + eval (starship init elvish) + ``` + ## 🤝 Contributing We are always looking for contributors of **all skill levels**! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). diff --git a/docs/de-DE/README.md b/docs/de-DE/README.md index b26599aba..88bd159c6 100644 --- a/docs/de-DE/README.md +++ b/docs/de-DE/README.md @@ -110,3 +110,16 @@ description: Starship ist eine minimale, super schnelle, und extrem anpassbare P eval $(starship init ion) ``` + + #### Elvish + + ::: warning Only elvish v0.15 or higher is supported. ::: + + Add the following to the end of `~/.elvish/rc.elv`: + + ```sh + # ~/.elvish/rc.elv + + eval (starship init elvish) + ``` + diff --git a/docs/de-DE/config/README.md b/docs/de-DE/config/README.md index fbf271cab..7fc923e9d 100644 --- a/docs/de-DE/config/README.md +++ b/docs/de-DE/config/README.md @@ -209,6 +209,7 @@ $ruby\ $rust\ $swift\ $terraform\ +$vagrant\ $zig\ $nix_shell\ $conda\ @@ -371,6 +372,8 @@ Das Zeichen zeigt an ob der letzte Befehl erfolgreich war, oder einen Fehler erz By default it only changes color. If you also want to change it's shape take a look at [this example](#with-custom-error-shape). +::: warning `error_symbol` is not supported on elvish shell. ::: + ### Optionen | Option | Standardwert | Beschreibung | @@ -1601,7 +1604,7 @@ truncation_symbol = "" The `nim` module shows the currently installed version of Nim. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: -- The current directory contains a `nim.cfg` file +- Das aktuelle Verzeichnis enthält eine `nim.cfg`-Datei - The current directory contains a file with the `.nim` extension - The current directory contains a file with the `.nims` extension - The current directory contains a file with the `.nimble` extension @@ -1677,7 +1680,7 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' Das `nodejs`-Modul zeigt die aktuell installierte Version von NodeJS. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: -- The current directory contains a `package.json` file +- Das aktuelle Verzeichnis enthält eine `package.json`-Datei - The current directory contains a `.node-version` file - Das aktuelle Verzeichnis enthält ein `node_modules`-Verzeichnis - The current directory contains a file with the `.js`, `.mjs` or `.cjs` extension @@ -1872,7 +1875,7 @@ format = "via [🦪 $version]($style) " Das `php`-Modul zeigt die aktuell installierte Version von PHP. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: -- The current directory contains a `composer.json` file +- Das aktuelle Verzeichnis enthält eine `composer.json`-Datei - The current directory contains a `.php-version` file - Das aktuelle Verzeichnis enthält eine `.php`-Datei @@ -1908,7 +1911,7 @@ format = "via [🔹 $version](147 bold) " The `purescript` module shows the currently installed version of PureScript version. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: -- The current directory contains a `spago.dhall` file +- Das aktuelle Verzeichnis enthält eine `spago.dhall`-Datei - The current directory contains a \*.purs files ### Optionen @@ -1948,8 +1951,8 @@ If `pyenv_version_name` is set to `true`, it will display the pyenv version name Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: - Das aktuelle Verzeichnis enthält eine `.python-version`-Datei -- The current directory contains a `requirements.txt` file -- The current directory contains a `pyproject.toml` file +- Das aktuelle Verzeichnis enthält eine `requirements.txt`-Datei +- Das aktuelle Verzeichnis enthält eine `pyproject.toml`-Datei - The current directory contains a file with the `.py` extension (and `scan_for_pyfiles` is true) - Das aktuelle Verzeichnis enthält eine `Pipfile`-Datei - Das aktuelle Verzeichnis enthält eine `tox.ini`-Datei @@ -2156,6 +2159,8 @@ Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `dis ::: +::: warning This module is not supported on elvish shell. ::: + ### Optionen | Option | Standardwert | Beschreibung | @@ -2195,7 +2200,7 @@ Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `dis [status] style = "bg:blue" symbol = "🔴" -format = '[\[$symbol $status_common_meaning$status_signal_name$status_maybe_int\]]($style) ' +format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) ' map_symbol = true disabled = false @@ -2238,7 +2243,7 @@ format = "via [🏎 $version](red bold)" ## Terraform -The `terraform` module shows the currently selected terraform workspace and version. +Das `Terraform` Modul zeigt den aktuell ausgewählten terraform Arbeitsbereich und die Version an. ::: Tipp @@ -2293,7 +2298,7 @@ format = "[🏎💨 $workspace]($style) " ## Zeit -The `time` module shows the current **local** time. The `format` configuration value is used by the [`chrono`](https://crates.io/crates/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) to see what options are available. +Das `time` Modul zeigt die aktuelle **lokale** Zeit an. Der `format` Wert wird von der crate [`chrono`](https://crates.io/crates/chrono) benutzt um die Zeit zu formatieren. Schau dir [die chrono strftime Dokumentation](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) an, um die möglichen Optionen zu sehen. ::: Tipp @@ -2313,7 +2318,7 @@ Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `dis | `disabled` | `true` | Deaktiviert das `time`-Modul. | | `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | -If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Otherwise, it defaults to `"%T"`. Manually setting `time_format` will override the `use_12hr` setting. +If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Andernfalls ist es standardmäßig `"%T"`. Manually setting `time_format` will override the `use_12hr` setting. ### Variables @@ -2339,7 +2344,7 @@ time_range = "10:00:00-14:00:00" ## Username -The `username` module shows active user's username. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: +Das `username` Modul zeigt den Namen des aktiven Benutzers. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: - Der aktuelle Benutzer ist root - Der aktuelle Benutzer ist nicht der eingeloggte Benutzer @@ -2382,6 +2387,40 @@ disabled = false show_always = true ``` +## Vagrant + +The `vagrant` module shows the currently installed version of Vagrant. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: + +- The current directory contains a `Vagrantfile` file + +### Optionen + +| Option | Standardwert | Beschreibung | +| ---------- | ------------------------------------ | --------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | +| `style` | `"cyan bold"` | Stil für dieses Modul. | +| `disabled` | `false` | Disables the `Vagrant` module. | + +### Variables + +| Variable | Beispiel | Beschreibung | +| --------- | ---------------- | ------------------------------------ | +| version | `Vagrant 2.2.10` | The version of `Vagrant` | +| 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 + +[vagrant] +format = "via [⍱ $version](bold white) " +``` + ## Zig The `zig` module shows the currently installed version of Zig. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: diff --git a/docs/de-DE/guide/README.md b/docs/de-DE/guide/README.md index 176267c44..3ad1e71eb 100644 --- a/docs/de-DE/guide/README.md +++ b/docs/de-DE/guide/README.md @@ -92,6 +92,13 @@ height="20" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-fr.png" alt="Français" /></a> + + <a + href="https://github.com/starship/starship/blob/master/docs/vi-VN/guide/README.md" + ><img + height="20" + src="https://raw.githubusercontent.com/starship/starship/master/media/flag-vn.png" + alt="Tiếng Việt" /></a> </p> <h1></h1> @@ -211,6 +218,17 @@ eval $(starship init ion) ``` + + #### Elvish + + **Warning** Only elvish v0.15 or higher is supported. Add the following to the end of `~/.elvish/rc.elv`: + + ```sh + # ~/.elvish/rc.elv + + eval (starship init elvish) + ``` + ## 🤝 Mitwirken Wir laden Leute **aller Erfahrungsstufen** herzlich ein mitzumachen! Falls du dich mit dem Projekt vertaut machen willst, versuche ein [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). diff --git a/docs/es-ES/README.md b/docs/es-ES/README.md index 3a91a166f..994c2ceca 100644 --- a/docs/es-ES/README.md +++ b/docs/es-ES/README.md @@ -110,3 +110,16 @@ description: Starship es el símbolo de sistema minimalista, ultrarápido e infi eval $(starship init ion) ``` + + #### Elvish + + ::: advertencia Solo se admite Elvish v0.15 o superior. ::: + + Añade el siguiente código al final de `~/.elvish/rc.elv`: + + ```sh + # ~/.elvish/rc.elv + + eval (starship init elvish) + ``` + diff --git a/docs/es-ES/config/README.md b/docs/es-ES/config/README.md index e83787cd5..48498183d 100644 --- a/docs/es-ES/config/README.md +++ b/docs/es-ES/config/README.md @@ -174,7 +174,7 @@ La varieble `format` por defecto se utiliza para definir el formato del prompt, ```toml format = "$all" -# Equivalente a +# Que es equivalente a format = """ $username\ $hostname\ @@ -210,6 +210,7 @@ $ruby\ $rust\ $swift\ $terraform\ +$vagrant\ $zig\ $nix_shell\ $conda\ @@ -372,6 +373,8 @@ El carácter te dirá si el último comando funcionó o no. Se puede hacer de do Por defecto sólo cambia el color. Si también se quiere cambiar su forma, ver [este ejemplo](#with-custom-error-shape). +::: advertencia `error_symbol` no es compatible con el intérprete de comandos Elvish. ::: + ### Opciones | Opción | Por defecto | Descripción | @@ -447,15 +450,15 @@ El módulo `cmake` muestra la versión instalada de CMake si se cumple alguna de ## 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 tomó ejecutarse el último comando. El módulo se mostrará solo si el comando tomó más de dos segundos, o si el valor de configuración de `min_time` existe. -::: warning No utilizar DEBUG en Bash +::: advertencia No utilizar la trampa 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 se está usando Starship con `bash`, no usar `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 una funcionalidad como preexec pueden usar el [framework rcaloras's bash_preexec](https://github.com/rcaloras/bash-preexec). Simplemente definir los arreglos `preexec_functions` y `precmd_functions` antes de ejecutar `eval $(starship init $0)`, y luego proceder de forma normal. ### Opciones @@ -500,7 +503,7 @@ El módulo `conda` muestra el actual entorno conda, si la variable `$CONDA_DEFAU ::: 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`. ::: @@ -536,7 +539,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` @@ -609,9 +612,9 @@ format = "via [🔰 $version](bold red) " 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. -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`. En ese caso, verás `~/D/N/nixpkgs/pkgs`, cuando antes hubiera sido `nixpkgs/pkgs`. ### Opciones |