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

This commit is contained in:
Matan Kushner 2022-06-26 18:29:51 -04:00 committed by GitHub
parent 277a7cc740
commit e00a6d47ec
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
50 changed files with 2123 additions and 1421 deletions

View File

@ -538,19 +538,19 @@ By default it only changes color. If you also want to change its shape take a lo
::: تحذير ::: تحذير
`vicmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148).
::: :::
### Options ### Options
| Option | الافتراضي | الوصف | | Option | الافتراضي | الوصف |
| -------------------------- | -------------------- | --------------------------------------------------------------------------------------- | | --------------------------- | -------------------- | --------------------------------------------------------------------------------------- |
| `format` | `"$symbol "` | The format string used before the text input. | | `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. | | `success_symbol` | `"[](bold green)"` | The format string used before the text input if the previous command succeeded. |
| `error_symbol` | `"[](bold red)"` | The format string used before the text input if the previous command failed. | | `error_symbol` | `"[](bold red)"` | The format string used before the text input if the previous command failed. |
| `vicmd_symbol` | `"[](bold green)"` | The format string used before the text input if the shell is in vim normal mode. | | `vimcmd_symbol` | `"[](bold green)"` | The format string used before the text input if the shell is in vim normal mode. |
| `vicmd_replace_one_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. | | `vimcmd_replace_one_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. |
| `vimcmd_replace_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. | | `vimcmd_replace_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. |
| `vimcmd_visual_symbol` | `"[](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. | | `vimcmd_visual_symbol` | `"[](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. |
| `disabled` | `false` | Disables the `character` module. | | `disabled` | `false` | Disables the `character` module. |
@ -2793,6 +2793,44 @@ The `rlang` module shows the currently installed version of [R](https://www.r-pr
format = "with [📐 $version](blue bold) " format = "with [📐 $version](blue bold) "
``` ```
## Raku
The `raku` module shows the currently installed version of [Raku](https://www.raku.org/). By default the module will be shown if any of the following conditions are met:
- The current directory contains a `META6.json` file
- The current directory contains a `.p6`, `.pm6`, `.raku`, `.rakumod` or `.pod6`
### Options
| Option | الافتراضي | الوصف |
| ------------------- | ------------------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version-$vm_version )]($style)"` | The format string for the module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🦋 "` | The symbol used before displaying the version of Raku |
| `detect_extensions` | `["p6", "pm6", "pod6", "raku", "rakumod"]` | Which extensions should trigger this module. |
| `detect_files` | `["META6.json"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold 149"` | The style for the module. |
| `disabled` | `false` | Disables the `raku` module. |
### Variables
| Variable | مثال | الوصف |
| ---------- | ------ | ------------------------------------ |
| version | `v6.d` | The version of `raku` |
| vm_version | `moar` | The version of VM `raku` is built on |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
### مثال
```toml
# ~/.config/starship.toml
[raku]
format = "via [🦪 $version]($style) "
```
## Red ## Red
By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met: By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met:
@ -3560,7 +3598,7 @@ These modules will be shown if any of the following conditions are met:
- The current directory contains a directory whose name is in `detect_folders` - The current directory contains a directory whose name is in `detect_folders`
- The current directory contains a file whose extension is in `detect_extensions` - The current directory contains a file whose extension is in `detect_extensions`
- The `when` command returns 0 - The `when` command returns 0
- The current Operating System (std::env::consts::OS) matchs with `os` field if defined. - The current Operating System (std::env::consts::OS) matches with `os` field if defined.
::: tip ::: tip
@ -3595,7 +3633,7 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt
| `command` | `""` | The command whose output should be printed. The command will be passed on stdin to the shell. | | `command` | `""` | The command whose output should be printed. The command will be passed on stdin to the shell. |
| `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. | | `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. |
| `shell` | | [See below](#custom-command-shell) | | `shell` | | [See below](#custom-command-shell) |
| `الوصف` | `"<custom module>"` | The description of the module that is shown when running `starship explain`. | | `description` | `"<custom module>"` | The description of the module that is shown when running `starship explain`. |
| `detect_files` | `[]` | The files that will be searched in the working directory for a match. | | `detect_files` | `[]` | The files that will be searched in the working directory for a match. |
| `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. | | `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. |
| `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. | | `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. |

View File

@ -256,11 +256,12 @@ Install the latest version for your system with the MSI-installers from the [rel
Install Starship using any of the following package managers: Install Starship using any of the following package managers:
| Repository | Instructions | | Repository | Instructions |
| -------------------------------------------------------------------------------- | --------------------------------------- | | -------------------------------------------------------------------------------------------- | --------------------------------------- |
| **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
| [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` | | [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` |
| [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` | | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
| [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json) | `scoop install starship` | | [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json) | `scoop install starship` |
| [winget](https://github.com/microsoft/winget-pkgs/tree/master/manifests/s/Starship/Starship) | `winget install --id Starship.Starship` |
</details> </details>

View File

@ -538,19 +538,19 @@ By default it only changes color. If you also want to change its shape take a lo
::: ئاگادارکردنەوە ::: ئاگادارکردنەوە
`vicmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148).
::: :::
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| -------------------------- | -------------------- | --------------------------------------------------------------------------------------- | | --------------------------- | -------------------- | --------------------------------------------------------------------------------------- |
| `format` | `"$symbol "` | The format string used before the text input. | | `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. | | `success_symbol` | `"[](bold green)"` | The format string used before the text input if the previous command succeeded. |
| `error_symbol` | `"[](bold red)"` | The format string used before the text input if the previous command failed. | | `error_symbol` | `"[](bold red)"` | The format string used before the text input if the previous command failed. |
| `vicmd_symbol` | `"[](bold green)"` | The format string used before the text input if the shell is in vim normal mode. | | `vimcmd_symbol` | `"[](bold green)"` | The format string used before the text input if the shell is in vim normal mode. |
| `vicmd_replace_one_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. | | `vimcmd_replace_one_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. |
| `vimcmd_replace_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. | | `vimcmd_replace_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. |
| `vimcmd_visual_symbol` | `"[](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. | | `vimcmd_visual_symbol` | `"[](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. |
| `disabled` | `false` | Disables the `character` module. | | `disabled` | `false` | Disables the `character` module. |
@ -2793,6 +2793,44 @@ The `rlang` module shows the currently installed version of [R](https://www.r-pr
format = "with [📐 $version](blue bold) " format = "with [📐 $version](blue bold) "
``` ```
## Raku
The `raku` module shows the currently installed version of [Raku](https://www.raku.org/). By default the module will be shown if any of the following conditions are met:
- The current directory contains a `META6.json` file
- The current directory contains a `.p6`, `.pm6`, `.raku`, `.rakumod` or `.pod6`
### Options
| Option | Default | Description |
| ------------------- | ------------------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version-$vm_version )]($style)"` | The format string for the module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🦋 "` | The symbol used before displaying the version of Raku |
| `detect_extensions` | `["p6", "pm6", "pod6", "raku", "rakumod"]` | Which extensions should trigger this module. |
| `detect_files` | `["META6.json"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold 149"` | The style for the module. |
| `disabled` | `false` | Disables the `raku` module. |
### Variables
| گۆڕاو | نموونە | Description |
| ---------- | ------ | ------------------------------------ |
| version | `v6.d` | The version of `raku` |
| vm_version | `moar` | The version of VM `raku` is built on |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
### نموونە
```toml
# ~/.config/starship.toml
[raku]
format = "via [🦪 $version]($style) "
```
## Red ## Red
By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met: By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met:
@ -3560,7 +3598,7 @@ These modules will be shown if any of the following conditions are met:
- The current directory contains a directory whose name is in `detect_folders` - The current directory contains a directory whose name is in `detect_folders`
- The current directory contains a file whose extension is in `detect_extensions` - The current directory contains a file whose extension is in `detect_extensions`
- The `when` command returns 0 - The `when` command returns 0
- The current Operating System (std::env::consts::OS) matchs with `os` field if defined. - The current Operating System (std::env::consts::OS) matches with `os` field if defined.
::: tip ::: tip

View File

@ -252,11 +252,12 @@ Install the latest version for your system with the MSI-installers from the [rel
Install Starship using any of the following package managers: Install Starship using any of the following package managers:
| Repository | Instructions | | Repository | Instructions |
| -------------------------------------------------------------------------------- | --------------------------------------- | | -------------------------------------------------------------------------------------------- | --------------------------------------- |
| **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
| [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` | | [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` |
| [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` | | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
| [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json) | `scoop install starship` | | [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json) | `scoop install starship` |
| [winget](https://github.com/microsoft/winget-pkgs/tree/master/manifests/s/Starship/Starship) | `winget install --id Starship.Starship` |
</details> </details>

View File

@ -538,19 +538,19 @@ By default it only changes color. If you also want to change its shape take a lo
::: warning ::: warning
`vicmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148).
::: :::
### Optionen ### Optionen
| Option | Standardwert | Beschreibung | | Option | Standardwert | Beschreibung |
| -------------------------- | -------------------- | --------------------------------------------------------------------------------------- | | --------------------------- | -------------------- | --------------------------------------------------------------------------------------- |
| `format` | `"$symbol "` | The format string used before the text input. | | `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. | | `success_symbol` | `"[](bold green)"` | The format string used before the text input if the previous command succeeded. |
| `error_symbol` | `"[](bold red)"` | The format string used before the text input if the previous command failed. | | `error_symbol` | `"[](bold red)"` | The format string used before the text input if the previous command failed. |
| `vicmd_symbol` | `"[](bold green)"` | The format string used before the text input if the shell is in vim normal mode. | | `vimcmd_symbol` | `"[](bold green)"` | The format string used before the text input if the shell is in vim normal mode. |
| `vicmd_replace_one_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. | | `vimcmd_replace_one_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. |
| `vimcmd_replace_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. | | `vimcmd_replace_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. |
| `vimcmd_visual_symbol` | `"[](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. | | `vimcmd_visual_symbol` | `"[](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. |
| `disabled` | `false` | Deaktiviert das `character`-Modul. | | `disabled` | `false` | Deaktiviert das `character`-Modul. |
@ -2793,9 +2793,47 @@ The `rlang` module shows the currently installed version of [R](https://www.r-pr
format = "with [📐 $version](blue bold) " format = "with [📐 $version](blue bold) "
``` ```
## Raku
The `raku` module shows the currently installed version of [Raku](https://www.raku.org/). By default the module will be shown if any of the following conditions are met:
- The current directory contains a `META6.json` file
- The current directory contains a `.p6`, `.pm6`, `.raku`, `.rakumod` or `.pod6`
### Optionen
| Option | Standardwert | Beschreibung |
| ------------------- | ------------------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version-$vm_version )]($style)"` | The format string for the module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🦋 "` | The symbol used before displaying the version of Raku |
| `detect_extensions` | `["p6", "pm6", "pod6", "raku", "rakumod"]` | Which extensions should trigger this module. |
| `detect_files` | `["META6.json"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold 149"` | Stil für dieses Modul. |
| `disabled` | `false` | Disables the `raku` module. |
### Variables
| Variable | Beispiel | Beschreibung |
| ---------- | -------- | ------------------------------------- |
| version | `v6.d` | The version of `raku` |
| vm_version | `moar` | The version of VM `raku` is built on |
| symbol | | Spiegelt den Wert der Option `symbol` |
| style\* | | Spiegelt den Wert der Option `style` |
### Beispiel
```toml
# ~/.config/starship.toml
[raku]
format = "via [🦪 $version]($style) "
```
## Red ## Red
By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). Das Modul wird nur dann angezeigt, wenn eine der folgenden Bedingungen zutrifft: By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met:
- The current directory contains a file with `.red` or `.reds` extension - The current directory contains a file with `.red` or `.reds` extension
@ -2833,11 +2871,11 @@ symbol = "🔴 "
## Ruby ## Ruby
By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). Das Modul wird nur dann angezeigt, wenn eine der folgenden Bedingungen zutrifft: By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). The module will be shown if any of the following conditions are met:
- Das aktuelle Verzeichnis enthält eine `Gemfile`-Datei - The current directory contains a `Gemfile` file
- The current directory contains a `.ruby-version` file - The current directory contains a `.ruby-version` file
- Das aktuelle Verzeichnis enthält eine `.rb`-Datei - The current directory contains a `.rb` file
- The environment variables `RUBY_VERSION` or `RBENV_VERSION` are set - The environment variables `RUBY_VERSION` or `RBENV_VERSION` are set
Starship gets the current Ruby version by running `ruby -v`. Starship gets the current Ruby version by running `ruby -v`.
@ -2854,7 +2892,7 @@ Starship gets the current Ruby version by running `ruby -v`.
| `detect_folders` | `[]` | Which folders should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. |
| `detect_variables` | `["RUBY_VERSION", "RBENV_VERSION"]` | Which environment variables should trigger this module. | | `detect_variables` | `["RUBY_VERSION", "RBENV_VERSION"]` | Which environment variables should trigger this module. |
| `style` | `"bold red"` | Stil für dieses Modul. | | `style` | `"bold red"` | Stil für dieses Modul. |
| `disabled` | `false` | Deaktiviert das `ruby`-Modul. | | `disabled` | `false` | Disables the `ruby` module. |
### Variables ### Variables
@ -2877,10 +2915,10 @@ symbol = "🔺 "
## Rust ## Rust
By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). Das Modul wird nur dann angezeigt, wenn eine der folgenden Bedingungen zutrifft: By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). The module will be shown if any of the following conditions are met:
- Das aktuelle Verzeichnis enthält eine `Cargo.toml`-Datei - The current directory contains a `Cargo.toml` file
- Das aktuelle Verzeichnis enthält eine Datei mit der `.rs`-Erweiterung - The current directory contains a file with the `.rs` extension
### Optionen ### Optionen
@ -2893,7 +2931,7 @@ By default the `rust` module shows the currently installed version of [Rust](htt
| `detect_files` | `["Cargo.toml"]` | Which filenames should trigger this module. | | `detect_files` | `["Cargo.toml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold red"` | Stil für dieses Modul. | | `style` | `"bold red"` | Stil für dieses Modul. |
| `disabled` | `false` | Deaktiviert das `rust`-Modul. | | `disabled` | `false` | Disables the `rust` module. |
### Variables ### Variables
@ -2978,7 +3016,7 @@ Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `dis
| `elvish_indicator` | `esh` | A format string used to represent elvish. | | `elvish_indicator` | `esh` | A format string used to represent elvish. |
| `tcsh_indicator` | `tsh` | A format string used to represent tcsh. | | `tcsh_indicator` | `tsh` | A format string used to represent tcsh. |
| `xonsh_indicator` | `xsh` | A format string used to represent xonsh. | | `xonsh_indicator` | `xsh` | A format string used to represent xonsh. |
| `cmd_indicator` | `cmd` | A format string used to represent cmd. | | `cmd_indicator` | `cmd` | A format string used to represent cmd. |
| `nu_indicator` | `nu` | A format string used to represent nu. | | `nu_indicator` | `nu` | A format string used to represent nu. |
| `unknown_indicator` | | The default value to be displayed when the shell is unknown. | | `unknown_indicator` | | The default value to be displayed when the shell is unknown. |
| `format` | `"[$indicator]($style) "` | Das Format für das Modul. | | `format` | `"[$indicator]($style) "` | Das Format für das Modul. |
@ -2990,7 +3028,7 @@ Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `dis
| Variable | Standardwert | Beschreibung | | Variable | Standardwert | Beschreibung |
| --------- | ------------ | ---------------------------------------------------------- | | --------- | ------------ | ---------------------------------------------------------- |
| indicator | | Mirrors the value of `indicator` for currently used shell. | | indicator | | Mirrors the value of `indicator` for currently used shell. |
| style\* | | Spiegelt den Wert der Option `style`. | | style\* | | Mirrors the value of option `style`. |
*: This variable can only be used as a part of a style string *: This variable can only be used as a part of a style string
@ -3219,7 +3257,7 @@ disabled = false
## Swift ## Swift
By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). Das Modul wird nur dann angezeigt, wenn eine der folgenden Bedingungen zutrifft: By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). 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 `Package.swift` file
- The current directory contains a file with the `.swift` extension - The current directory contains a file with the `.swift` extension
@ -3268,7 +3306,7 @@ By default the Terraform version is not shown, since this is slow for current ve
By default the module will be shown if any of the following conditions are met: By default the module will be shown if any of the following conditions are met:
- Das aktuelle Verzeichnis enthält eine `.terraform`-Datei - The current directory contains a `.terraform` folder
- Current directory contains a file with the `.tf`, `.tfplan` or `.tfstate` extensions - Current directory contains a file with the `.tf`, `.tfplan` or `.tfstate` extensions
### Optionen ### Optionen
@ -3282,7 +3320,7 @@ By default the module will be shown if any of the following conditions are met:
| `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[".terraform"]` | Which folders should trigger this module. | | `detect_folders` | `[".terraform"]` | Which folders should trigger this module. |
| `style` | `"bold 105"` | Stil für dieses Modul. | | `style` | `"bold 105"` | Stil für dieses Modul. |
| `disabled` | `false` | Deaktiviert das `terraform` Modul. | | `disabled` | `false` | Disables the `terraform` module. |
### Variables ### Variables
@ -3317,7 +3355,7 @@ format = "[🏎💨 $workspace]($style) "
## Uhrzeit ## Uhrzeit
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.
::: tip ::: tip
@ -3328,22 +3366,22 @@ Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `dis
### Optionen ### Optionen
| Option | Standardwert | Beschreibung | | Option | Standardwert | Beschreibung |
| ----------------- | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | | ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `format` | `"at [$time]($style) "` | The format string for the module. | | `format` | `"at [$time]($style) "` | The format string for the module. |
| `use_12hr` | `false` | Aktiviert die Formatierung der Uhrzeit im 12-Stunden-Format. | | `use_12hr` | `false` | Enables 12 hour formatting |
| `time_format` | Siehe unten | Das Format zum Anzeigen der Uhrzeit in [chrono-Formatierung](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html). | | `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. |
| `style` | `"bold yellow"` | Stil für dieses Modul. | | `style` | `"bold yellow"` | The style for the module time |
| `utc_time_offset` | `"local"` | Legt das UTC-Offset fest, das verwendet werden soll. Range from -24 &lt; x &lt; 24. Allows floats to accommodate 30/45 minute timezone offsets. | | `utc_time_offset` | `"local"` | Sets the UTC offset to use. Range from -24 &lt; x &lt; 24. Allows floats to accommodate 30/45 minute timezone offsets. |
| `disabled` | `true` | Deaktiviert das `time`-Modul. | | `disabled` | `true` | Disables the `time` module. |
| `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | | `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format |
If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Ansonsten ist der Standardwert hierfür `"%T"`. Manually setting `time_format` will override the `use_12hr` setting. If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Otherwise, it defaults to `"%T"`. Manually setting `time_format` will override the `use_12hr` setting.
### Variables ### Variables
| Variable | Beispiel | Beschreibung | | Variable | Beispiel | Beschreibung |
| --------- | ---------- | ------------------------------------ | | --------- | ---------- | ------------------------------------ |
| uhrzeit | `13:08:10` | The current time. | | time | `13:08:10` | The current time. |
| style\* | | Spiegelt den Wert der Option `style` | | style\* | | Spiegelt den Wert der Option `style` |
*: This variable can only be used as a part of a style string *: This variable can only be used as a part of a style string
@ -3361,14 +3399,14 @@ utc_time_offset = "-5"
time_range = "10:00:00-14:00:00" time_range = "10:00:00-14:00:00"
``` ```
## Benutzername ## Username
Das Modul `username` zeigt den Benutzernamen des aktiven Benutzers. Das Modul wird nur dann angezeigt, wenn eine der folgenden Bedingungen zutrifft: The `username` module shows active user's username. The module will be shown if any of the following conditions are met:
- The current user is root/admin - The current user is root/admin
- Der aktuelle Benutzer ist nicht derjenige, der derzeit angemeldet ist - The current user isn't the same as the one that is logged in
- Der Benutzer ist über eine SSH-Sitzung verbunden - The user is currently connected as an SSH session
- Die Variale `show_always` ist auf `true` gesetzt - The variable `show_always` is set to true
::: tip ::: tip
@ -3381,10 +3419,10 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, `
| Option | Standardwert | Beschreibung | | Option | Standardwert | Beschreibung |
| ------------- | ----------------------- | ------------------------------------------- | | ------------- | ----------------------- | ------------------------------------------- |
| `style_root` | `"bold red"` | The style used when the user is root/admin. | | `style_root` | `"bold red"` | The style used when the user is root/admin. |
| `style_user` | `"bold yellow"` | Stil bei allen anderen Benutzern. | | `style_user` | `"bold yellow"` | The style used for non-root users. |
| `format` | `"[$user]($style) in "` | Das Format für das Modul. | | `format` | `"[$user]($style) in "` | Das Format für das Modul. |
| `show_always` | `false` | `username`-Modul immer anzeigen. | | `show_always` | `false` | Always shows the `username` module. |
| `disabled` | `false` | Deaktiviert das `username`-Modul. | | `disabled` | `false` | Disables the `username` module. |
### Variables ### Variables
@ -3514,7 +3552,7 @@ format = "[🆅 $repo](bold blue) "
## Zig ## Zig
By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). Das Modul wird nur dann angezeigt, wenn eine der folgenden Bedingungen zutrifft: By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met:
- The current directory contains a `.zig` file - The current directory contains a `.zig` file
@ -3560,7 +3598,7 @@ These modules will be shown if any of the following conditions are met:
- The current directory contains a directory whose name is in `detect_folders` - The current directory contains a directory whose name is in `detect_folders`
- The current directory contains a file whose extension is in `detect_extensions` - The current directory contains a file whose extension is in `detect_extensions`
- The `when` command returns 0 - The `when` command returns 0
- The current Operating System (std::env::consts::OS) matchs with `os` field if defined. - The current Operating System (std::env::consts::OS) matches with `os` field if defined.
::: tip ::: tip
@ -3595,7 +3633,7 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt
| `command` | `""` | The command whose output should be printed. The command will be passed on stdin to the shell. | | `command` | `""` | The command whose output should be printed. The command will be passed on stdin to the shell. |
| `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. | | `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. |
| `shell` | | [See below](#custom-command-shell) | | `shell` | | [See below](#custom-command-shell) |
| `beschreibung` | `"<custom module>"` | The description of the module that is shown when running `starship explain`. | | `description` | `"<custom module>"` | The description of the module that is shown when running `starship explain`. |
| `detect_files` | `[]` | The files that will be searched in the working directory for a match. | | `detect_files` | `[]` | The files that will be searched in the working directory for a match. |
| `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. | | `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. |
| `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. | | `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. |

View File

@ -256,11 +256,12 @@ Install the latest version for your system with the MSI-installers from the [rel
Install Starship using any of the following package managers: Install Starship using any of the following package managers:
| Repository | Instructions | | Repository | Instructions |
| -------------------------------------------------------------------------------- | --------------------------------------- | | -------------------------------------------------------------------------------------------- | --------------------------------------- |
| **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
| [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` | | [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` |
| [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` | | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
| [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json) | `scoop install starship` | | [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json) | `scoop install starship` |
| [winget](https://github.com/microsoft/winget-pkgs/tree/master/manifests/s/Starship/Starship) | `winget install --id Starship.Starship` |
</details> </details>

View File

@ -545,12 +545,12 @@ Por defecto sólo cambia el color. Si también se quiere cambiar su forma, ver [
### Opciones ### Opciones
| Opción | Por defecto | Descripción | | Opción | Por defecto | Descripción |
| -------------------------- | -------------------- | ------------------------------------------------------------------------------------------------------- | | --------------------------- | -------------------- | ------------------------------------------------------------------------------------------------------- |
| `format` | `"$symbol "` | La cadena de formato usada antes de la entrada de texto. | | `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. | | `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ó. | | `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. | | `vimcmd_symbol` | `"[](bold green)"` | El cadena de formato antes de la entrada de texto si el intérprete de comandos está en modo vim normal. |
| `vicmd_replace_one_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. | | `vimcmd_replace_one_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. |
| `vimcmd_replace_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. | | `vimcmd_replace_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. |
| `vimcmd_visual_symbol` | `"[](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. | | `vimcmd_visual_symbol` | `"[](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. |
| `disabled` | `false` | Desactiva el módulo `character`. | | `disabled` | `false` | Desactiva el módulo `character`. |
@ -2793,11 +2793,49 @@ El módulo `rlang` muestra la versión instalada de [R](https://www.r-project.or
format = "with [📐 $version](blue bold) " format = "with [📐 $version](blue bold) "
``` ```
## Raku
The `raku` module shows the currently installed version of [Raku](https://www.raku.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
- The current directory contains a `META6.json` file
- The current directory contains a `.p6`, `.pm6`, `.raku`, `.rakumod` or `.pod6`
### Opciones
| Opción | Por defecto | Descripción |
| ------------------- | ------------------------------------------------ | --------------------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version-$vm_version )]($style)"` | La cadena de formato para el módulo. |
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🦋 "` | The symbol used before displaying the version of Raku |
| `detect_extensions` | `["p6", "pm6", "pod6", "raku", "rakumod"]` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `["META6.json"]` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
| `style` | `"bold 149"` | El estilo del módulo. |
| `disabled` | `false` | Disables the `raku` module. |
### Variables
| Variable | Ejemplo | Descripción |
| ---------- | ------- | -------------------------------------- |
| version | `v6.d` | The version of `raku` |
| vm_version | `moar` | The version of VM `raku` is built on |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
### Ejemplo
```toml
# ~/.config/starship.toml
[raku]
format = "via [🦪 $version]($style) "
```
## Red ## Red
Por defecto, el módulo `red` muestra la versión actualmente instalada de [Red](https://www.red-lang.org/). El módulo se muestra si algunas de las siguientes condiciones se cumplen: By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met:
- El directorio actual contiene un archivo con extensión `.red` o `.Red` - The current directory contains a file with `.red` or `.reds` extension
### Opciones ### Opciones
@ -2805,18 +2843,18 @@ Por defecto, el módulo `red` muestra la versión actualmente instalada de [Red]
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | | `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🔺 "` | Una cadena de formato que representa el símbolo de Red. | | `symbol` | `"🔺 "` | A format string representing the symbol of Red. |
| `detect_extensions` | `["red"]` | Qué extensiones deberían activar este módulo. | | `detect_extensions` | `["red"]` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. | | `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | | `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
| `style` | `"red bold"` | El estilo del módulo. | | `style` | `"red bold"` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `red`. | | `disabled` | `false` | Disables the `red` module. |
### Variables ### Variables
| Variable | Ejemplo | Descripción | | Variable | Ejemplo | Descripción |
| --------- | -------- | -------------------------------------- | | --------- | -------- | -------------------------------------- |
| version | `v2.5.1` | La versión de `red` | | version | `v2.5.1` | The version of `red` |
| symbol | | Refleja el valor de la opción `symbol` | | symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` | | style\* | | Refleja el valor de la opción `style` |
@ -2833,14 +2871,14 @@ symbol = "🔴 "
## Ruby ## Ruby
Por defecto, el módulo `ruby` muestra la versión actualmente instalada de [Ruby](https://www.ruby-lang.org/). El módulo se muestra si algunas de las siguientes condiciones se cumplen: By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). The module will be shown if any of the following conditions are met:
- El directorio actual contiene un archivo `Gemfile` - The current directory contains a `Gemfile` file
- El directorio actual contiene un archivo `.ruby-version` - The current directory contains a `.ruby-version` file
- El directorio actual contiene un archivo `.rb` - The current directory contains a `.rb` file
- Las variables de entorno `RUBY_VERSION` o `RBENV_VERSION` están configuradas - The environment variables `RUBY_VERSION` or `RBENV_VERSION` are set
Starship obtiene la versión actual de Ruby ejecutando `ruby -v`. Starship gets the current Ruby version by running `ruby -v`.
### Opciones ### Opciones
@ -2848,19 +2886,19 @@ Starship obtiene la versión actual de Ruby ejecutando `ruby -v`.
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | | `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"💎 "` | Una cadena de formato que representa el símbolo de Ruby. | | `symbol` | `"💎 "` | A format string representing the symbol of Ruby. |
| `detect_extensions` | `["rb"]` | Qué extensiones deberían activar este módulo. | | `detect_extensions` | `["rb"]` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `["Gemfile", ".ruby-version"]` | Qué nombres de archivo deberían activar este módulo. | | `detect_files` | `["Gemfile", ".ruby-version"]` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | | `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
| `detect_variables` | `["RUBY_VERSION", "RBENV_VERSION"]` | Qué variables de entorno deben activar este módulo. | | `detect_variables` | `["RUBY_VERSION", "RBENV_VERSION"]` | Which environment variables should trigger this module. |
| `style` | `"bold red"` | El estilo del módulo. | | `style` | `"bold red"` | El estilo del módulo. |
| `disabled` | `false` | Desactiva el módulo `ruby`. | | `disabled` | `false` | Disables the `ruby` module. |
### Variables ### Variables
| Variable | Ejemplo | Descripción | | Variable | Ejemplo | Descripción |
| --------- | -------- | -------------------------------------- | | --------- | -------- | -------------------------------------- |
| version | `v2.5.1` | La versión de `ruby` | | version | `v2.5.1` | The version of `ruby` |
| symbol | | Refleja el valor de la opción `symbol` | | symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` | | style\* | | Refleja el valor de la opción `style` |
@ -2877,10 +2915,10 @@ symbol = "🔺 "
## Rust ## Rust
Por defecto, el módulo `rust` muestra la versión instalada de [Rust](https://www.rust-lang.org/). El módulo se muestra si algunas de las siguientes condiciones se cumplen: By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). The module will be shown if any of the following conditions are met:
- El directorio actual contiene un archivo `Cargo.toml` - The current directory contains a `Cargo.toml` file
- El directorio actual contiene un archivo con la extensión `.rs` - The current directory contains a file with the `.rs` extension
### Opciones ### Opciones
@ -2888,20 +2926,20 @@ Por defecto, el módulo `rust` muestra la versión instalada de [Rust](https://w
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | | `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🦀 "` | Una cadena de formato que representa el símbolo de Rust | | `symbol` | `"🦀 "` | A format string representing the symbol of Rust |
| `detect_extensions` | `["rs"]` | Qué extensiones deberían activar este módulo. | | `detect_extensions` | `["rs"]` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `["Cargo.toml"]` | Qué nombres de archivo deberían activar este módulo. | | `detect_files` | `["Cargo.toml"]` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | | `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
| `style` | `"bold red"` | El estilo del módulo. | | `style` | `"bold red"` | El estilo del módulo. |
| `disabled` | `false` | Desactiva el módulo `rust`. | | `disabled` | `false` | Disables the `rust` module. |
### Variables ### Variables
| Variable | Ejemplo | Descripción | | Variable | Ejemplo | Descripción |
| --------- | ----------------- | -------------------------------------------- | | --------- | ----------------- | -------------------------------------------- |
| version | `v1.43.0-nightly` | La versión de `rustc` | | version | `v1.43.0-nightly` | The version of `rustc` |
| numver | `1.51.0` | El componente numérico de la versión `rustc` | | numver | `1.51.0` | The numeric component of the `rustc` version |
| toolchain | `beta` | La versión de toolchain | | toolchain | `beta` | The toolchain version |
| symbol | | Refleja el valor de la opción `symbol` | | symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` | | style\* | | Refleja el valor de la opción `style` |
@ -2918,11 +2956,11 @@ format = "via [⚙️ $version](red bold)"
## Scala ## Scala
El módulo `scala` muestra la versión actualmente instalada de [Scala](https://www.scala-lang.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
- El directorio actual contiene un archivo `build.sbt`, `.scalaenv` o `.sbtenv` - The current directory contains a `build.sbt`, `.scalaenv` or `.sbtenv` file
- El directorio actual contiene un archivo con la extensión `.scala` o `.sbt` - The current directory contains a file with the `.scala` or `.sbt` extension
- El directorio actual contiene un directorio llamado `.metals` - The current directory contains a directory named `.metals`
### Opciones ### Opciones
@ -2933,15 +2971,15 @@ El módulo `scala` muestra la versión actualmente instalada de [Scala](https://
| `detect_extensions` | `["sbt", "scala"]` | Qué extensiones deberían activar este módulo. | | `detect_extensions` | `["sbt", "scala"]` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Qué nombres de archivo deberían activar este módulo. | | `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[".metals"]` | Qué carpetas deberían activar estos módulos. | | `detect_folders` | `[".metals"]` | Qué carpetas deberían activar estos módulos. |
| `symbol` | `"🆂 "` | Una cadena de formato que representa el símbolo de Scala. | | `symbol` | `"🆂 "` | A format string representing the symbol of Scala. |
| `style` | `"red dimmed"` | El estilo del módulo. | | `style` | `"red dimmed"` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `scala`. | | `disabled` | `false` | Disables the `scala` module. |
### Variables ### Variables
| Variable | Ejemplo | Descripción | | Variable | Ejemplo | Descripción |
| --------- | -------- | -------------------------------------- | | --------- | -------- | -------------------------------------- |
| version | `2.13.5` | La versión de `scala` | | version | `2.13.5` | The version of `scala` |
| symbol | | Refleja el valor de la opción `symbol` | | symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` | | style\* | | Refleja el valor de la opción `style` |
@ -2958,7 +2996,7 @@ symbol = "🌟 "
## Shell ## Shell
El módulo `shell` muestra un indicador para el intérprete de comandos actualmente utilizado. The `shell` module shows an indicator for currently used shell.
::: tip ::: tip
@ -2969,28 +3007,28 @@ Este módulo está deshabilitado por defecto. Para activarlo, establece `disable
### Opciones ### Opciones
| Opción | Por defecto | Descripción | | Opción | Por defecto | Descripción |
| ---------------------- | ------------------------- | -------------------------------------------------------------------- | | ---------------------- | ------------------------- | ------------------------------------------------------------ |
| `bash_indicator` | `bsh` | Una cadena de formato usada para representar Bash. | | `bash_indicator` | `bsh` | A format string used to represent bash. |
| `fish_indicator` | `fsh` | Una cadena de formato usada para representar Fish. | | `fish_indicator` | `fsh` | A format string used to represent fish. |
| `zsh_indicator` | `zsh` | Una cadena de formato usada para representar Zsh. | | `zsh_indicator` | `zsh` | A format string used to represent zsh. |
| `powershell_indicator` | `psh` | Una cadena de formato usada para representar Powershell. | | `powershell_indicator` | `psh` | A format string used to represent powershell. |
| `ion_indicator` | `ion` | Una cadena de formato usada para representar Ion. | | `ion_indicator` | `ion` | A format string used to represent ion. |
| `elvish_indicator` | `esh` | Una cadena de formato usada para representar Elvish. | | `elvish_indicator` | `esh` | A format string used to represent elvish. |
| `tcsh_indicator` | `tsh` | Una cadena de formato usada para representar tcsh. | | `tcsh_indicator` | `tsh` | A format string used to represent tcsh. |
| `xonsh_indicator` | `xsh` | Una cadena de formato usada para representar xonsh. | | `xonsh_indicator` | `xsh` | A format string used to represent xonsh. |
| `cmd_indicator` | `cmd` | Una cadena de formato usada para representar cmd. | | `cmd_indicator` | `cmd` | A format string used to represent cmd. |
| `nu_indicator` | `nu` | Una cadena de formato usada para representar nu. | | `nu_indicator` | `nu` | A format string used to represent nu. |
| `unknown_indicator` | | El valor por defecto que se mostrará cuando se desconoce el comando. | | `unknown_indicator` | | The default value to be displayed when the shell is unknown. |
| `format` | `"[$indicator]($style) "` | El formato del módulo. | | `format` | `"[$indicator]($style) "` | El formato del módulo. |
| `style` | `"white bold"` | El estilo del módulo. | | `style` | `"white bold"` | El estilo del módulo. |
| `disabled` | `true` | Deshabilita el módulo `shell`. | | `disabled` | `true` | Disables the `shell` module. |
### Variables ### Variables
| Variable | Predeterminado | Descripción | | Variable | Predeterminado | Descripción |
| --------- | -------------- | ------------------------------------------------------------------------------------ | | --------- | -------------- | ---------------------------------------------------------- |
| indicador | | Ordena el valor de `indicator` para el intérprete de comandos actualmente utilizado. | | indicator | | Mirrors the value of `indicator` for currently used shell. |
| style\* | | Refleja el valor de la opción `style`. | | style\* | | Mirrors the value of option `style`. |
*: Esta variable sólo puede ser usada como parte de una cadena de estilo *: Esta variable sólo puede ser usada como parte de una cadena de estilo
@ -3009,24 +3047,24 @@ disabled = false
## SHLVL ## SHLVL
El módulo `shlvl` muestra la variable de entorno [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ("shell level") actual, si está establecido en un número y reúne o supera el umbral especificado. The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold.
### Opciones ### Opciones
| Opción | Por defecto | Descripción | | Opción | Por defecto | Descripción |
| ----------- | ---------------------------- | ----------------------------------------------------------------- | | ----------- | ---------------------------- | ------------------------------------------------------------- |
| `threshold` | `2` | Mostrar umbral. | | `threshold` | `2` | Display threshold. |
| `format` | `"[$symbol$shlvl]($style) "` | El formato del módulo. | | `format` | `"[$symbol$shlvl]($style) "` | El formato del módulo. |
| `symbol` | `"↕️ "` | El símbolo utilizado para representar el `SHLVL`. | | `symbol` | `"↕️ "` | The symbol used to represent the `SHLVL`. |
| `repetir` | `false` | Hace que el `symbol` se repita con la cantidad actual de `SHLVL`. | | `repeat` | `false` | Causes `symbol` to be repeated by the current `SHLVL` amount. |
| `style` | `"bold yellow"` | El estilo del módulo. | | `style` | `"bold yellow"` | El estilo del módulo. |
| `disabled` | `true` | Desactiva el módulo `shlvl`. | | `disabled` | `true` | Disables the `shlvl` module. |
### Variables ### Variables
| Variable | Ejemplo | Descripción | | Variable | Ejemplo | Descripción |
| --------- | ------- | -------------------------------------- | | --------- | ------- | -------------------------------------- |
| shlvl | `3` | El valor actual de `SHLVL` | | shlvl | `3` | The current value of `SHLVL` |
| symbol | | Refleja el valor de la opción `symbol` | | symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` | | style\* | | Refleja el valor de la opción `style` |
@ -3045,22 +3083,22 @@ threshold = 3
## Singularity ## Singularity
El módulo `singularity` muestra la imagen de [singularity](https://sylabs.io/singularity/) actual, si se encuentra dentro de un contenedor y `$SINGULARITY_NAME` está establecido. The `singularity` module shows the current [Singularity](https://sylabs.io/singularity/) image, if inside a container and `$SINGULARITY_NAME` is set.
### Opciones ### Opciones
| Opción | Por defecto | Descripción | | Opción | Por defecto | Descripción |
| ---------- | -------------------------------- | ------------------------------------------------------------------- | | ---------- | -------------------------------- | ------------------------------------------------ |
| `format` | `'[$symbol\[$env\]]($style) '` | El formato del módulo. | | `format` | `'[$symbol\[$env\]]($style) '` | El formato del módulo. |
| `symbol` | `""` | Una cadena de formato que se muestra antes del nombre de la imagen. | | `symbol` | `""` | A format string displayed before the image name. |
| `style` | `"bold dimmed blue"` | El estilo del módulo. | | `style` | `"bold dimmed blue"` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `singularity`. | | `disabled` | `false` | Disables the `singularity` module. |
### Variables ### Variables
| Variable | Ejemplo | Descripción | | Variable | Ejemplo | Descripción |
| --------- | ------------ | -------------------------------------- | | --------- | ------------ | -------------------------------------- |
| env | `centos.img` | La imagen de Singularity actual | | env | `centos.img` | The current Singularity image |
| symbol | | Refleja el valor de la opción `symbol` | | symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` | | style\* | | Refleja el valor de la opción `style` |
@ -3077,23 +3115,23 @@ format = '[📦 \[$env\]]($style) '
## Spack ## Spack
El módulo `spack` muestra el entorno actual [Spack](https://spack.readthedocs.io/en/latest/), si `$SPACK_ENV` está configurado. The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set.
### Opciones ### Opciones
| Opción | Por defecto | Descripción | | Opción | Por defecto | Descripción |
| ------------------- | -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------- | -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `truncation_length` | `1` | El número de directorios a los que se debe truncar la ruta de entorno. `0` significa sin truncamiento. Mirar también el módulo [`directory`](#directory). | | `truncation_length` | `1` | The number of directories the environment path should be truncated to. `0` significa sin truncamiento. Mirar también el módulo [`directory`](#directory). |
| `symbol` | `"🅢 "` | El símbolo usado antes del nombre del entorno. | | `symbol` | `"🅢 "` | El símbolo usado antes del nombre del entorno. |
| `style` | `"bold blue"` | El estilo del módulo. | | `style` | `"bold blue"` | El estilo del módulo. |
| `format` | `"via [$symbol$environment]($style) "` | El formato del módulo. | | `format` | `"via [$symbol$environment]($style) "` | El formato del módulo. |
| `disabled` | `false` | Deshabilita el módulo `spack`. | | `disabled` | `false` | Disables the `spack` module. |
### Variables ### Variables
| Variable | Ejemplo | Descripción | | Variable | Ejemplo | Descripción |
| ----------- | ------------ | -------------------------------------- | | ----------- | ------------ | -------------------------------------- |
| environment | `astronauts` | El entorno de spack actual | | environment | `astronauts` | The current spack environment |
| symbol | | Refleja el valor de la opción `symbol` | | symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` | | style\* | | Refleja el valor de la opción `style` |
@ -3108,9 +3146,9 @@ El módulo `spack` muestra el entorno actual [Spack](https://spack.readthedocs.i
format = "[$symbol$environment](dimmed blue) " format = "[$symbol$environment](dimmed blue) "
``` ```
## Estado ## Status
El módulo `status` muestra el código de salida del comando anterior. Si $success_symbol está vacío (por defecto), el módulo solo se mostrará si el código de salida no es `0`. El código de estado se convertirá a un entero con signo de 32 bits. The `status` module displays the exit code of the previous command. If $success_symbol is empty (default), the module will be shown only if the exit code is not `0`. The status code will cast to a signed 32-bit integer.
::: tip ::: tip
@ -3121,34 +3159,34 @@ Este módulo está deshabilitado por defecto. Para activarlo, establece `disable
### Opciones ### Opciones
| Opción | Por defecto | Descripción | | Opción | Por defecto | Descripción |
| ----------------------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------ | | ----------------------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------- |
| `format` | `"[$symbol$status]($style) "` | El formato del módulo | | `format` | `"[$symbol$status]($style) "` | El formato del módulo |
| `symbol` | `"✖"` | El símbolo mostrado en error del programa | | `symbol` | `"✖"` | The symbol displayed on program error |
| `success_symbol` | `""` | El símbolo mostrado en el éxito del programa | | `success_symbol` | `""` | The symbol displayed on program success |
| `not_executable_symbol` | `"🚫"` | El símbolo mostrado cuando el archivo no es ejecutable | | `not_executable_symbol` | `"🚫"` | The symbol displayed when file isn't executable |
| `not_found_symbol` | `"🔍"` | El símbolo mostrado cuando no se encuentra el comando | | `not_found_symbol` | `"🔍"` | The symbol displayed when the command can't be found |
| `sigint_symbol` | `"🧱"` | El símbolo mostrado en SIGINT (Ctrl + c) | | `sigint_symbol` | `"🧱"` | The symbol displayed on SIGINT (Ctrl + c) |
| `signal_symbol` | `"⚡"` | El símbolo mostrado en cualquier señal | | `signal_symbol` | `"⚡"` | The symbol displayed on any signal |
| `style` | `"bold red"` | El estilo del módulo. | | `style` | `"bold red"` | El estilo del módulo. |
| `recognize_signal_code` | `true` | Activar mapeo de señales desde el código de salida | | `recognize_signal_code` | `true` | Enable signal mapping from exit code |
| `map_symbol` | `false` | Activar mapeo de símbolos desde el código de salida | | `map_symbol` | `false` | Enable symbols mapping from exit code |
| `pipestatus` | `false` | Habilita el reporte de pipstatus | | `pipestatus` | `false` | Enable pipestatus reporting |
| `pipestatus_separator` | `|` | | | `pipestatus_separator` | `|` | |
| `pipestatus_format` | `\\[$pipestatus\\] => [$symbol$common_meaning$signal_name$maybe_int]($style)` | El formato del módulo cuando el comando es un pipeline | | `pipestatus_format` | `\\[$pipestatus\\] => [$symbol$common_meaning$signal_name$maybe_int]($style)` | The format of the module when the command is a pipeline |
| `disabled` | `true` | Desactiva el módulo `status`. | | `disabled` | `true` | Disables the `status` module. |
### Variables ### Variables
| Variable | Ejemplo | Descripción | | Variable | Ejemplo | Descripción |
| -------------- | ------- | ------------------------------------------------------------------------------------------------------------------ | | -------------- | ------- | ------------------------------------------------------------------------------------------- |
| estado | `127` | El código de salida del último comando | | status | `127` | The exit code of the last command |
| hex_status | `0x7F` | El código de salida del último comando en hexadecimal | | hex_status | `0x7F` | The exit code of the last command in hex |
| int | `127` | El código de salida del último comando | | int | `127` | The exit code of the last command |
| common_meaning | `ERROR` | Comprobación del código si no es una señal | | common_meaning | `ERROR` | Meaning of the code if not a signal |
| signal_number | `9` | Número de señal correspondiente al código de salida, sólo si está señalizada | | signal_number | `9` | Signal number corresponding to the exit code, only if signalled |
| signal_name | `KILL` | Nombre de la señal correspondiente al código de salida, sólo si está señalizada | | signal_name | `KILL` | Name of the signal corresponding to the exit code, only if signalled |
| maybe_int | `7` | Contiene el número de código de salida cuando no se ha encontrado ningún significado | | maybe_int | `7` | Contains the exit code number when no meaning has been found |
| pipestatus | | Renderizado en los códigos de salida de los programas del pipeline, esto sólo está disponible en pipestatus_format | | pipestatus | | Rendering of in pipeline programs's exit codes, this is only available in pipestatus_format |
| symbol | | Refleja el valor de la opción `symbol` | | symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` | | style\* | | Refleja el valor de la opción `style` |
@ -3170,7 +3208,7 @@ disabled = false
## Sudo ## Sudo
El módulo `sudo` muestra si las credenciales de sudo están actualmente en caché. El módulo solo se mostrará si las credenciales están guardadas en caché. The `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached.
::: tip ::: tip
@ -3181,12 +3219,12 @@ Este módulo está deshabilitado por defecto. Para activarlo, establece `disable
### Opciones ### Opciones
| Opción | Por defecto | Descripción | | Opción | Por defecto | Descripción |
| --------------- | ----------------------- | ------------------------------------------------------------------------------------------------ | | --------------- | ----------------------- | ------------------------------------------------------- |
| `format` | `[as $symbol]($style)"` | El formato del módulo | | `format` | `[as $symbol]($style)"` | El formato del módulo |
| `symbol` | `"🧙 "` | El símbolo mostrado cuando las credenciales se almacenan en caché | | `symbol` | `"🧙 "` | The symbol displayed when credentials are cached |
| `style` | `"bold blue"` | El estilo del módulo. | | `style` | `"bold blue"` | El estilo del módulo. |
| `allow_windows` | `false` | Como Windows no tiene sudo de manera predeterminada, el valor predeterminado está deshabilitado. | | `allow_windows` | `false` | Since windows has no default sudo, default is disabled. |
| `disabled` | `true` | Deshabilita el módulo `sudo`. | | `disabled` | `true` | Disables the `sudo` module. |
### Variables ### Variables
@ -3219,10 +3257,10 @@ disabled = false
## Swift ## Swift
Por defecto, el módulo `swift` muestra la versión instalada de [Swift](https://swift.org/). El módulo se muestra si algunas de las siguientes condiciones se cumplen: By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). The module will be shown if any of the following conditions are met:
- El directorio actual contiene un archivo `Package.swift` - The current directory contains a `Package.swift` file
- El directorio actual contiene un archivo con la extensión `.swift` - The current directory contains a file with the `.swift` extension
### Opciones ### Opciones
@ -3230,18 +3268,18 @@ Por defecto, el módulo `swift` muestra la versión instalada de [Swift](https:/
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | | `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🐦 "` | Una cadena de formato que representa el símbolo de Swift | | `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
| `detect_extensions` | `["swift"]` | Qué extensiones deberían activar este módulo. | | `detect_extensions` | `["swift"]` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `["Package.swift"]` | Qué nombres de archivo deberían activar este módulo. | | `detect_files` | `["Package.swift"]` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | | `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
| `style` | `"bold 202"` | El estilo del módulo. | | `style` | `"bold 202"` | El estilo del módulo. |
| `disabled` | `false` | Desactiva el módulo `swift`. | | `disabled` | `false` | Disables the `swift` module. |
### Variables ### Variables
| Variable | Ejemplo | Descripción | | Variable | Ejemplo | Descripción |
| --------- | -------- | -------------------------------------- | | --------- | -------- | -------------------------------------- |
| version | `v5.2.4` | La versión de `swift` | | version | `v5.2.4` | The version of `swift` |
| symbol | | Refleja el valor de la opción `symbol` | | symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` | | style\* | | Refleja el valor de la opción `style` |
@ -3258,18 +3296,18 @@ format = "via [🏎 $version](red bold)"
## Terraform ## Terraform
El módulo `Terraform` muestra el espacio de trabajo de [Terraform](https://www.terraform.io/docs/language/state/workspaces.html) y la versión seleccionados actualmente. The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version.
::: tip ::: tip
Por defecto no se muestra la versión de Terraform, ya que esto es lento para las versiones actuales de Terraform cuando hay muchos complementos en uso. Si aún deseas activarlo, [sigue el ejemplo que se muestra a continuación](#with-terraform-version). By default the Terraform version is not shown, since this is slow for 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-terraform-version).
::: :::
Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
- El directorio actual contiene una carpeta `.terraform` - The current directory contains a `.terraform` folder
- El directorio actual contiene un archivo con las extensiones `.tf`, `.tfplan` o `.tfstate` - Current directory contains a file with the `.tf`, `.tfplan` or `.tfstate` extensions
### Opciones ### Opciones
@ -3277,19 +3315,19 @@ Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
| `format` | `"via [$symbol$workspace]($style) "` | La cadena de formato para el módulo. | | `format` | `"via [$symbol$workspace]($style) "` | La cadena de formato para el módulo. |
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"💠"` | Una cadena de formato que se muestra antes del espacio de trabajo de terraform. | | `symbol` | `"💠"` | A format string shown before the terraform workspace. |
| `detect_extensions` | `["tf", "tfplan", "tfstate"]` | Qué extensiones deberían activar este módulo. | | `detect_extensions` | `["tf", "tfplan", "tfstate"]` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. | | `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[".terraform"]` | Qué carpetas deberían activar este módulo. | | `detect_folders` | `[".terraform"]` | Qué carpetas deberían activar este módulo. |
| `style` | `"bold 105"` | El estilo del módulo. | | `style` | `"bold 105"` | El estilo del módulo. |
| `disabled` | `false` | Desactiva el módulo `terraform`. | | `disabled` | `false` | Disables the `terraform` module. |
### Variables ### Variables
| Variable | Ejemplo | Descripción | | Variable | Ejemplo | Descripción |
| --------- | ---------------- | ----------------------------------------- | | --------- | ---------------- | -------------------------------------- |
| version | `v0.12.24` | La versión de `terraform` | | version | `v0.12.24` | The version of `terraform` |
| workspace | `predeterminado` | El espacio de trabajo actual de Terraform | | workspace | `predeterminado` | The current Terraform workspace |
| symbol | | Refleja el valor de la opción `symbol` | | symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` | | style\* | | Refleja el valor de la opción `style` |
@ -3317,7 +3355,7 @@ format = "[🏎💨 $workspace]($style) "
## Hora ## Hora
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. The `time` module shows the current **local** time. The `format` configuration value is used by the [`chrono`](https://crates.io/crates/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) to see what options are available.
::: tip ::: tip
@ -3328,22 +3366,22 @@ Este módulo está deshabilitado por defecto. Para activarlo, establece `disable
### Opciones ### Opciones
| Opción | Por defecto | Descripción | | Opción | Por defecto | Descripción |
| ----------------- | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `format` | `"at [$time]($style) "` | La cadena de formato para el módulo. | | `format` | `"at [$time]($style) "` | La cadena de formato para el módulo. |
| `use_12hr` | `false` | Habilita el formato de 12 horas | | `use_12hr` | `false` | Enables 12 hour formatting |
| `time_format` | ver abajo | La [cadena de formato de chrono](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) utilizada para formatear la hora. | | `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 para la hora del módulo | | `style` | `"bold yellow"` | The style for the module time |
| `utc_time_offset` | `"local"` | Establece el desplazamiento UTC a utilizar. Rango de -24 &lt; x &lt; 24. Permite a los flotantes acomodar los desplazamientos de zona horaria de 30/45 minutos. | | `utc_time_offset` | `"local"` | Sets the UTC offset to use. Range from -24 &lt; x &lt; 24. Allows floats to accommodate 30/45 minute timezone offsets. |
| `disabled` | `true` | Deshabilita el módulo `time`. | | `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 | | `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format |
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`. If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Otherwise, it defaults to `"%T"`. Manually setting `time_format` will override the `use_12hr` setting.
### Variables ### Variables
| Variable | Ejemplo | Descripción | | Variable | Ejemplo | Descripción |
| --------- | ---------- | ------------------------------------- | | --------- | ---------- | ------------------------------------- |
| hora | `13:08:10` | La hora actual. | | time | `13:08:10` | The current time. |
| style\* | | Refleja el valor de la opción `style` | | style\* | | Refleja el valor de la opción `style` |
*: Esta variable sólo puede ser usada como parte de una cadena de estilo *: Esta variable sólo puede ser usada como parte de una cadena de estilo
@ -3361,37 +3399,37 @@ utc_time_offset = "-5"
time_range = "10:00:00-14:00:00" time_range = "10:00:00-14:00:00"
``` ```
## Nombre de usuario ## Username
El módulo `username` muestra el nombre de usuario activo. El módulo se muestra si algunas de las siguientes condiciones se cumplen: The `username` module shows active user's username. The module will be shown if any of the following conditions are met:
- El usuario actual es root/admin - The current user is root/admin
- El usuario actual no es el mismo que el que está conectado - The current user isn't the same as the one that is logged in
- El usuario está actualmente conectado como una sesión SSH - The user is currently connected as an SSH session
- La variable `show_always` se establece en true - The variable `show_always` is set to true
::: tip ::: tip
La conexión SSH se detecta comprobando las variables de entorno `SSH_CONNECTION`, `SSH_CLIENT`, y `SSH_TTY`. Si su host SSH no configura estas variables, una solución es establecer una de ellas con un valor tonto. SSH connection is detected by checking environment variables `SSH_CONNECTION`, `SSH_CLIENT`, and `SSH_TTY`. If your SSH host does not set up these variables, one workaround is to set one of them with a dummy value.
::: :::
### Opciones ### Opciones
| Opción | Por defecto | Descripción | | Opción | Predeterminado | Descripción |
| ------------- | ----------------------- | ------------------------------------------------ | | ------------- | ----------------------- | ------------------------------------------- |
| `style_root` | `"bold red"` | El estilo usado cuando el usuario es root/admin. | | `style_root` | `"bold red"` | The style used when the user is root/admin. |
| `style_user` | `"bold yellow"` | El estilo usado para usuarios no root. | | `style_user` | `"bold yellow"` | The style used for non-root users. |
| `format` | `"[$user]($style) in "` | El formato del módulo. | | `format` | `"[$user]($style) in "` | El formato del módulo. |
| `show_always` | `false` | Siempre muestra el módulo `username`. | | `show_always` | `false` | Always shows the `username` module. |
| `disabled` | `false` | Desactiva el módulo `username`. | | `disabled` | `false` | Disables the `username` module. |
### Variables ### Variables
| Variable | Ejemplo | Descripción | | 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. | | `style` | `"red bold"` | Mirrors the value of option `style_root` when root is logged in and `style_user` otherwise. |
| `usuario` | `"matchai"` | El ID de usuario conectado actualmente. | | `usuario` | `"matchai"` | The currently logged-in user ID. |
### Ejemplo ### Ejemplo
@ -3408,9 +3446,9 @@ show_always = true
## Vagrant ## Vagrant
El módulo `vagrant` muestra la versión instalada de [Vagrant](https://www.vagrantup.com/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: The `vagrant` module shows the currently installed version of [Vagrant](https://www.vagrantup.com/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
- El directorio actual contiene un archivo `Vagrantfile` - The current directory contains a `Vagrantfile` file
### Opciones ### Opciones
@ -3418,18 +3456,18 @@ El módulo `vagrant` muestra la versión instalada de [Vagrant](https://www.vagr
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | | `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"⍱ "` | Una cadena de formato que representa el símbolo de Vagrant. | | `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. |
| `detect_extensions` | `[]` | Qué extensiones deberían activar este módulo. | | `detect_extensions` | `[]` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `["Vagrantfile"]` | Qué nombres de archivo deberían activar este módulo. | | `detect_files` | `["Vagrantfile"]` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | | `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
| `style` | `"cyan bold"` | El estilo del módulo. | | `style` | `"cyan bold"` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `vagrant`. | | `disabled` | `false` | Disables the `vagrant` module. |
### Variables ### Variables
| Variable | Ejemplo | Descripción | | Variable | Ejemplo | Descripción |
| --------- | ---------------- | -------------------------------------- | | --------- | ---------------- | -------------------------------------- |
| version | `Vagrant 2.2.10` | La versión de `Vagrant` | | version | `Vagrant 2.2.10` | The version of `Vagrant` |
| symbol | | Refleja el valor de la opción `symbol` | | symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` | | style\* | | Refleja el valor de la opción `style` |
@ -3446,10 +3484,10 @@ format = "via [⍱ $version](bold white) "
## V ## V
El módulo `vlang` te muestra la versión instalada de [V](https://vlang.io/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: The `vlang` module shows you your currently installed version of [V](https://vlang.io/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
- El directorio actual contiene un archivo con la extensión `.v` - The current directory contains a file with `.v` extension
- El directorio actual contiene un archivo `v.mod`, `vpkg.json` o `.vpkg-lock.json` - The current directory contains a `v.mod`, `vpkg.json` or `.vpkg-lock.json` file
### Opciones ### Opciones
@ -3457,18 +3495,18 @@ El módulo `vlang` te muestra la versión instalada de [V](https://vlang.io/). P
| ------------------- | -------------------------------------------- | --------------------------------------------------------------------------------------- | | ------------------- | -------------------------------------------- | --------------------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | | `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"V "` | Una cadena de formato que representa el símbolo de V | | `symbol` | `"V "` | A format string representing the symbol of V |
| `detect_extensions` | `["v"]` | Qué extensiones deberían activar este módulo. | | `detect_extensions` | `["v"]` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Qué nombres de archivo deberían activar este módulo. | | `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | | `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
| `style` | `"blue bold"` | El estilo del módulo. | | `style` | `"blue bold"` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `vlang`. | | `disabled` | `false` | Disables the `vlang` module. |
### Variables ### Variables
| Variable | Ejemplo | Descripción | | Variable | Ejemplo | Descripción |
| --------- | ------- | -------------------------------------- | | --------- | ------- | -------------------------------------- |
| version | `v0.2` | La versión de `v` | | version | `v0.2` | The version of `v` |
| symbol | | Refleja el valor de la opción `symbol` | | symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` | | style\* | | Refleja el valor de la opción `style` |
@ -3482,22 +3520,22 @@ format = "via [V $version](blue bold) "
## VCSH ## VCSH
El módulo `vcsh` muestra el repositorio activo [VCSH](https://github.com/RichiH/vcsh) actual. El módulo sólo se mostrará si un repositorio está actualmente en uso. The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. The module will be shown only if a repository is currently in use.
### Opciones ### Opciones
| Opción | Predeterminado | Descripción | | Opción | Predeterminado | Descripción |
| ---------- | -------------------------------- | ------------------------------------------------------------ | | ---------- | -------------------------------- | ------------------------------------------------------ |
| `symbol` | | El símbolo usado antes de mostrar el nombre del repositorio. | | `symbol` | | The symbol used before displaying the repository name. |
| `style` | `"bold yellow"` | El estilo del módulo. | | `style` | `"bold yellow"` | El estilo del módulo. |
| `format` | `"vcsh [$symbol$repo]($style) "` | El formato del módulo. | | `format` | `"vcsh [$symbol$repo]($style) "` | El formato del módulo. |
| `disabled` | `false` | Deshabilita el módulo `vcsh`. | | `disabled` | `false` | Disables the `vcsh` module. |
### Variables ### Variables
| Variable | Ejemplo | Descripción | | Variable | Ejemplo | Descripción |
| ----------- | ----------------------------------------------------------- | -------------------------------------- | | --------- | ------------------------------------------- | -------------------------------------- |
| repositorio | `dotfiles` si está en un repositorio VCSH nombrado dotfiles | El nombre del repositorio activo | | repo | `dotfiles` if in a VCSH repo named dotfiles | The active repository name |
| symbol | | Refleja el valor de la opción `symbol` | | symbol | | Refleja el valor de la opción `symbol` |
| style\* | `black bold dimmed` | Refleja el valor de la opción `style` | | style\* | `black bold dimmed` | Refleja el valor de la opción `style` |
@ -3514,9 +3552,9 @@ format = "[🆅 $repo](bold blue) "
## Zig ## Zig
Por defecto, el módulo `zig` muestra la versión instalada de [Zig](https://ziglang.org/). El módulo se muestra si algunas de las siguientes condiciones se cumplen: By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met:
- El directorio actual contiene un archivo `.zig` - The current directory contains a `.zig` file
### Opciones ### Opciones
@ -3524,9 +3562,9 @@ Por defecto, el módulo `zig` muestra la versión instalada de [Zig](https://zig
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | | `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"↯ "` | El símbolo usado antes de mostrar la versión de Zig. | | `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. |
| `style` | `"bold yellow"` | El estilo del módulo. | | `style` | `"bold yellow"` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `zig`. | | `disabled` | `false` | Disables the `zig` module. |
| `detect_extensions` | `["zig"]` | Qué extensiones deberían activar este módulo. | | `detect_extensions` | `["zig"]` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. | | `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | | `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
@ -3535,7 +3573,7 @@ Por defecto, el módulo `zig` muestra la versión instalada de [Zig](https://zig
| Variable | Ejemplo | Descripción | | Variable | Ejemplo | Descripción |
| --------- | -------- | -------------------------------------- | | --------- | -------- | -------------------------------------- |
| version | `v0.6.0` | La versión de `zig` | | version | `v0.6.0` | The version of `zig` |
| symbol | | Refleja el valor de la opción `symbol` | | symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` | | style\* | | Refleja el valor de la opción `style` |
@ -3550,68 +3588,68 @@ Por defecto, el módulo `zig` muestra la versión instalada de [Zig](https://zig
symbol = "⚡️ " symbol = "⚡️ "
``` ```
## Comandos personalizados ## Custom commands
Los módulos `personalizados` muestran la salida de algunos comandos arbitrarios. The `custom` modules show the output of some arbitrary commands.
Estos módulos se mostrarán si se cumplen alguna de las siguientes condiciones: These modules will be shown if any of the following conditions are met:
- El directorio actual contiene un archivo cuyo nombre está en `detect_files` - The current directory contains a file whose name is in `detect_files`
- El directorio actual contiene un directorio cuyo nombre está en `detect_folders` - The current directory contains a directory whose name is in `detect_folders`
- El directorio actual contiene un archivo cuya extensión está en `detect_extensions` - The current directory contains a file whose extension is in `detect_extensions`
- El comando `when` devuelve 0 - The `when` command returns 0
- El sistema operativo actual (std::env::consts::OS) coincide con el campo `os` si está definido. - The current Operating System (std::env::consts::OS) matches with `os` field if defined.
::: tip ::: tip
Múltiples módulos personalizados pueden definirse usando una `.`. Multiple custom modules can be defined by using a `.`.
::: :::
::: tip ::: 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. 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 ::: 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í! [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!
::: :::
::: warning la salida de comandos se imprime sin escapar al prompt ::: warning Command output is printed unescaped to the prompt
Cualquiera que sea la salida que genere el comando se imprime sin modificar en el prompt. Esto significa que si la salida contiene secuencias especiales que son interpretadas por el intérprete, se expandirán cuando se muestre. Estas secuencias especiales son específicas del intérprete, por ejemplo, puedes escribir un módulo de comando que escribe secuencias de bash, por ejemplo, `\h`, pero este módulo no funcionará en el intérprete fish o zsh. Whatever output the command generates is printed unmodified in the prompt. This means if the output contains special sequences that are interpreted by your shell they will be expanded when displayed. These special sequences are shell specific, e.g. you can write a command module that writes bash sequences, e.g. `\h`, but this module will not work in a fish or zsh shell.
Las cadenas de formato también pueden contener secuencias específicas del intérprete, por ejemplo, [Bash](https://www.gnu.org/software/bash/manual/html_node/Controlling-the-Prompt.html), [Zsh](https://zsh.sourceforge.io/Doc/Release/Prompt-Expansion.html). Format strings can also contain shell specific prompt sequences, e.g. [Bash](https://www.gnu.org/software/bash/manual/html_node/Controlling-the-Prompt.html), [Zsh](https://zsh.sourceforge.io/Doc/Release/Prompt-Expansion.html).
::: :::
### Opciones ### Opciones
| Opción | Predeterminado | Descripción | | Opción | Predeterminado | Descripción |
| ------------------- | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `command` | `""` | El comando cuya salida debe ser impresa. El comando se pasará en stdin al shell. | | `command` | `""` | The command whose output should be printed. The command will be passed on stdin to the shell. |
| `when` | `false` | Valor booleano (`true` o `false`, sin comillas) o un comando de shell usado como una condición para mostrar el módulo. En caso de una cadena, el módulo se mostrará si el comando devuelve un código de estado `0`. | | `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. |
| `shell` | | [Ver abajo](#custom-command-shell) | | `shell` | | [See below](#custom-command-shell) |
| `descripción` | `"<custom module>"` | La descripción del módulo que se muestra al ejecutar `starship explain`. | | `description` | `"<custom module>"` | The description of the module that is shown when running `starship explain`. |
| `detect_files` | `[]` | Los archivos que se buscarán en el directorio de trabajo para obtener una coincidencia. | | `detect_files` | `[]` | The files that will be searched in the working directory for a match. |
| `detect_folders` | `[]` | Los directorios que se buscarán en el directorio de trabajo para una coincidencia. | | `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. |
| `detect_extensions` | `[]` | Las extensiones que se buscarán en el directorio de trabajo para obtener una coincidencia. | | `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. |
| `symbol` | `""` | El símbolo usado antes de mostrar la salida del comando. | | `symbol` | `""` | The symbol used before displaying the command output. |
| `style` | `"bold green"` | El estilo del módulo. | | `style` | `"bold green"` | El estilo del módulo. |
| `format` | `"[$symbol($output )]($style)"` | El formato del módulo. | | `format` | `"[$symbol($output )]($style)"` | El formato del módulo. |
| `disabled` | `false` | Deshabilita este módulo `custom`. | | `disabled` | `false` | Disables this `custom` module. |
| `os` | | Nombre del sistema operativo en el que se mostrará el módulo (unix, linux, macos, windows, ... ) [Ver valores posibles](https://doc.rust-lang.org/std/env/consts/constant.OS.html). | | `os` | | Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) [See possible values](https://doc.rust-lang.org/std/env/consts/constant.OS.html). |
| `use_stdin` | | Un valor booleano opcional que anula si los comandos deben ser reenviados al shell a través de la entrada estándar o como argumento. Si la entrada estándar unset es usada de manera predeterminada, a menos que el shell no lo soporte (cmd, nushell). Configurar esto desactiva el manejo de argumentos específicos del shell. | | `use_stdin` | | An optional boolean value that overrides whether commands should be forwarded to the shell via the standard input or as an argument. If unset standard input is used by default, unless the shell does not support it (cmd, nushell). Setting this disables shell-specific argument handling. |
| `ignore_timeout` | `false` | Ignorar la configuración global de `command_timeout` y seguir ejecutando comandos externos, sin importar el tiempo que tarden. | | `ignore_timeout` | `false` | Ignore global `command_timeout` setting and keep running external commands, no matter how long they take. |
### Variables ### Variables
| Variable | Descripción | | Variable | Descripción |
| --------- | ----------------------------------------- | | --------- | -------------------------------------- |
| output | La salida del comando de shell en `shell` | | output | The output of shell command in `shell` |
| symbol | Refleja el valor de la opción `symbol` | | symbol | Refleja el valor de la opción `symbol` |
| style\* | Refleja el valor de la opción `style` | | style\* | Refleja el valor de la opción `style` |
@ -3619,30 +3657,30 @@ Las cadenas de formato también pueden contener secuencias específicas del int
#### Comando personalizado del intérprete de comandos #### Comando personalizado del intérprete de comandos
`shell` acepta una lista no vacía de cadenas, donde: `shell` accepts a non-empty list of strings, where:
- La primera cadena es la ruta al intérprete de comandos a usar para ejecutar el comando. - The first string is the path to the shell to use to execute the command.
- Otros argumentos siguientes son pasados al shell. - Other following arguments are passed to the shell.
Si no está activado, se retornará a STARSHIP_SHELL y luego a "sh" en Linux, y "cmd /C" en Windows. If unset, it will fallback to STARSHIP_SHELL and then to "sh" on Linux, and "cmd /C" on Windows.
El `comando` será pasado en stdin. The `command` will be passed in on 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 -`. If `shell` is not given or only contains one element and Starship detects Cmd will be used, the following argument will automatically be added: `/C` and `stdin` will be set to `false`. If `shell` is not given or only contains one element and Starship detects Nushell will be used, the following arguments will automatically be added: `-c` and `stdin` will be set to `false`. Este comportamiento puede evitarse pasando explícitamente argumentos al intérprete, p.ej. 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 -`. If `shell` is not given or only contains one element and Starship detects Cmd will be used, the following argument will automatically be added: `/C` and `stdin` will be set to `false`. If `shell` is not given or only contains one element and Starship detects Nushell will be used, the following arguments will automatically be added: `-c` and `stdin` will be set to `false`. This behavior can be avoided by explicitly passing arguments to the shell, e.g.
```toml ```toml
shell = ["pwsh", "-Command", "-"] shell = ["pwsh", "-Command", "-"]
``` ```
::: warning Asegúrate de que tu configuración personalizada del intérprete de comandos salga con éxito ::: warning Make sure your custom shell configuration exits gracefully
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`). 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).
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. 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.
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. 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.
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. 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.
::: :::

View File

@ -256,11 +256,12 @@ Install the latest version for your system with the MSI-installers from the [rel
Instalar Starship usando cualquiera de los siguientes gestores de paquetes: Instalar Starship usando cualquiera de los siguientes gestores de paquetes:
| Repositorio | Instrucciones | | Repositorio | Instrucciones |
| -------------------------------------------------------------------------------- | --------------------------------------- | | -------------------------------------------------------------------------------------------- | --------------------------------------- |
| **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
| [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` | | [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` |
| [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` | | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
| [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json) | `scoop install starship` | | [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json) | `scoop install starship` |
| [winget](https://github.com/microsoft/winget-pkgs/tree/master/manifests/s/Starship/Starship) | `winget install --id Starship.Starship` |
</details> </details>

View File

@ -538,19 +538,19 @@ Par défaut, il ne change que la couleur. Si vous désirez également changer sa
::: warning ::: warning
`vicmd_symbol` nest supporté que dans cmd, fish et zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148).
::: :::
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| -------------------------- | -------------------- | --------------------------------------------------------------------------------------- | | --------------------------- | -------------------- | --------------------------------------------------------------------------------------- |
| `format` | `"$symbol "` | Le format utilisée avant l'entrée de texte. | | `format` | `"$symbol "` | Le format utilisée avant l'entrée de texte. |
| `success_symbol` | `"[](bold green)"` | Le format utilisé avant l'entrée de texte si la commande précédente a réussi. | | `success_symbol` | `"[](bold green)"` | Le format utilisé avant l'entrée de texte si la commande précédente a réussi. |
| `error_symbol` | `"[](bold red)"` | Le format utilisé avant l'entrée de texte si la commande précédente a échoué. | | `error_symbol` | `"[](bold red)"` | Le format utilisé avant l'entrée de texte si la commande précédente a échoué. |
| `vicmd_symbol` | `"[](bold green)"` | Le format utilisé avant l'entrée de texte si le shell est en mode vim normal. | | `vimcmd_symbol` | `"[](bold green)"` | Le format utilisé avant l'entrée de texte si le shell est en mode vim normal. |
| `vicmd_replace_one_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. | | `vimcmd_replace_one_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. |
| `vimcmd_replace_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. | | `vimcmd_replace_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. |
| `vimcmd_visual_symbol` | `"[](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. | | `vimcmd_visual_symbol` | `"[](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. |
| `disabled` | `false` | Désactive le module `character`. | | `disabled` | `false` | Désactive le module `character`. |
@ -2794,11 +2794,49 @@ Le module `rlang` affiche la version de [R](https://www.r-project.org/) actuelle
format = "with [📐 $version](blue bold) " format = "with [📐 $version](blue bold) "
``` ```
## Raku
The `raku` module shows the currently installed version of [Raku](https://www.raku.org/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- The current directory contains a `META6.json` file
- The current directory contains a `.p6`, `.pm6`, `.raku`, `.rakumod` or `.pod6`
### Options
| Option | Défaut | Description |
| ------------------- | ------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| `format` | `"via [$symbol($version-$vm_version )]($style)"` | La chaîne de format pour le module. |
| `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🦋 "` | The symbol used before displaying the version of Raku |
| `detect_extensions` | `["p6", "pm6", "pod6", "raku", "rakumod"]` | Quelles extensions devraient activer ce module. |
| `detect_files` | `["META6.json"]` | Les fichiers qui activent ce module. |
| `detect_folders` | `[]` | Les dossiers qui activent ce module. |
| `style` | `"bold 149"` | Le style du module. |
| `disabled` | `false` | Disables the `raku` module. |
### Variables
| Variable | Exemple | Description |
| ---------- | ------- | -------------------------------------- |
| version | `v6.d` | The version of `raku` |
| vm_version | `moar` | The version of VM `raku` is built on |
| symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` |
### Exemple
```toml
# ~/.config/starship.toml
[raku]
format = "via [🦪 $version]($style) "
```
## Red ## Red
Par défaut, le module `red` affiche la version actuellement installée de [Red](https://www.red-lang.org/). Le module sera affiché si l'une de ces conditions est remplie: By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met:
- Le répertoire actuel contient un fichier avec l'extension `.red` ou `.reds` - The current directory contains a file with `.red` or `.reds` extension
### Options ### Options
@ -2806,18 +2844,18 @@ Par défaut, le module `red` affiche la version actuellement installée de [Red]
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `format` | `"via [$symbol($version )]($style)"` | Format du module. |
| `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🔺 "` | Une chaîne de caractères représentant le symbole de Red. | | `symbol` | `"🔺 "` | A format string representing the symbol of Red. |
| `detect_extensions` | `["red"]` | Quelles extensions devraient activer ce module. | | `detect_extensions` | `["red"]` | Quelles extensions devraient activer ce module. |
| `detect_files` | `[]` | Les fichiers qui activent ce module. | | `detect_files` | `[]` | Les fichiers qui activent ce module. |
| `detect_folders` | `[]` | Les dossiers qui activent ce module. | | `detect_folders` | `[]` | Les dossiers qui activent ce module. |
| `style` | `"red bold"` | Le style du module. | | `style` | `"red bold"` | Le style du module. |
| `disabled` | `false` | Désactive le module `red`. | | `disabled` | `false` | Disables the `red` module. |
### Variables ### Variables
| Variable | Exemple | Description | | Variable | Exemple | Description |
| --------- | -------- | -------------------------------------- | | --------- | -------- | -------------------------------------- |
| version | `v2.5.1` | La version de `red` | | version | `v2.5.1` | The version of `red` |
| symbol | | Reflète la valeur de l'option `symbol` | | symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` | | style\* | | Reflète la valeur de l'option `style` |
@ -2834,14 +2872,14 @@ symbol = "🔴 "
## Ruby ## Ruby
Par défaut, le module `ruby` affiche la version actuellement installée de [Ruby](https://www.ruby-lang.org/). Le module sera affiché si l'une de ces conditions est remplie: By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). The module will be shown if any of the following conditions are met:
- Le répertoire courant contient un fichier `Gemfile` - The current directory contains a `Gemfile` file
- Le répertoire courant contient un fichier `.ruby-version` - The current directory contains a `.ruby-version` file
- Le répertoire courant contient un fichier `.rb` - The current directory contains a `.rb` file
- La variable denvironnement `RUBY_VERSION` ou `RBENV_VERSION` est définie - The environment variables `RUBY_VERSION` or `RBENV_VERSION` are set
Starship obtient la version actuelle de Ruby en exécutant `ruby -v`. Starship gets the current Ruby version by running `ruby -v`.
### Options ### Options
@ -2849,19 +2887,19 @@ Starship obtient la version actuelle de Ruby en exécutant `ruby -v`.
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `format` | `"via [$symbol($version )]($style)"` | Format du module. |
| `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"💎 "` | Une chaîne de caractères représentant le symbole de Ruby. | | `symbol` | `"💎 "` | A format string representing the symbol of Ruby. |
| `detect_extensions` | `["rb"]` | Quelles extensions devraient activer ce module. | | `detect_extensions` | `["rb"]` | Quelles extensions devraient activer ce module. |
| `detect_files` | `["Gemfile", ".ruby-version"]` | Les fichiers qui activent ce module. | | `detect_files` | `["Gemfile", ".ruby-version"]` | Les fichiers qui activent ce module. |
| `detect_folders` | `[]` | Les dossiers qui activent ce module. | | `detect_folders` | `[]` | Les dossiers qui activent ce module. |
| `detect_variables` | `["RUBY_VERSION", "RBENV_VERSION"]` | Les variables denvironnement qui activent ce module. | | `detect_variables` | `["RUBY_VERSION", "RBENV_VERSION"]` | Which environment variables should trigger this module. |
| `style` | `"bold green"` | Le style du module. | | `style` | `"bold green"` | Le style du module. |
| `disabled` | `false` | Désactive le module `ruby`. | | `disabled` | `false` | Disables the `ruby` module. |
### Variables ### Variables
| Variable | Exemple | Description | | Variable | Exemple | Description |
| --------- | -------- | -------------------------------------- | | --------- | -------- | -------------------------------------- |
| version | `v2.5.1` | La version de `ruby` | | version | `v2.5.1` | The version of `ruby` |
| symbol | | Reflète la valeur de l'option `symbol` | | symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` | | style\* | | Reflète la valeur de l'option `style` |
@ -2878,10 +2916,10 @@ symbol = "🔺 "
## Rust ## Rust
Par défaut, le module `rust` affiche la version actuellement installée de [Rust](https://www.rust-lang.org/). Le module sera affiché si l'une de ces conditions est remplie: By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). The module will be shown if any of the following conditions are met:
- Le répertoire courant contient un fichier `Cargo.toml` - The current directory contains a `Cargo.toml` file
- Le répertoire actuel contient un fichier avec l'extension `.rs` - The current directory contains a file with the `.rs` extension
### Options ### Options
@ -2889,18 +2927,18 @@ Par défaut, le module `rust` affiche la version actuellement installée de [Rus
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `format` | `"via [$symbol($version )]($style)"` | Format du module. |
| `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🦀 "` | Une chaîne de caractères représentant le symbole de Rust | | `symbol` | `"🦀 "` | A format string representing the symbol of Rust |
| `detect_extensions` | `["rs"]` | Quelles extensions devraient activer ce module. | | `detect_extensions` | `["rs"]` | Quelles extensions devraient activer ce module. |
| `detect_files` | `["Cargo.toml"]` | Les fichiers qui activent ce module. | | `detect_files` | `["Cargo.toml"]` | Les fichiers qui activent ce module. |
| `detect_folders` | `[]` | Les dossiers qui activent ce module. | | `detect_folders` | `[]` | Les dossiers qui activent ce module. |
| `style` | `"bold green"` | Le style du module. | | `style` | `"bold green"` | Le style du module. |
| `disabled` | `false` | Désactive le module `rust`. | | `disabled` | `false` | Disables the `rust` module. |
### Variables ### Variables
| Variable | Exemple | Description | | Variable | Exemple | Description |
| --------- | ----------------- | -------------------------------------------- | | --------- | ----------------- | -------------------------------------------- |
| version | `v1.43.0-nightly` | La version de `rustc` | | version | `v1.43.0-nightly` | The version of `rustc` |
| numver | `1.51.0` | The numeric component of the `rustc` version | | numver | `1.51.0` | The numeric component of the `rustc` version |
| toolchain | `beta` | The toolchain version | | toolchain | `beta` | The toolchain version |
| symbol | | Reflète la valeur de l'option `symbol` | | symbol | | Reflète la valeur de l'option `symbol` |
@ -2919,11 +2957,11 @@ format = "via [⚙️ $version](red bold)"
## Scala ## Scala
Le module `scala` affiche la version actuellement installée de [Scala](https://www.scala-lang.org/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire courant contient un fichier `build.sbt`, `.scalaenv` ou `.sbtenv` - The current directory contains a `build.sbt`, `.scalaenv` or `.sbtenv` file
- Le répertoire actuel contient un fichier avec l'extension `.scala` ou `.sbt` - The current directory contains a file with the `.scala` or `.sbt` extension
- Le répertoire courant contient un répertoire nommé `.metals` - The current directory contains a directory named `.metals`
### Options ### Options
@ -2934,15 +2972,15 @@ Le module `scala` affiche la version actuellement installée de [Scala](https://
| `detect_extensions` | `["sbt", "scala"]` | Quelles extensions devraient activer ce module. | | `detect_extensions` | `["sbt", "scala"]` | Quelles extensions devraient activer ce module. |
| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Les fichiers qui activent ce module. | | `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Les fichiers qui activent ce module. |
| `detect_folders` | `[".metals"]` | Quels dossiers devraient activer ce module. | | `detect_folders` | `[".metals"]` | Quels dossiers devraient activer ce module. |
| `symbol` | `"🆂 "` | Une chaîne de caractères représentant le symbole de Scala. | | `symbol` | `"🆂 "` | A format string representing the symbol of Scala. |
| `style` | `"red dimmed"` | Le style du module. | | `style` | `"red dimmed"` | Le style du module. |
| `disabled` | `false` | Désactive le module `scala`. | | `disabled` | `false` | Disables the `scala` module. |
### Variables ### Variables
| Variable | Exemple | Description | | Variable | Exemple | Description |
| --------- | -------- | -------------------------------------- | | --------- | -------- | -------------------------------------- |
| version | `2.13.5` | La version de `scala` | | version | `2.13.5` | The version of `scala` |
| symbol | | Reflète la valeur de l'option `symbol` | | symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` | | style\* | | Reflète la valeur de l'option `style` |
@ -2959,7 +2997,7 @@ symbol = "🌟 "
## Shell ## Shell
Le module `shell` affiche un indicateur en fonction du shell actuellement utilisé. The `shell` module shows an indicator for currently used shell.
::: tip ::: tip
@ -2970,28 +3008,28 @@ Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| ---------------------- | ------------------------- | ----------------------------------------------------------- | | ---------------------- | ------------------------- | ------------------------------------------------------------ |
| `bash_indicator` | `bsh` | Une chaîne de format utilisée pour représenter bash. | | `bash_indicator` | `bsh` | A format string used to represent bash. |
| `fish_indicator` | `fsh` | Une chaîne de format utilisée pour représenter fish. | | `fish_indicator` | `fsh` | A format string used to represent fish. |
| `zsh_indicator` | `zsh` | Une chaîne de format utilisée pour représenter zsh. | | `zsh_indicator` | `zsh` | A format string used to represent zsh. |
| `powershell_indicator` | `psh` | Une chaîne de format utilisée pour représenter powershell. | | `powershell_indicator` | `psh` | A format string used to represent powershell. |
| `ion_indicator` | `ion` | Une chaîne de format utilisée pour représenter ion. | | `ion_indicator` | `ion` | A format string used to represent ion. |
| `elvish_indicator` | `esh` | Une chaîne de format utilisée pour représenter elvish. | | `elvish_indicator` | `esh` | A format string used to represent elvish. |
| `tcsh_indicator` | `tsh` | Une chaîne de format utilisée pour représenter tcsh. | | `tcsh_indicator` | `tsh` | A format string used to represent tcsh. |
| `xonsh_indicator` | `xsh` | Chaine de formatage utilisée pour représenter xonsh. | | `xonsh_indicator` | `xsh` | A format string used to represent xonsh. |
| `cmd_indicator` | `cmd` | Chaine de formatage utilisée pour représenter cmd. | | `cmd_indicator` | `cmd` | A format string used to represent cmd. |
| `nu_indicator` | `nu` | Chaine de formatage utilisée pour représenter nu. | | `nu_indicator` | `nu` | A format string used to represent nu. |
| `unknown_indicator` | | La valeur par défaut à afficher quand le shell est inconnu. | | `unknown_indicator` | | The default value to be displayed when the shell is unknown. |
| `format` | `"[$indicator]($style) "` | Format du module. | | `format` | `"[$indicator]($style) "` | Format du module. |
| `style` | `"white bold"` | Le style du module. | | `style` | `"white bold"` | Le style du module. |
| `disabled` | `true` | Désactive le module `shell`. | | `disabled` | `true` | Disables the `shell` module. |
### Variables ### Variables
| Variable | Défaut | Description | | Variable | Défaut | Description |
| --------- | ------ | ------------------------------------------------- | | --------- | ------ | ---------------------------------------------------------- |
| indicator | | Reflète la valeur de `indicator` du shell actuel. | | indicator | | Mirrors the value of `indicator` for currently used shell. |
| style\* | | Reflète la valeur de l'option `style`. | | style\* | | Mirrors the value of option `style`. |
*: Cette variable peut uniquement être utilisée dans une chaine de style *: Cette variable peut uniquement être utilisée dans une chaine de style
@ -3003,31 +3041,31 @@ Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur
[shell] [shell]
fish_indicator = "" fish_indicator = ""
powershell_indicator = "_" powershell_indicator = "_"
unknown_indicator = "shell mystère" unknown_indicator = "mystery shell"
style = "cyan bold" style = "cyan bold"
disabled = false disabled = false
``` ```
## SHLVL ## SHLVL
Le module `shlvl` montre la variable denvironnement [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) («niveau de shell») actuelle, si elle a une valeur numérique qui est égale ou dépasse le seuil défini. The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold.
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| ----------- | ---------------------------- | ----------------------------------------------------------------------- | | ----------- | ---------------------------- | ------------------------------------------------------------- |
| `threshold` | `2` | Seuil daffichage. | | `threshold` | `2` | Display threshold. |
| `format` | `"[$symbol$shlvl]($style) "` | Format du module. | | `format` | `"[$symbol$shlvl]($style) "` | Format du module. |
| `symbol` | `"↕️ "` | Le symbole utilisée pour représenter le `SHLVL`. | | `symbol` | `"↕️ "` | The symbol used to represent the `SHLVL`. |
| `repeat` | `false` | Fait répéter `symbol` autant de fois que la valeur actuelle de `SHLVL`. | | `repeat` | `false` | Causes `symbol` to be repeated by the current `SHLVL` amount. |
| `style` | `"bold yellow"` | Le style du module. | | `style` | `"bold yellow"` | Le style du module. |
| `disabled` | `true` | Désactive le module `shlvl`. | | `disabled` | `true` | Disables the `shlvl` module. |
### Variables ### Variables
| Variable | Exemple | Description | | Variable | Exemple | Description |
| --------- | ------- | -------------------------------------- | | --------- | ------- | -------------------------------------- |
| shlvl | `3` | La valeur actuelle de `SHLVL` | | shlvl | `3` | The current value of `SHLVL` |
| symbol | | Reflète la valeur de l'option `symbol` | | symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` | | style\* | | Reflète la valeur de l'option `style` |
@ -3046,22 +3084,22 @@ threshold = 3
## Singularity ## Singularity
Le module `singularity` affiche limage [Singularity](https://sylabs.io/singularity/) courante, quand vous êtes à lintérieur dun conteneur et que `$SINGULARITY_NAME` est définie. The `singularity` module shows the current [Singularity](https://sylabs.io/singularity/) image, if inside a container and `$SINGULARITY_NAME` is set.
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| ---------- | -------------------------------- | ------------------------------------------------------ | | ---------- | -------------------------------- | ------------------------------------------------ |
| `format` | `'[$symbol\[$env\]]($style) '` | Format du module. | | `format` | `'[$symbol\[$env\]]($style) '` | Format du module. |
| `symbol` | `""` | Une chaîne de format affichée avant le nom de l'image. | | `symbol` | `""` | A format string displayed before the image name. |
| `style` | `"bold dimmed blue"` | Le style du module. | | `style` | `"bold dimmed blue"` | Le style du module. |
| `disabled` | `false` | Désactive le module `singularity`. | | `disabled` | `false` | Disables the `singularity` module. |
### Variables ### Variables
| Variable | Exemple | Description | | Variable | Exemple | Description |
| --------- | ------------ | -------------------------------------- | | --------- | ------------ | -------------------------------------- |
| env | `centos.img` | Limage Singularity actuelle | | env | `centos.img` | The current Singularity image |
| symbol | | Reflète la valeur de l'option `symbol` | | symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` | | style\* | | Reflète la valeur de l'option `style` |
@ -3078,23 +3116,23 @@ format = '[📦 \[$env\]]($style) '
## Spack ## Spack
Le module `spack` affiche lenvironnement [Spack](https://spack.readthedocs.io/en/latest/) courant, si `$SPACK_ENV` est définie. The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set.
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| ------------------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | ------------------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `truncation_length` | `1` | Le nombre de dossiers auxquels le chemin denvironnement doit être tronqué. `0` ne signifie pas de troncature. Regardez aussi le module [`directory`](#directory). | | `truncation_length` | `1` | The number of directories the environment path should be truncated to. `0` ne signifie pas de troncature. Regardez aussi le module [`directory`](#directory). |
| `symbol` | `"🅢 "` | Le symbole utilisé avant le nom d'environnement. | | `symbol` | `"🅢 "` | Le symbole utilisé avant le nom d'environnement. |
| `style` | `"bold blue"` | Le style du module. | | `style` | `"bold blue"` | Le style du module. |
| `format` | `"via [$symbol$environment]($style) "` | Format du module. | | `format` | `"via [$symbol$environment]($style) "` | Format du module. |
| `disabled` | `false` | Désactive le module `spack`. | | `disabled` | `false` | Disables the `spack` module. |
### Variables ### Variables
| Variable | Exemple | Description | | Variable | Exemple | Description |
| ------------- | ------------ | -------------------------------------- | | ------------- | ------------ | -------------------------------------- |
| environnement | `astronauts` | Lenvironnement de spack courant | | environnement | `astronauts` | The current spack environment |
| symbol | | Reflète la valeur de l'option `symbol` | | symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` | | style\* | | Reflète la valeur de l'option `style` |
@ -3111,7 +3149,7 @@ format = "[$symbol$environment](dimmed blue) "
## Status ## Status
Le module `status` affiche le code de sortie de la commande précédente. Si $success_symbol est vide (par défaut), ce module sera affiché uniquement quand le code de sortie nest pas `0`. Le code de statut est converti en entier signé 32 bits. The `status` module displays the exit code of the previous command. If $success_symbol is empty (default), the module will be shown only if the exit code is not `0`. The status code will cast to a signed 32-bit integer.
::: tip ::: tip
@ -3136,16 +3174,16 @@ Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur
| `pipestatus` | `false` | Enable pipestatus reporting | | `pipestatus` | `false` | Enable pipestatus reporting |
| `pipestatus_separator` | `|` | | | `pipestatus_separator` | `|` | |
| `pipestatus_format` | `\\[$pipestatus\\] => [$symbol$common_meaning$signal_name$maybe_int]($style)` | The format of the module when the command is a pipeline | | `pipestatus_format` | `\\[$pipestatus\\] => [$symbol$common_meaning$signal_name$maybe_int]($style)` | The format of the module when the command is a pipeline |
| `disabled` | `true` | Désactiver le module `status`. | | `disabled` | `true` | Disables the `status` module. |
### Variables ### Variables
| Variable | Exemple | Description | | Variable | Exemple | Description |
| -------------- | ------- | ------------------------------------------------------------------------------------------- | | -------------- | ------- | ------------------------------------------------------------------------------------------- |
| status | `127` | Le code de sortie de la dernière commande | | status | `127` | The exit code of the last command |
| hex_status | `0x7F` | Le code de sortie de la dernière commande en hexa | | hex_status | `0x7F` | The exit code of the last command in hex |
| int | `127` | Le code de sortie de la dernière commande | | int | `127` | The exit code of the last command |
| common_meaning | `ERROR` | Signification du code si nest pas un signal | | common_meaning | `ERROR` | Meaning of the code if not a signal |
| signal_number | `9` | Signal number corresponding to the exit code, only if signalled | | signal_number | `9` | Signal number corresponding to the exit code, only if signalled |
| signal_name | `KILL` | Name of the signal corresponding to the exit code, only if signalled | | signal_name | `KILL` | Name of the signal corresponding to the exit code, only if signalled |
| maybe_int | `7` | Contains the exit code number when no meaning has been found | | maybe_int | `7` | Contains the exit code number when no meaning has been found |
@ -3171,7 +3209,7 @@ disabled = false
## Sudo ## Sudo
Le moduel `sudo` affiche si les identifiants sudo sont actuellement en cache. Le module sera uniquement affiché si les identifiants sont en cache. The `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached.
::: tip ::: tip
@ -3182,12 +3220,12 @@ Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| --------------- | ----------------------- | ----------------------------------------------------------------- | | --------------- | ----------------------- | ------------------------------------------------------- |
| `format` | `[as $symbol]($style)"` | Le format du module | | `format` | `[as $symbol]($style)"` | Le format du module |
| `symbol` | `"🧙 "` | Le symbole affiché quand les identifiants sont en cache | | `symbol` | `"🧙 "` | The symbol displayed when credentials are cached |
| `style` | `"bold blue"` | Le style du module. | | `style` | `"bold blue"` | Le style du module. |
| `allow_windows` | `false` | Puisque Windows na pas de sudo par défaut, désactivé par défaut. | | `allow_windows` | `false` | Since windows has no default sudo, default is disabled. |
| `disabled` | `true` | Désactive le module `sudo`. | | `disabled` | `true` | Disables the `sudo` module. |
### Variables ### Variables
@ -3210,7 +3248,7 @@ disabled = false
``` ```
```toml ```toml
# Sous Windows # On windows
# $HOME\.starship\config.toml # $HOME\.starship\config.toml
[sudo] [sudo]
@ -3220,10 +3258,10 @@ disabled = false
## Swift ## Swift
Par défaut, le module `swift` affiche la version actuellement installée de [Swift](https://swift.org/). Le module sera affiché si l'une de ces conditions est remplie: By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). The module will be shown if any of the following conditions are met:
- Le répertoire courant contient un fichier `Package.swift` - The current directory contains a `Package.swift` file
- Le répertoire actuel contient un fichier avec l'extension `.swift` - The current directory contains a file with the `.swift` extension
### Options ### Options
@ -3231,18 +3269,18 @@ Par défaut, le module `swift` affiche la version actuellement installée de [Sw
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `format` | `"via [$symbol($version )]($style)"` | Format du module. |
| `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🐦 "` | Une chaîne de caractères représentant le symbole de Swift | | `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
| `detect_extensions` | `["swift"]` | Quelles extensions devraient activer ce module. | | `detect_extensions` | `["swift"]` | Quelles extensions devraient activer ce module. |
| `detect_files` | `["Package.swift"]` | Les fichiers qui activent ce module. | | `detect_files` | `["Package.swift"]` | Les fichiers qui activent ce module. |
| `detect_folders` | `[]` | Les dossiers qui activent ce module. | | `detect_folders` | `[]` | Les dossiers qui activent ce module. |
| `style` | `"bold 202"` | Le style du module. | | `style` | `"bold 202"` | Le style du module. |
| `disabled` | `false` | Désactiver le module `swift`. | | `disabled` | `false` | Disables the `swift` module. |
### Variables ### Variables
| Variable | Exemple | Description | | Variable | Exemple | Description |
| --------- | -------- | -------------------------------------- | | --------- | -------- | -------------------------------------- |
| version | `v5.2.4` | La version de `swift` | | version | `v5.2.4` | The version of `swift` |
| symbol | | Reflète la valeur de l'option `symbol` | | symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` | | style\* | | Reflète la valeur de l'option `style` |
@ -3259,18 +3297,18 @@ format = "via [🏎 $version](red bold)"
## Terraform ## Terraform
Le module `terraform` affiche [lespace de travail Terraform](https://www.terraform.io/docs/language/state/workspaces.html) sélectionné et sa version. The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version.
::: tip ::: tip
Par défaut, la version de Terraform nest pas affichée, car elle est lente pour les versions actuelles de Terraform quand beaucoup de plugins sont utilisés. Si vous voulez quand même lactiver, [suivez lexemple montré plus bas](#with-terraform-version). By default the Terraform version is not shown, since this is slow for 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-terraform-version).
::: :::
Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire courant contient un dossier `.terraform` - The current directory contains a `.terraform` folder
- Le répertoire courant contient un fichier avec lextension `.tf`, `.tfplan` ou `.tfstate` - Current directory contains a file with the `.tf`, `.tfplan` or `.tfstate` extensions
### Options ### Options
@ -3278,19 +3316,19 @@ Par défaut le module sera activé si au moins l'une des conditions suivantes es
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------ |
| `format` | `"via [$symbol$workspace]($style) "` | La chaîne de format pour le module. | | `format` | `"via [$symbol$workspace]($style) "` | La chaîne de format pour le module. |
| `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"💠"` | Une chaîne de format montrée avant l'espace de travail terraform. | | `symbol` | `"💠"` | A format string shown before the terraform workspace. |
| `detect_extensions` | `["tf", "tfplan", "tfstate"]` | Quelles extensions devraient activer ce module. | | `detect_extensions` | `["tf", "tfplan", "tfstate"]` | Quelles extensions devraient activer ce module. |
| `detect_files` | `[]` | Les fichiers qui activent ce module. | | `detect_files` | `[]` | Les fichiers qui activent ce module. |
| `detect_folders` | `[".terraform"]` | Les dossiers qui activent ce module. | | `detect_folders` | `[".terraform"]` | Les dossiers qui activent ce module. |
| `style` | `"bold 105"` | Le style du module. | | `style` | `"bold 105"` | Le style du module. |
| `disabled` | `false` | Désactive le module `terraform`. | | `disabled` | `false` | Disables the `terraform` module. |
### Variables ### Variables
| Variable | Exemple | Description | | Variable | Exemple | Description |
| --------- | ---------- | -------------------------------------- | | --------- | ---------- | -------------------------------------- |
| version | `v0.12.24` | La version de `terraform` | | version | `v0.12.24` | The version of `terraform` |
| workspace | `default` | Lespace de travail Terraform courant | | workspace | `default` | The current Terraform workspace |
| symbol | | Reflète la valeur de l'option `symbol` | | symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` | | style\* | | Reflète la valeur de l'option `style` |
@ -3318,7 +3356,7 @@ format = "[🏎💨 $workspace]($style) "
## Date et Heure ## Date et Heure
Le module `time` affiche l'heure actuelle **localement**. La valeur de `format` est utilisée par le package [`chrono`](https://crates.io/crates/chrono) pour contrôler la façon dont l'heure est affichée. Consultez la [doc de chrono strftime](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) pour découvrir les options disponibles. The `time` module shows the current **local** time. The `format` configuration value is used by the [`chrono`](https://crates.io/crates/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) to see what options are available.
::: tip ::: tip
@ -3329,22 +3367,22 @@ Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| ----------------- | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `format` | `"at [$time]($style) "` | La chaîne de format pour le module. | | `format` | `"at [$time]($style) "` | La chaîne de format pour le module. |
| `use_12hr` | `false` | Activer le format 12h | | `use_12hr` | `false` | Enables 12 hour formatting |
| `time_format` | voir plus bas | Le [format chrono](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) utilisé pour formater l'heure. | | `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. |
| `style` | `"bold yellow"` | Le style utilisé par le module | | `style` | `"bold yellow"` | The style for the module time |
| `utc_time_offset` | `"local"` | Définir le décalage horaire UTC à utiliser. Intervalle de -24 &lt; x &lt; 24. Accepte des nombres décimaux pour s'adapter aux décalages de 30/45 minutes. | | `utc_time_offset` | `"local"` | Sets the UTC offset to use. Range from -24 &lt; x &lt; 24. Allows floats to accommodate 30/45 minute timezone offsets. |
| `disabled` | `true` | Désactiver le module `time`. | | `disabled` | `true` | Disables the `time` module. |
| `time_range` | `"-"` | Définit la plage de temps pendant laquelle le module sera affiché. Les heures doivent être spécifiées au format 24 heures | | `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format |
Si `use_12hr` est à `true`, alors `time_format` vaut `"%r"`. Sinon, il est défini comme `"%T"`. Définir manuellement `time_format` outrepasse le paramètre `use_12hr`. If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Otherwise, it defaults to `"%T"`. Manually setting `time_format` will override the `use_12hr` setting.
### Variables ### Variables
| Variable | Exemple | Description | | Variable | Exemple | Description |
| --------- | ---------- | ------------------------------------- | | --------- | ---------- | ------------------------------------- |
| time | `13:08:10` | Lheure actuelle. | | time | `13:08:10` | The current time. |
| style\* | | Reflète la valeur de l'option `style` | | style\* | | Reflète la valeur de l'option `style` |
*: Cette variable peut uniquement être utilisée dans une chaine de style *: Cette variable peut uniquement être utilisée dans une chaine de style
@ -3362,14 +3400,14 @@ utc_time_offset = "-5"
time_range = "10:00:00-14:00:00" time_range = "10:00:00-14:00:00"
``` ```
## Nom d'utilisateur ## Username
Le module `username` affiche le nom d'utilisateur de l'utilisateur actif. Le module sera affiché si l'une de 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/admin - The current user is root/admin
- L'utilisateur courant est différent de celui connecté - The current user isn't the same as the one that is logged in
- L'utilisateur est actuellement connecté à une session SSH - The user is currently connected as an SSH session
- La variable `show_always` a comme valeur true - The variable `show_always` is set to true
::: tip ::: tip
@ -3380,19 +3418,19 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, `
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| ------------- | ----------------------- | ---------------------------------------------------- | | ------------- | ----------------------- | ------------------------------------------- |
| `style_root` | `"bold green"` | Le style utilisé quand l'utilisateur est root/admin. | | `style_root` | `"bold green"` | The style used when the user is root/admin. |
| `style_user` | `"bold yellow"` | Le style utilisé pour les utilisateurs non-root. | | `style_user` | `"bold yellow"` | The style used for non-root users. |
| `format` | `"[$user]($style) in "` | Format du module. | | `format` | `"[$user]($style) in "` | Format du module. |
| `show_always` | `false` | Toujours afficher le module `username`. | | `show_always` | `false` | Always shows the `username` module. |
| `disabled` | `false` | Désactiver le module `username`. | | `disabled` | `false` | Disables the `username` module. |
### Variables ### Variables
| Variable | Exemple | Description | | Variable | Exemple | Description |
| -------- | ------------ | ------------------------------------------------------------------------------------------- | | -------- | ------------ | ------------------------------------------------------------------------------------------- |
| `style` | `"red bold"` | Mirrors the value of option `style_root` when root is logged in and `style_user` otherwise. | | `style` | `"red bold"` | Mirrors the value of option `style_root` when root is logged in and `style_user` otherwise. |
| `user` | `"matchai"` | Lidentifiant de lutilisateur courant. | | `user` | `"matchai"` | The currently logged-in user ID. |
### Exemple ### Exemple
@ -3409,9 +3447,9 @@ show_always = true
## Vagrant ## Vagrant
Le module `vagrant` affiche la version actuellement installée de [Vagrant](https://www.vagrantup.com/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: The `vagrant` module shows the currently installed version of [Vagrant](https://www.vagrantup.com/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire courant contient un fichier `Vagrantfile` - The current directory contains a `Vagrantfile` file
### Options ### Options
@ -3419,18 +3457,18 @@ Le module `vagrant` affiche la version actuellement installée de [Vagrant](http
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `format` | `"via [$symbol($version )]($style)"` | Format du module. |
| `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"⍱ "` | Une chaîne de caractères représentant le symbole de Vagrant. | | `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. |
| `detect_extensions` | `[]` | Quelles extensions devraient activer ce module. | | `detect_extensions` | `[]` | Quelles extensions devraient activer ce module. |
| `detect_files` | `["Vagrantfile"]` | Les fichiers qui activent ce module. | | `detect_files` | `["Vagrantfile"]` | Les fichiers qui activent ce module. |
| `detect_folders` | `[]` | Les dossiers qui activent ce module. | | `detect_folders` | `[]` | Les dossiers qui activent ce module. |
| `style` | `"cyan bold"` | Le style du module. | | `style` | `"cyan bold"` | Le style du module. |
| `disabled` | `false` | Désactive le module `vagrant`. | | `disabled` | `false` | Disables the `vagrant` module. |
### Variables ### Variables
| Variable | Exemple | Description | | Variable | Exemple | Description |
| --------- | ---------------- | -------------------------------------- | | --------- | ---------------- | -------------------------------------- |
| version | `Vagrant 2.2.10` | La version de `Vagrant` | | version | `Vagrant 2.2.10` | The version of `Vagrant` |
| symbol | | Reflète la valeur de l'option `symbol` | | symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` | | style\* | | Reflète la valeur de l'option `style` |
@ -3447,10 +3485,10 @@ format = "via [⍱ $version](bold white) "
## V ## V
Le module `vlang` affiche la version de [V](https://vlang.io/) installée. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: The `vlang` module shows you your currently installed version of [V](https://vlang.io/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le répertoire courant contient un fichier avec l'extension `.v` - The current directory contains a file with `.v` extension
- Le répertoire courant contient un fichier `v.mod`, `vpkg.json` ou `.vpkg-lock.json` - The current directory contains a `v.mod`, `vpkg.json` or `.vpkg-lock.json` file
### Options ### Options
@ -3458,18 +3496,18 @@ Le module `vlang` affiche la version de [V](https://vlang.io/) installée. Par d
| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------------------------ | | ------------------- | -------------------------------------------- | ------------------------------------------------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `format` | `"via [$symbol($version )]($style)"` | Format du module. |
| `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"V "` | Une chaîne de caractères représentant le symbole de V | | `symbol` | `"V "` | A format string representing the symbol of V |
| `detect_extensions` | `["v"]` | Quelles extensions devraient activer ce module. | | `detect_extensions` | `["v"]` | Quelles extensions devraient activer ce module. |
| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Les fichiers qui activent ce module. | | `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Les fichiers qui activent ce module. |
| `detect_folders` | `[]` | Les dossiers qui activent ce module. | | `detect_folders` | `[]` | Les dossiers qui activent ce module. |
| `style` | `"blue bold"` | Le style du module. | | `style` | `"blue bold"` | Le style du module. |
| `disabled` | `false` | Désactive le module `vlang`. | | `disabled` | `false` | Disables the `vlang` module. |
### Variables ### Variables
| Variable | Exemple | Description | | Variable | Exemple | Description |
| --------- | ------- | -------------------------------------- | | --------- | ------- | -------------------------------------- |
| version | `v0.2` | La version de `v` | | version | `v0.2` | The version of `v` |
| symbol | | Reflète la valeur de l'option `symbol` | | symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` | | style\* | | Reflète la valeur de l'option `style` |
@ -3488,17 +3526,17 @@ The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/v
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| ---------- | -------------------------------- | ---------------------------------------------------- | | ---------- | -------------------------------- | ------------------------------------------------------ |
| `symbol` | | Le symbole utilisé avant d'afficher le nom du dépôt. | | `symbol` | | The symbol used before displaying the repository name. |
| `style` | `"bold yellow"` | Le style du module. | | `style` | `"bold yellow"` | Le style du module. |
| `format` | `"vcsh [$symbol$repo]($style) "` | Format du module. | | `format` | `"vcsh [$symbol$repo]($style) "` | Format du module. |
| `disabled` | `false` | Désactive le module `vcsh`. | | `disabled` | `false` | Disables the `vcsh` module. |
### Variables ### Variables
| Variable | Exemple | Description | | Variable | Exemple | Description |
| --------- | ----------------------------------------------- | -------------------------------------- | | --------- | ------------------------------------------- | -------------------------------------- |
| repo | `dotfiles` si dans un dépôt VCSH nommé dotfiles | Le nom du dépôt actif | | repo | `dotfiles` if in a VCSH repo named dotfiles | The active repository name |
| symbol | | Reflète la valeur de l'option `symbol` | | symbol | | Reflète la valeur de l'option `symbol` |
| style\* | `black bold dimmed` | Reflète la valeur de l'option `style` | | style\* | `black bold dimmed` | Reflète la valeur de l'option `style` |
@ -3515,9 +3553,9 @@ format = "[🆅 $repo](bold blue) "
## Zig ## Zig
Par défaut, le module `zig` affiche la version actuellement installée de [Zig](https://ziglang.org/). Le module sera affiché si l'une de ces conditions est remplie: By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met:
- Le répertoire courant contient un fichier `.zig` - The current directory contains a `.zig` file
### Options ### Options
@ -3525,9 +3563,9 @@ Par défaut, le module `zig` affiche la version actuellement installée de [Zig]
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `format` | `"via [$symbol($version )]($style)"` | Format du module. |
| `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"↯ "` | Le symbole utilisé avant d'afficher la version de Zig. | | `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. |
| `style` | `"bold yellow"` | Le style du module. | | `style` | `"bold yellow"` | Le style du module. |
| `disabled` | `false` | Désactive le module `zig`. | | `disabled` | `false` | Disables the `zig` module. |
| `detect_extensions` | `["zig"]` | Quelles extensions devraient activer ce module. | | `detect_extensions` | `["zig"]` | Quelles extensions devraient activer ce module. |
| `detect_files` | `[]` | Les fichiers qui activent ce module. | | `detect_files` | `[]` | Les fichiers qui activent ce module. |
| `detect_folders` | `[]` | Les dossiers qui activent ce module. | | `detect_folders` | `[]` | Les dossiers qui activent ce module. |
@ -3536,7 +3574,7 @@ Par défaut, le module `zig` affiche la version actuellement installée de [Zig]
| Variable | Exemple | Description | | Variable | Exemple | Description |
| --------- | -------- | -------------------------------------- | | --------- | -------- | -------------------------------------- |
| version | `v0.6.0` | La version de `zig` | | version | `v0.6.0` | The version of `zig` |
| symbol | | Reflète la valeur de l'option `symbol` | | symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` | | style\* | | Reflète la valeur de l'option `style` |
@ -3551,21 +3589,21 @@ Par défaut, le module `zig` affiche la version actuellement installée de [Zig]
symbol = "⚡️ " symbol = "⚡️ "
``` ```
## Commandes personnalisées ## Custom commands
Les modules `custom` affichent la sortie dune commande arbitaitre. The `custom` modules show the output of some arbitrary commands.
Ces modules seront affichés si l'une de ces conditions est remplie: These modules will be shown if any of the following conditions are met:
- Le dossier courant contient un fichier dont le nom est dans `detect_files` - The current directory contains a file whose name is in `detect_files`
- Le dossier courant contient un dossier dont le nom est dans `detect_folders` - The current directory contains a directory whose name is in `detect_folders`
- Le dossier courant contient un fichier dont lextension est dans `detect_extensions` - The current directory contains a file whose extension is in `detect_extensions`
- La commande `when` retourne 0 - The `when` command returns 0
- Le système dexploitation courant (std::env::consts::OS) correspond au champ `os` si défini. - The current Operating System (std::env::consts::OS) matches with `os` field if defined.
::: tip ::: tip
Plusieurs modules personnalisés peuvent être définis en utilisant un `.`. Multiple custom modules can be defined by using a `.`.
::: :::
@ -3593,26 +3631,26 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt
| Option | Défaut | Description | | Option | Défaut | Description |
| ------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `command` | `""` | La commande dont la sortie doit être affichée. La commande sera transmise au shell sur lentrée standard. | | `command` | `""` | The command whose output should be printed. The command will be passed on stdin to the shell. |
| `when` | `false` | Soit une valeur booléenne (`true` ou `false`, sans guillemets) ou une commande shell utilisée comme condition pour afficher le module. Dans le cas dune chaine, le module sera affiché si la commande renvoie un code de statut `0`. | | `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. |
| `shell` | | [Voir plus bas](#custom-command-shell) | | `shell` | | [See below](#custom-command-shell) |
| `description` | `"<custom module>"` | La description du module qui est affichée lors de lexécution de `starship explain`. | | `description` | `"<custom module>"` | The description of the module that is shown when running `starship explain`. |
| `detect_files` | `[]` | The files that will be searched in the working directory for a match. | | `detect_files` | `[]` | The files that will be searched in the working directory for a match. |
| `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. | | `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. |
| `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. | | `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. |
| `symbol` | `""` | Le symbole utilisé avant d'afficher la sortie de la commande. | | `symbol` | `""` | The symbol used before displaying the command output. |
| `style` | `"bold green"` | Le style du module. | | `style` | `"bold green"` | Le style du module. |
| `format` | `"[$symbol($output )]($style)"` | Format du module. | | `format` | `"[$symbol($output )]($style)"` | Format du module. |
| `disabled` | `false` | Désactive le module `custom`. | | `disabled` | `false` | Disables this `custom` module. |
| `os` | | Nom du système d'exploitation sur lequel le module sera affiché (unix, linux, macos, windows, ... ) [Voir les valeurs possibles](https://doc.rust-lang.org/std/env/consts/constant.OS.html). | | `os` | | Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) [See possible values](https://doc.rust-lang.org/std/env/consts/constant.OS.html). |
| `use_stdin` | | An optional boolean value that overrides whether commands should be forwarded to the shell via the standard input or as an argument. If unset standard input is used by default, unless the shell does not support it (cmd, nushell). Setting this disables shell-specific argument handling. | | `use_stdin` | | An optional boolean value that overrides whether commands should be forwarded to the shell via the standard input or as an argument. If unset standard input is used by default, unless the shell does not support it (cmd, nushell). Setting this disables shell-specific argument handling. |
| `ignore_timeout` | `false` | Ignore le paramètre global `command_timeout` et continuer à exécuter des commandes externes, peu importe le temps qu'elles prennent. | | `ignore_timeout` | `false` | Ignore global `command_timeout` setting and keep running external commands, no matter how long they take. |
### Variables ### Variables
| Variable | Description | | Variable | Description |
| --------- | ------------------------------------------- | | --------- | -------------------------------------- |
| output | La sortie de la commande shell dans `shell` | | output | The output of shell command in `shell` |
| symbol | Reflète la valeur de l'option `symbol` | | symbol | Reflète la valeur de l'option `symbol` |
| style\* | Reflète la valeur de l'option `style` | | style\* | Reflète la valeur de l'option `style` |
@ -3620,9 +3658,9 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt
#### Commandes shell personnalisées #### Commandes shell personnalisées
`shell` accepte une liste de chaînes non vide, où: `shell` accepts a non-empty list of strings, where:
- La première chaîne est le chemin vers le shell à utiliser pour exécuter la commande. - The first string is the path to the shell to use to execute the command.
- Other following arguments are passed to the shell. - Other following arguments are passed to the shell.
If unset, it will fallback to STARSHIP_SHELL and then to "sh" on Linux, and "cmd /C" on Windows. If unset, it will fallback to STARSHIP_SHELL and then to "sh" on Linux, and "cmd /C" on Windows.

View File

@ -256,11 +256,12 @@ Install the latest version for your system with the MSI-installers from the [rel
Installez Starship en utilisant lun de ces gestionnaires de paquets: Installez Starship en utilisant lun de ces gestionnaires de paquets:
| Dépôt | Instructions | | Dépôt | Instructions |
| -------------------------------------------------------------------------------- | --------------------------------------- | | -------------------------------------------------------------------------------------------- | --------------------------------------- |
| **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
| [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` | | [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` |
| [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` | | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
| [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json) | `scoop install starship` | | [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json) | `scoop install starship` |
| [winget](https://github.com/microsoft/winget-pkgs/tree/master/manifests/s/Starship/Starship) | `winget install --id Starship.Starship` |
</details> </details>

View File

@ -7,18 +7,18 @@ actionText: Mari Mulai →
actionLink: ./guide/ actionLink: ./guide/
features: features:
- -
title: Mengutamakan Kompabilitas title: Kompatibilitas Yang Utama
details: Dapat bekerja di shells yang paling biasa dengan sistem operasi yang paling biasa. Bisa digunakan di mana saja! details: Dapat berfungsi di shells standar dengan sistem operasi yang paling biasa. Pakai di mana saja!
- -
title: Dibuat Dengan Rust title: Dibangun Dengan Rust
details: Menggunakan kecepatan dan keamanan dari Rust, untuk membuat prompt kamu bekerja secepat dan seandal mungkin. details: Menggunakan kecepatan dan keamanan dari Rust, untuk membuat prompt kamu bekerja secepat dan seandal mungkin.
- -
title: Dapat Dikustomisasi title: Dapat Dikustomisasi
details: Semua detail kecil yang ada dapat kamu atur sesukamu, entah untuk membuatnya sebagai prompt yang seminimal mungkin atau mungkin kaya akan fitur sesuai keinginanmu. details: Kamu dapat mengatur semua detail kecil dengan sesukamu, entah itu untuk membuatnya sebagai prompt yang seminimal mungkin atau kaya akan fitur yang kamu mau.
footer: Berlisensi ISC | Hak Cipta © 2019-sekarang Kontributor Starship footer: Berlisensi ISC | Hak Cipta © 2019-sekarang Kontributor Starship
#Used for the description meta tag, for SEO #Used for the description meta tag, for SEO
metaTitle: "Starship: Prompt Lintas Shell" metaTitle: "Starship: Prompt Lintas Shell"
description: Starship merupakan sebuah prompt yang minimal, super cepat, dan sangat bisa untuk dikustomisasi untuk shell apapun! Bisa menampilkan informasi yang kamu butuhkan, namun tetap bisa tampil dengan ramping dan minimal. Pemasangan singkat tersedia untuk Bash, Fish, ZSH, Ion, Tcsh, Elvish, Nu, Xonsh, Cmd, dan PowerShell. description: Starship merupakan sebuah prompt yang minimal, super cepat, dan sangat bisa untuk dikustomisasi untuk shell apapun! Bisa menampilkan informasi yang kamu butuhkan, namun tetap bisa tampil dengan ramping dan minimal. Instalasi sederhana tersedia untuk Bash, Fish, ZSH, Ion, Tcsh, Elvish, Nu, Xonsh, Cmd, dan PowerShell.
--- ---
<div class="center"> <div class="center">
@ -30,7 +30,7 @@ description: Starship merupakan sebuah prompt yang minimal, super cepat, dan san
### Prasyarat ### Prasyarat
- [Nerd Font](https://www.nerdfonts.com/) yang telah terinstalasi dan telah diaktifkan di dalam terminal. - [Nerd Font](https://www.nerdfonts.com/) yang sudah terpasang dan berjalan di dalam terminalmu.
### Instalasi Sederhana ### Instalasi Sederhana
@ -45,7 +45,7 @@ description: Starship merupakan sebuah prompt yang minimal, super cepat, dan san
curl -sS https://starship.rs/install.sh | sh curl -sS https://starship.rs/install.sh | sh
``` ```
Untuk memperbarui Starship, jalankan kembali skrip di atas. Hal ini dapat memperbarui versi yang terpasang tanpa mengubah konfigurasi Starship. Untuk memperbarui Starship, jalankan ulang skrip di atas. Hal ini akan memperbarui versi yang terpasang tanpa mengubah konfigurasi Starship.
#### Pasang Melalui Package Manager #### Pasang Melalui Package Manager
@ -122,7 +122,7 @@ description: Starship merupakan sebuah prompt yang minimal, super cepat, dan san
::: warning ::: warning
Only elvish v0.18 or higher is supported. Hanya elvish v0.18 atau versi yang lebih baru yang mendapat dukungan pengembangan.
::: :::
@ -150,11 +150,11 @@ description: Starship merupakan sebuah prompt yang minimal, super cepat, dan san
::: warning ::: warning
This will change in the future. Hanya Nushell v0.61+ yang menerima dukungan. Hal ini dapat berubah di kemudian hari. Hanya Nushell v0.61+ yang menerima dukungan.
::: :::
Add the following to to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell): Tambahkan baris berikut di akhir env file Nushell (dengan menjalankan `$nu.env-path` di Nushell):
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu starship init nu | save ~/.cache/starship/init.nu

View File

@ -1,18 +1,18 @@
# Konfigurasi Lanjutan # Konfigurasi Lanjutan
Meskipun Starship tergolong sebagai shell yang serbaguna, terkadang kita butuh upaya yang lebih dari sekadar mengedit `starship.toml` untuk membuatnya menjalankan beberapa hal tertentu. Halaman ini merincikan beberapa teknik konfigurasi lanjutan yang digunakan oleh starship. Walaupun Starship adalah shell yang serbaguna, terkadang kita butuh upaya lebih dari sekadar mengedit `starship.toml` untuk membuatnya menjalankan beberapa hal tertentu. Halaman ini merincikan beberapa teknik konfigurasi lanjutan yang digunakan starship.
::: warning ::: warning
Konfigurasi pada bagian ini dapat berubah saat pembaruan Starship rilis di kemudian hari nanti. Konfigurasi pada bagian ini dapat berubah saat Starship terbaru rilis di kemudian hari nanti.
::: :::
## Custom pre-prompt and pre-execution Commands in Cmd ## Kustomisasi Perintah pre-prompt dan pre-execution Pada Cmd
Clink provides extremely flexible APIs to run pre-prompt and pre-exec commands in Cmd shell. It is fairly simple to use with Starship. Make the following changes to your `starship.lua` file as per your requirements: Clink menyediakan APIs yang sangat fleksibel untuk menjalankan perintah pre-prompt dan pre-exec di Cmd shell. Caranya sangat mudah dengan Starship. Ubahlah file `starship.lua` sesuai kebutuhanmu:
- To run a custom function right before the prompt is drawn, define a new function called `starship_preprompt_user_func`. This function receives the current prompt as a string that you can utilize. For example, to draw a rocket before the prompt, you would do - Untuk menjalankan custom function sebelum prompt muncul, definisikan function baru dengan nama `starship_preprompt_user_func`. Function ini menerima prompt yang berjalan sebagai string yang mampu kamu gunakan. Sebagai contoh, untuk menampilkan roket sebelum prompt, kamu bisa
```lua ```lua
function starship_preprompt_user_func(prompt) function starship_preprompt_user_func(prompt)
@ -22,7 +22,7 @@ end
load(io.popen('starship init cmd'):read("*a"))() load(io.popen('starship init cmd'):read("*a"))()
``` ```
- To run a custom function right before a command is executed, define a new function called `starship_precmd_user_func`. This function receives the current commandline as a string that you can utilize. For example, to print the command that's about to be executed, you would do - Untuk menjalankan custom function tepat sebelum perintah dieksekusi, definisikan function baru dengan nama `starship_precmd_user_func`. Function ini menerima prompt yang berjalan sebagai string yang mampu kamu gunakan. Sebagai contoh, untuk menampilkan perintah yang akan dieksekusi, kamu bisa
```lua ```lua
function starship_precmd_user_func(line) function starship_precmd_user_func(line)
@ -36,7 +36,7 @@ load(io.popen('starship init cmd'):read("*a"))()
Bash tidak memiliki framework preexec/precmd yang tetap seperti kebanyakan shell pada umumnya. Oleh karena itu, sulit halnya untuk membuat hook yang dapat dikustomisasi sepenuhnya di dalam `bash`. Namun, Starship memberikan beberapa cara supaya kamu bisa memasukkan fungsimu sendiri ke dalam prosedur prompt-rendering: Bash tidak memiliki framework preexec/precmd yang tetap seperti kebanyakan shell pada umumnya. Oleh karena itu, sulit halnya untuk membuat hook yang dapat dikustomisasi sepenuhnya di dalam `bash`. Namun, Starship memberikan beberapa cara supaya kamu bisa memasukkan fungsimu sendiri ke dalam prosedur prompt-rendering:
- Untuk menjalankan fungsi yang dikustomisasi tepat sebelum prompt, buatlah sebuah fungsi baru lalu berikan nama `starship_precmd_user_func` ke fungsi tersebut. Sebagai contoh, untuk menampilkan gambar roket sebelum prompt, kamu bisa melakukannya dengan cara - Untuk menjalankan custom function tepat sebelum prompt, buatlah sebuah fungsi baru lalu berikan nama `starship_precmd_user_func` ke fungsi tersebut. Sebagai contoh, untuk menampilkan roket sebelum prompt, kamu bisa
```bash ```bash
function blastoff(){ function blastoff(){
@ -45,7 +45,7 @@ function blastoff(){
starship_precmd_user_func="blastoff" starship_precmd_user_func="blastoff"
``` ```
- Untuk menjalankan fungsi yang dikustomisasi tepat sebelum commands berjalan, kamu bisa menggunakan [`DEBUG` trap mechanism](https://jichu4n.com/posts/debug-trap-and-prompt_command-in-bash/). Akan tetapi, kamu **harus** melakukan proses trap pada DEBUG signal _sebelum_ menjalankan Starship! Starship bisa menyimpan nilai dari DEBUG trap, tapi jika trap diganti setelah starship berjalan, beberapa fungsi akan rusak. - Untuk menjalankan custom function tepat sebelum perintah berjalan, kamu bisa menggunakan [`DEBUG` trap mechanism](https://jichu4n.com/posts/debug-trap-and-prompt_command-in-bash/). Akan tetapi, kamu **harus** melakukan proses trap pada DEBUG signal _sebelum_ menjalankan Starship! Starship bisa menyimpan nilai dari DEBUG trap, tapi jika trap diganti setelah starship berjalan, beberapa fungsi akan rusak.
```bash ```bash
function blastoff(){ function blastoff(){
@ -57,11 +57,11 @@ eval $(starship init bash)
set +o functrace set +o functrace
``` ```
## Custom pre-prompt and pre-execution Commands in PowerShell ## Perintah Custom pre-promt dan pre-execution di PowerShell
PowerShell does not have a formal preexec/precmd framework like most other shells. Because of this, it is difficult to provide fully customizable hooks in `powershell`. Namun, Starship memberikan beberapa cara supaya kamu bisa memasukkan fungsimu sendiri ke dalam prosedur prompt-rendering: PowerShell tidak memiliki framework preecex/precmd seperti kebanyak shells pada umumnya. Karena itu, sulit halnya untuk membuat hook yang dapat dikustomisasi sepenuhnya di dalam `powershell`. Namun, Starship memberimu sedikit kemampuan untuk bisa menambahkan function milikmu ke dalam prosedur prompt-rendering:
Create a function named `Invoke-Starship-PreCommand` Buatlah sebuah funciton dengan nama `Invoke-Starship-PreCommand`
```powershell ```powershell
function Invoke-Starship-PreCommand { function Invoke-Starship-PreCommand {
@ -71,9 +71,9 @@ function Invoke-Starship-PreCommand {
## Mengubah Judul Window ## Mengubah Judul Window
Beberapa prompt shell dengan otomatis akan mengubah judul window-nya untukmu (mis. untuk merefleksikan direktori kerjamu). Fish bahkan mengaturnya sebagai bawaan. Starship does not do this, but it's fairly straightforward to add this functionality to `bash`, `zsh`, `cmd` or `powershell`. Beberapa prompt shell dengan otomatis akan mengubah judul window-nya untukmu (mis. untuk merefleksikan direktori kerjamu). Fish bahkan mengaturnya sebagai bawaan. Di dalam Starship tidak bisa, namun mudah halnya untuk menambahkan fungsionalitas tersebut ke dalam `bash`, `zsh`, `cmd` ataupun `powershell`.
Pertama, buatlah fungsi untuk mengubah judul window (bekerja pada bash dan zsh): Pertama, buatlah function untuk mengubah judul window (pada bash dan zsh):
```bash ```bash
function set_win_title(){ function set_win_title(){
@ -83,7 +83,7 @@ function set_win_title(){
Kamu bisa menggunakan variabel untuk mengkustomisasi judulnya (`$USER`, `$HOSTNAME`, dan `$PWD` adalah opsi yang populer). Kamu bisa menggunakan variabel untuk mengkustomisasi judulnya (`$USER`, `$HOSTNAME`, dan `$PWD` adalah opsi yang populer).
Di dalam `bash`, atur fungsi berikut menjadi fungsi precmd untuk starship: Di dalam `bash`, atur function berikut menjadi function precmd untuk starship:
```bash ```bash
starship_precmd_user_func="set_win_title" starship_precmd_user_func="set_win_title"
@ -95,7 +95,7 @@ Dalam `zsh`, pada array `precmd_functions`, tambahkan:
precmd_functions+=(set_win_title) precmd_functions+=(set_win_title)
``` ```
Kalau kamu suka hasilnya, tambahkan baris (`~/.bashrc` or `~/.zshrc`) ke dalam file konfigurasi shell milikmu untuk membuatnya permanen. Kalau kamu suka dengan hasilnya, tambahkan baris (`~/.bashrc` or `~/.zshrc`) ke dalam file konfigurasi shell milikmu untuk membuatnya menjadi tetap.
Sebagai contoh, kalau kamu mau menampilkan lokasi direktori pada judul label terminalmu, tambahkan bagian berikut ke dalam `~/.bashrc` atau `~/.zshrc`: Sebagai contoh, kalau kamu mau menampilkan lokasi direktori pada judul label terminalmu, tambahkan bagian berikut ke dalam `~/.bashrc` atau `~/.zshrc`:
@ -106,7 +106,7 @@ function set_win_title(){
starship_precmd_user_func="set_win_title" starship_precmd_user_func="set_win_title"
``` ```
For Cmd, you can change the window title using the `starship_preprompt_user_func` function. Untuk Cmd, kamu dapat mengubah judul window-mu dengan menggunakan function `starship_preprompt_user_func`.
```lua ```lua
function starship_preprompt_user_func(prompt) function starship_preprompt_user_func(prompt)
@ -116,7 +116,7 @@ end
load(io.popen('starship init cmd'):read("*a"))() load(io.popen('starship init cmd'):read("*a"))()
``` ```
You can also set a similar output with PowerShell by creating a function named `Invoke-Starship-PreCommand`. Kamu juga dapat mengatur keluaran yang sama dengan PowerShell dengan membuat sebuah function bernama `Invoke-Starship-PreCommand`.
```powershell ```powershell
# edit $PROFILE # edit $PROFILE
@ -127,13 +127,13 @@ function Invoke-Starship-PreCommand {
Invoke-Expression (&starship init powershell) Invoke-Expression (&starship init powershell)
``` ```
## Enable Right Prompt ## Mengaktifkan Right Prompt
Some shells support a right prompt which renders on the same line as the input. Starship can set the content of the right prompt using the `right_format` option. Any module that can be used in `format` is also supported in `right_format`. The `$all` variable will only contain modules not explicitly used in either `format` or `right_format`. Sebagian shells mendukung right prompt yang mana dirender di baris yang sama sesuai dengan masukannya. Starship mampu mengatur konten right prompt dengan menggunakan opsi `right_format`. Semua modul yang bisa digunakan di dalam `format` juga dapat digunakan di dalam `right_format`. Variabel `$all` hanya akan memuat modul yang tidak digunakan secara eksplisit di dalam `format` ataupun `right_format`.
Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [`fill` module](/config/#fill). Catatan: Right propmt merupakan sebuah baris yang mengikuti lokasi baris inputan. Untuk membuat modul rata ke kanan di atas baris masukan di dalam multi-line prompt, lihat [`fill` module](/config/#fill).
`right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd. `right_format` saat ini hanya dapat bekerja pada beberapa shells berikut: elvish, fish, zsh, xonsh, cmd.
### Contoh ### Contoh
@ -150,18 +150,18 @@ right_format = """$all"""
Menghasilkan prompt seperti berikut: Menghasilkan prompt seperti berikut:
``` ```
starship on  rprompt [!] is 📦 v0.57.0 via 🦀 v1.54.0 took 17s starship on  rprompt [!] is 📦 v0.57.0 via 🦀 v1.54.0 took 17s
``` ```
## Continuation Prompt ## Prompt Berkelanjutan
Some shells support a continuation prompt along with the normal prompt. This prompt is rendered instead of the normal prompt when the user has entered an incomplete statement (such as a single left parenthesis or quote). Beberapa shells mendukung continuation prompt bersamaan dengan prompt biasa. Prompt tersebutlah yang akan dirender daripada prompt biasa ketika pengguna memasukkan perintah yang kurang lengkap (seperti tanda kurung atau tanda kutipan tunggal).
Starship can set the continuation prompt using the `continuation_prompt` option. The default prompt is `"[∙](bright-black) "`. Starship dapat mengatur continuation prompt dengan opsi `continuation_prompt`. Prompt bawaannya adalah `"[∙](bright-black) "`.
Note: `continuation_prompt` should be set to a literal string without any variables. Catatan: `continuation_prompt` harus diubah menjadi string literal tanpa variabel apapun.
Note: Continuation prompts are only available in the following shells: Catatan: Continuation prompts hanya tersedia pada beberapa shells berikut:
- `bash` - `bash`
- `zsh` - `zsh`
@ -172,13 +172,13 @@ Note: Continuation prompts are only available in the following shells:
```toml ```toml
# ~/.config/starship.toml # ~/.config/starship.toml
# A continuation prompt that displays two filled in arrows # Continuation prompt yang menampilkan dua panah solid
continuation_prompt = "▶▶" continuation_prompt = "▶▶"
``` ```
## Menata String ## Penataan String
Style strings are a list of words, separated by whitespace. Kumpulan katanya tidak bersifat case sensitive (mis. `tebal` dan `TeBaL` dianggap sebagai string yang sama). Tiap-tiap kata berikut adalah opsinya: Penataan string adalah kumpulan kata-kata, yang dipisahkan oleh ruang kosong. Kumpulannya tidak bersifat case sensitive (mis. `tebal` dan `TeBaL` dianggap sebagai string yang sama). Tiap-tiap kata berikut adalah opsinya:
- `bold` - `bold`
- `italic` - `italic`
@ -196,7 +196,7 @@ yang mana `<color>` merupakan sebuah penentu warna (dibahas di bawah). `fg:<colo
Penentuan warna bisa dilakukan dengan salah satu cara berikut: Penentuan warna bisa dilakukan dengan salah satu cara berikut:
- One of the standard terminal colors: `black`, `red`, `green`, `blue`, `yellow`, `purple`, `cyan`, `white`. You can optionally prefix these with `bright-` to get the bright version (e.g. `bright-white`). - Warna terminal pada umumnya terdiri dari: `black`, `red`, `green`, `blue`, `yellow`, `purple`, `cyan`, `white`. Secar opsional kamu bisa menambahkannya dengan `bright-` untuk mendapatkan versi yang lebih terang (mis. `bright-white`).
- Menuliskannya dengan menggunakan `#` dan diikuti oleh enam digit angka hexadesimal. Spesifikasi [kode heksadesimal pada warna RGB](https://www.w3schools.com/colors/colors_hexadecimal.asp). - Menuliskannya dengan menggunakan `#` dan diikuti oleh enam digit angka hexadesimal. Spesifikasi [kode heksadesimal pada warna RGB](https://www.w3schools.com/colors/colors_hexadecimal.asp).
- Menggunakan bilangan antara 0-255. Spesifikasi [8-bit Kode Warna ANSI](https://i.stack.imgur.com/KTSQa.png). - Menggunakan bilangan antara 0-255. Spesifikasi [8-bit Kode Warna ANSI](https://i.stack.imgur.com/KTSQa.png).

View File

@ -538,19 +538,19 @@ Secara bawaan karakter hanya dapat mengganti warna. Jika kamu juga ingin menggan
::: warning ::: warning
`vicmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148).
::: :::
### Opsi ### Opsi
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| -------------------------- | -------------------- | ------------------------------------------------------------------------------------------------- | | --------------------------- | -------------------- | ------------------------------------------------------------------------------------------------- |
| `fromat` | `"$symbol "` | Format string yang digunakan sebelum masukan teks. | | `fromat` | `"$symbol "` | Format string yang digunakan sebelum masukan teks. |
| `success_symbol` | `"[](bold green)"` | Format string yang digunakan sebelum masukan teks jika perintah sebelumnya berhasil. | | `success_symbol` | `"[](bold green)"` | Format string yang digunakan sebelum masukan teks jika perintah sebelumnya berhasil. |
| `error_symbol` | `"[](bold red)"` | Format string yang digunakan sebelum masukan teks jika perintah sebelumnya gagal. | | `error_symbol` | `"[](bold red)"` | Format string yang digunakan sebelum masukan teks jika perintah sebelumnya gagal. |
| `vicmd_symbol` | `"[](bold green)"` | Format string yang digunakan sebelum masukan teks jika shell sedang dalam vim dengan mode normal. | | `vimcmd_symbol` | `"[](bold green)"` | Format string yang digunakan sebelum masukan teks jika shell sedang dalam vim dengan mode normal. |
| `vicmd_replace_one_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. | | `vimcmd_replace_one_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. |
| `vimcmd_replace_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. | | `vimcmd_replace_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. |
| `vimcmd_visual_symbol` | `"[](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. | | `vimcmd_visual_symbol` | `"[](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. |
| `disabled` | `false` | Menonaktifkan module `character`. | | `disabled` | `false` | Menonaktifkan module `character`. |
@ -2793,6 +2793,44 @@ The `rlang` module shows the currently installed version of [R](https://www.r-pr
format = "with [📐 $version](blue bold) " format = "with [📐 $version](blue bold) "
``` ```
## Raku
The `raku` module shows the currently installed version of [Raku](https://www.raku.org/). Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:
- The current directory contains a `META6.json` file
- The current directory contains a `.p6`, `.pm6`, `.raku`, `.rakumod` or `.pod6`
### Opsi
| Opsi | Bawaan | Deskripsi |
| ------------------- | ------------------------------------------------ | ----------------------------------------------------------------------------------- |
| `fromat` | `"via [$symbol($version-$vm_version )]($style)"` | The format string for the module. |
| `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🦋 "` | The symbol used before displaying the version of Raku |
| `detect_extensions` | `["p6", "pm6", "pod6", "raku", "rakumod"]` | Ekstensi mana yang sebaiknya memicu modul ini. |
| `detect_files` | `["META6.json"]` | filenames mana yang sebaiknya memicu modul ini. |
| `detect_folders` | `[]` | Folder mana yang sebaiknya memicul modul ini. |
| `style` | `"bold 149"` | Gaya penataan untuk modul. |
| `disabled` | `false` | Disables the `raku` module. |
### Variabel
| Variabel | Contoh | Deskripsi |
| ---------- | ------ | ------------------------------------ |
| version | `v6.d` | The version of `raku` |
| vm_version | `moar` | The version of VM `raku` is built on |
| symbol | | Menyalin nilai dari opsi `symbol` |
| style\* | | Menyalin nilai dari opsi `style` |
### Contoh
```toml
# ~/.config/starship.toml
[raku]
format = "via [🦪 $version]($style) "
```
## Red ## Red
By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met: By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met:
@ -2990,7 +3028,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| Variabel | Bawaan | Deskripsi | | Variabel | Bawaan | Deskripsi |
| --------- | ------ | ---------------------------------------------------------- | | --------- | ------ | ---------------------------------------------------------- |
| indicator | | Mirrors the value of `indicator` for currently used shell. | | indicator | | Mirrors the value of `indicator` for currently used shell. |
| style\* | | Menyalin nilai dari opsi `style`. | | style\* | | Mirrors the value of option `style`. |
*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string *: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string
@ -3509,7 +3547,7 @@ The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/v
# ~/.config/starship.toml # ~/.config/starship.toml
[vcsh] [vcsh]
format = "via [✨ $repo](bold blue) " format = "[🆅 $repo](bold blue) "
``` ```
## Zig ## Zig
@ -3560,7 +3598,7 @@ These modules will be shown if any of the following conditions are met:
- The current directory contains a directory whose name is in `detect_folders` - The current directory contains a directory whose name is in `detect_folders`
- The current directory contains a file whose extension is in `detect_extensions` - The current directory contains a file whose extension is in `detect_extensions`
- The `when` command returns 0 - The `when` command returns 0
- The current Operating System (std::env::consts::OS) matchs with `os` field if defined. - The current Operating System (std::env::consts::OS) matches with `os` field if defined.
::: tip ::: tip
@ -3595,7 +3633,7 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt
| `command` | `""` | The command whose output should be printed. The command will be passed on stdin to the shell. | | `command` | `""` | The command whose output should be printed. The command will be passed on stdin to the shell. |
| `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. | | `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. |
| `shell` | | [See below](#custom-command-shell) | | `shell` | | [See below](#custom-command-shell) |
| `deskripsi` | `"<custom module>"` | The description of the module that is shown when running `starship explain`. | | `description` | `"<custom module>"` | The description of the module that is shown when running `starship explain`. |
| `detect_files` | `[]` | The files that will be searched in the working directory for a match. | | `detect_files` | `[]` | The files that will be searched in the working directory for a match. |
| `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. | | `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. |
| `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. | | `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. |

View File

@ -256,11 +256,12 @@ Install the latest version for your system with the MSI-installers from the [rel
Install Starship using any of the following package managers: Install Starship using any of the following package managers:
| Repository | Instructions | | Repository | Instructions |
| -------------------------------------------------------------------------------- | --------------------------------------- | | -------------------------------------------------------------------------------------------- | --------------------------------------- |
| **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
| [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` | | [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` |
| [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` | | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
| [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json) | `scoop install starship` | | [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json) | `scoop install starship` |
| [winget](https://github.com/microsoft/winget-pkgs/tree/master/manifests/s/Starship/Starship) | `winget install --id Starship.Starship` |
</details> </details>

View File

@ -6,7 +6,7 @@ Petunjuk berikut memandu kamu ke perubahan besar kami.
## `prompt_order` kini digantikan dengan sebuah `format` root-level ## `prompt_order` kini digantikan dengan sebuah `format` root-level
Sebelum v0.45.0, `prompt_order` dapat menerima sebuah nama modul dengan urutan yang harusya di-render oleh Starship. Sebelum v0.45.0, `prompt_order` dapat menerima masukan berupa sebuah nama modul dengan urutan yang harusya di-render oleh Starship.
Starship v0.45.0 kini menerima nilai dari `format`, memungkinkan kustomisasi prompt di luar modul itu sendiri. Starship v0.45.0 kini menerima nilai dari `format`, memungkinkan kustomisasi prompt di luar modul itu sendiri.
@ -54,9 +54,9 @@ format = """\
## Modul `prefix` dan `suffix` kini digantikan dengan `format` ## Modul `prefix` dan `suffix` kini digantikan dengan `format`
Sebelum v0.45.0, beberapa modul bisa menerima `prefix` dan/atau `suffix` untuk menata gayanya sesuai yang di-render modul. Sebelum v0.45.0, beberapa modul bisa menerima `prefix` dan/atau `suffix` untuk menata gayanya sesuai modul yang di-render.
Starship v0.45.0 menerima nilai `format` sebagai gantinya, memungkinkan bagaimana modul di-render untuk kustomisasi yang lebih jauh. Ketimbang membuat prefix dan suffix untuk varibel berbasis konteks, kini variabel dapat disubtitusikan dari sebuah format string, yang mana merepresantikan keluaran dari sebuah modul. Starship v0.45.0 menerima nilai `format` sebagai gantinya, yang memungkinkan bagaimana modul di-render untuk kustomisasi yang lebih jauh. Daripada membuat prefix dan suffix untuk varibel yang berbasis konteks, kini variabel dapat disubtitusikan dari dalam sebuah format string, yang mana mewakili hasil keluaran dari modul.
**Contoh konfigurasi pra-v0.45.0** **Contoh konfigurasi pra-v0.45.0**
@ -74,7 +74,7 @@ prefix = "took "
format = "took [$duration]($style) " format = "took [$duration]($style) "
``` ```
### Affected Modules ### Modul yang terpengaruh
#### Karakter #### Karakter
@ -98,9 +98,9 @@ format = "took [$duration]($style) "
++ vicmd_symbol = "[](bold green)" ++ vicmd_symbol = "[](bold green)"
``` ```
Sebelumnya, properti `use_symbol_for_status` digunakan untuk mengkonfigurasi prompt untuk menampilkan `error_symbol` saat perintah terakhir berakhir dengan nilai code status yang bukan nol. Sebelumnya, properti `use_symbol_for_status` digunakan untuk mengkonfigurasi prompt buat menampilkan `error_symbol` saat perintah terakhir berakhir dengan nilai code status yang bukan nol.
Dengan rilisnya v0.45.0, kini kita selalu menggunakan `error_symbol` setelah nilai code status yang bukan nol, menggabungkan properti `use_symbol_for_status` dan `error_symbol`. Dengan rilisnya v0.45.0, kini kita selalu memakai `error_symbol` setelah nilai code status yang bukan nol, untuk menyatukan properti `use_symbol_for_status` dan `error_symbol`.
Untuk mengkonfigurasi prompt agar menggunakan konfigurasi `use_symbol_for_status = true`, tambahkan baris berikut ke dalam file config: Untuk mengkonfigurasi prompt agar menggunakan konfigurasi `use_symbol_for_status = true`, tambahkan baris berikut ke dalam file config:
@ -189,7 +189,7 @@ _Catatan:_ Element `character` secara otomatis menambahkan sebuah spasi setelahn
++ format = '([\[$all_status$ahead_behind\]]($style) )' ++ format = '([\[$all_status$ahead_behind\]]($style) )'
``` ```
Sebelumnya, properti `show_sync_count` digunakan untuk mengkonfigurasi prompt untuk menampilkan jumlah commits dari branch yang terdepan atau terbelakang dari remote branch. Sebelumnya, properti `show_sync_count` digunakan untuk mengkonfigurasi prompt buat menampilkan jumlah commits dari branch yang terdepan atau terbelakang dari remote branch.
Dengan rilisnya v0.45.0, hal ini kini digantikan dengan tiga properti terpisah, `ahead`, `behind`, dan `diverged`. Dengan rilisnya v0.45.0, hal ini kini digantikan dengan tiga properti terpisah, `ahead`, `behind`, dan `diverged`.

View File

@ -538,19 +538,19 @@ By default it only changes color. If you also want to change its shape take a lo
::: warning ::: warning
`vicmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148).
::: :::
### Opzioni ### Opzioni
| Opzione | Default | Descrizione | | Opzione | Default | Descrizione |
| -------------------------- | -------------------- | --------------------------------------------------------------------------------------- | | --------------------------- | -------------------- | --------------------------------------------------------------------------------------- |
| `format` | `"$symbol "` | The format string used before the text input. | | `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. | | `success_symbol` | `"[](bold green)"` | The format string used before the text input if the previous command succeeded. |
| `error_symbol` | `"[](bold red)"` | The format string used before the text input if the previous command failed. | | `error_symbol` | `"[](bold red)"` | The format string used before the text input if the previous command failed. |
| `vicmd_symbol` | `"[](bold green)"` | The format string used before the text input if the shell is in vim normal mode. | | `vimcmd_symbol` | `"[](bold green)"` | The format string used before the text input if the shell is in vim normal mode. |
| `vicmd_replace_one_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. | | `vimcmd_replace_one_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. |
| `vimcmd_replace_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. | | `vimcmd_replace_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. |
| `vimcmd_visual_symbol` | `"[](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. | | `vimcmd_visual_symbol` | `"[](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. |
| `disabled` | `false` | Disables the `character` module. | | `disabled` | `false` | Disables the `character` module. |
@ -2793,6 +2793,44 @@ The `rlang` module shows the currently installed version of [R](https://www.r-pr
format = "with [📐 $version](blue bold) " format = "with [📐 $version](blue bold) "
``` ```
## Raku
The `raku` module shows the currently installed version of [Raku](https://www.raku.org/). By default the module will be shown if any of the following conditions are met:
- The current directory contains a `META6.json` file
- The current directory contains a `.p6`, `.pm6`, `.raku`, `.rakumod` or `.pod6`
### Opzioni
| Opzione | Default | Descrizione |
| ------------------- | ------------------------------------------------ | -------------------------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version-$vm_version )]($style)"` | The format string for the module. |
| `version_format` | `"v${raw}"` | Il formato della versione. Le variabili disponibili sono `raw`, `major`, `minore`, & `patch` |
| `symbol` | `"🦋 "` | The symbol used before displaying the version of Raku |
| `detect_extensions` | `["p6", "pm6", "pod6", "raku", "rakumod"]` | Quali estensioni dovrebbero attivare questo modulo. |
| `detect_files` | `["META6.json"]` | Quali nomi di file dovrebbero attivare questo modulo. |
| `detect_folders` | `[]` | Quali cartelle dovrebbero attivare questo modulo. |
| `style` | `"bold 149"` | Lo stile per il modulo. |
| `disabled` | `false` | Disables the `raku` module. |
### Variables
| Variable | Esempio | Descrizione |
| ---------- | ------- | ------------------------------------ |
| version | `v6.d` | The version of `raku` |
| vm_version | `moar` | The version of VM `raku` is built on |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
### Esempio
```toml
# ~/.config/starship.toml
[raku]
format = "via [🦪 $version]($style) "
```
## Red ## Red
By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met: By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met:
@ -3343,7 +3381,7 @@ If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Otherwise, it de
| Variable | Esempio | Descrizione | | Variable | Esempio | Descrizione |
| --------- | ---------- | ----------------------------------- | | --------- | ---------- | ----------------------------------- |
| ora | `13:08:10` | The current time. | | time | `13:08:10` | The current time. |
| style\* | | Mirrors the value of option `style` | | style\* | | Mirrors the value of option `style` |
*: This variable can only be used as a part of a style string *: This variable can only be used as a part of a style string
@ -3457,12 +3495,12 @@ The `vlang` module shows you your currently installed version of [V](https://vla
| ------------------- | -------------------------------------------- | -------------------------------------------------------------------------------------------- | | ------------------- | -------------------------------------------- | -------------------------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `version_format` | `"v${raw}"` | Il formato della versione. Le variabili disponibili sono `raw`, `major`, `minore`, & `patch` | | `version_format` | `"v${raw}"` | Il formato della versione. Le variabili disponibili sono `raw`, `major`, `minore`, & `patch` |
| `symbol` | `"V "` | Una stringa di formato che rappresenta il simbolo di V | | `symbol` | `"V "` | A format string representing the symbol of V |
| `detect_extensions` | `["v"]` | Quali estensioni dovrebbero attivare questo modulo. | | `detect_extensions` | `["v"]` | Quali estensioni dovrebbero attivare questo modulo. |
| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Quali nomi di file dovrebbero attivare questo modulo. | | `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Quali nomi di file dovrebbero attivare questo modulo. |
| `detect_folders` | `[]` | Quali cartelle dovrebbero attivare questo modulo. | | `detect_folders` | `[]` | Quali cartelle dovrebbero attivare questo modulo. |
| `style` | `"blu grassetto"` | Lo stile per il modulo. | | `style` | `"blu grassetto"` | Lo stile per il modulo. |
| `disabled` | `false` | Disabilita il modulo `vlang`. | | `disabled` | `false` | Disables the `vlang` module. |
### Variables ### Variables
@ -3560,7 +3598,7 @@ These modules will be shown if any of the following conditions are met:
- The current directory contains a directory whose name is in `detect_folders` - The current directory contains a directory whose name is in `detect_folders`
- The current directory contains a file whose extension is in `detect_extensions` - The current directory contains a file whose extension is in `detect_extensions`
- The `when` command returns 0 - The `when` command returns 0
- The current Operating System (std::env::consts::OS) matchs with `os` field if defined. - The current Operating System (std::env::consts::OS) matches with `os` field if defined.
::: tip ::: tip
@ -3595,7 +3633,7 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt
| `command` | `""` | The command whose output should be printed. The command will be passed on stdin to the shell. | | `command` | `""` | The command whose output should be printed. The command will be passed on stdin to the shell. |
| `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. | | `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. |
| `shell` | | [See below](#custom-command-shell) | | `shell` | | [See below](#custom-command-shell) |
| `descrizione` | `"<custom module>"` | The description of the module that is shown when running `starship explain`. | | `description` | `"<custom module>"` | The description of the module that is shown when running `starship explain`. |
| `detect_files` | `[]` | The files that will be searched in the working directory for a match. | | `detect_files` | `[]` | The files that will be searched in the working directory for a match. |
| `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. | | `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. |
| `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. | | `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. |

View File

@ -256,11 +256,12 @@ Install the latest version for your system with the MSI-installers from the [rel
Install Starship using any of the following package managers: Install Starship using any of the following package managers:
| Repository | Instructions | | Repository | Instructions |
| -------------------------------------------------------------------------------- | --------------------------------------- | | -------------------------------------------------------------------------------------------- | --------------------------------------- |
| **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
| [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` | | [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` |
| [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` | | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
| [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json) | `scoop install starship` | | [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json) | `scoop install starship` |
| [winget](https://github.com/microsoft/winget-pkgs/tree/master/manifests/s/Starship/Starship) | `winget install --id Starship.Starship` |
</details> </details>

View File

@ -261,7 +261,7 @@ $shell\
$character""" $character"""
``` ```
If you just want to extend the default format, you can use `$all`; modules you explicitly add to the format will not be duplicated. 例: デフォルトのフォーマットを拡張したいだけなら、`$all`を使用できます。 フォーマットに明示的に追加したモジュールは重複しません。 例:
```toml ```toml
# ディレクトリを2行目に移動 # ディレクトリを2行目に移動
@ -270,15 +270,15 @@ format = "$all$directory$character"
## AWS ## AWS
The `aws` module shows the current AWS region and profile and an expiration timer when using temporary credentials. The output of the module uses the `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env vars and the `~/.aws/config` and `~/.aws/credentials` files as required. `aws`モジュールは、一時的な資格情報を使用する場合、現在のAWSリージョンとプロファイル、および有効期限タイマーを表示します。 モジュールの出力は、必要に応じて`AWS_REGION`、`AWS_DEFAULT_REGION`と`AWS_PROFILE`の環境変数と、`~/.aws/config`と`~/.aws/credentials`のファイルが使用されます。
The module will display a profile only if its credentials are present in `~/.aws/credentials` or if a `credential_process` or `sso_start_url` are defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if no credentials per the conditions above are detected. モジュールは、資格情報が`~/.aws/credentials`にある場合、または`~/.aws/config`に`credential_process`または`sso_start_url`が定義されている場合にのみプロファイルを表示します。 あるいは、環境変数に`AWS_ACCESS_KEY_ID`、`AWS_SECRET_ACCESS_KEY`または`AWS_SESSION_TOKEN`のいずれかが定義されていれば条件を満たします。 もし`force_display`のオプションを`true`に設定した場合、上記の条件による資格情報が検出されない場合でも、利用可能なすべての情報が表示されます。
When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var. [aws-vault](https://github.com/99designs/aws-vault)を使う場合、環境変数`AWS_VAULT`からプロファイルが、環境変数`AWS_SESSION_EXPIRATION`から資格情報の有効期限が読み込まれます。
[awsu](https://github.com/kreuzwerker/awsu) を使う場合、そのプロファイルは環境変数 `AWSU_PROFILE` から読まれます。 [awsu](https://github.com/kreuzwerker/awsu) を使う場合、そのプロファイルは環境変数 `AWSU_PROFILE` から読まれます。
When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFILE` env var and the credentials expiration date is read from the `AWSUME_EXPIRATION` env var. [AWSume](https://awsu.me)を使う場合、環境変数`AWSUME_PROFILE`からプロファイルが、環境変数`AWSUME_EXPIRATION`から資格情報の有効期限が読み込まれます。
### オプション ### オプション
@ -287,19 +287,19 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)'` | module のフォーマットです。 | | `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)'` | module のフォーマットです。 |
| `symbol` | `"☁️ "` | 現在のAWSプロファイルを表示する前に表示される記号です。 | | `symbol` | `"☁️ "` | 現在のAWSプロファイルを表示する前に表示される記号です。 |
| `region_aliases` | | AWS名に加えて表示するリージョンのエイリアスです。 | | `region_aliases` | | AWS名に加えて表示するリージョンのエイリアスです。 |
| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | | `profile_aliases` | | AWS名に加えて表示するプロファイルのエイリアスです。 |
| `style` | `"bold yellow"` | モジュールのスタイルです。 | | `style` | `"bold yellow"` | モジュールのスタイルです。 |
| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. | | `expiration_symbol` | `X` | この記号は一時的な資格情報が有効期限切れの場合に表示されます。 |
| `disabled` | `false` | `aws`モジュールを無効にします。 | | `disabled` | `false` | `aws`モジュールを無効にします。 |
| `force_display` | `false` | `true`の場合、`credentials`、`credential_process`または`sso_start_url`が設定されていない場合でも情報を表示します。 | | `force_display` | `false` | `true`の場合、`credentials`、`credential_process`または`sso_start_url`が設定されていない場合でも情報を表示します。 |
### 変数 ### 変数
| 変数 | 設定例 | 説明 | | 変数 | 設定例 | 説明 |
| --------- | ---------------- | ------------------------------------------- | | --------- | ---------------- | ---------------------- |
| region | `ap-northeast-1` | 現在のAWSリージョン | | region | `ap-northeast-1` | 現在のAWSリージョン |
| profile | `astronauts` | 現在のAWSプロファイル | | profile | `astronauts` | 現在のAWSプロファイル |
| duration | `2h27m20s` | The temporary credentials validity duration | | duration | `2h27m20s` | 一時的な資格情報の有効期限 |
| symbol | | オプション `記号` の値をミラーする | | symbol | | オプション `記号` の値をミラーする |
| style\* | | オプション `style` の値をミラーする | | style\* | | オプション `style` の値をミラーする |
@ -463,7 +463,7 @@ discharging_symbol = "💦"
| 変数 | 設定例 | 説明 | | 変数 | 設定例 | 説明 |
| ------------- | -------- | ---------------------- | | ------------- | -------- | ---------------------- |
| `buf_version` | `v1.0.0` | The version of `buf` | | `buf_version` | `v1.0.0` | `buf`のバージョン |
| `symbol` | | オプション `記号` の値をミラーする | | `symbol` | | オプション `記号` の値をミラーする |
| `style`* | | オプション `style` の値をミラーする | | `style`* | | オプション `style` の値をミラーする |
@ -492,9 +492,9 @@ symbol = "🦬 "
| `detect_extensions` | `["c", "h"]` | どの拡張子がこのモジュールをアクティブにするか | | `detect_extensions` | `["c", "h"]` | どの拡張子がこのモジュールをアクティブにするか |
| `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか | | `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか |
| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | | `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか |
| `commands` | [ [ "cc", "--version" ], [ "gcc", "--version" ], [ "clang", "--version" ] ] | How to detect what the compiler is | | `commands` | [ [ "cc", "--version" ], [ "gcc", "--version" ], [ "clang", "--version" ] ] | コンパイラを検出する方法 |
| `style` | `"bold 149"` | モジュールのスタイルです。 | | `style` | `"bold 149"` | モジュールのスタイルです。 |
| `disabled` | `false` | Disables the `c` module. | | `disabled` | `false` | `c`モジュールを無効にします。 |
### 変数 ### 変数
@ -505,15 +505,15 @@ symbol = "🦬 "
| symbol | | オプション `記号` の値をミラーする | | symbol | | オプション `記号` の値をミラーする |
| style | | オプション `style` の値をミラーする | | style | | オプション `style` の値をミラーする |
NB that `version` is not in the default format. `version`はデフォルトのフォーマットではないことに注意してください。
### Commands ### Commands
The `commands` option accepts a list of commands to determine the compiler version and name. `commands`オプションは、コンパイラのバージョンと名前を判別するためのコマンドのリストを受け入れます。
Each command is represented as a list of the executable name, followed by its arguments, usually something like `["mycc", "--version"]`. Starship will try executing each command until it gets a result on STDOUT. 各コマンドは、実行可能ファイル名の後に引数を続けるリストとして表されます。通常は`["mycc", "--version"]`のようになります。 StarshipはSTDOUTから結果が得られるまで各コマンドを実行を試みます。
If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). もし、Cコンパイラがこのモジュールでサポートされていない場合は、[GitHubで問題を提起する](https://github.com/starship/starship/)ことでリクエストできます。
### 設定例 ### 設定例
@ -537,21 +537,21 @@ format = "via [$name $version]($style)"
::: warning ::: warning
`vicmd_symbol` はcmd、fish、zshでのみサポートされています。 `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`、`vimcmd_replace_symbol`と`vimcmd_visual_symbol`は、[zshでのモード検出による問題](https://github.com/starship/starship/issues/625#issuecomment-732454148)のため、fishでのみサポートされています。
::: :::
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| -------------------------- | -------------------- | --------------------------------------------------------------------------------------- | | --------------------------- | -------------------- | ------------------------------------------------------ |
| `format` | `"$symbol"` | テキスト入力の前に使用される書式文字列。 | | `format` | `"$symbol"` | テキスト入力の前に使用されるフォーマット文字列。 |
| `success_symbol` | `"[](bold green)"` | 前のコマンドが成功した場合にテキスト入力の前に使用される書式文字列です。 | | `success_symbol` | `"[](bold green)"` | 前のコマンドが成功した場合にテキスト入力の前に使用されるフォーマット文字列です。 |
| `error_symbol` | `"[](bold red)"` | 前のコマンドが失敗した場合にテキスト入力の前に使用される書式文字列です。 | | `error_symbol` | `"[](bold red)"` | 前のコマンドが失敗した場合にテキスト入力の前に使用されるフォーマット文字列です。 |
| `vicmd_symbol` | `"[](bold green)"` | シェルが vim ノーマルモードの場合にテキスト入力の前に使用されるフォーマット文字列。 | | `vimcmd_symbol` | `"[](bold green)"` | シェルがvimーマルモードの場合にテキスト入力の前に使用されるフォーマット文字列です。 |
| `vicmd_replace_one_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. | | `vimcmd_replace_one_symbol` | `"[](bold purple)"` | シェルがvimの`replace_one`モードの場合にテキスト入力の前に使用されるフォーマット文字列です。 |
| `vimcmd_replace_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. | | `vimcmd_replace_symbol` | `"[](bold purple)"` | シェルがvimの置換モードの場合にテキスト入力の前に使用されるフォーマット文字列。 |
| `vimcmd_visual_symbol` | `"[](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. | | `vimcmd_visual_symbol` | `"[](bold yellow)"` | シェルがvimの置換モードの場合にテキスト入力の前に使用されるフォーマット文字列。 |
| `disabled` | `false` | `character`モジュールを無効にします。 | | `disabled` | `false` | `character`モジュールを無効にします。 |
### 変数 ### 変数
@ -666,15 +666,15 @@ preexecのような機能を必要とするBashユーザーは、 [rcalorasのba
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ---------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ---------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------- |
| `min_time` | `2_000` | 実行時間を表示する最短期間(ミリ秒単位)です。 | | `min_time` | `2_000` | 実行時間を表示する最短期間(ミリ秒単位)です。 |
| `show_milliseconds` | `false` | 実行時間の秒に加えてミリ秒を表示します。 | | `show_milliseconds` | `false` | 実行時間の秒に加えてミリ秒を表示します。 |
| `format` | `"took [$duration]($style) "` | module のフォーマットです。 | | `format` | `"took [$duration]($style) "` | module のフォーマットです。 |
| `style` | `"bold yellow"` | モジュールのスタイルです。 | | `style` | `"bold yellow"` | モジュールのスタイルです。 |
| `disabled` | `false` | `cmd_duration`モジュールを無効にします。 | | `disabled` | `false` | `cmd_duration`モジュールを無効にします。 |
| `show_notifications` | `false` | コマンドが完了したらデスクトップ通知を表示します。 | | `show_notifications` | `false` | コマンドが完了したらデスクトップ通知を表示します。 |
| `min_time_to_notify` | `45_000` | 通知を持続する最短期間(ミリ秒単位) | | `min_time_to_notify` | `45_000` | 通知を持続する最短期間 (ミリ秒単位) です。 |
| `notification_timeout` | | Duration to show notification for (in milliseconds). If unset, notification timeout will be determined by daemon. Not all notification daemons honor this option. | | `notification_timeout` | | 通知を表示する期間 (ミリ秒単位) です。 もし設定されていない場合、通知のタイムアウトはデーモンによって決定されます。 すべての通知デーモンがこのオプションを受け入れるわけではありません。 |
### 変数 ### 変数
@ -808,9 +808,9 @@ format = "via [✨ $version](bold blue) "
## Daml ## Daml
The `daml` module shows the currently used [Daml](https://www.digitalasset.com/developers) SDK version when you are in the root directory of your Daml project. The `sdk-version` in the `daml.yaml` file will be used, unless it's overridden by the `DAML_SDK_VERSION` environment variable. デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 `daml`モジュールは、Damlプロジェクトのルートディレクトリにいるときに、使用している[Daml](https://www.digitalasset.com/developers) SDKバージョンを表示します。 環境変数`DAML_SDK_VERSION`を上書きしない限り、`daml.yaml`ファイルの`sdk-version`が使用されます。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
- The current directory contains a `daml.yaml` file - カレントディレクトリに`daml.yaml`ファイルが含まれている
### オプション ### オプション
@ -818,18 +818,18 @@ The `daml` module shows the currently used [Daml](https://www.digitalasset.com/d
| ------------------- | ---------------------------------- | ------------------------------------------------------ | | ------------------- | ---------------------------------- | ------------------------------------------------------ |
| `format` | `via [$symbol($version )]($style)` | module のフォーマットです。 | | `format` | `via [$symbol($version )]($style)` | module のフォーマットです。 |
| `version_format` | `v${raw}` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | | `version_format` | `v${raw}` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 |
| `symbol` | `"Λ "` | A format string representing the symbol of Daml | | `symbol` | `"Λ "` | Damlの記号を表すフォーマット文字列です。 |
| `style` | `"bold cyan"` | モジュールのスタイルです。 | | `style` | `"bold cyan"` | モジュールのスタイルです。 |
| `detect_extensions` | `[]` | どの拡張子がこのモジュールをアクティブにするか | | `detect_extensions` | `[]` | どの拡張子がこのモジュールをアクティブにするか |
| `detect_files` | `["daml.yaml"]` | どのファイル名がこのモジュールをアクティブにするか | | `detect_files` | `["daml.yaml"]` | どのファイル名がこのモジュールをアクティブにするか |
| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | | `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか |
| `disabled` | `false` | Disables the `daml` module. | | `disabled` | `false` | `daml`モジュールを無効にします。 |
### 変数 ### 変数
| 変数 | 設定例 | 説明 | | 変数 | 設定例 | 説明 |
| --------- | -------- | ---------------------- | | --------- | -------- | ---------------------- |
| version | `v2.2.0` | The version of `daml` | | version | `v2.2.0` | `daml`のバージョン |
| symbol | | オプション `記号` の値をミラーする | | symbol | | オプション `記号` の値をミラーする |
| style\* | | オプション `style` の値をミラーする | | style\* | | オプション `style` の値をミラーする |
@ -976,17 +976,17 @@ fishスタイルのpwdオプションを使用すると、切り捨てられた
*: この変数は、スタイル文字列の一部としてのみ使用することができます。 *: この変数は、スタイル文字列の一部としてのみ使用することができます。
<details> <details>
<summary>The git repos have additional variables.</summary> <summary>gitリポジトリは追加の変数があります。</summary>
Let us consider the path `/path/to/home/git_repo/src/lib` `/path/to/home/git_repo/src/lib`のパスについて考えます。
| 変数 | 設定例 | 説明 | | 変数 | 設定例 | 説明 |
| ------------------ | --------------------- | --------------------------------------- | | ------------------ | --------------------- | ---------------------- |
| before_root_path | `"/path/to/home/"` | The path before git root directory path | | before_root_path | `"/path/to/home/"` | gitルートディレクトリパスの前のパス |
| repo_root | `"git_repo"` | The git root directory name | | repo_root | `"git_repo"` | gitルートディレクトリの名前 |
| path | `"/src/lib"` | The remaining path | | path | `"/src/lib"` | 残りのパス |
| style | `"black bold dimmed"` | オプション `style` の値をミラーする | | style | `"black bold dimmed"` | オプション `style` の値をミラーする |
| repo_root_style | `"underline white"` | Style for git root directory name | | repo_root_style | `"underline white"` | gitルートディレクトリの名前のスタイル |
</details> </details>
@ -1002,7 +1002,7 @@ truncation_symbol = "…/"
## Docker Context ## Docker Context
The `docker_context` module shows the currently active [Docker context](https://docs.docker.com/engine/context/working-with-contexts/) if it's not set to `default` or if the `DOCKER_MACHINE_NAME`, `DOCKER_HOST` or `DOCKER_CONTEXT` environment variables are set (as they are meant to override the context in use). `docker_context`モジュールは、`default`に設定されていない場合、または環境変数`DOCKER_MACHINE_NAME`、`DOCKER_HOST`または`DOCKER_CONTEXT`が設定されている場合 (使用中のコンテキストを上書きするため)、現在アクティブな[Docker context](https://docs.docker.com/engine/context/working-with-contexts/)を表示します。
### オプション ### オプション
@ -1115,10 +1115,10 @@ heuristic = false
### 変数 ### 変数
| 変数 | 設定例 | 説明 | | 変数 | 設定例 | 説明 |
| ----------- | ------- | --------------------------- | | ----------- | ------- | ----------------------- |
| version | `v1.10` | `elixir`のバージョン | | version | `v1.10` | `elixir`のバージョン |
| otp_version | | The otp version of `elixir` | | otp_version | | `elixir`のotpバージョン |
| symbol | | オプション `記号` の値をミラーする | | symbol | | オプション `symbol` の値をミラーする |
| style\* | | オプション `style` の値をミラーする | | style\* | | オプション `style` の値をミラーする |
*: この変数は、スタイル文字列の一部としてのみ使用することができます。 *: この変数は、スタイル文字列の一部としてのみ使用することができます。
@ -2792,11 +2792,49 @@ python_binary = ["./venv/bin/python", "python", "python3", "python2"]
format = "with [📐 $version](blue bold) " format = "with [📐 $version](blue bold) "
``` ```
## Raku
The `raku` module shows the currently installed version of [Raku](https://www.raku.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
- The current directory contains a `META6.json` file
- The current directory contains a `.p6`, `.pm6`, `.raku`, `.rakumod` or `.pod6`
### オプション
| オプション | デフォルト | 説明 |
| ------------------- | ------------------------------------------------ | ------------------------------------------------------ |
| `format` | `"via [$symbol($version-$vm_version )]($style)"` | モジュールのフォーマット文字列。 |
| `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 |
| `symbol` | `"🦋 "` | The symbol used before displaying the version of Raku |
| `detect_extensions` | `["p6", "pm6", "pod6", "raku", "rakumod"]` | どの拡張子がこのモジュールをアクティブにするか |
| `detect_files` | `["META6.json"]` | どのファイル名がこのモジュールをアクティブにするか |
| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか |
| `style` | `"bold 149"` | モジュールのスタイルです。 |
| `disabled` | `false` | Disables the `raku` module. |
### 変数
| 変数 | 設定例 | 説明 |
| ---------- | ------ | ------------------------------------ |
| version | `v6.d` | The version of `raku` |
| vm_version | `moar` | The version of VM `raku` is built on |
| symbol | | オプション `記号` の値をミラーする |
| style\* | | オプション `style` の値をミラーする |
### 設定例
```toml
# ~/.config/starship.toml
[raku]
format = "via [🦪 $version]($style) "
```
## Red ## Red
デフォルトでは`red`モジュールは、現在インストールされている[Red](https://www.red-lang.org/)のバージョンを表示します。 次の条件のいずれかが満たされると、モジュールが表示されます: By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met:
- カレントディレクトリに拡張子が`.red` or `.reds`のファイルが含まれている - The current directory contains a file with `.red` or `.reds` extension
### オプション ### オプション
@ -2832,12 +2870,12 @@ symbol = "🔴 "
## Ruby ## Ruby
デフォルトでは`ruby`モジュールは現在インストールされている[Ruby](https://www.ruby-lang.org/)のバージョンを表示します。 次の条件のいずれかが満たされると、モジュールが表示されます: By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). The module will be shown if any of the following conditions are met:
- カレントディレクトリに`Gemfile`ファイルが含まれている - The current directory contains a `Gemfile` file
- カレントディレクトリに `.ruby-version` ファイルが含まれている - The current directory contains a `.ruby-version` file
- カレントディレクトリに`.rb`の拡張子のファイルが含まれている - The current directory contains a `.rb` file
- 環境変数に`RUBY_VERSION`または`RBENV_VERSION`が設定されている - The environment variables `RUBY_VERSION` or `RBENV_VERSION` are set
Starship gets the current Ruby version by running `ruby -v`. Starship gets the current Ruby version by running `ruby -v`.
@ -2847,13 +2885,13 @@ Starship gets the current Ruby version by running `ruby -v`.
| ------------------- | ------------------------------------ | ------------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 | | `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 |
| `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | | `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 |
| `symbol` | `"💎 "` | Rubyのシンボルを表すフォーマット文字列. | | `symbol` | `"💎 "` | A format string representing the symbol of Ruby. |
| `detect_extensions` | `["rb"]` | どの拡張子がこのモジュールをアクティブにするか | | `detect_extensions` | `["rb"]` | どの拡張子がこのモジュールをアクティブにするか |
| `detect_files` | `["Gemfile", ".ruby-version"]` | どのファイル名がこのモジュールをアクティブにするか | | `detect_files` | `["Gemfile", ".ruby-version"]` | どのファイル名がこのモジュールをアクティブにするか |
| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | | `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか |
| `detect_variables` | `["RUBY_VERSION", "RBENV_VERSION"]` | Which environment variables should trigger this module. | | `detect_variables` | `["RUBY_VERSION", "RBENV_VERSION"]` | Which environment variables should trigger this module. |
| `style` | `"bold red"` | モジュールのスタイルです。 | | `style` | `"bold red"` | モジュールのスタイルです。 |
| `disabled` | `false` | `ruby`モジュールを無効にします。 | | `disabled` | `false` | Disables the `ruby` module. |
### 変数 ### 変数
@ -2876,10 +2914,10 @@ symbol = "🔺 "
## Rust ## Rust
デフォルトでは`rust`モジュールは現在インストールされている[Rust](https://www.rust-lang.org/)のバージョンを表示します。 次の条件のいずれかが満たされると、モジュールが表示されます: By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). The module will be shown if any of the following conditions are met:
- カレントディレクトリに`Cargo.toml`ファイルが含まれている - The current directory contains a `Cargo.toml` file
- カレントディレクトリに`.rs`の拡張子のファイルが含まれている - The current directory contains a file with the `.rs` extension
### オプション ### オプション
@ -2887,18 +2925,18 @@ symbol = "🔺 "
| ------------------- | ------------------------------------ | ------------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 | | `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 |
| `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | | `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 |
| `symbol` | `"🦀 "` | Rustのシンボルを表すフォーマット文字列 | | `symbol` | `"🦀 "` | A format string representing the symbol of Rust |
| `detect_extensions` | `["rs"]` | どの拡張子がこのモジュールをアクティブにするか | | `detect_extensions` | `["rs"]` | どの拡張子がこのモジュールをアクティブにするか |
| `detect_files` | `["Cargo.toml"]` | どのファイル名がこのモジュールをアクティブにするか | | `detect_files` | `["Cargo.toml"]` | どのファイル名がこのモジュールをアクティブにするか |
| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | | `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか |
| `style` | `"bold red"` | モジュールのスタイルです。 | | `style` | `"bold red"` | モジュールのスタイルです。 |
| `disabled` | `false` | `rust`モジュールを無効にします。 | | `disabled` | `false` | Disables the `rust` module. |
### 変数 ### 変数
| 変数 | 設定例 | 説明 | | 変数 | 設定例 | 説明 |
| --------- | ----------------- | -------------------------------------------- | | --------- | ----------------- | -------------------------------------------- |
| version | `v1.43.0-nightly` | `rustc`のバージョン | | version | `v1.43.0-nightly` | The version of `rustc` |
| numver | `1.51.0` | The numeric component of the `rustc` version | | numver | `1.51.0` | The numeric component of the `rustc` version |
| toolchain | `beta` | The toolchain version | | toolchain | `beta` | The toolchain version |
| symbol | | オプション `記号` の値をミラーする | | symbol | | オプション `記号` の値をミラーする |
@ -2917,11 +2955,11 @@ format = "via [⚙️ $version](red bold)"
## Scala ## Scala
`scala` モジュールは、現在インストールされている[Scala](https://www.scala-lang.org/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
- カレントディレクトリに`build.sbt`、`.scalaenv`または`.sbtenv`ファイルが含まれている - The current directory contains a `build.sbt`, `.scalaenv` or `.sbtenv` file
- カレントディレクトリに拡張子が`.scala`または`.sbt`のファイルが含まれている - The current directory contains a file with the `.scala` or `.sbt` extension
- カレントディレクトリに`.metals`ディレクトリが含まれている - The current directory contains a directory named `.metals`
### オプション ### オプション
@ -2989,7 +3027,7 @@ The `shell` module shows an indicator for currently used shell.
| 変数 | デフォルト | 説明 | | 変数 | デフォルト | 説明 |
| --------- | ----- | ---------------------------------------------------------- | | --------- | ----- | ---------------------------------------------------------- |
| indicator | | Mirrors the value of `indicator` for currently used shell. | | indicator | | Mirrors the value of `indicator` for currently used shell. |
| style\* | | オプション `style` の値をミラーする. | | style\* | | Mirrors the value of option `style`. |
*: この変数は、スタイル文字列の一部としてのみ使用することができます。 *: この変数は、スタイル文字列の一部としてのみ使用することができます。
@ -3218,10 +3256,10 @@ disabled = false
## Swift ## Swift
デフォルトでは`swift` モジュールは、現在インストールされている[Swift](https://swift.org/)のバージョンを表示します。 次の条件のいずれかが満たされると、モジュールが表示されます: By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). The module will be shown if any of the following conditions are met:
- カレントディレクトリに`Package.swift`ファイルが含まれている - The current directory contains a `Package.swift` file
- カレントディレクトリに拡張子が`.swift`のファイルが含まれている - The current directory contains a file with the `.swift` extension
### オプション ### オプション
@ -3257,18 +3295,18 @@ format = "via [🏎 $version](red bold)"
## Terraform ## Terraform
`terraform` モジュールは、現在選択されている[Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) とバージョンを表示します。 The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version.
::: tip ::: tip
Terraformのバージョンはデフォルトでは表示されません。多くのプラグインが使用されている場合、現在のTerraformのバージョンでは遅くなるからです。 それでも有効にしたい場合は、 [以下の例に従ってください](#with-terraform-version). By default the Terraform version is not shown, since this is slow for 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-terraform-version).
::: :::
デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
- カレントディレクトリに`.terraform`フォルダが含まれている - The current directory contains a `.terraform` folder
- 現在のディレクトリに `.tf`, `.tfplan` または `.tfstate` のいずれかの拡張子を持つファイルがある。 - Current directory contains a file with the `.tf`, `.tfplan` or `.tfstate` extensions
### オプション ### オプション
@ -3276,19 +3314,19 @@ Terraformのバージョンはデフォルトでは表示されません。多
| ------------------- | ------------------------------------ | ------------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------------ |
| `format` | `"via [$symbol$workspace]($style) "` | モジュールのフォーマット文字列。 | | `format` | `"via [$symbol$workspace]($style) "` | モジュールのフォーマット文字列。 |
| `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | | `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 |
| `symbol` | `"💠"` | ワークスペースの前に表示されるフォーマット文字列。 | | `symbol` | `"💠"` | A format string shown before the terraform workspace. |
| `detect_extensions` | `["tf", "tfplan", "tfstate"]` | どの拡張子がこのモジュールをアクティブにするか | | `detect_extensions` | `["tf", "tfplan", "tfstate"]` | どの拡張子がこのモジュールをアクティブにするか |
| `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか | | `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか |
| `detect_folders` | `[".terraform"]` | どのフォルダーがこのモジュールをアクティブにするか | | `detect_folders` | `[".terraform"]` | どのフォルダーがこのモジュールをアクティブにするか |
| `style` | `"bold 105"` | モジュールのスタイルです。 | | `style` | `"bold 105"` | モジュールのスタイルです。 |
| `disabled` | `false` | `terraform`モジュールを無効にします。 | | `disabled` | `false` | Disables the `terraform` module. |
### 変数 ### 変数
| 変数 | 設定例 | 説明 | | 変数 | 設定例 | 説明 |
| --------- | ---------- | ---------------------- | | --------- | ---------- | ------------------------------- |
| version | `v0.12.24` | `terraform` のバージョン | | version | `v0.12.24` | The version of `terraform` |
| workspace | `default` | 現在のTerraformワークスペース | | workspace | `default` | The current Terraform workspace |
| symbol | | オプション `記号` の値をミラーする | | symbol | | オプション `記号` の値をミラーする |
| style\* | | オプション `style` の値をミラーする | | style\* | | オプション `style` の値をミラーする |
@ -3316,7 +3354,7 @@ 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 ::: tip
@ -3327,22 +3365,22 @@ format = "[🏎💨 $workspace]($style) "
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ----------------- | ----------------------- | ----------------------------------------------------------------------------------------------------- | | ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `format` | `"at [$time]($style) "` | モジュールのフォーマット文字列。 | | `format` | `"at [$time]($style) "` | モジュールのフォーマット文字列。 |
| `use_12hr` | `false` | 12時間のフォーマットを有効にします。 | | `use_12hr` | `false` | Enables 12 hour formatting |
| `time_format` | この表の下を参照してください | 時刻のフォーマットに使用される[クロノフォーマット文字列](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) です。 | | `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. |
| `style` | `"bold yellow"` | モジュールのスタイルです。 | | `style` | `"bold yellow"` | The style for the module time |
| `utc_time_offset` | `"local"` | 使用するUTCオフセットを設定します。 Range from -24 &lt; x &lt; 24. フロートが30/45分のタイムゾーンオフセットに対応できるようにします。 | | `utc_time_offset` | `"local"` | Sets the UTC offset to use. Range from -24 &lt; x &lt; 24. Allows floats to accommodate 30/45 minute timezone offsets. |
| `disabled` | `true` | `time`モジュールを無効にします。 | | `disabled` | `true` | Disables the `time` module. |
| `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | | `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format |
If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. それ以外の場合、デフォルトは`"%T"`です。 Manually setting `time_format` will override the `use_12hr` setting. If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Otherwise, it defaults to `"%T"`. Manually setting `time_format` will override the `use_12hr` setting.
### 変数 ### 変数
| 変数 | 設定例 | 説明 | | 変数 | 設定例 | 説明 |
| --------- | ---------- | ---------------------- | | --------- | ---------- | ---------------------- |
| 時刻 | `13:08:10` | The current time. | | time | `13:08:10` | The current time. |
| style\* | | オプション `style` の値をミラーする | | style\* | | オプション `style` の値をミラーする |
*: この変数は、スタイル文字列の一部としてのみ使用することができます。 *: この変数は、スタイル文字列の一部としてのみ使用することができます。
@ -3360,14 +3398,14 @@ utc_time_offset = "-5"
time_range = "10:00:00-14:00:00" time_range = "10:00:00-14:00:00"
``` ```
## ユーザー名 ## Username
`username`モジュールには、アクティブなユーザーのユーザー名が表示されます。 次の条件のいずれかが満たされると、モジュールが表示されます: The `username` module shows active user's username. The module will be shown if any of the following conditions are met:
- The current user is root/admin - The current user is root/admin
- カレントユーザーが、ログインしているユーザーとは異なる - The current user isn't the same as the one that is logged in
- ユーザーがSSHセッションとして接続されている - The user is currently connected as an SSH session
- `show_always`変数がtrueに設定されている - The variable `show_always` is set to true
::: tip ::: tip
@ -3380,10 +3418,10 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, `
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ------------- | ----------------------- | ------------------------------------------- | | ------------- | ----------------------- | ------------------------------------------- |
| `style_root` | `"bold red"` | The style used when the user is root/admin. | | `style_root` | `"bold red"` | The style used when the user is root/admin. |
| `style_user` | `"bold yellow"` | 非rootユーザーに使用されるスタイルです。 | | `style_user` | `"bold yellow"` | The style used for non-root users. |
| `format` | `"[$user]($style) in "` | module のフォーマットです。 | | `format` | `"[$user]($style) in "` | module のフォーマットです。 |
| `show_always` | `false` | `username`モジュールを常に表示します。 | | `show_always` | `false` | Always shows the `username` module. |
| `disabled` | `false` | `username`モジュールを無効にします。 | | `disabled` | `false` | Disables the `username` module. |
### 変数 ### 変数
@ -3407,9 +3445,9 @@ show_always = true
## Vagrant ## Vagrant
`vagrant`モジュールは、現在インストールされている[Vagrant](https://www.vagrantup.com/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 The `vagrant` module shows the currently installed version of [Vagrant](https://www.vagrantup.com/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
- カレントディレクトリに`Vagrantfile`ファイルが含まれている - The current directory contains a `Vagrantfile` file
### オプション ### オプション
@ -3445,10 +3483,10 @@ format = "via [⍱ $version](bold white) "
## V ## V
`vlang`モジュールは、現在インストールされている[V](https://vlang.io/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 The `vlang` module shows you your currently installed version of [V](https://vlang.io/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
- カレントディレクトリに拡張子が`.v`のファイルが含まれている - The current directory contains a file with `.v` extension
- カレントディレクトリに`v.mod`、`vpkg.json`または`.vpkg-lock.json`ファイルが含まれている - The current directory contains a `v.mod`, `vpkg.json` or `.vpkg-lock.json` file
### オプション ### オプション
@ -3513,9 +3551,9 @@ format = "[🆅 $repo](bold blue) "
## Zig ## Zig
デフォルトでは`zig`モジュールは、現在インストールされている[Zig](https://ziglang.org/)のバージョンを表示します。 次の条件のいずれかが満たされると、モジュールが表示されます: By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met:
- カレントディレクトリに拡張子が`.zig`のファイルが含まれている - The current directory contains a `.zig` file
### オプション ### オプション
@ -3559,7 +3597,7 @@ These modules will be shown if any of the following conditions are met:
- The current directory contains a directory whose name is in `detect_folders` - The current directory contains a directory whose name is in `detect_folders`
- The current directory contains a file whose extension is in `detect_extensions` - The current directory contains a file whose extension is in `detect_extensions`
- The `when` command returns 0 - The `when` command returns 0
- The current Operating System (std::env::consts::OS) matchs with `os` field if defined. - The current Operating System (std::env::consts::OS) matches with `os` field if defined.
::: tip ::: tip
@ -3593,8 +3631,8 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt
| ------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `command` | `""` | The command whose output should be printed. The command will be passed on stdin to the shell. | | `command` | `""` | The command whose output should be printed. The command will be passed on stdin to the shell. |
| `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. | | `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. |
| `shell` | | [この表の下を参照してください](#custom-command-shell) | | `shell` | | [See below](#custom-command-shell) |
| `説明` | `"<custom module>"` | The description of the module that is shown when running `starship explain`. | | `description` | `"<custom module>"` | The description of the module that is shown when running `starship explain`. |
| `detect_files` | `[]` | The files that will be searched in the working directory for a match. | | `detect_files` | `[]` | The files that will be searched in the working directory for a match. |
| `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. | | `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. |
| `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. | | `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. |

View File

@ -256,11 +256,12 @@ Install the latest version for your system with the MSI-installers from the [rel
以下のいずれかのパッケージマネージャーを使用して、Starshipをインストールします。 以下のいずれかのパッケージマネージャーを使用して、Starshipをインストールします。
| リポジトリ | 手順 | | リポジトリ | 手順 |
| -------------------------------------------------------------------------------- | --------------------------------------- | | -------------------------------------------------------------------------------------------- | --------------------------------------- |
| **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
| [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` | | [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` |
| [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` | | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
| [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json) | `scoop install starship` | | [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json) | `scoop install starship` |
| [winget](https://github.com/microsoft/winget-pkgs/tree/master/manifests/s/Starship/Starship) | `winget install --id Starship.Starship` |
</details> </details>

View File

@ -538,19 +538,19 @@ By default it only changes color. If you also want to change its shape take a lo
::: warning ::: warning
`vicmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148).
::: :::
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| -------------------------- | -------------------- | --------------------------------------------------------------------------------------- | | --------------------------- | -------------------- | --------------------------------------------------------------------------------------- |
| `format` | `"$symbol "` | The format string used before the text input. | | `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. | | `success_symbol` | `"[](bold green)"` | The format string used before the text input if the previous command succeeded. |
| `error_symbol` | `"[](bold red)"` | The format string used before the text input if the previous command failed. | | `error_symbol` | `"[](bold red)"` | The format string used before the text input if the previous command failed. |
| `vicmd_symbol` | `"[](bold green)"` | The format string used before the text input if the shell is in vim normal mode. | | `vimcmd_symbol` | `"[](bold green)"` | The format string used before the text input if the shell is in vim normal mode. |
| `vicmd_replace_one_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. | | `vimcmd_replace_one_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. |
| `vimcmd_replace_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. | | `vimcmd_replace_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. |
| `vimcmd_visual_symbol` | `"[](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. | | `vimcmd_visual_symbol` | `"[](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. |
| `disabled` | `false` | Disables the `character` module. | | `disabled` | `false` | Disables the `character` module. |
@ -2793,6 +2793,44 @@ The `rlang` module shows the currently installed version of [R](https://www.r-pr
format = "with [📐 $version](blue bold) " format = "with [📐 $version](blue bold) "
``` ```
## Raku
The `raku` module shows the currently installed version of [Raku](https://www.raku.org/). By default the module will be shown if any of the following conditions are met:
- The current directory contains a `META6.json` file
- The current directory contains a `.p6`, `.pm6`, `.raku`, `.rakumod` or `.pod6`
### Options
| Option | Default | Description |
| ------------------- | ------------------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version-$vm_version )]($style)"` | The format string for the module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🦋 "` | The symbol used before displaying the version of Raku |
| `detect_extensions` | `["p6", "pm6", "pod6", "raku", "rakumod"]` | Which extensions should trigger this module. |
| `detect_files` | `["META6.json"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold 149"` | The style for the module. |
| `disabled` | `false` | Disables the `raku` module. |
### Variables
| Variable | Example | Description |
| ---------- | ------- | ------------------------------------ |
| version | `v6.d` | The version of `raku` |
| vm_version | `moar` | The version of VM `raku` is built on |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
### Example
```toml
# ~/.config/starship.toml
[raku]
format = "via [🦪 $version]($style) "
```
## Red ## Red
By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met: By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met:
@ -3560,7 +3598,7 @@ These modules will be shown if any of the following conditions are met:
- The current directory contains a directory whose name is in `detect_folders` - The current directory contains a directory whose name is in `detect_folders`
- The current directory contains a file whose extension is in `detect_extensions` - The current directory contains a file whose extension is in `detect_extensions`
- The `when` command returns 0 - The `when` command returns 0
- The current Operating System (std::env::consts::OS) matchs with `os` field if defined. - The current Operating System (std::env::consts::OS) matches with `os` field if defined.
::: tip ::: tip

View File

@ -256,11 +256,12 @@ Install the latest version for your system with the MSI-installers from the [rel
다음 패키지 관리자 중 하나를 사용해 Starship 을 설치하세요: 다음 패키지 관리자 중 하나를 사용해 Starship 을 설치하세요:
| Repository | Instructions | | Repository | Instructions |
| -------------------------------------------------------------------------------- | --------------------------------------- | | -------------------------------------------------------------------------------------------- | --------------------------------------- |
| **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
| [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` | | [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` |
| [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` | | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
| [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json) | `scoop install starship` | | [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json) | `scoop install starship` |
| [winget](https://github.com/microsoft/winget-pkgs/tree/master/manifests/s/Starship/Starship) | `winget install --id Starship.Starship` |
</details> </details>

View File

@ -538,19 +538,19 @@ By default it only changes color. If you also want to change its shape take a lo
::: warning ::: warning
`vicmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148).
::: :::
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| -------------------------- | -------------------- | --------------------------------------------------------------------------------------- | | --------------------------- | -------------------- | --------------------------------------------------------------------------------------- |
| `format` | `"$symbol "` | The format string used before the text input. | | `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. | | `success_symbol` | `"[](bold green)"` | The format string used before the text input if the previous command succeeded. |
| `error_symbol` | `"[](bold red)"` | The format string used before the text input if the previous command failed. | | `error_symbol` | `"[](bold red)"` | The format string used before the text input if the previous command failed. |
| `vicmd_symbol` | `"[](bold green)"` | The format string used before the text input if the shell is in vim normal mode. | | `vimcmd_symbol` | `"[](bold green)"` | The format string used before the text input if the shell is in vim normal mode. |
| `vicmd_replace_one_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. | | `vimcmd_replace_one_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. |
| `vimcmd_replace_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. | | `vimcmd_replace_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. |
| `vimcmd_visual_symbol` | `"[](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. | | `vimcmd_visual_symbol` | `"[](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. |
| `disabled` | `false` | Disables the `character` module. | | `disabled` | `false` | Disables the `character` module. |
@ -2793,6 +2793,44 @@ The `rlang` module shows the currently installed version of [R](https://www.r-pr
format = "with [📐 $version](blue bold) " format = "with [📐 $version](blue bold) "
``` ```
## Raku
The `raku` module shows the currently installed version of [Raku](https://www.raku.org/). By default the module will be shown if any of the following conditions are met:
- The current directory contains a `META6.json` file
- The current directory contains a `.p6`, `.pm6`, `.raku`, `.rakumod` or `.pod6`
### Options
| Option | Default | Description |
| ------------------- | ------------------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version-$vm_version )]($style)"` | The format string for the module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🦋 "` | The symbol used before displaying the version of Raku |
| `detect_extensions` | `["p6", "pm6", "pod6", "raku", "rakumod"]` | Which extensions should trigger this module. |
| `detect_files` | `["META6.json"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold 149"` | The style for the module. |
| `disabled` | `false` | Disables the `raku` module. |
### Variables
| Variable | Example | Description |
| ---------- | ------- | ------------------------------------ |
| version | `v6.d` | The version of `raku` |
| vm_version | `moar` | The version of VM `raku` is built on |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
### Example
```toml
# ~/.config/starship.toml
[raku]
format = "via [🦪 $version]($style) "
```
## Red ## Red
By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met: By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met:
@ -3560,7 +3598,7 @@ These modules will be shown if any of the following conditions are met:
- The current directory contains a directory whose name is in `detect_folders` - The current directory contains a directory whose name is in `detect_folders`
- The current directory contains a file whose extension is in `detect_extensions` - The current directory contains a file whose extension is in `detect_extensions`
- The `when` command returns 0 - The `when` command returns 0
- The current Operating System (std::env::consts::OS) matchs with `os` field if defined. - The current Operating System (std::env::consts::OS) matches with `os` field if defined.
::: tip ::: tip

View File

@ -254,11 +254,12 @@ Install the latest version for your system with the MSI-installers from the [rel
Install Starship using any of the following package managers: Install Starship using any of the following package managers:
| Repository | Instructions | | Repository | Instructions |
| -------------------------------------------------------------------------------- | --------------------------------------- | | -------------------------------------------------------------------------------------------- | --------------------------------------- |
| **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
| [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` | | [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` |
| [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` | | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
| [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json) | `scoop install starship` | | [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json) | `scoop install starship` |
| [winget](https://github.com/microsoft/winget-pkgs/tree/master/manifests/s/Starship/Starship) | `winget install --id Starship.Starship` |
</details> </details>

View File

@ -3,22 +3,22 @@ home: true
heroImage: /logo.svg heroImage: /logo.svg
heroText: heroText:
tagline: Minimalny, szybki i nieskończenie konfigurowalny wiersz poleceń dla dowolnej powłoki! tagline: Minimalny, szybki i nieskończenie konfigurowalny wiersz poleceń dla dowolnej powłoki!
actionText: Get Started actionText: Pierwsze kroki
actionLink: ./guide/ actionLink: ./guide/
features: features:
- -
title: Kompatybilność przede wszystkim title: Kompatybilność przede wszystkim
details: Works on the most common shells on the most common operating systems. Use it everywhere! details: Działa na większości powszechnych powłokach, na większości najpopularniejszych systemach. Używaj go wszędzie!
- -
title: Napędzany językiem Rust title: Napędzany językiem Rust
details: Brings the best-in-class speed and safety of Rust, to make your prompt as quick and reliable as possible. details: Zapewnia najlepszą w swojej klasie prędkość i bezpieczeństwo języka Rust, w celu zapewnienia jak najszybszej i niezawodnej odpowiedzi.
- -
title: Konfigurowalny title: Konfigurowalny
details: Every little detail is customizable to your liking, to make this prompt as minimal or feature-rich as you'd like it to be. details: Każdy mały detal jest konfigurowalny do Twoich preferencji, aby wiersz poleceń był tak minimalny lub tak bogaty w funkcje, jak tylko zechcesz.
footer: ISC Licensed | Copyright © 2019-present Starship Contributors footer: Licencja ISC | Copyright © 2019-obecnie Kontrybutorzy Starship
#Used for the description meta tag, for SEO #Used for the description meta tag, for SEO
metaTitle: "Starship: Cross-Shell Prompt" metaTitle: "Starship: Wiersz poleceń dla dowolnej powłoki"
description: Starship is the minimal, blazing fast, and extremely customizable prompt for any shell! Shows the information you need, while staying sleek and minimal. Quick installation available for Bash, Fish, ZSH, Ion, Tcsh, Elvish, Nu, Xonsh, Cmd, and PowerShell. description: Starship to minimalny, szybki i ekstremalnie konfigurowalny wiersz poleceń dla każdej powłoki! Pokazuje informacje których potrzebujesz, pozostając elegancki i minimalny. Szybka instalacja dostępna dla powłok Bash, Fish, ZSH, Ion, Tcsh, Elvish, Nu, Xonsh, Cmd i PowerShell.
--- ---
<div class="center"> <div class="center">
@ -30,16 +30,16 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
### Wymagania wstępne ### Wymagania wstępne
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal. - Czcionka typu [Nerd Font](https://www.nerdfonts.com/) zainstalowana i włączona w twoim terminalu.
### Quick Install ### Instalacja
1. Zainstaluj plik programu **starship**: 1. Zainstaluj plik programu **starship**:
#### Instalacja najnowszej wersji #### Instalacja najnowszej wersji
With Shell: Za pomocą powłoki:
```sh ```sh
curl -sS https://starship.rs/install.sh | sh curl -sS https://starship.rs/install.sh | sh
@ -50,7 +50,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
#### Instalacja za pomocą menedżera pakietów #### Instalacja za pomocą menedżera pakietów
With [Homebrew](https://brew.sh/): Za pomocą [Homebrew](https://brew.sh/):
```sh ```sh
brew install starship brew install starship
@ -120,9 +120,9 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
#### Elvish #### Elvish
::: warning ::: uwaga
Only elvish v0.18 or higher is supported. Działa tylko dla elvish v0.18 albo wyższej wersji.
::: :::
@ -148,19 +148,19 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
#### Nushell #### Nushell
::: warning ::: uwaga
This will change in the future. Only Nushell v0.61+ is supported. Ten sposób zmieni się w przyszłości. Działa tylko na Nushell v0.61+.
::: :::
Add the following to to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell): Dodaj następujący kod na koniec Twojego pliku Nushell env (możesz go znaleźć uruchamiając `$nu.env-path` w Nushell):
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu starship init nu | save ~/.cache/starship/init.nu
``` ```
And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`): Dodaj następujący kod na koniec Twojego pliku konfiguracyjnego Nushell (możesz go znaleźć uruchamiając `$nu.config-path`):
```sh ```sh
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
@ -179,7 +179,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
#### Cmd #### Cmd
You need to use [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) with Cmd. Add the following to a file `starship.lua` and place this file in Clink scripts directory: Musisz użyć [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) z Cmd. Dodaj następujący kod do pliku `starship.lua` i przenieś ten plik do folderu ze skryptami Clink:
```lua ```lua
-- starship.lua -- starship.lua

View File

@ -2,7 +2,7 @@
Mimo że Starship jest wszechstronny, czasem nie wystarczy modyfikacja pliku `starship.toml` żeby uzyskać pewne rzeczy. Na tej stronie opisano bardziej zaawansowane sposoby konfigurowania używane w Starship. Mimo że Starship jest wszechstronny, czasem nie wystarczy modyfikacja pliku `starship.toml` żeby uzyskać pewne rzeczy. Na tej stronie opisano bardziej zaawansowane sposoby konfigurowania używane w Starship.
::: warning ::: uwaga
Konfiguracja opisana w tej sekcji może ulec zmianie w przyszłych wydaniach Starship. Konfiguracja opisana w tej sekcji może ulec zmianie w przyszłych wydaniach Starship.

View File

@ -536,21 +536,21 @@ 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 its shape take a look at [this example](#with-custom-error-shape). By default it only changes color. If you also want to change its shape take a look at [this example](#with-custom-error-shape).
::: warning ::: uwaga
`vicmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148).
::: :::
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| -------------------------- | -------------------- | --------------------------------------------------------------------------------------- | | --------------------------- | -------------------- | --------------------------------------------------------------------------------------- |
| `format` | `"$symbol "` | The format string used before the text input. | | `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. | | `success_symbol` | `"[](bold green)"` | The format string used before the text input if the previous command succeeded. |
| `error_symbol` | `"[](bold red)"` | The format string used before the text input if the previous command failed. | | `error_symbol` | `"[](bold red)"` | The format string used before the text input if the previous command failed. |
| `vicmd_symbol` | `"[](bold green)"` | The format string used before the text input if the shell is in vim normal mode. | | `vimcmd_symbol` | `"[](bold green)"` | The format string used before the text input if the shell is in vim normal mode. |
| `vicmd_replace_one_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. | | `vimcmd_replace_one_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. |
| `vimcmd_replace_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. | | `vimcmd_replace_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. |
| `vimcmd_visual_symbol` | `"[](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. | | `vimcmd_visual_symbol` | `"[](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. |
| `disabled` | `false` | Disables the `character` module. | | `disabled` | `false` | Disables the `character` module. |
@ -1844,13 +1844,13 @@ The default functionality is:
- 1 job -> `symbol` is shown. - 1 job -> `symbol` is shown.
- 2 jobs or more -> `symbol` + `number` are shown. - 2 jobs or more -> `symbol` + `number` are shown.
::: warning ::: uwaga
This module is not supported on tcsh and nu. This module is not supported on tcsh and nu.
::: :::
::: warning ::: uwaga
The `threshold` option is deprecated, but if you want to use it, 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. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. The `threshold` option is deprecated, but if you want to use it, 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. If `threshold` is set to 0, then the module will also show when there are 0 jobs running.
@ -2793,6 +2793,44 @@ The `rlang` module shows the currently installed version of [R](https://www.r-pr
format = "with [📐 $version](blue bold) " format = "with [📐 $version](blue bold) "
``` ```
## Raku
The `raku` module shows the currently installed version of [Raku](https://www.raku.org/). By default the module will be shown if any of the following conditions are met:
- The current directory contains a `META6.json` file
- The current directory contains a `.p6`, `.pm6`, `.raku`, `.rakumod` or `.pod6`
### Options
| Option | Default | Description |
| ------------------- | ------------------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version-$vm_version )]($style)"` | The format string for the module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🦋 "` | The symbol used before displaying the version of Raku |
| `detect_extensions` | `["p6", "pm6", "pod6", "raku", "rakumod"]` | Which extensions should trigger this module. |
| `detect_files` | `["META6.json"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold 149"` | The style for the module. |
| `disabled` | `false` | Disables the `raku` module. |
### Variables
| Zmienne | Example | Description |
| ---------- | ------- | ------------------------------------ |
| version | `v6.d` | The version of `raku` |
| vm_version | `moar` | The version of VM `raku` is built on |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
### Example
```toml
# ~/.config/starship.toml
[raku]
format = "via [🦪 $version]($style) "
```
## Red ## Red
By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met: By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met:
@ -3560,7 +3598,7 @@ These modules will be shown if any of the following conditions are met:
- The current directory contains a directory whose name is in `detect_folders` - The current directory contains a directory whose name is in `detect_folders`
- The current directory contains a file whose extension is in `detect_extensions` - The current directory contains a file whose extension is in `detect_extensions`
- The `when` command returns 0 - The `when` command returns 0
- The current Operating System (std::env::consts::OS) matchs with `os` field if defined. - The current Operating System (std::env::consts::OS) matches with `os` field if defined.
::: tip ::: tip

View File

@ -171,7 +171,7 @@
- Czcionka typu [Nerd Font](https://www.nerdfonts.com/) zainstalowana i ustawiona w twoim terminalu (wypróbuj na przykład [Fira Code Nerd Font](https://www.nerdfonts.com/font-downloads)). - Czcionka typu [Nerd Font](https://www.nerdfonts.com/) zainstalowana i ustawiona w twoim terminalu (wypróbuj na przykład [Fira Code Nerd Font](https://www.nerdfonts.com/font-downloads)).
### Step 1. Install Starship ### Krok 1. Install Starship
Select your operating system from the list below to view installation instructions: Select your operating system from the list below to view installation instructions:
@ -256,15 +256,16 @@ Install the latest version for your system with the MSI-installers from the [rel
Install Starship using any of the following package managers: Install Starship using any of the following package managers:
| Repository | Instructions | | Repository | Instructions |
| -------------------------------------------------------------------------------- | --------------------------------------- | | -------------------------------------------------------------------------------------------- | --------------------------------------- |
| **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
| [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` | | [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` |
| [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` | | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
| [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json) | `scoop install starship` | | [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json) | `scoop install starship` |
| [winget](https://github.com/microsoft/winget-pkgs/tree/master/manifests/s/Starship/Starship) | `winget install --id Starship.Starship` |
</details> </details>
### Step 2. Setup your shell to use Starship ### Krok 2. Setup your shell to use Starship
Configure your shell to initialize starship. Select yours from the list below: Configure your shell to initialize starship. Select yours from the list below:
@ -282,7 +283,7 @@ eval "$(starship init bash)"
<details> <details>
<summary>Cmd</summary> <summary>Cmd</summary>
You need to use [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) with Cmd. Create a file at this path `%LocalAppData%\clink\starship.lua` with the following contents: Musisz użyć [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) z Cmd. Create a file at this path `%LocalAppData%\clink\starship.lua` with the following contents:
```lua ```lua
load(io.popen('starship init cmd'):read("*a"))() load(io.popen('starship init cmd'):read("*a"))()
@ -335,7 +336,7 @@ mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu starship init nu | save ~/.cache/starship/init.nu
``` ```
And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`): Dodaj następujący kod na koniec Twojego pliku konfiguracyjnego Nushell (możesz go znaleźć uruchamiając `$nu.config-path`):
```sh ```sh
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
@ -389,7 +390,7 @@ eval "$(starship init zsh)"
</details> </details>
### Step 3. Configure Starship ### Krok 3. Configure Starship
Start a new shell instance, and you should see your beautiful new shell prompt. If you're happy with the defaults, enjoy! Start a new shell instance, and you should see your beautiful new shell prompt. If you're happy with the defaults, enjoy!

View File

@ -5,15 +5,15 @@ Aby zainstalować starship, musisz zrobić dwie rzeczy:
1. Pobrać plik wykonywalny **starship** na swój komputer 1. Pobrać plik wykonywalny **starship** na swój komputer
1. Skonfigurować swoją powłokę żeby używała pliku wykonywalnego starship jako wiersza poleceń poprzez modyfikację skryptów inicjalizacyjnych 1. Skonfigurować swoją powłokę żeby używała pliku wykonywalnego starship jako wiersza poleceń poprzez modyfikację skryptów inicjalizacyjnych
Dla większości użytkowników instrukcje na [stronie głównej](/guide/#🚀-installation) są wystarczające. However, for some more specialized platforms, different instructions are needed. Dla większości użytkowników instrukcje na [stronie głównej](/guide/#🚀-installation) są wystarczające. Jednakże, dla niektórych wyspecjalizowanych platform, potrzebne będą inne.
There are so many platforms out there that they didn't fit into the main README.md file, so here are some installation instructions for other platforms from the community. Is yours not here? Please do add it here if you figure it out! Istnieje tak wiele platform, że nie zmieściły się one w głównym pliku README.md, więc poniżej znajdują się instrukcje instalacji dla innych platform od społeczności. Nie ma tutaj Twojej? Jeśli się o tym dowiesz, dodaj je tutaj!
## [Chocolatey](https://chocolatey.org) ## [Chocolatey](https://chocolatey.org)
### Wymagania wstępne ### Wymagania wstępne
Head over to the [Chocolatey installation page](https://chocolatey.org/install) and follow the instructions to install Chocolatey. Przejdź na stronę [Instalacja Chocolatey](https://chocolatey.org/install) i postępuj zgodnie z instrukcjami, aby zainstalować Chocolatey.
### Instalacja ### Instalacja
@ -39,7 +39,7 @@ curl -sS https://starship.rs/install.sh | sh -s -- --bin-dir /data/data/com.term
### Instalacja ### Instalacja
On Funtoo Linux, starship can be installed from [core-kit](https://github.com/funtoo/core-kit/tree/1.4-release/app-shells/starship) via Portage: Na Funtoo Linux, starship może być zainstalowany przez Portage z [core-kit](https://github.com/funtoo/core-kit/tree/1.4-release/app-shells/starship):
```sh ```sh
emerge app-shells/starship emerge app-shells/starship

View File

@ -538,19 +538,19 @@ Por padrão ele apenas muda de cor. Se você deseja alterar o formato de uma olh
::: atenção ::: atenção
`vicmd_symbol` só é suportado no cmd, fish e zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148).
::: :::
### Opções ### Opções
| Opções | Padrão | Descrição | | Opções | Padrão | Descrição |
| -------------------------- | -------------------- | ------------------------------------------------------------------------------------------- | | --------------------------- | -------------------- | ------------------------------------------------------------------------------------------- |
| `format` | `"$symbol"` | O formato da string usado antes da entrada dos textos. | | `format` | `"$symbol"` | O formato da string usado antes da entrada dos textos. |
| `success_symbol` | `"[](bold green)"` | O formato da string usado antes da entrada de texto se o comando anterior for bem-sucedido. | | `success_symbol` | `"[](bold green)"` | O formato da string usado antes da entrada de texto se o comando anterior for bem-sucedido. |
| `error_symbol` | `"[](bold red)"` | O formato de string usado antes da entrada de texto se o comando anterior tiver falhado. | | `error_symbol` | `"[](bold red)"` | O formato de string usado antes da entrada de texto se o comando anterior tiver falhado. |
| `vicmd_symbol` | `"[](bold green)"` | O fromato de string usado antes da entrada de texto se o shell esta no vim normal mode. | | `vimcmd_symbol` | `"[](bold green)"` | O fromato de string usado antes da entrada de texto se o shell esta no vim normal mode. |
| `vicmd_replace_one_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. | | `vimcmd_replace_one_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. |
| `vimcmd_replace_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. | | `vimcmd_replace_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. |
| `vimcmd_visual_symbol` | `"[](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. | | `vimcmd_visual_symbol` | `"[](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. |
| `disabled` | `false` | Desabilita o módulo `character`. | | `disabled` | `false` | Desabilita o módulo `character`. |
@ -2791,11 +2791,49 @@ O módulo `rlang` mostra a versão atualmente instalada do [R](https://www.r-pro
format = "with [📐 $version](blue bold) " format = "with [📐 $version](blue bold) "
``` ```
## Raku
The `raku` module shows the currently installed version of [Raku](https://www.raku.org/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida:
- The current directory contains a `META6.json` file
- The current directory contains a `.p6`, `.pm6`, `.raku`, `.rakumod` or `.pod6`
### Opções
| Opções | Padrão | Descrição |
| ------------------- | ------------------------------------------------ | ------------------------------------------------------------------------------------ |
| `format` | `"via [$symbol($version-$vm_version )]($style)"` | A string de formato do módulo. |
| `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🦋 "` | The symbol used before displaying the version of Raku |
| `detect_extensions` | `["p6", "pm6", "pod6", "raku", "rakumod"]` | Quais extensões devem ativar este módulo. |
| `detect_files` | `["META6.json"]` | Quais nomes de arquivos devem ativar este módulo. |
| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. |
| `style` | `"bold 149"` | O estilo do módulo. |
| `disabled` | `false` | Disables the `raku` module. |
### Variáveis
| Variável | Exemplo | Descrição |
| ---------- | ------- | ------------------------------------ |
| version | `v6.d` | The version of `raku` |
| vm_version | `moar` | The version of VM `raku` is built on |
| symbol | | Espelha o valor da opção `symbol` |
| style\* | | Espelha o valor da opção `style` |
### Exemplo
```toml
# ~/.config/starship.toml
[raku]
format = "via [🦪 $version]($style) "
```
## Red ## Red
Por padrão o módulo `red` exibe a versão atual instalada do [Red](https://www.red-lang.org/). O módulo vai exibir se algumas das condições a seguir for atendida: By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met:
- O diretório atual contenha um arquivo com a extensão `.red` or `.reds` - The current directory contains a file with `.red` or `.reds` extension
### Opções ### Opções
@ -2803,18 +2841,18 @@ Por padrão o módulo `red` exibe a versão atual instalada do [Red](https://www
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | | `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. |
| `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🔺 "` | Uma string que representa o simbolo do Red. | | `symbol` | `"🔺 "` | A format string representing the symbol of Red. |
| `detect_extensions` | `["red"]` | Quais extensões devem ativar este módulo. | | `detect_extensions` | `["red"]` | Quais extensões devem ativar este módulo. |
| `detect_files` | `[]` | Quais nomes de arquivos devem ativar este módulo. | | `detect_files` | `[]` | Quais nomes de arquivos devem ativar este módulo. |
| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | | `detect_folders` | `[]` | Quais pastas devem ativar este módulo. |
| `style` | `"red bold"` | O estilo do módulo. | | `style` | `"red bold"` | O estilo do módulo. |
| `disabled` | `false` | Desabilita o módulo `red`. | | `disabled` | `false` | Disables the `red` module. |
### Variáveis ### Variáveis
| Variável | Exemplo | Descrição | | Variável | Exemplo | Descrição |
| --------- | -------- | --------------------------------- | | --------- | -------- | --------------------------------- |
| version | `v2.5.1` | A versão do `red` | | version | `v2.5.1` | The version of `red` |
| symbol | | Espelha o valor da opção `symbol` | | symbol | | Espelha o valor da opção `symbol` |
| style\* | | Espelha o valor da opção `style` | | style\* | | Espelha o valor da opção `style` |
@ -2831,14 +2869,14 @@ symbol = "🔴 "
## Ruby ## Ruby
Por padrão o módulo `ruby` vai exibir a versão atual instalada do [Ruby](https://www.ruby-lang.org/). O módulo vai exibir se algumas das condições a seguir for atendida: By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). The module will be shown if any of the following conditions are met:
- O diretório atual tenha um arquivo `Gemfile` - The current directory contains a `Gemfile` file
- O diretório atual contém um arquivo `.ruby-version` - The current directory contains a `.ruby-version` file
- O diretório atual contem um arquivo `.rb` - The current directory contains a `.rb` file
- As variáveis de ambiente `RUBY_VERSION` ou `RBENV_VERSION` estão definidas - The environment variables `RUBY_VERSION` or `RBENV_VERSION` are set
O Starship pega a versão atual do Ruby rodando `ruby -v`. Starship gets the current Ruby version by running `ruby -v`.
### Opções ### Opções
@ -2846,19 +2884,19 @@ O Starship pega a versão atual do Ruby rodando `ruby -v`.
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | | `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. |
| `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"💎 "` | Uma string que representa o simbolo do Ruby. | | `symbol` | `"💎 "` | A format string representing the symbol of Ruby. |
| `detect_extensions` | `["rb"]` | Quais extensões devem ativar este módulo. | | `detect_extensions` | `["rb"]` | Quais extensões devem ativar este módulo. |
| `detect_files` | `["Gemfile", ".ruby-version"]` | Quais nomes de arquivos devem ativar este módulo. | | `detect_files` | `["Gemfile", ".ruby-version"]` | Quais nomes de arquivos devem ativar este módulo. |
| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | | `detect_folders` | `[]` | Quais pastas devem ativar este módulo. |
| `detect_variables` | `["RUBY_VERSION", "RBENV_VERSION"]` | Quais variáveis de ambiente devem ativar este módulo. | | `detect_variables` | `["RUBY_VERSION", "RBENV_VERSION"]` | Which environment variables should trigger this module. |
| `style` | `"bold red"` | O estilo do módulo. | | `style` | `"bold red"` | O estilo do módulo. |
| `disabled` | `false` | Desabilita o módulo `ruby`. | | `disabled` | `false` | Disables the `ruby` module. |
### Variáveis ### Variáveis
| Variável | Exemplo | Descrição | | Variável | Exemplo | Descrição |
| --------- | -------- | --------------------------------- | | --------- | -------- | --------------------------------- |
| version | `v2.5.1` | A versão do `ruby` | | version | `v2.5.1` | The version of `ruby` |
| symbol | | Espelha o valor da opção `symbol` | | symbol | | Espelha o valor da opção `symbol` |
| style\* | | Espelha o valor da opção `style` | | style\* | | Espelha o valor da opção `style` |
@ -2875,10 +2913,10 @@ symbol = "🔺 "
## Rust ## Rust
Por padrão o módulo `rust` vai exibir a versão atual instalada do [Rust](https://www.rust-lang.org/). O módulo vai exibir se algumas das condições a seguir for atendida: By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). The module will be shown if any of the following conditions are met:
- O diretório atual contem um arquivo `Cargo.toml` - The current directory contains a `Cargo.toml` file
- O diretório atual tenha um arquivo com a extensão `.rs` - The current directory contains a file with the `.rs` extension
### Opções ### Opções
@ -2886,20 +2924,20 @@ Por padrão o módulo `rust` vai exibir a versão atual instalada do [Rust](http
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | | `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. |
| `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🦀 "` | Uma string que representa o simbolo do Rust | | `symbol` | `"🦀 "` | A format string representing the symbol of Rust |
| `detect_extensions` | `["rs"]` | Quais extensões devem ativar este módulo. | | `detect_extensions` | `["rs"]` | Quais extensões devem ativar este módulo. |
| `detect_files` | `["Cargo.toml"]` | Quais nomes de arquivos devem ativar este módulo. | | `detect_files` | `["Cargo.toml"]` | Quais nomes de arquivos devem ativar este módulo. |
| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | | `detect_folders` | `[]` | Quais pastas devem ativar este módulo. |
| `style` | `"bold red"` | O estilo do módulo. | | `style` | `"bold red"` | O estilo do módulo. |
| `disabled` | `false` | Desabilita o módulo `rust`. | | `disabled` | `false` | Disables the `rust` module. |
### Variáveis ### Variáveis
| Variável | Exemplo | Descrição | | Variável | Exemplo | Descrição |
| --------- | ----------------- | --------------------------------------- | | --------- | ----------------- | -------------------------------------------- |
| version | `v1.43.0-nightly` | A versão do `rustc` | | version | `v1.43.0-nightly` | The version of `rustc` |
| numver | `1.51.0` | O componente numérico da versão `rustc` | | numver | `1.51.0` | The numeric component of the `rustc` version |
| toolchain | `beta` | A versão do toolchain | | toolchain | `beta` | The toolchain version |
| symbol | | Espelha o valor da opção `symbol` | | symbol | | Espelha o valor da opção `symbol` |
| style\* | | Espelha o valor da opção `style` | | style\* | | Espelha o valor da opção `style` |
@ -2916,11 +2954,11 @@ format = "via [⚙️ $version](red bold)"
## Scala ## Scala
O módulo `scala` exibe a versão atual instalada do [Scala](https://www.scala-lang.org/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida:
- O diretório atual contem um arquivo `build.sbt`, `.scalaenv` ou `.sbtenv` - The current directory contains a `build.sbt`, `.scalaenv` or `.sbtenv` file
- O diretório atual tenha um arquivo com a extensão `.scala` ou `.sbt` - The current directory contains a file with the `.scala` or `.sbt` extension
- O diretório atual tenha um diretório chamado `.metals` - The current directory contains a directory named `.metals`
### Opções ### Opções
@ -2928,18 +2966,18 @@ O módulo `scala` exibe a versão atual instalada do [Scala](https://www.scala-l
| ------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------ | | ------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------ |
| `format` | `"via [${symbol}(${version} )]($style)"` | O formato do módulo. | | `format` | `"via [${symbol}(${version} )]($style)"` | O formato do módulo. |
| `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` |
| `detect_extensions` | `["sbt", "escala"]` | Quais extensões devem ativar este módulo. | | `detect_extensions` | `["sbt", "scala"]` | Quais extensões devem ativar este módulo. |
| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Quais nomes de arquivos devem ativar este módulo. | | `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Quais nomes de arquivos devem ativar este módulo. |
| `detect_folders` | `[".metals"]` | Quais pastas devem ativar este módulo. | | `detect_folders` | `[".metals"]` | Quais pastas devem ativar este módulo. |
| `symbol` | `"🆂 "` | Uma string que representa o simbolo do Scala. | | `symbol` | `"🆂 "` | A format string representing the symbol of Scala. |
| `style` | `"red dimmed"` | O estilo do módulo. | | `style` | `"red dimmed"` | O estilo do módulo. |
| `disabled` | `false` | Desabilita o módulo `scala`. | | `disabled` | `false` | Disables the `scala` module. |
### Variáveis ### Variáveis
| Variável | Exemplo | Descrição | | Variável | Exemplo | Descrição |
| --------- | -------- | --------------------------------- | | --------- | -------- | --------------------------------- |
| version | `2.13.5` | A versão do `scala` | | version | `2.13.5` | The version of `scala` |
| symbol | | Espelha o valor da opção `symbol` | | symbol | | Espelha o valor da opção `symbol` |
| style\* | | Espelha o valor da opção `style` | | style\* | | Espelha o valor da opção `style` |
@ -2956,7 +2994,7 @@ symbol = "🌟 "
## Shell ## Shell
O módulo de `shell` exibe um indicador para o shell que esta sendo usado. The `shell` module shows an indicator for currently used shell.
::: tip ::: tip
@ -2967,28 +3005,28 @@ Este módulo é desabilitado por padrão. Para habilitar, defina `disabled` para
### Opções ### Opções
| Opções | Padrão | Descrição | | Opções | Padrão | Descrição |
| ---------------------- | ------------------------- | ------------------------------------------------------- | | ---------------------- | ------------------------- | ------------------------------------------------------------ |
| `bash_indicator` | `bsh` | Uma string para representar o bash. | | `bash_indicator` | `bsh` | A format string used to represent bash. |
| `fish_indicator` | `fsh` | Uma string usada para representar o fish. | | `fish_indicator` | `fsh` | A format string used to represent fish. |
| `zsh_indicator` | `zsh` | Uma string usada para representar o zsh. | | `zsh_indicator` | `zsh` | A format string used to represent zsh. |
| `powershell_indicator` | `psh` | Uma string usada para representar o powershell. | | `powershell_indicator` | `psh` | A format string used to represent powershell. |
| `ion_indicator` | `ion` | Uma string usada para representar o ion. | | `ion_indicator` | `ion` | A format string used to represent ion. |
| `elvish_indicator` | `esh` | Uma string usada para representar o elvish. | | `elvish_indicator` | `esh` | A format string used to represent elvish. |
| `tcsh_indicator` | `tsh` | Uma string usada para representar o tcsh. | | `tcsh_indicator` | `tsh` | A format string used to represent tcsh. |
| `xonsh_indicator` | `xsh` | Uma string usada para representar o xonsh. | | `xonsh_indicator` | `xsh` | A format string used to represent xonsh. |
| `cmd_indicator` | `cmd` | Uma string usada para representar o cmd. | | `cmd_indicator` | `cmd` | A format string used to represent cmd. |
| `nu_indicator` | `nu` | Uma string usada para representar o nu. | | `nu_indicator` | `nu` | A format string used to represent nu. |
| `unknown_indicator` | | Valor padrão para exibir quando o shell é desconhecido. | | `unknown_indicator` | | The default value to be displayed when the shell is unknown. |
| `format` | `"[$indicator]($style) "` | O formato do módulo. | | `format` | `"[$indicator]($style) "` | O formato do módulo. |
| `style` | `"white bold"` | O estilo do módulo. | | `style` | `"white bold"` | O estilo do módulo. |
| `disabled` | `true` | Desabilita o módulo `shell`. | | `disabled` | `true` | Disables the `shell` module. |
### Variáveis ### Variáveis
| Variável | Padrão | Descrição | | Variável | Padrão | Descrição |
| --------- | ------ | ------------------------------------------------------------- | | --------- | ------ | ---------------------------------------------------------- |
| indicator | | Espelha o valor do `indicator` para o shell usado atualmente. | | indicator | | Mirrors the value of `indicator` for currently used shell. |
| style\* | | Espelha o valor da opção `style`. | | style\* | | Mirrors the value of option `style`. |
*: Esta variável só pode ser usada como parte de uma string de estilo *: Esta variável só pode ser usada como parte de uma string de estilo
@ -3007,24 +3045,24 @@ disabled = false
## SHLVL ## SHLVL
O módulo `shlvl` exibe o atual [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ("shell level") variável de ambiente, se estiver definido um número e coincidir ou exceder o limite especificado. The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold.
### Opções ### Opções
| Opções | Padrão | Descrição | | Opções | Padrão | Descrição |
| ----------- | ---------------------------- | ----------------------------------------------------------------- | | ----------- | ---------------------------- | ------------------------------------------------------------- |
| `threshold` | `2` | Limite de exibição. | | `threshold` | `2` | Display threshold. |
| `format` | `"[$symbol$shlvl]($style) "` | O formato do módulo. | | `format` | `"[$symbol$shlvl]($style) "` | O formato do módulo. |
| `symbol` | `"↕️ "` | O simbolo usado para representar o `SHLVL`. | | `symbol` | `"↕️ "` | The symbol used to represent the `SHLVL`. |
| `repeat` | `false` | Caso o `symbol` deva se repetir de acordo com o total do `SHLVL`. | | `repeat` | `false` | Causes `symbol` to be repeated by the current `SHLVL` amount. |
| `style` | `"bold yellow"` | O estilo do módulo. | | `style` | `"bold yellow"` | O estilo do módulo. |
| `disabled` | `true` | Desabilita o módulo `shlvl`. | | `disabled` | `true` | Disables the `shlvl` module. |
### Variáveis ### Variáveis
| Variável | Exemplo | Descrição | | Variável | Exemplo | Descrição |
| --------- | ------- | --------------------------------- | | --------- | ------- | --------------------------------- |
| shlvl | `3` | O valor atual do `SHLVL` | | shlvl | `3` | The current value of `SHLVL` |
| symbol | | Espelha o valor da opção `symbol` | | symbol | | Espelha o valor da opção `symbol` |
| style\* | | Espelha o valor da opção `style` | | style\* | | Espelha o valor da opção `style` |
@ -3043,22 +3081,22 @@ threshold = 3
## Singularidade ## Singularidade
O módulo `singularity` exibe a imagem atual do [Singularity](https://sylabs.io/singularity/), se dentro de um contêiner e definido `$SINGULARITY_NAME`. The `singularity` module shows the current [Singularity](https://sylabs.io/singularity/) image, if inside a container and `$SINGULARITY_NAME` is set.
### Opções ### Opções
| Opções | Padrão | Descrição | | Opções | Padrão | Descrição |
| ---------- | -------------------------------- | ------------------------------------------- | | ---------- | -------------------------------- | ------------------------------------------------ |
| `format` | `'[$symbol\[$env\]]($style) '` | O formato do módulo. | | `format` | `'[$symbol\[$env\]]($style) '` | O formato do módulo. |
| `symbol` | `""` | Uma string exibida antes do nome da imagem. | | `symbol` | `""` | A format string displayed before the image name. |
| `style` | `"bold dimmed blue"` | O estilo do módulo. | | `style` | `"bold dimmed blue"` | O estilo do módulo. |
| `disabled` | `false` | Desabilita o módulo `singularity`. | | `disabled` | `false` | Disables the `singularity` module. |
### Variáveis ### Variáveis
| Variável | Exemplo | Descrição | | Variável | Exemplo | Descrição |
| --------- | ------------ | --------------------------------- | | --------- | ------------ | --------------------------------- |
| env | `centos.img` | A imagem atual do Singularity | | env | `centos.img` | The current Singularity image |
| symbol | | Espelha o valor da opção `symbol` | | symbol | | Espelha o valor da opção `symbol` |
| style\* | | Espelha o valor da opção `style` | | style\* | | Espelha o valor da opção `style` |
@ -3075,23 +3113,23 @@ format = '[📦 \[$env\]]($style) '
## Spack ## Spack
O módulo `spack` mostra o ambiente [Spack](https://spack.readthedocs.io/en/latest/) atual, se o `$SPACK_ENV` estiver definido. The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set.
### Opções ### Opções
| Opções | Padrão | Descrição | | Opções | Padrão | Descrição |
| ------------------- | -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------- | -------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `truncation_length` | `1` | O número de diretórios para os quais o caminho do ambiente deve ser truncado. `0` quer dizer sem truncação. Também consulte o módulo [`directory`](#directory). | | `truncation_length` | `1` | The number of directories the environment path should be truncated to. `0` quer dizer sem truncação. Também consulte o módulo [`directory`](#directory). |
| `symbol` | `"🅢 "` | O simbolo usado antes do nome do environment. | | `symbol` | `"🅢 "` | O simbolo usado antes do nome do environment. |
| `style` | `"bold blue"` | O estilo do módulo. | | `style` | `"bold blue"` | O estilo do módulo. |
| `format` | `"via [$symbol$environment]($style) "` | O formato do módulo. | | `format` | `"via [$symbol$environment]($style) "` | O formato do módulo. |
| `disabled` | `false` | Desabilita o módulo `spack`. | | `disabled` | `false` | Disables the `spack` module. |
### Variáveis ### Variáveis
| Variável | Exemplo | Descrição | | Variável | Exemplo | Descrição |
| ----------- | ------------ | --------------------------------- | | ----------- | ------------ | --------------------------------- |
| environment | `astronauts` | O ambiente spack atual | | environment | `astronauts` | The current spack environment |
| symbol | | Espelha o valor da opção `symbol` | | symbol | | Espelha o valor da opção `symbol` |
| style\* | | Espelha o valor da opção `style` | | style\* | | Espelha o valor da opção `style` |
@ -3108,7 +3146,7 @@ format = "[$symbol$environment](dimmed blue) "
## Status ## Status
O módulo `status` exibe o código de saída do comando anterior. Se o $success_symbol estiver vazio (padrão), o módulo será exibido apenas se o código de saída não for `0.`. O código de status será convertido em um inteiro de 32 bits signed. The `status` module displays the exit code of the previous command. If $success_symbol is empty (default), the module will be shown only if the exit code is not `0`. The status code will cast to a signed 32-bit integer.
::: tip ::: tip
@ -3121,32 +3159,32 @@ Este módulo é desabilitado por padrão. Para habilitar, defina `disabled` para
| Opções | Padrão | Descrição | | Opções | Padrão | Descrição |
| ----------------------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------- | | ----------------------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------- |
| `format` | `"[$symbol$status]($style) "` | O formato do módulo | | `format` | `"[$symbol$status]($style) "` | O formato do módulo |
| `symbol` | `"✖"` | O simbolo exibido no erro de programa | | `symbol` | `"✖"` | The symbol displayed on program error |
| `success_symbol` | `""` | O simbolo exibido no sucesso de programa | | `success_symbol` | `""` | The symbol displayed on program success |
| `not_executable_symbol` | `"🚫"` | O simbolo exibido quando o arquivo não é executável | | `not_executable_symbol` | `"🚫"` | The symbol displayed when file isn't executable |
| `not_found_symbol` | `"🔍"` | O simbolo exibido quando o comando não é encontrado | | `not_found_symbol` | `"🔍"` | The symbol displayed when the command can't be found |
| `sigint_symbol` | `"🧱"` | O simbolo exibido no SIGINT (Ctrl + c) | | `sigint_symbol` | `"🧱"` | The symbol displayed on SIGINT (Ctrl + c) |
| `signal_symbol` | `"⚡"` | O simbolo exibido em qualquer sinal | | `signal_symbol` | `"⚡"` | The symbol displayed on any signal |
| `style` | `"bold red"` | O estilo do módulo. | | `style` | `"bold red"` | O estilo do módulo. |
| `recognize_signal_code` | `true` | Habilita o mapeamento de sinais para códigos de saída | | `recognize_signal_code` | `true` | Enable signal mapping from exit code |
| `map_symbol` | `false` | Habilita o mapeamento de símbolos para códigos de saída | | `map_symbol` | `false` | Enable symbols mapping from exit code |
| `pipestatus` | `false` | Habilita o relatório de pipestatus | | `pipestatus` | `false` | Enable pipestatus reporting |
| `pipestatus_separator` | `|` | | | `pipestatus_separator` | `|` | |
| `pipestatus_format` | `\\[$pipestatus\\] => [$symbol$common_meaning$signal_name$maybe_int]($style)` | O formato do módulo quando o comando é um pipeline | | `pipestatus_format` | `\\[$pipestatus\\] => [$symbol$common_meaning$signal_name$maybe_int]($style)` | The format of the module when the command is a pipeline |
| `disabled` | `true` | Desabilita o módulo `status`. | | `disabled` | `true` | Disables the `status` module. |
### Variáveis ### Variáveis
| Variável | Exemplo | Descrição | | Variável | Exemplo | Descrição |
| -------------- | ------- | -------------------------------------------------------------------------------------------------------- | | -------------- | ------- | ------------------------------------------------------------------------------------------- |
| status | `127` | O codígo de saída do último comando | | status | `127` | The exit code of the last command |
| hex_status | `0x7F` | O codígo de saída do último comando em hex | | hex_status | `0x7F` | The exit code of the last command in hex |
| int | `127` | O codígo de saída do último comando | | int | `127` | The exit code of the last command |
| common_meaning | `ERROR` | Significa que o código não é um sinal | | common_meaning | `ERROR` | Meaning of the code if not a signal |
| signal_number | `9` | Número do sinal correspondente ao código de saída, apenas se sinalizado | | signal_number | `9` | Signal number corresponding to the exit code, only if signalled |
| signal_name | `KILL` | Nome do sinal correspondente ao código de saída, apenas se for sinalizado | | signal_name | `KILL` | Name of the signal corresponding to the exit code, only if signalled |
| maybe_int | `7` | Contém o código de saída quando nenhum significado for encontrado | | maybe_int | `7` | Contains the exit code number when no meaning has been found |
| pipestatus | | Exibição do pipeline de programas com os códigos de saída, este é apenas disponível no pipestatus_format | | pipestatus | | Rendering of in pipeline programs's exit codes, this is only available in pipestatus_format |
| symbol | | Espelha o valor da opção `symbol` | | symbol | | Espelha o valor da opção `symbol` |
| style\* | | Espelha o valor da opção `style` | | style\* | | Espelha o valor da opção `style` |
@ -3168,7 +3206,7 @@ disabled = false
## Sudo ## Sudo
O módulo `sudo` é exibido se uma credencial sudo estiver em cache. O módulo vai ser exibido somente se as credenciais estiverem em cache. The `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached.
::: tip ::: tip
@ -3179,12 +3217,12 @@ Este módulo é desabilitado por padrão. Para habilitar, defina `disabled` para
### Opções ### Opções
| Opções | Padrão | Descrição | | Opções | Padrão | Descrição |
| --------------- | ----------------------- | -------------------------------------------------------------------------- | | --------------- | ----------------------- | ------------------------------------------------------- |
| `format` | `[as $symbol]($style)"` | O formato do módulo | | `format` | `[as $symbol]($style)"` | O formato do módulo |
| `symbol` | `"🧙 "` | O simbolo exibido quando as credenciais estão em cache | | `symbol` | `"🧙 "` | The symbol displayed when credentials are cached |
| `style` | `"bold blue"` | O estilo do módulo. | | `style` | `"bold blue"` | O estilo do módulo. |
| `allow_windows` | `false` | Desde que o Windows não tem um padrão sudo, o valor padrão é desabilitado. | | `allow_windows` | `false` | Since windows has no default sudo, default is disabled. |
| `disabled` | `true` | Desabilita o módulo `sudo`. | | `disabled` | `true` | Disables the `sudo` module. |
### Variáveis ### Variáveis
@ -3207,7 +3245,7 @@ disabled = false
``` ```
```toml ```toml
# No windows # On windows
# $HOME\.starship\config.toml # $HOME\.starship\config.toml
[sudo] [sudo]
@ -3217,10 +3255,10 @@ disabled = false
## Swift ## Swift
Por padrão o módulo `swift` vai exibir a versão atual instalada do [Swift](https://swift.org/). O módulo vai exibir se algumas das condições a seguir for atendida: By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). The module will be shown if any of the following conditions are met:
- O diretório atual tenha um arquivo `Package.swift` - The current directory contains a `Package.swift` file
- O diretório atual tenha um arquivo com a extensão `.swift` - The current directory contains a file with the `.swift` extension
### Opções ### Opções
@ -3228,18 +3266,18 @@ Por padrão o módulo `swift` vai exibir a versão atual instalada do [Swift](ht
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | | `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. |
| `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🐦 "` | Uma string que representa o simbolo do Swift | | `symbol` | `"🐦 "` | A format string representing the symbol of Swift |
| `detect_extensions` | `["swift"]` | Quais extensões devem ativar este módulo. | | `detect_extensions` | `["swift"]` | Quais extensões devem ativar este módulo. |
| `detect_files` | `["Package.swift"]` | Quais nomes de arquivos devem ativar este módulo. | | `detect_files` | `["Package.swift"]` | Quais nomes de arquivos devem ativar este módulo. |
| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | | `detect_folders` | `[]` | Quais pastas devem ativar este módulo. |
| `style` | `"bold 202"` | O estilo do módulo. | | `style` | `"bold 202"` | O estilo do módulo. |
| `disabled` | `false` | Desabilita o módulo `swift`. | | `disabled` | `false` | Disables the `swift` module. |
### Variáveis ### Variáveis
| Variável | Exemplo | Descrição | | Variável | Exemplo | Descrição |
| --------- | -------- | --------------------------------- | | --------- | -------- | --------------------------------- |
| version | `v5.2.4` | A versão do `swift` | | version | `v5.2.4` | The version of `swift` |
| symbol | | Espelha o valor da opção `symbol` | | symbol | | Espelha o valor da opção `symbol` |
| style\* | | Espelha o valor da opção `style` | | style\* | | Espelha o valor da opção `style` |
@ -3256,18 +3294,18 @@ format = "via [🏎 $version](red bold)"
## Terraform ## Terraform
O módulo `terraform` exibe o [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) selecionado e sua versão. The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version.
::: tip ::: tip
Por padrão a versão do Terraform não é exibida, desde que é lento recuperar a versão atual quando muitos plugins estão em uso. Se você deseja habilitar,, [Siga o exemplo abaixo](#with-terraform-version). By default the Terraform version is not shown, since this is slow for 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-terraform-version).
::: :::
Por padrão o módulo vai exibir se uma das condições a seguir for atendida: Por padrão o módulo vai exibir se uma das condições a seguir for atendida:
- O diretório atual tenha uma pasta `.terraform` - The current directory contains a `.terraform` folder
- O diretório atual tenha arquivos com as extensões `.tf`, `.tfplan` or `.tfstate` - Current directory contains a file with the `.tf`, `.tfplan` or `.tfstate` extensions
### Opções ### Opções
@ -3275,19 +3313,19 @@ Por padrão o módulo vai exibir se uma das condições a seguir for atendida:
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ |
| `format` | `"via [$symbol$workspace]($style) "` | A string de formato do módulo. | | `format` | `"via [$symbol$workspace]($style) "` | A string de formato do módulo. |
| `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"💠"` | Uma string que é exibida antes do workspace terraform. | | `symbol` | `"💠"` | A format string shown before the terraform workspace. |
| `detect_extensions` | `["tf", "tfplan", "tfstate"]` | Quais extensões devem ativar este módulo. | | `detect_extensions` | `["tf", "tfplan", "tfstate"]` | Quais extensões devem ativar este módulo. |
| `detect_files` | `[]` | Quais nomes de arquivos devem ativar este módulo. | | `detect_files` | `[]` | Quais nomes de arquivos devem ativar este módulo. |
| `detect_folders` | `[".terraform"]` | Quais pastas devem ativar este módulo. | | `detect_folders` | `[".terraform"]` | Quais pastas devem ativar este módulo. |
| `style` | `"bold 105"` | O estilo do módulo. | | `style` | `"bold 105"` | O estilo do módulo. |
| `disabled` | `false` | Desabilita o módulo `terraform`. | | `disabled` | `false` | Disables the `terraform` module. |
### Variáveis ### Variáveis
| Variável | Exemplo | Descrição | | Variável | Exemplo | Descrição |
| --------- | ---------- | --------------------------------- | | --------- | ---------- | --------------------------------- |
| version | `v0.12.24` | A versão do `terraform` | | version | `v0.12.24` | The version of `terraform` |
| workspace | `default` | O workspace atual do Terraform | | workspace | `default` | The current Terraform workspace |
| symbol | | Espelha o valor da opção `symbol` | | symbol | | Espelha o valor da opção `symbol` |
| style\* | | Espelha o valor da opção `style` | | style\* | | Espelha o valor da opção `style` |
@ -3315,7 +3353,7 @@ format = "[🏎💨 $workspace]($style) "
## Horário ## Horário
O módulo `time` exibe a hora **local** atual. A configuração de `format` é usada pelo [`chrono`](https://crates.io/crates/chrono) para controlar qual hora é exibida. Dê uma olhada na [documentação do chrono strftime](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) para ver quais opções estão disponíveis. The `time` module shows the current **local** time. The `format` configuration value is used by the [`chrono`](https://crates.io/crates/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) to see what options are available.
::: tip ::: tip
@ -3326,22 +3364,22 @@ Este módulo é desabilitado por padrão. Para habilitar, defina `disabled` para
### Opções ### Opções
| Opções | Padrão | Descrição | | Opções | Padrão | Descrição |
| ----------------- | ----------------------- | --------------------------------------------------------------------------------------------------------------------------- | | ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `format` | `"at [$time]($style) "` | A string de formato do módulo. | | `format` | `"at [$time]($style) "` | A string de formato do módulo. |
| `use_12hr` | `false` | Habilita a formatação de 12 horas | | `use_12hr` | `false` | Enables 12 hour formatting |
| `time_format` | veja abaixo | A string [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) usada para formatar a hora. | | `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"` | O estilo do módulo time | | `style` | `"bold yellow"` | The style for the module time |
| `utc_time_offset` | `"local"` | Define o UTC a ser usado. Intervalo de -24 &lt; x &lt; 24. Aceita floats para acomodar timezones 30/45. | | `utc_time_offset` | `"local"` | Sets the UTC offset to use. Range from -24 &lt; x &lt; 24. Allows floats to accommodate 30/45 minute timezone offsets. |
| `disabled` | `true` | Desabilita o módulo `time`. | | `disabled` | `true` | Disables the `time` module. |
| `time_range` | `"-"` | Define o intervalo de tempo o qual o módulo será exibido. O horário deve ser especificado no formato de 24-hours | | `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format |
Se `use_12hr` é `true`, então `time_format` tem o padrão `"%r"`. Caso contrário, o padrão é `"%T"`. Ajustes manuais no `time_format` irão sobrescrever a configuração `use_12hr`. 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.
### Variáveis ### Variáveis
| Variável | Exemplo | Descrição | | Variável | Exemplo | Descrição |
| --------- | ---------- | -------------------------------- | | --------- | ---------- | -------------------------------- |
| time | `13:08:10` | A hora atual. | | time | `13:08:10` | The current time. |
| style\* | | Espelha o valor da opção `style` | | style\* | | Espelha o valor da opção `style` |
*: Esta variável só pode ser usada como parte de uma string de estilo *: Esta variável só pode ser usada como parte de uma string de estilo
@ -3361,35 +3399,35 @@ time_range = "10:00:00-14:00:00"
## Username ## Username
O módulo `username` exibe o username do usuário ativo. O módulo vai exibir se algumas das condições a seguir for atendida: The `username` module shows active user's username. The module will be shown if any of the following conditions are met:
- O usuário atual é root/admin - The current user is root/admin
- O usuário atual não é o mesmo que está logado - The current user isn't the same as the one that is logged in
- O usuário atual esta conectado em uma sessão SSH - The user is currently connected as an SSH session
- A variável `show_always` esta definida como true - The variable `show_always` is set to true
::: tip ::: tip
Conexões SSH são detectadas checando as variáveis de ambiente `SSH_CONNECTION`, `SSH_CLIENT`, and `SSH_TTY`. Se seu host SSH não tem estas variáveis configuradas, uma alternativa é definir uma delas com valor burro. SSH connection is detected by checking environment variables `SSH_CONNECTION`, `SSH_CLIENT`, and `SSH_TTY`. If your SSH host does not set up these variables, one workaround is to set one of them with a dummy value.
::: :::
### Opções ### Opções
| Opções | Padrão | Descrição | | Opções | Padrão | Descrição |
| ------------- | ----------------------- | --------------------------------------------- | | ------------- | ----------------------- | ------------------------------------------- |
| `style_root` | `"bold red"` | O estilo usado quando o usuário é root/admin. | | `style_root` | `"bold red"` | The style used when the user is root/admin. |
| `style_user` | `"bold yellow"` | O estilo usado para usuários não root. | | `style_user` | `"bold yellow"` | The style used for non-root users. |
| `format` | `"[$user]($style) in "` | O formato do módulo. | | `format` | `"[$user]($style) in "` | O formato do módulo. |
| `show_always` | `false` | Sempre exibe o módulo `username`. | | `show_always` | `false` | Always shows the `username` module. |
| `disabled` | `false` | Desabilita o módulo `username`. | | `disabled` | `false` | Disables the `username` module. |
### Variáveis ### Variáveis
| Variável | Exemplo | Descrição | | Variável | Exemplo | Descrição |
| -------- | ------------ | -------------------------------------------------------------------------------------- | | -------- | ------------ | ------------------------------------------------------------------------------------------- |
| `style` | `"red bold"` | Espelha o valor da opção `style_root` quando o root esta logado e `style_user` se não. | | `style` | `"red bold"` | Mirrors the value of option `style_root` when root is logged in and `style_user` otherwise. |
| `user` | `"matchai"` | O ID do usuário logado atualmente. | | `user` | `"matchai"` | The currently logged-in user ID. |
### Exemplo ### Exemplo
@ -3406,9 +3444,9 @@ show_always = true
## Vagrant ## Vagrant
O módulo `vagrant` exibe a versão atual instalada do [Vagrant](https://www.vagrantup.com/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: The `vagrant` module shows the currently installed version of [Vagrant](https://www.vagrantup.com/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida:
- O diretório atual contem um arquivo `Vagrantfile` - The current directory contains a `Vagrantfile` file
### Opções ### Opções
@ -3416,18 +3454,18 @@ O módulo `vagrant` exibe a versão atual instalada do [Vagrant](https://www.vag
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | | `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. |
| `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"⍱ "` | Um formato de string que representa o simbolo do Vagrant. | | `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. |
| `detect_extensions` | `[]` | Quais extensões devem ativar este módulo. | | `detect_extensions` | `[]` | Quais extensões devem ativar este módulo. |
| `detect_files` | `["Vagrantfile"]` | Quais nomes de arquivos devem ativar este módulo. | | `detect_files` | `["Vagrantfile"]` | Quais nomes de arquivos devem ativar este módulo. |
| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | | `detect_folders` | `[]` | Quais pastas devem ativar este módulo. |
| `style` | `"cyan bold"` | O estilo do módulo. | | `style` | `"cyan bold"` | O estilo do módulo. |
| `disabled` | `false` | Desabilita o módulo `vagrant`. | | `disabled` | `false` | Disables the `vagrant` module. |
### Variáveis ### Variáveis
| Variável | Exemplo | Descrição | | Variável | Exemplo | Descrição |
| --------- | ---------------- | --------------------------------- | | --------- | ---------------- | --------------------------------- |
| version | `Vagrant 2.2.10` | A versão do `Vagrant` | | version | `Vagrant 2.2.10` | The version of `Vagrant` |
| symbol | | Espelha o valor da opção `symbol` | | symbol | | Espelha o valor da opção `symbol` |
| style\* | | Espelha o valor da opção `style` | | style\* | | Espelha o valor da opção `style` |
@ -3444,10 +3482,10 @@ format = "via [⍱ $version](bold white) "
## V ## V
O módulo `vlang` exibe a versão atual instalada do [V](https://vlang.io/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: The `vlang` module shows you your currently installed version of [V](https://vlang.io/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida:
- O diretório atual cotem qualquer arquivo com a extensão `.v` - The current directory contains a file with `.v` extension
- O diretório atual contem um arquivo `v.mod`, `vpkg.json` ou `.vpkg-lock.json` - The current directory contains a `v.mod`, `vpkg.json` or `.vpkg-lock.json` file
### Opções ### Opções
@ -3455,18 +3493,18 @@ O módulo `vlang` exibe a versão atual instalada do [V](https://vlang.io/). Por
| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------------------ | | ------------------- | -------------------------------------------- | ------------------------------------------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | | `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. |
| `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"V "` | Um formato de string que representa o simbolo do V | | `symbol` | `"V "` | A format string representing the symbol of V |
| `detect_extensions` | `["v"]` | Quais extensões devem ativar este módulo. | | `detect_extensions` | `["v"]` | Quais extensões devem ativar este módulo. |
| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Quais nomes de arquivos devem ativar este módulo. | | `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Quais nomes de arquivos devem ativar este módulo. |
| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | | `detect_folders` | `[]` | Quais pastas devem ativar este módulo. |
| `style` | `"blue bold"` | O estilo do módulo. | | `style` | `"blue bold"` | O estilo do módulo. |
| `disabled` | `false` | Desabilita o módulo `vlang`. | | `disabled` | `false` | Disables the `vlang` module. |
### Variáveis ### Variáveis
| Variável | Exemplo | Descrição | | Variável | Exemplo | Descrição |
| --------- | ------- | --------------------------------- | | --------- | ------- | --------------------------------- |
| version | `v0.2` | A versão do `v` | | version | `v0.2` | The version of `v` |
| symbol | | Espelha o valor da opção `symbol` | | symbol | | Espelha o valor da opção `symbol` |
| style\* | | Espelha o valor da opção `style` | | style\* | | Espelha o valor da opção `style` |
@ -3480,22 +3518,22 @@ format = "via [V $version](blue bold) "
## VCSH ## VCSH
O módulo `vcsh` exibe o repositório [VCSH](https://github.com/RichiH/vcsh) atual ativo. O módulo vai ser exibido apenas se um repositório estiver em uso. The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. The module will be shown only if a repository is currently in use.
### Opções ### Opções
| Opções | Padrão | Descrição | | Opções | Padrão | Descrição |
| ---------- | -------------------------------- | ------------------------------------------------------ | | ---------- | -------------------------------- | ------------------------------------------------------ |
| `symbol` | | O simbolo usado antes de exibir o nome do repositório. | | `symbol` | | The symbol used before displaying the repository name. |
| `style` | `"bold yellow"` | O estilo do módulo. | | `style` | `"bold yellow"` | O estilo do módulo. |
| `format` | `"vcsh [$symbol$repo]($style) "` | O formato do módulo. | | `format` | `"vcsh [$symbol$repo]($style) "` | O formato do módulo. |
| `disabled` | `false` | Desabilita o módulo `vcsh`. | | `disabled` | `false` | Disables the `vcsh` module. |
### Variáveis ### Variáveis
| Variável | Exemplo | Descrição | | Variável | Exemplo | Descrição |
| --------- | ------------------------------------------- | --------------------------------- | | --------- | ------------------------------------------- | --------------------------------- |
| repo | `dotfiles` if in a VCSH repo named dotfiles | O nome do repositório ativo | | repo | `dotfiles` if in a VCSH repo named dotfiles | The active repository name |
| symbol | | Espelha o valor da opção `symbol` | | symbol | | Espelha o valor da opção `symbol` |
| style\* | `black bold dimmed` | Espelha o valor da opção `style` | | style\* | `black bold dimmed` | Espelha o valor da opção `style` |
@ -3512,9 +3550,9 @@ format = "[🆅 $repo](bold blue) "
## Zig ## Zig
Por padrão, o módulo `zig` mostra a versão atualmente instalada do [Zig](https://ziglang.org/). O módulo vai exibir se algumas das condições a seguir for atendida: By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met:
- O diretório atual contém arquivo com a extensão `.zig` - The current directory contains a `.zig` file
### Opções ### Opções
@ -3522,9 +3560,9 @@ Por padrão, o módulo `zig` mostra a versão atualmente instalada do [Zig](http
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | | `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. |
| `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"↯ "` | O símbolo usado antes de exibir a versão do Zig. | | `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. |
| `style` | `"bold yellow"` | O estilo do módulo. | | `style` | `"bold yellow"` | O estilo do módulo. |
| `disabled` | `false` | Desabilita o módulo `zig`. | | `disabled` | `false` | Disables the `zig` module. |
| `detect_extensions` | `["zig"]` | Quais extensões devem ativar este módulo. | | `detect_extensions` | `["zig"]` | Quais extensões devem ativar este módulo. |
| `detect_files` | `[]` | Quais nomes de arquivos devem ativar este módulo. | | `detect_files` | `[]` | Quais nomes de arquivos devem ativar este módulo. |
| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | | `detect_folders` | `[]` | Quais pastas devem ativar este módulo. |
@ -3533,7 +3571,7 @@ Por padrão, o módulo `zig` mostra a versão atualmente instalada do [Zig](http
| Variável | Exemplo | Descrição | | Variável | Exemplo | Descrição |
| --------- | -------- | --------------------------------- | | --------- | -------- | --------------------------------- |
| version | `v0.6.0` | A versão do `zig` | | version | `v0.6.0` | The version of `zig` |
| symbol | | Espelha o valor da opção `symbol` | | symbol | | Espelha o valor da opção `symbol` |
| style\* | | Espelha o valor da opção `style` | | style\* | | Espelha o valor da opção `style` |
@ -3548,68 +3586,68 @@ Por padrão, o módulo `zig` mostra a versão atualmente instalada do [Zig](http
symbol = "⚡️ " symbol = "⚡️ "
``` ```
## Comandos Personalizados ## Custom commands
O módulo `custom` exibe a saída de alguns comandos arbitrários. The `custom` modules show the output of some arbitrary commands.
Este módulo vai ser exibir se algumas das condições a seguir for atendida: These modules will be shown if any of the following conditions are met:
- O diretório atual contém um arquivo cujo nome está em `detect_files` - The current directory contains a file whose name is in `detect_files`
- O diretório atual contém um diretório cujo nome está em `detect_folders` - The current directory contains a directory whose name is in `detect_folders`
- O diretório atual contém um arquivo cuja extensão está em `detect_extensions` - The current directory contains a file whose extension is in `detect_extensions`
- O comando `when` retorna 0 - The `when` command returns 0
- O sistema operacional (std::env::consts::OS) corresponde com o `os` se definido. - The current Operating System (std::env::consts::OS) matches with `os` field if defined.
::: tip ::: tip
Vários módulos personalizados podem ser definidos usando `.`. Multiple custom modules can be defined by using a `.`.
::: :::
::: tip ::: tip
A ordem em que o módulo custom é exibido pode ser definido individualmente incluindo `${custom.foo}` em nilve superior `format` (pois inclui um ponto, você precisa usar `${...}`). Por padrão, o módulo `custom` mostrará todos os módulos personalizados na ordem em que eles foram definidos. 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 ::: tip
A [Issue #1252](https://github.com/starship/starship/discussions/1252) contém exemplos de módulos personalizados. Se você tem um exemplo interessante que não esta coberto lá, sinta-se livre para compartilha-lo! [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!
::: :::
::: warning A saída do comando é exibido unescaped no prompt ::: warning Command output is printed unescaped to the prompt
Seja qual for a saída o comando irá gerar uma saída sem modificações no prompt. Isto siguinifica que a saída tenha sequencias especiais estas serão interpretadas pelo seu shell, elas serão expandidas quando exibidas. Estas sequencias especiais são especificas da shell, ex: você pode escrever um módulo de comando que escreve uma sequencia de bash, ex:. `\h`, mas este módulo não irá funcionar no shell fish ou zsh. Whatever output the command generates is printed unmodified in the prompt. This means if the output contains special sequences that are interpreted by your shell they will be expanded when displayed. These special sequences are shell specific, e.g. you can write a command module that writes bash sequences, e.g. `\h`, but this module will not work in a fish or zsh shell.
Strings de formatação também podem conter sequencias de prompt especificas de shell, ex: [Bash](https://www.gnu.org/software/bash/manual/html_node/Controlling-the-Prompt.html), [Zsh](https://zsh.sourceforge.io/Doc/Release/Prompt-Expansion.html). Format strings can also contain shell specific prompt sequences, e.g. [Bash](https://www.gnu.org/software/bash/manual/html_node/Controlling-the-Prompt.html), [Zsh](https://zsh.sourceforge.io/Doc/Release/Prompt-Expansion.html).
::: :::
### Opções ### Opções
| Opções | Padrão | Descrição | | Opções | Padrão | Descrição |
| ------------------- | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `command` | `""` | O comando cuja a saída deve ser exibida. O comando será passado no stdin para o shell. | | `command` | `""` | The command whose output should be printed. The command will be passed on stdin to the shell. |
| `when` | `false` | Ou um valor booleano (`true` ou `false`, sem aspas) ou um comando shell de string usado como condição para mostrar o módulo. No caso de uma string, o módulo será mostrado se o comando retornar um código de status `0`. | | `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. |
| `shell` | | [Veja abaixo](#custom-command-shell) | | `shell` | | [See below](#custom-command-shell) |
| `description` | `"<custom module>"` | A descrição do módulo, isto será exibido quando executar `starship explain`. | | `description` | `"<custom module>"` | The description of the module that is shown when running `starship explain`. |
| `detect_files` | `[]` | Os arquivos que serão buscados por correspondência no diretório atual. | | `detect_files` | `[]` | The files that will be searched in the working directory for a match. |
| `detect_folders` | `[]` | Os diretórios que serão buscados por correspondência no diretório atual. | | `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. |
| `detect_extensions` | `[]` | As extensões que serão buscadas por correspondência no diretório atual. | | `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. |
| `symbol` | `""` | O simbolo usado antes de exibir a saída do comando. | | `symbol` | `""` | The symbol used before displaying the command output. |
| `style` | `"bold green"` | O estilo do módulo. | | `style` | `"bold green"` | O estilo do módulo. |
| `format` | `"[$symbol($output )]($style)"` | O formato do módulo. | | `format` | `"[$symbol($output )]($style)"` | O formato do módulo. |
| `disabled` | `false` | Desabilita este módulo `custom`. | | `disabled` | `false` | Disables this `custom` module. |
| `os` | | Nome do sistema operacional onde módulo sera exibido (unix, linux, macos, windows, ... ) [Veja os possíveis valores](https://doc.rust-lang.org/std/env/consts/constant.OS.html). | | `os` | | Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) [See possible values](https://doc.rust-lang.org/std/env/consts/constant.OS.html). |
| `use_stdin` | | Um valor booleano opcional que substitui se os comandos devem ser encaminhados para o shell por meio da entrada padrão ou como um argumento. Se a entrada padrão não definida for usada por padrão, a menos que o shell não a suporte (cmd, nushell). Configurar isso desativa a manipulação de argumentos específicos do shell. | | `use_stdin` | | An optional boolean value that overrides whether commands should be forwarded to the shell via the standard input or as an argument. If unset standard input is used by default, unless the shell does not support it (cmd, nushell). Setting this disables shell-specific argument handling. |
| `ignore_timeout` | `false` | Ignora a configuração global do `command_timeout` e continua executando comandos externos, não importa quanto tempo eles demorem. | | `ignore_timeout` | `false` | Ignore global `command_timeout` setting and keep running external commands, no matter how long they take. |
### Variáveis ### Variáveis
| Variável | Descrição | | Variável | Descrição |
| --------- | --------------------------------- | | --------- | -------------------------------------- |
| output | A saída do comando no `shell` | | output | The output of shell command in `shell` |
| symbol | Espelha o valor da opção `symbol` | | symbol | Espelha o valor da opção `symbol` |
| style\* | Espelha o valor da opção `style` | | style\* | Espelha o valor da opção `style` |
@ -3617,30 +3655,30 @@ Strings de formatação também podem conter sequencias de prompt especificas de
#### Comandos personalizados de shell #### Comandos personalizados de shell
`shell` aceita uma lista não vazia de string, onde: `shell` accepts a non-empty list of strings, where:
- A primeira string é o caminho para o shell que executará o comando. - The first string is the path to the shell to use to execute the command.
- Outros argumentos que serão passados para o shell. - Other following arguments are passed to the shell.
Se não definido, ele retornará para o STARSHIP_SHELl e então para o "sh" no Linux e "cmd/C" no Windows. If unset, it will fallback to STARSHIP_SHELL and then to "sh" on Linux, and "cmd /C" on Windows.
O `command` será passado no stdin. The `command` will be passed in on stdin.
Se o `shell` não for dado ou apenas conter um elemento e o Starship detectar PowerShell ele será usado, os seguintes argumentos serão automaticamente adicionados: `-NoProfile -Command -`. Se `shell` não for fornecido ou contiver apenas um elemento e o Starship detectar que o Cmd será usado, o seguinte argumento será adicionado automaticamente: `/C` e `stdin` serão definidos como `false`. Se `shell` não for fornecido ou contiver apenas um elemento e o Starship detectar que o Nushell será usado, os seguintes argumentos serão adicionados automaticamente: `-c` e `stdin` serão definidos como `false`. Este comportamento pode ser evitado passando explicitamente argumento para o shell, ex. 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 -`. If `shell` is not given or only contains one element and Starship detects Cmd will be used, the following argument will automatically be added: `/C` and `stdin` will be set to `false`. If `shell` is not given or only contains one element and Starship detects Nushell will be used, the following arguments will automatically be added: `-c` and `stdin` will be set to `false`. This behavior can be avoided by explicitly passing arguments to the shell, e.g.
```toml ```toml
shell = ["pwsh", "-Command", "-"] shell = ["pwsh", "-Command", "-"]
``` ```
::: warning Tenha certeza que tenha uma configuração de shell ::: warning Make sure your custom shell configuration exits gracefully
Se você definir um comando personalizado, tenha certeza que o shell padrão usado pelo starship execute este comando com uma saída graciosa (via the `shell` option). 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).
Por exemplo, PowerShell requer o parâmetro `-Command` para executar um liner. Omitindo este parâmetro pode ser que o starship entre em um loop recursivo, onde o shell tente carrega um ambiente completo de perfil com o próprio starship novamente e portanto execute novamente o comando, entrando em um loop sem fim. 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.
Parâmetros similares ao `-NoProfile` no PowerShell são recomendados para outras shells, bem como para evitar um tempo de carregamento maior toda vez que o starship for chamado. 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.
Detecção automática de shell e adição de parâmetros estão sendo implementados atualmente, mas é possível que nem todas as shells sejam cobertas. [Por favor abra uma issue](https://github.com/starship/starship/issues/new/choose) com detalhes do shell e configurações do starship se você acertar algum cenário. 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.
::: :::

View File

@ -256,11 +256,12 @@ Install the latest version for your system with the MSI-installers from the [rel
Instale o Starship usando qualquer um dos seguintes gerenciadores de pacotes: Instale o Starship usando qualquer um dos seguintes gerenciadores de pacotes:
| Repositório | Instruções | | Repositório | Instruções |
| -------------------------------------------------------------------------------- | --------------------------------------- | | -------------------------------------------------------------------------------------------- | --------------------------------------- |
| **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
| [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` | | [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` |
| [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` | | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
| [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json) | `scoop install starship` | | [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json) | `scoop install starship` |
| [winget](https://github.com/microsoft/winget-pkgs/tree/master/manifests/s/Starship/Starship) | `winget install --id Starship.Starship` |
</details> </details>

View File

@ -538,19 +538,19 @@ By default it only changes color. If you also want to change its shape take a lo
::: warning ::: warning
`vicmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148).
::: :::
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| -------------------------- | -------------------- | --------------------------------------------------------------------------------------- | | --------------------------- | -------------------- | --------------------------------------------------------------------------------------- |
| `format` | `"$symbol "` | The format string used before the text input. | | `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. | | `success_symbol` | `"[](bold green)"` | The format string used before the text input if the previous command succeeded. |
| `error_symbol` | `"[](bold red)"` | The format string used before the text input if the previous command failed. | | `error_symbol` | `"[](bold red)"` | The format string used before the text input if the previous command failed. |
| `vicmd_symbol` | `"[](bold green)"` | The format string used before the text input if the shell is in vim normal mode. | | `vimcmd_symbol` | `"[](bold green)"` | The format string used before the text input if the shell is in vim normal mode. |
| `vicmd_replace_one_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. | | `vimcmd_replace_one_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. |
| `vimcmd_replace_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. | | `vimcmd_replace_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. |
| `vimcmd_visual_symbol` | `"[](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. | | `vimcmd_visual_symbol` | `"[](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. |
| `disabled` | `false` | Disables the `character` module. | | `disabled` | `false` | Disables the `character` module. |
@ -2793,6 +2793,44 @@ The `rlang` module shows the currently installed version of [R](https://www.r-pr
format = "with [📐 $version](blue bold) " format = "with [📐 $version](blue bold) "
``` ```
## Raku
The `raku` module shows the currently installed version of [Raku](https://www.raku.org/). By default the module will be shown if any of the following conditions are met:
- The current directory contains a `META6.json` file
- The current directory contains a `.p6`, `.pm6`, `.raku`, `.rakumod` or `.pod6`
### Options
| Option | Default | Description |
| ------------------- | ------------------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version-$vm_version )]($style)"` | The format string for the module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🦋 "` | The symbol used before displaying the version of Raku |
| `detect_extensions` | `["p6", "pm6", "pod6", "raku", "rakumod"]` | Which extensions should trigger this module. |
| `detect_files` | `["META6.json"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold 149"` | The style for the module. |
| `disabled` | `false` | Disables the `raku` module. |
### Variables
| Variable | Example | Description |
| ---------- | ------- | ------------------------------------ |
| version | `v6.d` | The version of `raku` |
| vm_version | `moar` | The version of VM `raku` is built on |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
### Example
```toml
# ~/.config/starship.toml
[raku]
format = "via [🦪 $version]($style) "
```
## Red ## Red
By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met: By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met:
@ -3560,7 +3598,7 @@ These modules will be shown if any of the following conditions are met:
- The current directory contains a directory whose name is in `detect_folders` - The current directory contains a directory whose name is in `detect_folders`
- The current directory contains a file whose extension is in `detect_extensions` - The current directory contains a file whose extension is in `detect_extensions`
- The `when` command returns 0 - The `when` command returns 0
- The current Operating System (std::env::consts::OS) matchs with `os` field if defined. - The current Operating System (std::env::consts::OS) matches with `os` field if defined.
::: tip ::: tip

View File

@ -256,11 +256,12 @@ Install the latest version for your system with the MSI-installers from the [rel
Install Starship using any of the following package managers: Install Starship using any of the following package managers:
| Repository | Instructions | | Repository | Instructions |
| -------------------------------------------------------------------------------- | --------------------------------------- | | -------------------------------------------------------------------------------------------- | --------------------------------------- |
| **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
| [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` | | [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` |
| [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` | | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
| [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json) | `scoop install starship` | | [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json) | `scoop install starship` |
| [winget](https://github.com/microsoft/winget-pkgs/tree/master/manifests/s/Starship/Starship) | `winget install --id Starship.Starship` |
</details> </details>

View File

@ -538,19 +538,19 @@ By default it only changes color. If you also want to change its shape take a lo
::: warning ::: warning
`vicmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148).
::: :::
### Опции ### Опции
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| -------------------------- | -------------------- | --------------------------------------------------------------------------------------- | | --------------------------- | -------------------- | --------------------------------------------------------------------------------------- |
| `format` | `"$symbol "` | The format string used before the text input. | | `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. | | `success_symbol` | `"[](bold green)"` | The format string used before the text input if the previous command succeeded. |
| `error_symbol` | `"[](bold red)"` | The format string used before the text input if the previous command failed. | | `error_symbol` | `"[](bold red)"` | The format string used before the text input if the previous command failed. |
| `vicmd_symbol` | `"[](bold green)"` | The format string used before the text input if the shell is in vim normal mode. | | `vimcmd_symbol` | `"[](bold green)"` | The format string used before the text input if the shell is in vim normal mode. |
| `vicmd_replace_one_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. | | `vimcmd_replace_one_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. |
| `vimcmd_replace_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. | | `vimcmd_replace_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. |
| `vimcmd_visual_symbol` | `"[](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. | | `vimcmd_visual_symbol` | `"[](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. |
| `disabled` | `false` | Отключает модуль `character`. | | `disabled` | `false` | Отключает модуль `character`. |
@ -2793,9 +2793,47 @@ The `rlang` module shows the currently installed version of [R](https://www.r-pr
format = "with [📐 $version](blue bold) " format = "with [📐 $version](blue bold) "
``` ```
## Raku
The `raku` module shows the currently installed version of [Raku](https://www.raku.org/). By default the module will be shown if any of the following conditions are met:
- The current directory contains a `META6.json` file
- The current directory contains a `.p6`, `.pm6`, `.raku`, `.rakumod` or `.pod6`
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | ------------------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version-$vm_version )]($style)"` | The format string for the module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🦋 "` | The symbol used before displaying the version of Raku |
| `detect_extensions` | `["p6", "pm6", "pod6", "raku", "rakumod"]` | Which extensions should trigger this module. |
| `detect_files` | `["META6.json"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold 149"` | Стиль модуля. |
| `disabled` | `false` | Disables the `raku` module. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | ------ | ------------------------------------ |
| version | `v6.d` | The version of `raku` |
| vm_version | `moar` | The version of VM `raku` is built on |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
### Пример
```toml
# ~/.config/starship.toml
[raku]
format = "via [🦪 $version]($style) "
```
## Red ## Red
By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). Модуль будет показан, если любое из следующих условий соблюдено: By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met:
- The current directory contains a file with `.red` or `.reds` extension - The current directory contains a file with `.red` or `.reds` extension
@ -2833,11 +2871,11 @@ symbol = "🔴 "
## Ruby ## Ruby
By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). Модуль будет показан, если любое из следующих условий соблюдено: By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). The module will be shown if any of the following conditions are met:
- Текущий каталог содержит файл `Gemfile` - The current directory contains a `Gemfile` file
- Текущий каталог содержит файл `.ruby-version` - The current directory contains a `.ruby-version` file
- Текущий каталог содержит файл `.rb` - The current directory contains a `.rb` file
- The environment variables `RUBY_VERSION` or `RBENV_VERSION` are set - The environment variables `RUBY_VERSION` or `RBENV_VERSION` are set
Starship gets the current Ruby version by running `ruby -v`. Starship gets the current Ruby version by running `ruby -v`.
@ -2854,7 +2892,7 @@ Starship gets the current Ruby version by running `ruby -v`.
| `detect_folders` | `[]` | Which folders should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. |
| `detect_variables` | `["RUBY_VERSION", "RBENV_VERSION"]` | Which environment variables should trigger this module. | | `detect_variables` | `["RUBY_VERSION", "RBENV_VERSION"]` | Which environment variables should trigger this module. |
| `style` | `"bold red"` | Стиль модуля. | | `style` | `"bold red"` | Стиль модуля. |
| `disabled` | `false` | Отключает модуль `ruby`. | | `disabled` | `false` | Disables the `ruby` module. |
### Переменные ### Переменные
@ -2877,10 +2915,10 @@ symbol = "🔺 "
## Rust ## Rust
By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). Модуль будет показан, если любое из следующих условий соблюдено: By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). The module will be shown if any of the following conditions are met:
- Текущий каталог содержит файл `Cargo.toml` - The current directory contains a `Cargo.toml` file
- Текущий каталог содержит файл с расширением `.rs` - The current directory contains a file with the `.rs` extension
### Опции ### Опции
@ -2893,7 +2931,7 @@ By default the `rust` module shows the currently installed version of [Rust](htt
| `detect_files` | `["Cargo.toml"]` | Which filenames should trigger this module. | | `detect_files` | `["Cargo.toml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold red"` | Стиль модуля. | | `style` | `"bold red"` | Стиль модуля. |
| `disabled` | `false` | Отключает модуль `rust`. | | `disabled` | `false` | Disables the `rust` module. |
### Переменные ### Переменные
@ -2990,7 +3028,7 @@ The `shell` module shows an indicator for currently used shell.
| Переменная | По умолчанию | Описание | | Переменная | По умолчанию | Описание |
| ---------- | ------------ | ---------------------------------------------------------- | | ---------- | ------------ | ---------------------------------------------------------- |
| indicator | | Mirrors the value of `indicator` for currently used shell. | | indicator | | Mirrors the value of `indicator` for currently used shell. |
| style\* | | Отражает значение параметра `style`. | | style\* | | Mirrors the value of option `style`. |
*: Эта переменная может использоваться только в качестве части строки style *: Эта переменная может использоваться только в качестве части строки style
@ -3219,7 +3257,7 @@ disabled = false
## Swift ## Swift
By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). Модуль будет показан, если любое из следующих условий соблюдено: By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). 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 `Package.swift` file
- The current directory contains a file with the `.swift` extension - The current directory contains a file with the `.swift` extension
@ -3268,7 +3306,7 @@ By default the Terraform version is not shown, since this is slow for current ve
By default the module will be shown if any of the following conditions are met: By default the module will be shown if any of the following conditions are met:
- Текущий каталог содержит папку `.terraform` - The current directory contains a `.terraform` folder
- Current directory contains a file with the `.tf`, `.tfplan` or `.tfstate` extensions - Current directory contains a file with the `.tf`, `.tfplan` or `.tfstate` extensions
### Опции ### Опции
@ -3282,7 +3320,7 @@ By default the module will be shown if any of the following conditions are met:
| `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[".terraform"]` | Which folders should trigger this module. | | `detect_folders` | `[".terraform"]` | Which folders should trigger this module. |
| `style` | `"bold 105"` | Стиль модуля. | | `style` | `"bold 105"` | Стиль модуля. |
| `disabled` | `false` | Отключает модуль `terraform`. | | `disabled` | `false` | Disables the `terraform` module. |
### Переменные ### Переменные
@ -3317,7 +3355,7 @@ 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 Подсказка ::: tip Подсказка
@ -3328,22 +3366,22 @@ format = "[🏎💨 $workspace]($style) "
### Опции ### Опции
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| ----------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `format` | `"at [$time]($style) "` | The format string for the module. | | `format` | `"at [$time]($style) "` | The format string for the module. |
| `use_12hr` | `false` | Включить 12-часовое форматирование | | `use_12hr` | `false` | Enables 12 hour formatting |
| `time_format` | см. ниже | [Строка формата chrono](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html), используемая для форматирования времени. | | `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. |
| `style` | `"bold yellow"` | Стиль модуля времени | | `style` | `"bold yellow"` | The style for the module time |
| `utc_time_offset` | `"local"` | Устанавливает смещение UTC. Range from -24 &lt; x &lt; 24. Разрешает числам с плавающей точкой встраивать 30/45-минутное смещение временной зоны. | | `utc_time_offset` | `"local"` | Sets the UTC offset to use. Range from -24 &lt; x &lt; 24. Allows floats to accommodate 30/45 minute timezone offsets. |
| `disabled` | `true` | Отключает модуль `time`. | | `disabled` | `true` | Disables the `time` module. |
| `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | | `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format |
If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Иначе по умолчанию используется `"%T"`. Manually setting `time_format` will override the `use_12hr` setting. If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Otherwise, it defaults to `"%T"`. Manually setting `time_format` will override the `use_12hr` setting.
### Переменные ### Переменные
| Переменная | Пример | Описание | | Переменная | Пример | Описание |
| ---------- | ---------- | ----------------------------------- | | ---------- | ---------- | ----------------------------------- |
| время | `13:08:10` | The current time. | | time | `13:08:10` | The current time. |
| style\* | | Отражает значение параметра `style` | | style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style *: Эта переменная может использоваться только в качестве части строки style
@ -3361,14 +3399,14 @@ utc_time_offset = "-5"
time_range = "10:00:00-14:00:00" time_range = "10:00:00-14:00:00"
``` ```
## Имя пользователя ## Username
Модуль `username` показывает имя активного пользователя. Модуль будет показан, если любое из следующих условий соблюдено: The `username` module shows active user's username. The module will be shown if any of the following conditions are met:
- The current user is root/admin - The current user is root/admin
- Текущий пользователь отличается от залогиненного - The current user isn't the same as the one that is logged in
- Пользователь подключен к SSH-сессии - The user is currently connected as an SSH session
- Переменная `show_always` равна true - The variable `show_always` is set to true
::: tip Подсказка ::: tip Подсказка
@ -3379,12 +3417,12 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, `
### Опции ### Опции
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| ------------- | ----------------------- | ------------------------------------------------------- | | ------------- | ----------------------- | ------------------------------------------- |
| `style_root` | `"bold red"` | The style used when the user is root/admin. | | `style_root` | `"bold red"` | The style used when the user is root/admin. |
| `style_user` | `"bold yellow"` | Стиль, используемый для всех пользователей, кроме root. | | `style_user` | `"bold yellow"` | The style used for non-root users. |
| `format` | `"[$user]($style) in "` | Формат модуля. | | `format` | `"[$user]($style) in "` | Формат модуля. |
| `show_always` | `false` | Всегда показывать модуль `username`. | | `show_always` | `false` | Always shows the `username` module. |
| `disabled` | `false` | Отключает модуль `username`. | | `disabled` | `false` | Disables the `username` module. |
### Переменные ### Переменные
@ -3514,7 +3552,7 @@ format = "[🆅 $repo](bold blue) "
## Zig ## Zig
By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). Модуль будет показан, если любое из следующих условий соблюдено: By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met:
- The current directory contains a `.zig` file - The current directory contains a `.zig` file
@ -3560,7 +3598,7 @@ These modules will be shown if any of the following conditions are met:
- The current directory contains a directory whose name is in `detect_folders` - The current directory contains a directory whose name is in `detect_folders`
- The current directory contains a file whose extension is in `detect_extensions` - The current directory contains a file whose extension is in `detect_extensions`
- The `when` command returns 0 - The `when` command returns 0
- The current Operating System (std::env::consts::OS) matchs with `os` field if defined. - The current Operating System (std::env::consts::OS) matches with `os` field if defined.
::: tip Подсказка ::: tip Подсказка
@ -3595,7 +3633,7 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt
| `command` | `""` | The command whose output should be printed. The command will be passed on stdin to the shell. | | `command` | `""` | The command whose output should be printed. The command will be passed on stdin to the shell. |
| `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. | | `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. |
| `shell` | | [See below](#custom-command-shell) | | `shell` | | [See below](#custom-command-shell) |
| `описание` | `"<custom module>"` | The description of the module that is shown when running `starship explain`. | | `description` | `"<custom module>"` | The description of the module that is shown when running `starship explain`. |
| `detect_files` | `[]` | The files that will be searched in the working directory for a match. | | `detect_files` | `[]` | The files that will be searched in the working directory for a match. |
| `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. | | `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. |
| `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. | | `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. |

View File

@ -256,11 +256,12 @@ Install the latest version for your system with the MSI-installers from the [rel
Install Starship using any of the following package managers: Install Starship using any of the following package managers:
| Repository | Instructions | | Repository | Instructions |
| -------------------------------------------------------------------------------- | --------------------------------------- | | -------------------------------------------------------------------------------------------- | --------------------------------------- |
| **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
| [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` | | [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` |
| [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` | | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
| [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json) | `scoop install starship` | | [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json) | `scoop install starship` |
| [winget](https://github.com/microsoft/winget-pkgs/tree/master/manifests/s/Starship/Starship) | `winget install --id Starship.Starship` |
</details> </details>

View File

@ -3,22 +3,22 @@ home: true
heroImage: /logo.svg heroImage: /logo.svg
heroText: heroText:
tagline: Sade, hızlı, dilediğiniz gibi özelleştirilebilen ve istenilen shell'de kullanılabilen prompt! tagline: Sade, hızlı, dilediğiniz gibi özelleştirilebilen ve istenilen shell'de kullanılabilen prompt!
actionText: Get Started actionText: Kullanmaya Başlayın
actionLink: ./guide/ actionLink: ./guide/
features: features:
- -
title: Compatibility First title: Önce Uyumluluk
details: Works on the most common shells on the most common operating systems. Use it everywhere! details: En yaygın işletim sistemlerindeki en yaygın shell'ler üzerinde çalışır. Use it everywhere!
- -
title: Rust-Powered title: Rust-Powered
details: Brings the best-in-class speed and safety of Rust, to make your prompt as quick and reliable as possible. details: Prompt'u mümkün olduğunca hızlı ve güvenilir hale getirmek için sınıfının en iyisi Rust hızını ve güvenliğini sağlar.
- -
title: Customizable title: Özelleştirilebilir
details: Every little detail is customizable to your liking, to make this prompt as minimal or feature-rich as you'd like it to be. details: Her küçük ayrıntı beğeninize göre özelleştirilebilir, böylece bu prompt'u istediğiniz kadar minimal veya zengin özelliklere sahip hale getirirsiniz.
footer: ISC Licensed | Copyright © 2019-present Starship Contributors footer: ISC Lisanslı | Telif Hakkı © 2019-günümüz Starship Contributors
#Used for the description meta tag, for SEO #Used for the description meta tag, for SEO
metaTitle: "Starship: Cross-Shell Prompt" metaTitle: "Starship: Cross-Shell Prompt"
description: Starship is the minimal, blazing fast, and extremely customizable prompt for any shell! Shows the information you need, while staying sleek and minimal. Quick installation available for Bash, Fish, ZSH, Ion, Tcsh, Elvish, Nu, Xonsh, Cmd, and PowerShell. description: Starship, her prompt için minimal, son derece hızlı ve son derece özelleştirilebilir bir shelldir! Şık ve minimal kalırken ihtiyacınız olan bilgileri gösterir. Bash, Fish, ZSH, Ion, Tcsh, Elvish, Nu, Xonsh, Cmd ve PowerShell için hızlı kurulum mevcuttur.
--- ---
<div class="center"> <div class="center">
@ -30,33 +30,33 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
### Ön koşullar ### Ön koşullar
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal. - Terminalinizde bir [Nerd Font](https://www.nerdfonts.com/) yüklü ve etkin olmalı.
### Quick Install ### Hızlı Kurulum
1. Install the **starship** binary: 1. Install the **starship** binary:
#### Install Latest Version #### En Son Sürümü Yükle
With Shell: Shell ile:
```sh ```sh
curl -sS https://starship.rs/install.sh | sh curl -sS https://starship.rs/install.sh | sh
``` ```
To update the Starship itself, rerun the above script. It will replace the current version without touching Starship's configuration. Starship'in kendisini güncellemek için yukarıdaki komudu yeniden çalıştırın. Starship'in yapılandırmasına dokunmadan mevcut sürümün yerini alacak.
#### Install via Package Manager #### Paket Yöneticisi ile yükleme
With [Homebrew](https://brew.sh/): Homebrew [ile](https://brew.sh/):
```sh ```sh
brew install starship brew install starship
``` ```
With [Scoop](https://scoop.sh): Scoop [ile](https://scoop.sh):
```powershell ```powershell
scoop install starship scoop install starship

View File

@ -538,19 +538,19 @@ By default it only changes color. If you also want to change its shape take a lo
::: uyarı ::: uyarı
`vicmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). `vimcmd_symbol` yalnızca cmd, fish ve zsh'de desteklenir. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148).
::: :::
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| -------------------------- | -------------------- | --------------------------------------------------------------------------------------- | | --------------------------- | -------------------- | --------------------------------------------------------------------------------------- |
| `format` | `"$symbol "` | The format string used before the text input. | | `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. | | `success_symbol` | `"[](bold green)"` | The format string used before the text input if the previous command succeeded. |
| `error_symbol` | `"[](bold red)"` | The format string used before the text input if the previous command failed. | | `error_symbol` | `"[](bold red)"` | The format string used before the text input if the previous command failed. |
| `vicmd_symbol` | `"[](bold green)"` | The format string used before the text input if the shell is in vim normal mode. | | `vimcmd_symbol` | `"[](bold green)"` | The format string used before the text input if the shell is in vim normal mode. |
| `vicmd_replace_one_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. | | `vimcmd_replace_one_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. |
| `vimcmd_replace_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. | | `vimcmd_replace_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. |
| `vimcmd_visual_symbol` | `"[](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. | | `vimcmd_visual_symbol` | `"[](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. |
| `disabled` | `false` | Disables the `character` module. | | `disabled` | `false` | Disables the `character` module. |
@ -2793,6 +2793,44 @@ The `rlang` module shows the currently installed version of [R](https://www.r-pr
format = "with [📐 $version](blue bold) " format = "with [📐 $version](blue bold) "
``` ```
## Raku
The `raku` module shows the currently installed version of [Raku](https://www.raku.org/). By default the module will be shown if any of the following conditions are met:
- The current directory contains a `META6.json` file
- The current directory contains a `.p6`, `.pm6`, `.raku`, `.rakumod` or `.pod6`
### Options
| Option | Default | Description |
| ------------------- | ------------------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version-$vm_version )]($style)"` | The format string for the module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🦋 "` | The symbol used before displaying the version of Raku |
| `detect_extensions` | `["p6", "pm6", "pod6", "raku", "rakumod"]` | Which extensions should trigger this module. |
| `detect_files` | `["META6.json"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `stil` | `"bold 149"` | The style for the module. |
| `disabled` | `false` | Disables the `raku` module. |
### Variables
| Variable | Example | Description |
| ---------- | ------- | ------------------------------------ |
| version | `v6.d` | The version of `raku` |
| vm_version | `moar` | The version of VM `raku` is built on |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
### Example
```toml
# ~/.config/starship.toml
[raku]
format = "via [🦪 $version]($style) "
```
## Red ## Red
By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met: By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met:
@ -3560,7 +3598,7 @@ These modules will be shown if any of the following conditions are met:
- The current directory contains a directory whose name is in `detect_folders` - The current directory contains a directory whose name is in `detect_folders`
- The current directory contains a file whose extension is in `detect_extensions` - The current directory contains a file whose extension is in `detect_extensions`
- The `when` command returns 0 - The `when` command returns 0
- The current Operating System (std::env::consts::OS) matchs with `os` field if defined. - The current Operating System (std::env::consts::OS) matches with `os` field if defined.
::: tip ::: tip

View File

@ -15,7 +15,7 @@
<a href="https://crates.io/crates/starship" <a href="https://crates.io/crates/starship"
><img ><img
src="https://img.shields.io/crates/v/starship?style=flat-square" src="https://img.shields.io/crates/v/starship?style=flat-square"
alt="Crates.io version" alt="Crates.io versiyonu"
/></a> /></a>
<a href="https://repology.org/project/starship/versions" <a href="https://repology.org/project/starship/versions"
><img ><img
@ -25,12 +25,12 @@
<a href="https://discord.gg/starship" <a href="https://discord.gg/starship"
><img ><img
src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square" src="https://img.shields.io/discord/567163873606500352?label=discord&logoColor=white&style=flat-square"
alt="Chat on Discord" alt="Discord'da sohbet et"
/></a> /></a>
<a href="https://twitter.com/StarshipPrompt" <a href="https://twitter.com/StarshipPrompt"
><img ><img
src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square" src="https://img.shields.io/badge/twitter-@StarshipPrompt-1DA1F3?style=flat-square"
alt="Follow @StarshipPrompt on Twitter" alt="@StarshipPrompt'u Twitter'da takip edin"
/></a> /></a>
</p> </p>
@ -47,7 +47,7 @@
><img ><img
height="20" height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-us.png" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-us.png"
alt="English" alt="İngilizce"
/></a> /></a>
&nbsp; &nbsp;
<a <a
@ -55,7 +55,7 @@
><img ><img
height="20" height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-de.png" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-de.png"
alt="Deutsch" alt="Almanca"
/></a> /></a>
&nbsp; &nbsp;
<a <a
@ -63,7 +63,7 @@
><img ><img
height="20" height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-es.png" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-es.png"
alt="Español" alt="İspanyolca"
/></a> /></a>
&nbsp; &nbsp;
<a <a
@ -71,7 +71,7 @@
><img ><img
height="20" height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-fr.png" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-fr.png"
alt="Français" alt="Fransızca"
/></a> /></a>
&nbsp; &nbsp;
<a <a
@ -79,7 +79,7 @@
><img ><img
height="20" height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-id.png" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-id.png"
alt="Bahasa Indonesia" alt="Endonezyaca"
/></a> /></a>
&nbsp; &nbsp;
<a <a
@ -87,7 +87,7 @@
><img ><img
height="20" height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-it.png" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-it.png"
alt="Italiano" alt="İtalyanca"
/></a> /></a>
&nbsp; &nbsp;
<a <a
@ -95,7 +95,7 @@
><img ><img
height="20" height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-jp.png" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-jp.png"
alt="日本語" alt="Japonca"
/></a> /></a>
&nbsp; &nbsp;
<a <a
@ -103,7 +103,7 @@
><img ><img
height="20" height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-br.png" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-br.png"
alt="Português do Brasil" alt="Brezilya Portekizcesi"
/></a> /></a>
&nbsp; &nbsp;
<a <a
@ -111,7 +111,7 @@
><img ><img
height="20" height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-ru.png"
alt="Русский" alt="Rusça"
/></a> /></a>
&nbsp; &nbsp;
<a <a
@ -119,7 +119,7 @@
><img ><img
height="20" height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-vn.png" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-vn.png"
alt="Tiếng Việt" alt="Vietnamca"
/></a> /></a>
&nbsp; &nbsp;
<a <a
@ -127,7 +127,7 @@
><img ><img
height="20" height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-cn.png" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-cn.png"
alt="简体中文" alt="Basitleştirilmiş Çince"
/></a> /></a>
&nbsp; &nbsp;
<a <a
@ -135,7 +135,7 @@
><img ><img
height="20" height="20"
src="https://raw.githubusercontent.com/starship/starship/master/media/flag-tw.png" src="https://raw.githubusercontent.com/starship/starship/master/media/flag-tw.png"
alt="繁體中文" alt="Geleneksel Çince"
/></a> /></a>
</p> </p>
@ -145,7 +145,7 @@
<img <img
src="https://raw.githubusercontent.com/starship/starship/master/media/demo.gif" src="https://raw.githubusercontent.com/starship/starship/master/media/demo.gif"
alt="Starship with iTerm2 and the Snazzy theme" alt="iTerm2 ve Snazzy temalı Starship"
width="50%" width="50%"
align="right" align="right"
/> />
@ -180,7 +180,7 @@ Kurulum talimatlarını görmek için aşağıdaki listeden işletim sisteminizi
Starship'i herhangi bir paket yöneticisi ile yükleyin: Starship'i herhangi bir paket yöneticisi ile yükleyin:
| Repository | Instructions | | Depo | Talimatlar |
| --------------------------------------------------------------------------------- | ---------------------- | | --------------------------------------------------------------------------------- | ---------------------- |
| [Termux](https://github.com/termux/termux-packages/tree/master/packages/starship) | `pkg install starship` | | [Termux](https://github.com/termux/termux-packages/tree/master/packages/starship) | `pkg install starship` |
@ -191,9 +191,9 @@ Starship'i herhangi bir paket yöneticisi ile yükleyin:
Starship'i herhangi bir paket yöneticisi ile yükleyin: Starship'i herhangi bir paket yöneticisi ile yükleyin:
| Distribution | Repository | Instructions | | Dıtım | Depo | Talimatlar |
| ------------ | -------------------------------------------------------- | --------------------------------- | | -------------------------- | -------------------------------------------------------- | --------------------------------- |
| **_Any_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | | **_Herhangi bir dağıtım_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
| FreeBSD | [FreshPorts](https://www.freshports.org/shells/starship) | `pkg install starship` | | FreeBSD | [FreshPorts](https://www.freshports.org/shells/starship) | `pkg install starship` |
| NetBSD | [pkgsrc](https://pkgsrc.se/shells/starship) | `pkgin install starship` | | NetBSD | [pkgsrc](https://pkgsrc.se/shells/starship) | `pkgin install starship` |
@ -210,12 +210,12 @@ curl -sS https://starship.rs/install.sh | sh
Alternatif olarak aşağıdaki paket yöneticileri ile de Starship'i yükleyebilirsiniz: Alternatif olarak aşağıdaki paket yöneticileri ile de Starship'i yükleyebilirsiniz:
| Distribution | Repository | Instructions | | Dıtım | Depo | Talimatlar |
| ------------------ | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | | -------------------------- | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
| **_Any_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | | **_Herhangi bir dağıtım_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
| _Any_ | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` | | _Herhangi bir dağıtım_ | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
| _Any_ | [Linuxbrew](https://formulae.brew.sh/formula/starship) | `brew install starship` | | _Herhangi bir dağıtım_ | [Linuxbrew](https://formulae.brew.sh/formula/starship) | `brew install starship` |
| _Any_ | [Snapcraft](https://snapcraft.io/starship) | `snap install starship` | | _Herhangi bir dağıtım_ | [Snapcraft](https://snapcraft.io/starship) | `snap install starship` |
| Alpine Linux 3.13+ | [Alpine Linux Packages](https://pkgs.alpinelinux.org/packages?name=starship) | `apk add starship` | | Alpine Linux 3.13+ | [Alpine Linux Packages](https://pkgs.alpinelinux.org/packages?name=starship) | `apk add starship` |
| Arch Linux | [Arch Linux Community](https://archlinux.org/packages/community/x86_64/starship) | `pacman -S starship` | | Arch Linux | [Arch Linux Community](https://archlinux.org/packages/community/x86_64/starship) | `pacman -S starship` |
| CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship` <br /> `dnf install starship` | | CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship` <br /> `dnf install starship` |
@ -239,7 +239,7 @@ curl -sS https://starship.rs/install.sh | sh
Alternatif olarak aşağıdaki paket yöneticileri ile de Starship'i yükleyebilirsiniz: Alternatif olarak aşağıdaki paket yöneticileri ile de Starship'i yükleyebilirsiniz:
| Repository | Instructions | | Depo | Talimatlar |
| -------------------------------------------------------- | --------------------------------------- | | -------------------------------------------------------- | --------------------------------------- |
| **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
| [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` | | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
@ -251,16 +251,17 @@ Alternatif olarak aşağıdaki paket yöneticileri ile de Starship'i yükleyebil
<details> <details>
<summary>Windows</summary> <summary>Windows</summary>
Install the latest version for your system with the MSI-installers from the [releases section](https://github.com/starship/starship/releases/latest). Sisteminiz için en son sürümü [releases bölümündeki](https://github.com/starship/starship/releases/latest) MSI yükleyicileri ile yükleyin.
Starship'i herhangi bir paket yöneticisi ile yükleyin: Starship'i herhangi bir paket yöneticisi ile yükleyin:
| Repository | Instructions | | Depo | Talimatlar |
| -------------------------------------------------------------------------------- | --------------------------------------- | | -------------------------------------------------------------------------------------------- | --------------------------------------- |
| **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
| [Chocolatey ](https://community.chocolatey.org/packages/starship) | `choco install starship` | | [Chocolatey ](https://community.chocolatey.org/packages/starship) | `choco install starship` |
| [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` | | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
| [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json) | `scoop install starship` | | [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json) | `scoop install starship` |
| [winget](https://github.com/microsoft/winget-pkgs/tree/master/manifests/s/Starship/Starship) | `winget install --id Starship.Starship` |
</details> </details>
@ -282,7 +283,7 @@ eval "$(starship init bash)"
<details> <details>
<summary>Cmd</summary> <summary>Cmd</summary>
Cmd ıle beraber [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) kullanmalısınız. `%LocalAppData%\clink\starship.lua` dosyasını belirtilen dizinde aşağıdaki kod içeriği olacak şekilde oluşturun: Cmd ile beraber [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) kullanmalısınız. `%LocalAppData%\clink\starship.lua` dosyasını belirtilen dizinde aşağıdaki kod içeriği olacak şekilde oluşturun:
```lua ```lua
load(io.popen('starship init cmd'):read("*a"))() load(io.popen('starship init cmd'):read("*a"))()
@ -328,7 +329,7 @@ eval $(starship init ion)
<details> <details>
<summary>Nushell</summary> <summary>Nushell</summary>
Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell): Nushell env dosyanızın sonuna aşağıdakileri ekleyin (Nushell'de `$nu.env-path` komutunu çalıştırarak bulabilirsiniz):
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
@ -413,15 +414,15 @@ Lütfen starship'in oluşmasında ilham kaynağı olan çalışmalara da göz at
- **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** A ZSH prompt for astronauts. - **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** A ZSH prompt for astronauts.
- **[denysdovhan/robbyrussell-node](https://github.com/denysdovhan/robbyrussell-node)** Cross-shell robbyrussell theme written in JavaScript. - **[denysdovhan/robbyrussell-node](https://github.com/denysdovhan/robbyrussell-node)** - JavaScript ile yazılmış robbyrussell Cross-shell teması.
- **[reujab/silver](https://github.com/reujab/silver)** A cross-shell customizable powerline-like prompt with icons. - **[reujab/silver](https://github.com/reujab/silver)** A cross-shell customizable powerline-like prompt with icons.
<p align="center"> <p align="center">
<br> <br>
<img width="100" src="https://raw.githubusercontent.com/starship/starship/master/media/icon.png" alt="Starship rocket icon"> <img width="100" src="https://raw.githubusercontent.com/starship/starship/master/media/icon.png" alt="Starship roket simgesi">
</p> </p>
## 📝 Lisans ## 📝 Lisans
Copyright © 2019-present, [Starship Contributors](https://github.com/starship/starship/graphs/contributors).<br /> This project is [ISC](https://github.com/starship/starship/blob/master/LICENSE) licensed. Telif Hakkı © 2019-günümüz, [Starship Contributors](https://github.com/starship/starship/graphs/contributors). <br /> Bu proje [ISC](https://github.com/starship/starship/blob/master/LICENSE) lisanslıdır.

View File

@ -538,19 +538,19 @@ Mặc định, nó chỉ thay đổi màu. If you also want to change its shape
::: cảnh báo ::: cảnh báo
`vicmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148).
::: :::
### Các tuỳ chọn ### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả | | Tuỳ chọn | Mặc định | Mô tả |
| -------------------------- | -------------------- | --------------------------------------------------------------------------------------- | | --------------------------- | -------------------- | --------------------------------------------------------------------------------------- |
| `format` | `"$symbol "` | Định dạng chuỗi sử dụng trước văn bản nhập vào. | | `format` | `"$symbol "` | Định dạng chuỗi sử dụng trước văn bản nhập vào. |
| `success_symbol` | `"[](bold green)"` | Định dạng chuỗi sửa dụng trước văn bản nhập vào nếu câu lệnh trước đó đã thành công. | | `success_symbol` | `"[](bold green)"` | Định dạng chuỗi sửa dụng trước văn bản nhập vào nếu câu lệnh trước đó đã thành công. |
| `error_symbol` | `"[](bold red)"` | Định dạng chuỗi sửa dụng trước văn bản nhập vào nếu câu lệnh trước đó đã thất bại. | | `error_symbol` | `"[](bold red)"` | Định dạng chuỗi sửa dụng trước văn bản nhập vào nếu câu lệnh trước đó đã thất bại. |
| `vicmd_symbol` | `"[](bold green)"` | Định dạng chuỗi sửa dụng trước văn bản nhập vào nếu shell trong chế độ vim normal. | | `vimcmd_symbol` | `"[](bold green)"` | Định dạng chuỗi sửa dụng trước văn bản nhập vào nếu shell trong chế độ vim normal. |
| `vicmd_replace_one_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. | | `vimcmd_replace_one_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. |
| `vimcmd_replace_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. | | `vimcmd_replace_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. |
| `vimcmd_visual_symbol` | `"[](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. | | `vimcmd_visual_symbol` | `"[](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. |
| `disabled` | `false` | Vô hiệu module `character`. | | `disabled` | `false` | Vô hiệu module `character`. |
@ -2793,9 +2793,47 @@ The `rlang` module shows the currently installed version of [R](https://www.r-pr
format = "with [📐 $version](blue bold) " format = "with [📐 $version](blue bold) "
``` ```
## Raku
The `raku` module shows the currently installed version of [Raku](https://www.raku.org/). Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn:
- The current directory contains a `META6.json` file
- The current directory contains a `.p6`, `.pm6`, `.raku`, `.rakumod` or `.pod6`
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ------------------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version-$vm_version )]($style)"` | The format string for the module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🦋 "` | The symbol used before displaying the version of Raku |
| `detect_extensions` | `["p6", "pm6", "pod6", "raku", "rakumod"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `["META6.json"]` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `style` | `"bold 149"` | Kiểu cho module. |
| `disabled` | `false` | Disables the `raku` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| ---------- | ------ | ------------------------------------ |
| version | `v6.d` | The version of `raku` |
| vm_version | `moar` | The version of VM `raku` is built on |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| style\* | | Giá trị ghi đè của `style` |
### Ví dụ
```toml
# ~/.config/starship.toml
[raku]
format = "via [🦪 $version]($style) "
```
## Red ## Red
By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn: By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met:
- The current directory contains a file with `.red` or `.reds` extension - The current directory contains a file with `.red` or `.reds` extension
@ -2833,7 +2871,7 @@ symbol = "🔴 "
## Ruby ## Ruby
By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn: By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). The module will be shown if any of the following conditions are met:
- The current directory contains a `Gemfile` file - The current directory contains a `Gemfile` file
- The current directory contains a `.ruby-version` file - The current directory contains a `.ruby-version` file
@ -2877,7 +2915,7 @@ symbol = "🔺 "
## Rust ## Rust
By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn: By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). The module will be shown if any of the following conditions are met:
- The current directory contains a `Cargo.toml` file - The current directory contains a `Cargo.toml` file
- The current directory contains a file with the `.rs` extension - The current directory contains a file with the `.rs` extension
@ -2990,7 +3028,7 @@ Mặc định, mô đun này được vô hiệu. Để kích hoạt nó, thiế
| Biến | Mặc định | Mô tả | | Biến | Mặc định | Mô tả |
| --------- | -------- | ---------------------------------------------------------- | | --------- | -------- | ---------------------------------------------------------- |
| indicator | | Mirrors the value of `indicator` for currently used shell. | | indicator | | Mirrors the value of `indicator` for currently used shell. |
| style\* | | Giá trị ghi đè của `style`. | | style\* | | Mirrors the value of option `style`. |
*: Biến này có thể chỉ được sử dụng như một phần của style string *: Biến này có thể chỉ được sử dụng như một phần của style string
@ -3219,7 +3257,7 @@ disabled = false
## Swift ## Swift
By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn: By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). 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 `Package.swift` file
- The current directory contains a file with the `.swift` extension - The current directory contains a file with the `.swift` extension
@ -3343,7 +3381,7 @@ If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Otherwise, it de
| Biến | Ví dụ | Mô tả | | Biến | Ví dụ | Mô tả |
| --------- | ---------- | -------------------------- | | --------- | ---------- | -------------------------- |
| thời gian | `13:08:10` | The current time. | | time | `13:08:10` | The current time. |
| style\* | | Giá trị ghi đè của `style` | | style\* | | Giá trị ghi đè của `style` |
*: Biến này có thể chỉ được sử dụng như một phần của style string *: Biến này có thể chỉ được sử dụng như một phần của style string
@ -3363,7 +3401,7 @@ time_range = "10:00:00-14:00:00"
## Username ## Username
The `username` module shows active user's username. Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn: The `username` module shows active user's username. The module will be shown if any of the following conditions are met:
- The current user is root/admin - The current user is root/admin
- The current user isn't the same as the one that is logged in - The current user isn't the same as the one that is logged in
@ -3514,7 +3552,7 @@ format = "[🆅 $repo](bold blue) "
## Zig ## Zig
By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn: By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met:
- The current directory contains a `.zig` file - The current directory contains a `.zig` file
@ -3560,7 +3598,7 @@ These modules will be shown if any of the following conditions are met:
- The current directory contains a directory whose name is in `detect_folders` - The current directory contains a directory whose name is in `detect_folders`
- The current directory contains a file whose extension is in `detect_extensions` - The current directory contains a file whose extension is in `detect_extensions`
- The `when` command returns 0 - The `when` command returns 0
- The current Operating System (std::env::consts::OS) matchs with `os` field if defined. - The current Operating System (std::env::consts::OS) matches with `os` field if defined.
::: tip ::: tip
@ -3595,7 +3633,7 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt
| `command` | `""` | The command whose output should be printed. The command will be passed on stdin to the shell. | | `command` | `""` | The command whose output should be printed. The command will be passed on stdin to the shell. |
| `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. | | `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. |
| `shell` | | [See below](#custom-command-shell) | | `shell` | | [See below](#custom-command-shell) |
| `mô tả` | `"<custom module>"` | The description of the module that is shown when running `starship explain`. | | `description` | `"<custom module>"` | The description of the module that is shown when running `starship explain`. |
| `detect_files` | `[]` | The files that will be searched in the working directory for a match. | | `detect_files` | `[]` | The files that will be searched in the working directory for a match. |
| `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. | | `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. |
| `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. | | `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. |

View File

@ -256,11 +256,12 @@ Install the latest version for your system with the MSI-installers from the [rel
Install Starship using any of the following package managers: Install Starship using any of the following package managers:
| Repository | Instructions | | Repository | Instructions |
| -------------------------------------------------------------------------------- | --------------------------------------- | | -------------------------------------------------------------------------------------------- | --------------------------------------- |
| **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
| [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` | | [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` |
| [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` | | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
| [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json) | `scoop install starship` | | [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json) | `scoop install starship` |
| [winget](https://github.com/microsoft/winget-pkgs/tree/master/manifests/s/Starship/Starship) | `winget install --id Starship.Starship` |
</details> </details>

View File

@ -129,11 +129,11 @@ Invoke-Expression (&starship init powershell)
## 启用右侧提示 ## 启用右侧提示
一些 Shell 支持右侧提示, 它与输入区渲染在同一行。 Starship 可以设置右侧提示的内容,使用 `right_format` 选项。 Any module that can be used in `format` is also supported in `right_format`. The `$all` variable will only contain modules not explicitly used in either `format` or `right_format`. 一些 Shell 支持右侧提示, 它与输入区渲染在同一行。 使用 `right_format` 选项来设置 Starship 的右侧提示。 所有支持 `format` 的组件也同时支持 `right_format`。 未显式在 `format``right_format` 中使用的组件,会保存在变量 `$all` 中。
Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [`fill` module](/config/#fill). 注意:右侧提示和输入区显示在同一行。 如果需要在输入区的上方显示右对齐的组件,请查阅 [`fill` 组件](/config/#fill)。
`right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd. `right_format` 现支持 elvish、fish、zsh、xonsh、cmd。
### 示例 ### 示例
@ -147,21 +147,21 @@ format = """$character"""
right_format = """$all""" right_format = """$all"""
``` ```
Produces a prompt like the following: 会显示成如下方案
``` ```
▶ starship on  rprompt [!] is 📦 v0.57.0 via 🦀 v1.54.0 took 17s ▶ starship on  rprompt [!] is 📦 v0.57.0 via 🦀 v1.54.0 took 17s
``` ```
## Continuation Prompt ## 多行提示符
Some shells support a continuation prompt along with the normal prompt. This prompt is rendered instead of the normal prompt when the user has entered an incomplete statement (such as a single left parenthesis or quote). 一些 Shell 也同时支持多行提示符。 若用户输入了不完整的命令例如一个左括号或引号Shell 会渲染多行提示符。
Starship can set the continuation prompt using the `continuation_prompt` option. The default prompt is `"[∙](bright-black) "`. 使用 `continuation_prompt` 选项来设置 Starship 的多行提示符。 它的默认值为 `[∙](bright-black)`
Note: `continuation_prompt` should be set to a literal string without any variables. 注意:`continuation_prompt` 应设置为没有变量的字符串。
Note: Continuation prompts are only available in the following shells: 注意,仅以下 Shell 支持多行提示符:
- `bash` - `bash`
- `zsh` - `zsh`
@ -190,13 +190,13 @@ continuation_prompt = "▶▶"
- `<color>` - `<color>`
- `none` - `none`
`<color>` 是颜色说明符(下面解释)。 `fg:<color>` and `<color>` currently do the same thing, though this may change in the future. `inverted` swaps the background and foreground colors. 字符串中的单词顺序不影响显示结果。 `<color>` 可以声明颜色,会在下面解释。 `fg:<color>``<color>` 的功能暂时相同,未来可能会更改。 `inverted` 会反转背景和文字的颜色。 字符串中的单词顺序不影响显示结果。
The `none` token overrides all other tokens in a string if it is not part of a `bg:` specifier, so that e.g. `fg:red none fg:blue` will still create a string with no styling. `bg:none` sets the background to the default color so `fg:red bg:none` is equivalent to `red` or `fg:red` and `bg:green fg:red bg:none` is also equivalent to `fg:red` or `red`. 未来可能会将 `none` 与其它标识符一起使用视为一种错误。 `none` 不是 `bg:` 的一部分,则它会覆盖其他的设置:比如 `fg:red none fg:blue` 不会更改任何样式。 `bg:none` 会设置成默认背景色,因此 `fg:red bg:none`、`red`、`fg:red` 的作用相同;类似,`bg:green fg:red bg:none`、`fg:red`、`red` 的作用也相同。 未来可能会将 `none` 与其它单词一起使用视为错误。
颜色说明符可以是以下内容之一 颜色可以由以下任一内容定义
- One of the standard terminal colors: `black`, `red`, `green`, `blue`, `yellow`, `purple`, `cyan`, `white`. You can optionally prefix these with `bright-` to get the bright version (e.g. `bright-white`). - 任一标准的终端颜色:`black`, `red`, `green`, `blue`, `yellow`, `purple`, `cyan`, `white`。 您也可以使用前缀 `bright-` 定义浅色版本(例如 `bright-white`)。
- 一个 `#` 后跟一个六位十六进制数。 这将指定一个 [十六进制 RGB 颜色代码](https://www.w3schools.com/colors/colors_hexadecimal.asp)。 - 一个 `#` 后跟一个六位十六进制数。 这将指定一个 [十六进制 RGB 颜色代码](https://www.w3schools.com/colors/colors_hexadecimal.asp)。
- 0-255 之间的数字。 这将指定一个 [8 位 ANSI 颜色码](https://i.stack.imgur.com/KTSQa.png)。 - 0-255 之间的数字。 这将指定一个 [8 位 ANSI 颜色码](https://i.stack.imgur.com/KTSQa.png)。

View File

@ -9,17 +9,17 @@ mkdir -p ~/.config && touch ~/.config/starship.toml
Starship 的所有配置都在此 [TOML](https://github.com/toml-lang/toml) 配置文件中完成: Starship 的所有配置都在此 [TOML](https://github.com/toml-lang/toml) 配置文件中完成:
```toml ```toml
# Get editor completions based on the config schema # 设置配置范例,开启编辑器的自动补全
"$schema" = 'https://starship.rs/config-schema.json' "$schema" = 'https://starship.rs/config-schema.json'
# Inserts a blank line between shell prompts # 在命令之间插入空行
add_newline = true add_newline = true
# Replace the "" symbol in the prompt with "➜" # 将提示符的“❯”替换为“➜”
[character] # The name of the module we are configuring is "character" [character] # “character”是我们正在配置的组件
success_symbol = "[➜](bold green)" # The "success_symbol" segment is being set to "➜" with the color "bold green" success_symbol = "[➜](bold green)" # 设置“success_symbol” 字段为绿色加粗的“➜”
# Disable the package module, hiding it from the prompt completely # 禁用 package 组件,完全隐藏它的提示符
[package] [package]
disabled = true disabled = true
``` ```
@ -36,7 +36,7 @@ export STARSHIP_CONFIG=~/example/non/default/path/starship.toml
$ENV:STARSHIP_CONFIG = "$HOME\example\non\default\path\starship.toml" $ENV:STARSHIP_CONFIG = "$HOME\example\non\default\path\starship.toml"
``` ```
Or for Cmd (Windows) would be adding this line to your `starship.lua`: 或者在 Cmd (Windows) 中,将下面的代码添加到 `starship.lua`
```lua ```lua
os.setenv('STARSHIP_CONFIG', 'C:\\Users\\user\\example\\non\\default\\path\\starship.toml') os.setenv('STARSHIP_CONFIG', 'C:\\Users\\user\\example\\non\\default\\path\\starship.toml')
@ -56,7 +56,7 @@ export STARSHIP_CACHE=~/.starship/cache
$ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp" $ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp"
``` ```
Or for Cmd (Windows) would be adding this line to your `starship.lua`: 或者在 Cmd (Windows) 中,将以下内容添加到您的 `starship.lua`
```lua ```lua
os.setenv('STARSHIP_CACHE', 'C:\\Users\\user\\AppData\\Local\\Temp') os.setenv('STARSHIP_CACHE', 'C:\\Users\\user\\AppData\\Local\\Temp')
@ -66,23 +66,23 @@ os.setenv('STARSHIP_CACHE', 'C:\\Users\\user\\AppData\\Local\\Temp')
**组件Module**:提示符的组成部分,通过来自系统的上下文信息向用户显示各种信息。 例如,如果您当前的目录是 Node.js 项目“nodejs” 模块会显示当前安装在您电脑上的 Node.js 的版本。 **组件Module**:提示符的组成部分,通过来自系统的上下文信息向用户显示各种信息。 例如,如果您当前的目录是 Node.js 项目“nodejs” 模块会显示当前安装在您电脑上的 Node.js 的版本。
**Variable**: Smaller sub-components that contain information provided by the module. For example, the "version" variable in the "nodejs" module contains the current version of Node.js. **字段Variable**:更小的子模块,包含由组件提供的信息。 例如“nodejs”组件里的“version”字段包含了现有 Node.js 的版本。
By convention, most modules have a prefix of default terminal color (e.g. `via` in "nodejs") and an empty space as a suffix. 依惯例大多组件都有一个带有默认终端颜色的前缀例如“nodejs”的 `via`),以及一个空格作为后缀。
### 格式字符串 ### 格式设定
模块通过格式字符串定义的格式输出它所有的变量。 大多数模块拥有一个名为 `format` 的入口来配置它的显示格式。 你可以在其中使用文本,变量或者文本组。 组件会根据定义的格式输出它所有的字段。 大多数组件可以通过 `format` 项来配置它的显示格式。 格式设定内可以包含文本、字段以及文本组。
#### 字段 #### 字段
A variable contains a `$` symbol followed by the name of the variable. The name of a variable can only contain letters, numbers and `_`. 一个字段由 `$` 和字段名依序组成。 字段名只能包含字母、数字以及 `_`
例如: 例如:
- `$version` is a format string with a variable named `version`. - 格式设定 `$version` 由一个变量 `version` 组成。
- `$git_branch$git_commit` is a format string with two variables named `git_branch` and `git_commit`. - 格式设定 `$git_branch$git_commit` 由两个变量 `git_branch`、`git_commit` 组成。
- `$git_branch $git_commit` has the two variables separated with a space. - 格式设定 `$git_branch $git_commit` 由两个变量和一个空格组成。
#### 文本组 #### 文本组
@ -94,9 +94,9 @@ A variable contains a `$` symbol followed by the name of the variable. The name
例如: 例如:
- `[on](red bold)` will print a string `on` with bold text colored red. - `[on](red bold)` 会输出一个加粗的红色 `on`
- `[⌘ $version](bold green)` will print a symbol `⌘` followed by the content of variable `version`, with bold text colored green. - `[⌘ $version](bold green)` 会先输出一个 `⌘`,之后是 `version` 字段的内容,都是绿色加粗的样式。
- `[a [b](red) c](green)` will print `a b c` with `b` red, and `a` and `c` green. - `[a [b](red) c](green)` 会依序输出绿色 `a`、红色 `b`、绿色 `c`
#### 样式设定 #### 样式设定
@ -538,19 +538,19 @@ By default it only changes color. If you also want to change its shape take a lo
::: warning ::: warning
`vicmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148).
::: :::
### 配置项 ### 配置项
| 选项 | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| -------------------------- | -------------------- | --------------------------------------------------------------------------------------- | | --------------------------- | -------------------- | --------------------------------------------------------------------------------------- |
| `format` | `"$symbol "` | The format string used before the text input. | | `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. | | `success_symbol` | `"[](bold green)"` | The format string used before the text input if the previous command succeeded. |
| `error_symbol` | `"[](bold red)"` | The format string used before the text input if the previous command failed. | | `error_symbol` | `"[](bold red)"` | The format string used before the text input if the previous command failed. |
| `vicmd_symbol` | `"[](bold green)"` | The format string used before the text input if the shell is in vim normal mode. | | `vimcmd_symbol` | `"[](bold green)"` | The format string used before the text input if the shell is in vim normal mode. |
| `vicmd_replace_one_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. | | `vimcmd_replace_one_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. |
| `vimcmd_replace_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. | | `vimcmd_replace_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. |
| `vimcmd_visual_symbol` | `"[](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. | | `vimcmd_visual_symbol` | `"[](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. |
| `disabled` | `false` | 禁用 `character` 组件。 | | `disabled` | `false` | 禁用 `character` 组件。 |
@ -2793,9 +2793,47 @@ The `rlang` module shows the currently installed version of [R](https://www.r-pr
format = "with [📐 $version](blue bold) " format = "with [📐 $version](blue bold) "
``` ```
## Raku
The `raku` module shows the currently installed version of [Raku](https://www.raku.org/). By default the module will be shown if any of the following conditions are met:
- The current directory contains a `META6.json` file
- The current directory contains a `.p6`, `.pm6`, `.raku`, `.rakumod` or `.pod6`
### 配置项
| 选项 | 默认值 | 描述 |
| ------------------- | ------------------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version-$vm_version )]($style)"` | The format string for the module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🦋 "` | The symbol used before displaying the version of Raku |
| `detect_extensions` | `["p6", "pm6", "pod6", "raku", "rakumod"]` | Which extensions should trigger this module. |
| `detect_files` | `["META6.json"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold 149"` | 此组件的样式。 |
| `disabled` | `false` | Disables the `raku` module. |
### Variables
| 字段 | 示例 | 描述 |
| ---------- | ------ | ------------------------------------ |
| version | `v6.d` | The version of `raku` |
| vm_version | `moar` | The version of VM `raku` is built on |
| symbol | | `symbol`对应值 |
| style\* | | `style`对应值 |
### 示例
```toml
# ~/.config/starship.toml
[raku]
format = "via [🦪 $version]($style) "
```
## Red ## Red
By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). 此组件只有满足以下条件之一时才会被显示: By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met:
- The current directory contains a file with `.red` or `.reds` extension - The current directory contains a file with `.red` or `.reds` extension
@ -2833,11 +2871,11 @@ symbol = "🔴 "
## Ruby ## Ruby
By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). 此组件只有满足以下条件之一时才会被显示: By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). The module will be shown if any of the following conditions are met:
- 当前目录包含 `Gemfile` 文件 - The current directory contains a `Gemfile` file
- The current directory contains a `.ruby-version` file - The current directory contains a `.ruby-version` file
- 当前目录包含 `.rb` 文件 - The current directory contains a `.rb` file
- The environment variables `RUBY_VERSION` or `RBENV_VERSION` are set - The environment variables `RUBY_VERSION` or `RBENV_VERSION` are set
Starship gets the current Ruby version by running `ruby -v`. Starship gets the current Ruby version by running `ruby -v`.
@ -2854,7 +2892,7 @@ Starship gets the current Ruby version by running `ruby -v`.
| `detect_folders` | `[]` | Which folders should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. |
| `detect_variables` | `["RUBY_VERSION", "RBENV_VERSION"]` | Which environment variables should trigger this module. | | `detect_variables` | `["RUBY_VERSION", "RBENV_VERSION"]` | Which environment variables should trigger this module. |
| `style` | `"bold red"` | 此组件的样式。 | | `style` | `"bold red"` | 此组件的样式。 |
| `disabled` | `false` | 禁用 `ruby` 组件。 | | `disabled` | `false` | Disables the `ruby` module. |
### Variables ### Variables
@ -2877,10 +2915,10 @@ symbol = "🔺 "
## Rust ## Rust
By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). 此组件只有满足以下条件之一时才会被显示: By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). The module will be shown if any of the following conditions are met:
- 当前目录包含 `Cargo.toml` 文件 - The current directory contains a `Cargo.toml` file
- 当前目录包含一个使用 `.rs` 扩展名的文件 - The current directory contains a file with the `.rs` extension
### 配置项 ### 配置项
@ -2893,7 +2931,7 @@ By default the `rust` module shows the currently installed version of [Rust](htt
| `detect_files` | `["Cargo.toml"]` | Which filenames should trigger this module. | | `detect_files` | `["Cargo.toml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold red"` | 此组件的样式。 | | `style` | `"bold red"` | 此组件的样式。 |
| `disabled` | `false` | 禁用 `rust` 组件。 | | `disabled` | `false` | Disables the `rust` module. |
### Variables ### Variables
@ -2990,7 +3028,7 @@ The `shell` module shows an indicator for currently used shell.
| 字段 | 默认值 | 描述 | | 字段 | 默认值 | 描述 |
| --------- | --- | ---------------------------------------------------------- | | --------- | --- | ---------------------------------------------------------- |
| indicator | | Mirrors the value of `indicator` for currently used shell. | | indicator | | Mirrors the value of `indicator` for currently used shell. |
| style\* | | `style`对应值. | | style\* | | Mirrors the value of option `style`. |
*: This variable can only be used as a part of a style string *: This variable can only be used as a part of a style string
@ -3219,7 +3257,7 @@ disabled = false
## Swift ## Swift
By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). 此组件只有满足以下条件之一时才会被显示: By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). 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 `Package.swift` file
- The current directory contains a file with the `.swift` extension - The current directory contains a file with the `.swift` extension
@ -3268,7 +3306,7 @@ By default the Terraform version is not shown, since this is slow for current ve
By default the module will be shown if any of the following conditions are met: By default the module will be shown if any of the following conditions are met:
- 当前目录包含 `.terraform` 目录 - The current directory contains a `.terraform` folder
- Current directory contains a file with the `.tf`, `.tfplan` or `.tfstate` extensions - Current directory contains a file with the `.tf`, `.tfplan` or `.tfstate` extensions
### 配置项 ### 配置项
@ -3282,7 +3320,7 @@ By default the module will be shown if any of the following conditions are met:
| `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[".terraform"]` | Which folders should trigger this module. | | `detect_folders` | `[".terraform"]` | Which folders should trigger this module. |
| `style` | `"bold 105"` | 此组件的样式。 | | `style` | `"bold 105"` | 此组件的样式。 |
| `disabled` | `false` | 禁用 `terraform` 组件。 | | `disabled` | `false` | Disables the `terraform` module. |
### Variables ### Variables
@ -3317,7 +3355,7 @@ format = "[🏎💨 $workspace]($style) "
## Time ## 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 ::: tip
@ -3328,16 +3366,16 @@ format = "[🏎💨 $workspace]($style) "
### 配置项 ### 配置项
| 选项 | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ----------------- | ----------------------- | ----------------------------------------------------------------------------------------------------- | | ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `format` | `"at [$time]($style) "` | The format string for the module. | | `format` | `"at [$time]($style) "` | The format string for the module. |
| `use_12hr` | `false` | 启用 12 小时格式 | | `use_12hr` | `false` | Enables 12 hour formatting |
| `time_format` | 见下文解释 | 用来格式化时间显示的 [chrono 格式字符串](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) | | `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. |
| `style` | `"bold yellow"` | 显示时间的样式。 | | `style` | `"bold yellow"` | The style for the module time |
| `utc_time_offset` | `"local"` | 设置所用 UTC 偏移量。 Range from -24 &lt; x &lt; 24. 允许使用浮点数来得到 30/45 分钟的时区偏移。 | | `utc_time_offset` | `"local"` | Sets the UTC offset to use. Range from -24 &lt; x &lt; 24. Allows floats to accommodate 30/45 minute timezone offsets. |
| `disabled` | `true` | 禁用 `time` 组件。 | | `disabled` | `true` | Disables the `time` module. |
| `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | | `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format |
If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. 否则,其默认值为 `"%T"` Manually setting `time_format` will override the `use_12hr` setting. If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Otherwise, it defaults to `"%T"`. Manually setting `time_format` will override the `use_12hr` setting.
### Variables ### Variables
@ -3363,12 +3401,12 @@ time_range = "10:00:00-14:00:00"
## Username ## Username
`username` 组件显示当前活跃的用户名。 此组件只有满足以下条件之一时才会被显示: The `username` module shows active user's username. The module will be shown if any of the following conditions are met:
- The current user is root/admin - The current user is root/admin
- 当前用户与登录用户不相同 - The current user isn't the same as the one that is logged in
- 用户正通过 SSH 会话连接访问 - The user is currently connected as an SSH session
- 字段 `show_always` 被设置为 true - The variable `show_always` is set to true
::: tip ::: tip
@ -3381,10 +3419,10 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, `
| 选项 | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ------------- | ----------------------- | ------------------------------------------- | | ------------- | ----------------------- | ------------------------------------------- |
| `style_root` | `"bold red"` | The style used when the user is root/admin. | | `style_root` | `"bold red"` | The style used when the user is root/admin. |
| `style_user` | `"bold yellow"` | 非 root 用户使用的样式。 | | `style_user` | `"bold yellow"` | The style used for non-root users. |
| `format` | `"[$user]($style) in "` | 组件格式化模板。 | | `format` | `"[$user]($style) in "` | 组件格式化模板。 |
| `show_always` | `false` | 总是显示 `username` 组件。 | | `show_always` | `false` | Always shows the `username` module. |
| `disabled` | `false` | 禁用 `username` 组件。 | | `disabled` | `false` | Disables the `username` module. |
### Variables ### Variables
@ -3514,7 +3552,7 @@ format = "[🆅 $repo](bold blue) "
## Zig ## Zig
By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). 此组件只有满足以下条件之一时才会被显示: By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met:
- The current directory contains a `.zig` file - The current directory contains a `.zig` file
@ -3560,7 +3598,7 @@ These modules will be shown if any of the following conditions are met:
- The current directory contains a directory whose name is in `detect_folders` - The current directory contains a directory whose name is in `detect_folders`
- The current directory contains a file whose extension is in `detect_extensions` - The current directory contains a file whose extension is in `detect_extensions`
- The `when` command returns 0 - The `when` command returns 0
- The current Operating System (std::env::consts::OS) matchs with `os` field if defined. - The current Operating System (std::env::consts::OS) matches with `os` field if defined.
::: tip ::: tip
@ -3595,7 +3633,7 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt
| `command` | `""` | The command whose output should be printed. The command will be passed on stdin to the shell. | | `command` | `""` | The command whose output should be printed. The command will be passed on stdin to the shell. |
| `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. | | `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. |
| `shell` | | [See below](#custom-command-shell) | | `shell` | | [See below](#custom-command-shell) |
| `描述` | `"<custom module>"` | The description of the module that is shown when running `starship explain`. | | `description` | `"<custom module>"` | The description of the module that is shown when running `starship explain`. |
| `detect_files` | `[]` | The files that will be searched in the working directory for a match. | | `detect_files` | `[]` | The files that will be searched in the working directory for a match. |
| `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. | | `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. |
| `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. | | `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. |

View File

@ -256,11 +256,12 @@ curl -sS https://starship.rs/install.sh | sh
使用下列软件包管理器安装Starship 使用下列软件包管理器安装Starship
| 软件包来源 | 指令 | | 软件包来源 | 指令 |
| -------------------------------------------------------------------------------- | --------------------------------------- | | -------------------------------------------------------------------------------------------- | --------------------------------------- |
| **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
| [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` | | [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` |
| [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` | | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
| [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json) | `scoop install starship` | | [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json) | `scoop install starship` |
| [winget](https://github.com/microsoft/winget-pkgs/tree/master/manifests/s/Starship/Starship) | `winget install --id Starship.Starship` |
</details> </details>
@ -328,14 +329,14 @@ eval $(starship init ion)
<details> <details>
<summary>Nushell</summary> <summary>Nushell</summary>
将以下内容添加到您 Nushell 环境文件的末尾(使用 `$nu.env-path` 来获取它的路径): 在您的 Nushell 环境文件的最后(使用 `$nu.env-path` 来获取它的路径),添加以下内容
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu starship init nu | save ~/.cache/starship/init.nu
``` ```
然后将以下内容添加到您 Nushell 配置文件的末尾(使用 `$nu.config-path` 来获取它的路径): 然后在您的 Nushell 配置文件的最后(使用 `$nu.config-path` 来获取它的路径),添加以下内容
```sh ```sh
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
@ -424,4 +425,4 @@ eval "$(starship init zsh)"
## 📝 许可证 ## 📝 许可证
版权所有 © 2019 - 目前, [Starship 贡献者](https://github.com/starship/starship/graphs/contributors).<br /> 此项目使用 [ISC](https://github.com/starship/starship/blob/master/LICENSE) 许可. 版权所有 © 2019 至今, [Starship 贡献者](https://github.com/starship/starship/graphs/contributors).<br /> 此项目使用 [ISC](https://github.com/starship/starship/blob/master/LICENSE) 许可.

View File

@ -250,7 +250,7 @@ behind = "⇣${count}"
++ format = "at 🕙[$time]($style) " ++ format = "at 🕙[$time]($style) "
``` ```
#### Custom Commands #### 自定义命令
| Removed Property | Replacement | | Removed Property | Replacement |
| ---------------- | ----------- | | ---------------- | ----------- |

View File

@ -1,4 +1,4 @@
[Return to Presets](./README.md#bracketed-segments) [返回全部预设](./README.md#bracketed-segments)
# Bracketed Segments Preset # Bracketed Segments Preset
@ -8,6 +8,6 @@
### 配置 ### 配置
[Click to download TOML](/presets/toml/bracketed-segments.toml) [点击下载 TOML 文件](/presets/toml/bracketed-segments.toml)
<<< @/.vuepress/public/presets/toml/bracketed-segments.toml <<< @/.vuepress/public/presets/toml/bracketed-segments.toml

View File

@ -1,4 +1,4 @@
[Return to Presets](./README.md#no-runtime-versions) [返回全部预设](./README.md#no-runtime-versions)
# No Runtime Versions Preset # No Runtime Versions Preset
@ -8,6 +8,6 @@
### 配置 ### 配置
[Click to download TOML](/presets/toml/no-runtime-versions.toml) [点击下载 TOML 文件](/presets/toml/no-runtime-versions.toml)
<<< @/.vuepress/public/presets/toml/no-runtime-versions.toml <<< @/.vuepress/public/presets/toml/no-runtime-versions.toml

View File

@ -1,4 +1,4 @@
[Return to Presets](./README.md#pastel-powerline) [返回全部预设](./README.md#pastel-powerline)
# Pastel Powerline Preset # Pastel Powerline Preset
@ -12,6 +12,6 @@
### 配置 ### 配置
[Click to download TOML](/presets/toml/pastel-powerline.toml) [点击下载 TOML 文件](/presets/toml/pastel-powerline.toml)
<<< @/.vuepress/public/presets/toml/pastel-powerline.toml <<< @/.vuepress/public/presets/toml/pastel-powerline.toml

View File

@ -1,4 +1,4 @@
[Return to Presets](./README.md#plain-text-symbols) [返回全部预设](./README.md#plain-text-symbols)
## Plain Text Symbols Preset ## Plain Text Symbols Preset
@ -8,6 +8,6 @@
### 配置 ### 配置
[Click to download TOML](/presets/toml/plain-text-symbols.toml) [点击下载 TOML 文件](/presets/toml/plain-text-symbols.toml)
<<< @/.vuepress/public/presets/toml/plain-text-symbols.toml <<< @/.vuepress/public/presets/toml/plain-text-symbols.toml

View File

@ -1,4 +1,4 @@
[Return to Presets](./README.md#pure) [返回全部预设](./README.md#pure)
# Pure Preset # Pure Preset
@ -8,6 +8,6 @@
### 配置 ### 配置
[Click to download TOML](/presets/toml/pure-preset.toml) [点击下载 TOML 文件](/presets/toml/pure-preset.toml)
<<< @/.vuepress/public/presets/toml/pure-preset.toml <<< @/.vuepress/public/presets/toml/pure-preset.toml

View File

@ -538,19 +538,19 @@ By default it only changes color. If you also want to change its shape take a lo
::: warning ::: warning
`vicmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148). `vimcmd_symbol` is only supported in cmd, fish and zsh. `vimcmd_replace_one_symbol`, `vimcmd_replace_symbol`, and `vimcmd_visual_symbol` are only supported in fish due to [upstream issues with mode detection in zsh](https://github.com/starship/starship/issues/625#issuecomment-732454148).
::: :::
### 選項 ### 選項
| Option | 預設 | 說明 | | Option | 預設 | 說明 |
| -------------------------- | -------------------- | --------------------------------------------------------------------------------------- | | --------------------------- | -------------------- | --------------------------------------------------------------------------------------- |
| `format` | `"$symbol "` | The format string used before the text input. | | `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. | | `success_symbol` | `"[](bold green)"` | The format string used before the text input if the previous command succeeded. |
| `error_symbol` | `"[](bold red)"` | The format string used before the text input if the previous command failed. | | `error_symbol` | `"[](bold red)"` | The format string used before the text input if the previous command failed. |
| `vicmd_symbol` | `"[](bold green)"` | The format string used before the text input if the shell is in vim normal mode. | | `vimcmd_symbol` | `"[](bold green)"` | The format string used before the text input if the shell is in vim normal mode. |
| `vicmd_replace_one_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. | | `vimcmd_replace_one_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim `replace_one` mode. |
| `vimcmd_replace_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. | | `vimcmd_replace_symbol` | `"[](bold purple)"` | The format string used before the text input if the shell is in vim replace mode. |
| `vimcmd_visual_symbol` | `"[](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. | | `vimcmd_visual_symbol` | `"[](bold yellow)"` | The format string used before the text input if the shell is in vim replace mode. |
| `disabled` | `false` | 停用 `character` 模組。 | | `disabled` | `false` | 停用 `character` 模組。 |
@ -2793,9 +2793,47 @@ The `rlang` module shows the currently installed version of [R](https://www.r-pr
format = "with [📐 $version](blue bold) " format = "with [📐 $version](blue bold) "
``` ```
## Raku
The `raku` module shows the currently installed version of [Raku](https://www.raku.org/). By default the module will be shown if any of the following conditions are met:
- The current directory contains a `META6.json` file
- The current directory contains a `.p6`, `.pm6`, `.raku`, `.rakumod` or `.pod6`
### 選項
| Option | 預設 | 說明 |
| ------------------- | ------------------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version-$vm_version )]($style)"` | The format string for the module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🦋 "` | The symbol used before displaying the version of Raku |
| `detect_extensions` | `["p6", "pm6", "pod6", "raku", "rakumod"]` | Which extensions should trigger this module. |
| `detect_files` | `["META6.json"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold 149"` | 這個模組的風格。 |
| `disabled` | `false` | Disables the `raku` module. |
### Variables
| 變數 | 範例 | 說明 |
| ---------- | ------ | ------------------------------------ |
| version | `v6.d` | The version of `raku` |
| vm_version | `moar` | The version of VM `raku` is built on |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
### 範例
```toml
# ~/.config/starship.toml
[raku]
format = "via [🦪 $version]($style) "
```
## Red ## Red
By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). 這個模組在下列其中一個條件達成時顯示: By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met:
- The current directory contains a file with `.red` or `.reds` extension - The current directory contains a file with `.red` or `.reds` extension
@ -2833,11 +2871,11 @@ symbol = "🔴 "
## Ruby ## Ruby
By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). 這個模組在下列其中一個條件達成時顯示: By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). The module will be shown if any of the following conditions are met:
- 目前資料夾中有一個 `Gemfile` 檔案 - The current directory contains a `Gemfile` file
- The current directory contains a `.ruby-version` file - The current directory contains a `.ruby-version` file
- 目前資料夾中有一個 `.rb` 檔案 - The current directory contains a `.rb` file
- The environment variables `RUBY_VERSION` or `RBENV_VERSION` are set - The environment variables `RUBY_VERSION` or `RBENV_VERSION` are set
Starship gets the current Ruby version by running `ruby -v`. Starship gets the current Ruby version by running `ruby -v`.
@ -2854,7 +2892,7 @@ Starship gets the current Ruby version by running `ruby -v`.
| `detect_folders` | `[]` | Which folders should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. |
| `detect_variables` | `["RUBY_VERSION", "RBENV_VERSION"]` | Which environment variables should trigger this module. | | `detect_variables` | `["RUBY_VERSION", "RBENV_VERSION"]` | Which environment variables should trigger this module. |
| `style` | `"bold red"` | 這個模組的風格。 | | `style` | `"bold red"` | 這個模組的風格。 |
| `disabled` | `false` | 停用 `ruby` 模組。 | | `disabled` | `false` | Disables the `ruby` module. |
### Variables ### Variables
@ -2877,10 +2915,10 @@ symbol = "🔺 "
## Rust ## Rust
By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). 這個模組在下列其中一個條件達成時顯示: By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). The module will be shown if any of the following conditions are met:
- 目前資料夾中有一個 `Cargo.toml` 檔案 - The current directory contains a `Cargo.toml` file
- 現在資料夾中包含一個檔案具有 `.rs` 副檔名 - The current directory contains a file with the `.rs` extension
### 選項 ### 選項
@ -2893,7 +2931,7 @@ By default the `rust` module shows the currently installed version of [Rust](htt
| `detect_files` | `["Cargo.toml"]` | Which filenames should trigger this module. | | `detect_files` | `["Cargo.toml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold red"` | 這個模組的風格。 | | `style` | `"bold red"` | 這個模組的風格。 |
| `disabled` | `false` | 停用 `rust` 模組。 | | `disabled` | `false` | Disables the `rust` module. |
### Variables ### Variables
@ -3219,7 +3257,7 @@ disabled = false
## Swift ## Swift
By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). 這個模組在下列其中一個條件達成時顯示: By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). 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 `Package.swift` file
- The current directory contains a file with the `.swift` extension - The current directory contains a file with the `.swift` extension
@ -3317,7 +3355,7 @@ format = "[🏎💨 $workspace]($style) "
## 時間 ## 時間
`time` 模組顯示目前的**當地**時間. `format` 設定值被 [`chrono`](https://crates.io/crates/chrono) crate 用來控制時間如何顯示。 請看 [chrono 的 strftime 文件](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html)來了解有那些選項可以使用。 The `time` module shows the current **local** time. The `format` configuration value is used by the [`chrono`](https://crates.io/crates/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) to see what options are available.
::: tip ::: tip
@ -3328,22 +3366,22 @@ format = "[🏎💨 $workspace]($style) "
### 選項 ### 選項
| Option | 預設 | 說明 | | Option | 預設 | 說明 |
| ----------------- | ----------------------- | ----------------------------------------------------------------------------------------------------- | | ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |
| `format` | `"at [$time]($style) "` | The format string for the module. | | `format` | `"at [$time]($style) "` | The format string for the module. |
| `use_12hr` | `false` | 啟用 12 小時格式。 | | `use_12hr` | `false` | Enables 12 hour formatting |
| `time_format` | 請看下列 | 用來顯示時間的 [chrono 格式字串](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html)。 | | `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. |
| `style` | `"bold yellow"` | 這個模組的時間的風格。 | | `style` | `"bold yellow"` | The style for the module time |
| `utc_time_offset` | `"local"` | 設定相對於 UTC 的時差。 Range from -24 &lt; x &lt; 24. 允許使用浮點數來表示 30/45 分鐘時差的時區。 | | `utc_time_offset` | `"local"` | Sets the UTC offset to use. Range from -24 &lt; x &lt; 24. Allows floats to accommodate 30/45 minute timezone offsets. |
| `disabled` | `true` | 停用 `time` 模組。 | | `disabled` | `true` | Disables the `time` module. |
| `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | | `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format |
If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. 不然的話,它會被預設為 `"%T"` Manually setting `time_format` will override the `use_12hr` setting. If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Otherwise, it defaults to `"%T"`. Manually setting `time_format` will override the `use_12hr` setting.
### Variables ### Variables
| 變數 | 範例 | 說明 | | 變數 | 範例 | 說明 |
| --------- | ---------- | ----------------------------------- | | --------- | ---------- | ----------------------------------- |
| 時間 | `13:08:10` | The current time. | | time | `13:08:10` | The current time. |
| style\* | | Mirrors the value of option `style` | | style\* | | Mirrors the value of option `style` |
*: This variable can only be used as a part of a style string *: This variable can only be used as a part of a style string
@ -3361,14 +3399,14 @@ utc_time_offset = "-5"
time_range = "10:00:00-14:00:00" time_range = "10:00:00-14:00:00"
``` ```
## 使用者名稱 ## Username
`username` 模組顯示現在使用中的使用者名稱。 這個模組在下列其中一個條件達成時顯示: The `username` module shows active user's username. The module will be shown if any of the following conditions are met:
- The current user is root/admin - The current user is root/admin
- 目前使用者並非登入時的使用者 - The current user isn't the same as the one that is logged in
- 使用者透過 SSH session 進行連線 - The user is currently connected as an SSH session
- 變數 `show_always` 被設為 true - The variable `show_always` is set to true
::: tip ::: tip
@ -3381,10 +3419,10 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, `
| Option | 預設 | 說明 | | Option | 預設 | 說明 |
| ------------- | ----------------------- | ------------------------------------------- | | ------------- | ----------------------- | ------------------------------------------- |
| `style_root` | `"bold red"` | The style used when the user is root/admin. | | `style_root` | `"bold red"` | The style used when the user is root/admin. |
| `style_user` | `"bold yellow"` | 非 root 使用者時使用的風格。 | | `style_user` | `"bold yellow"` | The style used for non-root users. |
| `format` | `"[$user]($style) in "` | The format for the module. | | `format` | `"[$user]($style) in "` | The format for the module. |
| `show_always` | `false` | 總是顯示 `username` 模組。 | | `show_always` | `false` | Always shows the `username` module. |
| `disabled` | `false` | 停用 `username` 模組。 | | `disabled` | `false` | Disables the `username` module. |
### Variables ### Variables
@ -3514,7 +3552,7 @@ format = "[🆅 $repo](bold blue) "
## Zig ## Zig
By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). 這個模組在下列其中一個條件達成時顯示: By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met:
- The current directory contains a `.zig` file - The current directory contains a `.zig` file
@ -3560,7 +3598,7 @@ These modules will be shown if any of the following conditions are met:
- The current directory contains a directory whose name is in `detect_folders` - The current directory contains a directory whose name is in `detect_folders`
- The current directory contains a file whose extension is in `detect_extensions` - The current directory contains a file whose extension is in `detect_extensions`
- The `when` command returns 0 - The `when` command returns 0
- The current Operating System (std::env::consts::OS) matchs with `os` field if defined. - The current Operating System (std::env::consts::OS) matches with `os` field if defined.
::: tip ::: tip
@ -3595,7 +3633,7 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt
| `command` | `""` | The command whose output should be printed. The command will be passed on stdin to the shell. | | `command` | `""` | The command whose output should be printed. The command will be passed on stdin to the shell. |
| `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. | | `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. |
| `shell` | | [See below](#custom-command-shell) | | `shell` | | [See below](#custom-command-shell) |
| `說明` | `"<custom module>"` | The description of the module that is shown when running `starship explain`. | | `description` | `"<custom module>"` | The description of the module that is shown when running `starship explain`. |
| `detect_files` | `[]` | The files that will be searched in the working directory for a match. | | `detect_files` | `[]` | The files that will be searched in the working directory for a match. |
| `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. | | `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. |
| `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. | | `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. |

View File

@ -256,11 +256,12 @@ Install the latest version for your system with the MSI-installers from the [rel
Install Starship using any of the following package managers: Install Starship using any of the following package managers:
| Repository | Instructions | | Repository | Instructions |
| -------------------------------------------------------------------------------- | --------------------------------------- | | -------------------------------------------------------------------------------------------- | --------------------------------------- |
| **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
| [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` | | [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` |
| [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` | | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
| [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json) | `scoop install starship` | | [Scoop](https://github.com/ScoopInstaller/Main/blob/master/bucket/starship.json) | `scoop install starship` |
| [winget](https://github.com/microsoft/winget-pkgs/tree/master/manifests/s/Starship/Starship) | `winget install --id Starship.Starship` |
</details> </details>