1
0
mirror of https://github.com/Llewellynvdm/starship.git synced 2024-05-31 15:40:51 +00:00

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

This commit is contained in:
Matan Kushner 2022-06-16 08:48:50 -04:00 committed by GitHub
parent c9f74f7f42
commit f2c73d65ee
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
44 changed files with 1517 additions and 635 deletions

View File

@ -206,6 +206,7 @@ $c\
$cmake\
$cobol\
$container\
$daml\
$dart\
$deno\
$dotnet\
@ -268,9 +269,9 @@ format = "$all$directory$character"
## AWS
The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. Alternatively, you can force this module to show the region and profile even when the credentials have not been setup with the `force_display` option. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file. This module also shows an expiration timer when using temporary credentials.
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.
The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is 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 the conditions above are not respected.
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.
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.
@ -537,19 +538,22 @@ 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.
`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).
:::
### Options
| Option | الافتراضي | الوصف |
| ---------------- | ------------------- | -------------------------------------------------------------------------------- |
| `format` | `"$symbol "` | The format string used before the text input. |
| `success_symbol` | `"[](bold green)"` | The format string used before the text input if the previous command succeeded. |
| `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. |
| `disabled` | `false` | Disables the `character` module. |
| Option | الافتراضي | الوصف |
| -------------------------- | -------------------- | --------------------------------------------------------------------------------------- |
| `format` | `"$symbol "` | The format string used before the text input. |
| `success_symbol` | `"[](bold green)"` | The format string used before the text input if the previous command succeeded. |
| `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. |
| `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_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. |
| `disabled` | `false` | Disables the `character` module. |
### Variables
@ -803,6 +807,44 @@ The `crystal` module shows the currently installed version of [Crystal](https://
format = "via [✨ $version](bold blue) "
```
## 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. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `daml.yaml` file
### Options
| Option | الافتراضي | الوصف |
| ------------------- | ---------------------------------- | ------------------------------------------------------------------------- |
| `format` | `via [$symbol($version )]($style)` | The format for the module. |
| `version_format` | `v${raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"Λ "` | A format string representing the symbol of Daml |
| `style` | `"bold cyan"` | The style for the module. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `detect_files` | `["daml.yaml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `disabled` | `false` | Disables the `daml` module. |
### Variables
| Variable | مثال | الوصف |
| --------- | -------- | ------------------------------------ |
| version | `v2.2.0` | The version of `daml` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
*: This variable can only be used as a part of a style string
### مثال
```toml
# ~/.config/starship.toml
[daml]
format = "via [D $version](bold bright-green) "
```
## Dart
The `dart` module shows the currently installed version of [Dart](https://dart.dev/). By default the module will be shown if any of the following conditions are met:
@ -1954,6 +1996,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | The format for the module. |
| `style` | `"cyan bold"` | The style for the module. |
| `context_aliases` | | Table of context aliases to display. |
| `user_aliases` | | Table of user aliases to display. |
| `disabled` | `true` | Disables the `kubernetes` module. |
### Variables
@ -1981,11 +2024,14 @@ disabled = false
"dev.local.cluster.k8s" = "dev"
".*/openshift-cluster/.*" = "openshift"
"gke_.*_(?P<var_cluster>[\\w-]+)" = "gke-$var_cluster"
[kubernetes.user_aliases]
"dev.local.cluster.k8s" = "dev"
"root/.*" = "root"
```
#### Regex Matching
Additional to simple aliasing, `context_aliases` also supports extended matching and renaming using regular expressions.
Additional to simple aliasing, `context_aliases` and `user_aliases` also supports extended matching and renaming using regular expressions.
The regular expression must match on the entire kube context, capture groups can be referenced using `$name` and `$N` in the replacement. This is more explained in the [regex crate](https://docs.rs/regex/1.5.4/regex/struct.Regex.html#method.replace) documentation.
@ -2388,7 +2434,7 @@ symbol = "☁️ "
## Package Version
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards` and `dart` packages.
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages.
- [**npm**](https://docs.npmjs.com/cli/commands/npm) The `npm` package version is extracted from the `package.json` present in the current directory
- [**Cargo**](https://doc.rust-lang.org/cargo/) The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
@ -2405,6 +2451,7 @@ The `package` module is shown when the current directory is the repository for a
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory
- [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory
- [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory
- [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory
- [**Dart**](https://pub.dev/) - The `dart` package version is extracted from the `pubspec.yaml` present in the current directory
> ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager.

View File

@ -251,6 +251,8 @@ Alternatively, install Starship using any of the following package managers:
<details>
<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).
Install Starship using any of the following package managers:
| Repository | Instructions |

View File

@ -206,6 +206,7 @@ $c\
$cmake\
$cobol\
$container\
$daml\
$dart\
$deno\
$dotnet\
@ -268,9 +269,9 @@ format = "$all$directory$character"
## AWS
The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. Alternatively, you can force this module to show the region and profile even when the credentials have not been setup with the `force_display` option. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file. This module also shows an expiration timer when using temporary credentials.
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.
The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is 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 the conditions above are not respected.
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.
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.
@ -537,19 +538,22 @@ 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.
`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).
:::
### Options
| Option | Default | Description |
| ---------------- | ------------------- | -------------------------------------------------------------------------------- |
| `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. |
| `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. |
| `disabled` | `false` | Disables the `character` module. |
| Option | Default | Description |
| -------------------------- | -------------------- | --------------------------------------------------------------------------------------- |
| `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. |
| `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. |
| `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_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. |
| `disabled` | `false` | Disables the `character` module. |
### Variables
@ -803,6 +807,44 @@ The `crystal` module shows the currently installed version of [Crystal](https://
format = "via [✨ $version](bold blue) "
```
## 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. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `daml.yaml` file
### Options
| Option | Default | Description |
| ------------------- | ---------------------------------- | ------------------------------------------------------------------------- |
| `format` | `via [$symbol($version )]($style)` | The format for the module. |
| `version_format` | `v${raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"Λ "` | A format string representing the symbol of Daml |
| `style` | `"bold cyan"` | The style for the module. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `detect_files` | `["daml.yaml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `disabled` | `false` | Disables the `daml` module. |
### Variables
| گۆڕاو | نموونە | Description |
| --------- | -------- | ------------------------------------ |
| version | `v2.2.0` | The version of `daml` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
*: This variable can only be used as a part of a style string
### نموونە
```toml
# ~/.config/starship.toml
[daml]
format = "via [D $version](bold bright-green) "
```
## Dart
The `dart` module shows the currently installed version of [Dart](https://dart.dev/). By default the module will be shown if any of the following conditions are met:
@ -1954,6 +1996,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | The format for the module. |
| `style` | `"cyan bold"` | The style for the module. |
| `context_aliases` | | Table of context aliases to display. |
| `user_aliases` | | Table of user aliases to display. |
| `disabled` | `true` | Disables the `kubernetes` module. |
### Variables
@ -1981,11 +2024,14 @@ disabled = false
"dev.local.cluster.k8s" = "dev"
".*/openshift-cluster/.*" = "openshift"
"gke_.*_(?P<var_cluster>[\\w-]+)" = "gke-$var_cluster"
[kubernetes.user_aliases]
"dev.local.cluster.k8s" = "dev"
"root/.*" = "root"
```
#### Regex Matching
Additional to simple aliasing, `context_aliases` also supports extended matching and renaming using regular expressions.
Additional to simple aliasing, `context_aliases` and `user_aliases` also supports extended matching and renaming using regular expressions.
The regular expression must match on the entire kube context, capture groups can be referenced using `$name` and `$N` in the replacement. This is more explained in the [regex crate](https://docs.rs/regex/1.5.4/regex/struct.Regex.html#method.replace) documentation.
@ -2388,7 +2434,7 @@ symbol = "☁️ "
## Package Version
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards` and `dart` packages.
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages.
- [**npm**](https://docs.npmjs.com/cli/commands/npm) The `npm` package version is extracted from the `package.json` present in the current directory
- [**Cargo**](https://doc.rust-lang.org/cargo/) The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
@ -2405,6 +2451,7 @@ The `package` module is shown when the current directory is the repository for a
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory
- [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory
- [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory
- [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory
- [**Dart**](https://pub.dev/) - The `dart` package version is extracted from the `pubspec.yaml` present in the current directory
> ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager.

View File

@ -247,6 +247,8 @@ Alternatively, install Starship using any of the following package managers:
<details>
<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).
Install Starship using any of the following package managers:
| Repository | Instructions |

View File

@ -206,6 +206,7 @@ $c\
$cmake\
$cobol\
$container\
$daml\
$dart\
$deno\
$dotnet\
@ -268,9 +269,9 @@ format = "$all$directory$character"
## AWS
The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. Alternatively, you can force this module to show the region and profile even when the credentials have not been setup with the `force_display` option. Dies basiert auf den Umgebungsvariablen: `AWS_REGION`, `AWS_DEFAULT_REGION`, `AWS_PROFILE` und der `~/.aws/config` Datei. This module also shows an expiration timer when using temporary credentials.
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.
The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is 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 the conditions above are not respected.
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.
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.
@ -537,19 +538,22 @@ By default it only changes color. If you also want to change its shape take a lo
::: warning
`vicmd_symbol` is only supported in cmd, fish and zsh.
`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).
:::
### Optionen
| Option | Standardwert | Beschreibung |
| ---------------- | ------------------- | -------------------------------------------------------------------------------- |
| `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. |
| `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. |
| `disabled` | `false` | Deaktiviert das `character`-Modul. |
| Option | Standardwert | Beschreibung |
| -------------------------- | -------------------- | --------------------------------------------------------------------------------------- |
| `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. |
| `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. |
| `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_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. |
| `disabled` | `false` | Deaktiviert das `character`-Modul. |
### Variables
@ -803,13 +807,51 @@ The `crystal` module shows the currently installed version of [Crystal](https://
format = "via [✨ $version](bold blue) "
```
## 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. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `daml.yaml` file
### Optionen
| Option | Standardwert | Beschreibung |
| ------------------- | ---------------------------------- | ------------------------------------------------------------------------- |
| `format` | `via [$symbol($version )]($style)` | Das Format für das Modul. |
| `version_format` | `v${raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"Λ "` | A format string representing the symbol of Daml |
| `style` | `"bold cyan"` | Stil für dieses Modul. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `detect_files` | `["daml.yaml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `disabled` | `false` | Disables the `daml` module. |
### Variables
| Variable | Beispiel | Beschreibung |
| --------- | -------- | ------------------------------------- |
| version | `v2.2.0` | The version of `daml` |
| symbol | | Spiegelt den Wert der Option `symbol` |
| style\* | | Spiegelt den Wert der Option `style` |
*: This variable can only be used as a part of a style string
### Beispiel
```toml
# ~/.config/starship.toml
[daml]
format = "via [D $version](bold bright-green) "
```
## Dart
The `dart` module shows the currently installed version of [Dart](https://dart.dev/). By default the module will be shown if any of the following conditions are met:
- The current directory contains a file with `.dart` extension
- The current directory contains a `.dart_tool` directory
- Das aktuelle Verzeichnis enthält `pubspec.yaml`, `pubspec.yml` oder `pubspec.lock`
- The current directory contains a `pubspec.yaml`, `pubspec.yml` or `pubspec.lock` file
### Optionen
@ -965,7 +1007,7 @@ The `docker_context` module shows the currently active [Docker context](https://
### Optionen
| Option | Standardwert | Beschreibung |
| Option | Standartwert | Beschreibung |
| ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `format` | `"via [$symbol$context]($style) "` | Das Format für das Modul. |
| `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. |
@ -1018,7 +1060,7 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
### Optionen
| Option | Standartwert | Beschreibung |
| Option | Standardwert | Beschreibung |
| ------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )(🎯 $tfm )]($style)"` | Das Format für das Modul. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
@ -1954,7 +1996,8 @@ Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `dis
| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | Das Format für das Modul. |
| `style` | `"cyan bold"` | Stil für dieses Modul. |
| `context_aliases` | | Table of context aliases to display. |
| `disabled` | `true` | Deaktiviert das `kubernetes`-Modul. |
| `user_aliases` | | Table of user aliases to display. |
| `disabled` | `true` | Disables the `kubernetes` module. |
### Variables
@ -1981,11 +2024,14 @@ disabled = false
"dev.local.cluster.k8s" = "dev"
".*/openshift-cluster/.*" = "openshift"
"gke_.*_(?P<var_cluster>[\\w-]+)" = "gke-$var_cluster"
[kubernetes.user_aliases]
"dev.local.cluster.k8s" = "dev"
"root/.*" = "root"
```
#### Regex Matching
Additional to simple aliasing, `context_aliases` also supports extended matching and renaming using regular expressions.
Additional to simple aliasing, `context_aliases` and `user_aliases` also supports extended matching and renaming using regular expressions.
The regular expression must match on the entire kube context, capture groups can be referenced using `$name` and `$N` in the replacement. This is more explained in the [regex crate](https://docs.rs/regex/1.5.4/regex/struct.Regex.html#method.replace) documentation.
@ -2388,7 +2434,7 @@ symbol = "☁️ "
## Paketversion
Das `Package` Modul wird angezeigt, wenn das aktuelle Verzeichnis das Repository für ein Paket ist, und zeigt dessen aktuelle Version an. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards` and `dart` packages.
Das `Package` Modul wird angezeigt, wenn das aktuelle Verzeichnis das Repository für ein Paket ist, und zeigt dessen aktuelle Version an. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages.
- [**npm**](https://docs.npmjs.com/cli/commands/npm) The `npm` package version is extracted from the `package.json` present in the current directory
- [**Cargo**](https://doc.rust-lang.org/cargo/) The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
@ -2405,6 +2451,7 @@ Das `Package` Modul wird angezeigt, wenn das aktuelle Verzeichnis das Repository
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory
- [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory
- [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory
- [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory
- [**Dart**](https://pub.dev/) - The `dart` package version is extracted from the `pubspec.yaml` present in the current directory
> ⚠️ Die angezeigte Version ist die des Pakets, dessen Quellcode im Verzeichnis liegt, nicht die des Paketmanagers.

View File

@ -251,6 +251,8 @@ Alternatively, install Starship using any of the following package managers:
<details>
<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).
Install Starship using any of the following package managers:
| Repository | Instructions |

View File

@ -183,7 +183,7 @@ El `format` predeterminado se utiliza para definir el formato del prompt, si est
```toml
format = "$all"
# El cual es equivalente a
# Which is equivalent to
format = """
$username\
$hostname\
@ -206,6 +206,7 @@ $c\
$cmake\
$cobol\
$container\
$daml\
$dart\
$deno\
$dotnet\
@ -268,9 +269,9 @@ format="$all$directory$character"
## AWS
El módulo `aws` muestra la región y el perfil actual de AWS cuando las credenciales, un `credential_process` o un `sso_start_url` se han configurado. Alternativamente, puedes forzar a este módulo a mostrar la región y el perfil incluso cuando las credenciales no han sido configuradas con la opción `force_display`. Éste se basa en las variables de entorno `AWS_REGION`, `AWS_DEFAULT_REGION`, y `AWS_PROFILE` del archivo `~/.aws/config`. Este módulo también muestra un temporizador de caducidad al usar credenciales temporales.
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.
El módulo mostrará un perfil solamente si sus credenciales están presentes en `~/.aws/credentials` o un `credential_process` está definido en `~/.aws/config`. Alternativamente, es suficiente con tener cualquiera de las siguientes variables de entorno `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, o `AWS_SESSION_TOKEN`. Si la opción `force_display` se establece en `true`, toda la información disponible será mostrada incluso si las condiciones anteriores no se respetan.
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.
Cuando se utiliza [aws-vault](https://github.com/99designs/aws-vault), el perfil se lee de la variable de entorno `AWS_VAULT` y la fecha de expiración de credenciales se lee de la variable de entorno `AWS_SESSION_EXPIRATION`.
@ -537,19 +538,22 @@ Por defecto sólo cambia el color. Si también se quiere cambiar su forma, ver [
::: warning
`vicmd_symbol` solo es compatible con cmd, fish y zsh.
`vicmd_symbol` solo es compatible con cmd, fish y 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).
:::
### Opciones
| Opción | Por defecto | Descripción |
| ---------------- | ------------------- | ------------------------------------------------------------------------------------------------------- |
| `format` | `"$symbol "` | La cadena de formato usada antes de la entrada de texto. |
| `success_symbol` | `"[](bold green)"` | La cadena de formato usada antes de la entrada de texto si el comando anterior tuvo éxito. |
| `error_symbol` | `"[](bold red)"` | La cadena de formato usada antes de la entrada de texto si el comando anterior falló. |
| `vicmd_symbol` | `"[](bold green)"` | El cadena de formato antes de la entrada de texto si el intérprete de comandos está en modo vim normal. |
| `disabled` | `false` | Desactiva el módulo `character`. |
| Opción | Por defecto | Descripción |
| -------------------------- | -------------------- | ------------------------------------------------------------------------------------------------------- |
| `format` | `"$symbol "` | La cadena de formato usada antes de la entrada de texto. |
| `success_symbol` | `"[](bold green)"` | La cadena de formato usada antes de la entrada de texto si el comando anterior tuvo éxito. |
| `error_symbol` | `"[](bold red)"` | La cadena de formato usada antes de la entrada de texto si el comando anterior falló. |
| `vicmd_symbol` | `"[](bold green)"` | El cadena de formato antes de la entrada de texto si el intérprete de comandos está en modo vim normal. |
| `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_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. |
| `disabled` | `false` | Desactiva el módulo `character`. |
### Variables
@ -803,6 +807,44 @@ El módulo `cristal` muestra la versión instalada de [Crystal](https://crystal-
format = "via [✨ $version](bold blue) "
```
## 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. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
- The current directory contains a `daml.yaml` file
### Opciones
| Opción | Por defecto | Descripción |
| ------------------- | ---------------------------------- | --------------------------------------------------------------------------------------- |
| `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` |
| `symbol` | `"Λ "` | A format string representing the symbol of Daml |
| `style` | `"bold cyan"` | El estilo del módulo. |
| `detect_extensions` | `[]` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `["daml.yaml"]` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
| `disabled` | `false` | Deshabilita el módulo `daml`. |
### Variables
| Variable | Ejemplo | Descripción |
| --------- | -------- | -------------------------------------- |
| version | `v2.2.0` | La versión de `daml` |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
*: Esta variable sólo puede ser usada como parte de una cadena de estilo
### Ejemplo
```toml
# ~/.config/starship.toml
[daml]
format = "via [D $version](bold bright-green) "
```
## Dart
El módulo `dart` muestra la versión instalada de [Dart](https://dart.dev/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones:
@ -813,7 +855,7 @@ El módulo `dart` muestra la versión instalada de [Dart](https://dart.dev/). Po
### Opciones
| Opción | Por defecto | Descripción |
| Opción | Predeterminado | Descripción |
| ------------------- | ------------------------------------------------- | --------------------------------------------------------------------------------------- |
| `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` |
@ -822,7 +864,7 @@ El módulo `dart` muestra la versión instalada de [Dart](https://dart.dev/). Po
| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[".dart_tool"]` | Qué carpetas deberían activar este módulo. |
| `style` | `"bold blue"` | El estilo del módulo. |
| `disabled` | `false` | Desactiva el módulo `dart`. |
| `disabled` | `false` | Deshabilita el módulo `dart`. |
### Variables
@ -899,7 +941,7 @@ Por ejemplo, dado `~/Dev/Nix/nixpkgs/pkgs` donde `nixpkgs` es la raíz del repos
| `read_only` | `"🔒"` | El símbolo que indica si el directorio actual es de sólo lectura. |
| `read_only_style` | `"red"` | El estilo para el símbolo de sólo lectura. |
| `truncation_symbol` | `""` | El símbolo a prefijar a las rutas truncadas. ej: "…/" |
| `repo_root_style` | `None` | El estilo para la raíz del repositorio de git. El valor por defecto es equivalente al `style`. |
| `repo_root_style` | `Ninguno` | El estilo para la raíz del repositorio de git. El valor por defecto es equivalente al `style`. |
| `repo_root_format` | `"[$before_root_path]($style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) "` | El formato de un repositorio de git cuando `repo_root_style` está definido. |
| `home_symbol` | `"~"` | El símbolo que indica el directorio personal. |
| `use_os_path_sep` | `true` | Utiliza el separador de ruta del sistema operativo específico en lugar de usar siempre `/` (por ejemplo, `\` en Windows) |
@ -907,9 +949,9 @@ Por ejemplo, dado `~/Dev/Nix/nixpkgs/pkgs` donde `nixpkgs` es la raíz del repos
<details>
<summary>Este módulo tiene algunas opciones avanzadas de configuración que controlan cómo se muestra el directorio.</summary>
| Opciones avanzadas | Predeterminado | Descripción |
| Opción avanzada | Predeterminado | Descripción |
| --------------------------- | -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `substitutions` | | Una tabla de sustituciones que se deben hacer a la ruta. |
| `sustituciones` | | Una tabla de sustituciones que se deben hacer a la ruta. |
| `fish_style_pwd_dir_length` | `0` | El número de caracteres a usar al aplicar la lógica de ruta pwd de la shell de fish. |
| `use_logical_path` | `true` | Si `true` renderiza la ruta lógica originada desde el intérprete de comandos a través de `PWD` o `--logical-path`. Si `false` en su lugar renderiza la ruta física del sistema de archivos con enlaces simbólicos resueltos. |
@ -943,7 +985,7 @@ Consideremos la ruta `/path/to/home/git_repo/src/lib`
| ------------------ | --------------------- | --------------------------------------------------- |
| before_root_path | `"/path/to/home/"` | La ruta antes de la ruta del directorio raíz de git |
| repo_root | `"git_repo"` | El nombre del directorio raíz de git |
| path | `"/src/lib"` | La ruta restante |
| ruta | `"/src/lib"` | La ruta restante |
| style | `"black bold dimmed"` | Refleja el valor de la opción `style` |
| repo_root_style | `"underline white"` | Estilo para el nombre del directorio raíz de git |
@ -959,7 +1001,7 @@ truncation_length = 8
truncation_symbol = "…/"
```
## Docker context
## Contexto de Docker
El módulo `docker_context` muestra el [contexto de Docker](https://docs.docker.com/engine/context/working-with-contexts/) actualmente activo si no está definido en `default` o si las variables de entorno `DOCKER_MACHINE_NAME`, `DOCKER_HOST` o `DOCKER_CONTEXT` están definidas (como se entiende para sobrescribir el contexto en uso).
@ -1157,13 +1199,13 @@ default = "unknown user"
### Opciones
| Opción | Por defecto | Descripción |
| ---------- | ------------------------------ | -------------------------------------------------------------------------------------- |
| `symbol` | `""` | El símbolo usado antes de mostrar el valor de la variable. |
| `variable` | | La variable de entorno a mostrar. |
| `default` | | El valor por defecto que se mostrará cuando la variable seleccionada no está definida. |
| `format` | `"with [$env_value]($style) "` | El formato del módulo. |
| `disabled` | `false` | Desactiva el módulo `env_var`. |
| Opción | Predeterminado | Descripción |
| ---------------- | ----------------------------- | -------------------------------------------------------------------------------------- |
| `symbol` | `""` | El símbolo usado antes de mostrar el valor de la variable. |
| `variable` | | La variable de entorno a mostrar. |
| `predeterminado` | | El valor por defecto que se mostrará cuando la variable seleccionada no está definida. |
| `format` | `"con [$env_value]($style) "` | El formato del módulo. |
| `disabled` | `false` | Desactiva el módulo `env_var`. |
### Variables
@ -1236,7 +1278,7 @@ El módulo `erlang` muestra la versión instalada de [Erlang/OTP](https://erlang
format = "via [e $version](bold red) "
```
## Llenar
## Rellenar
El módulo `fill` llena cualquier espacio extra en la línea con un símbolo. Si múltiples módulos `fill` están presentes en una línea, dividirán el espacio equitativamente entre ellos. Esto es útil para alinear otros módulos.
@ -1278,19 +1320,19 @@ El módulo `gcloud` muestra la configuración actual para el CLI de [`gcloud`](h
| `region_aliases` | | Tabla de alias de región a mostrar además del nombre GCP. |
| `project_aliases` | | Tabla de alias del proyecto a mostrar además del nombre GCP. |
| `style` | `"bold blue"` | El estilo del módulo. |
| `disabled` | `false` | Desactiva el módulo `gcloud`. |
| `disabled` | `false` | Deshabilita el módulo `gcloud`. |
### Variables
| Variable | Ejemplo | Descripción |
| --------- | ------------- | ----------------------------------------------------------------------------- |
| region | `us-central1` | La región GCP actual |
| account | `foo` | El perfil actual de GCP |
| dominio | `ejemplo.com` | El dominio actual del perfil GCP |
| project | | El proyecto GCP actual |
| active | `default` | El nombre de configuración activo escrito en `~/.config/gcloud/active_config` |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
| Variable | Ejemplo | Descripción |
| --------- | ---------------- | ----------------------------------------------------------------------------- |
| region | `us-central1` | La actual región GCP |
| cuenta | `foo` | El perfil actual de GCP |
| domain | `example.com` | El dominio actual del perfil GCP |
| proyecto | | El proyecto GCP actual |
| activo | `predeterminado` | El nombre de configuración activo escrito en `~/.config/gcloud/active_config` |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
*: Esta variable sólo puede ser usada como parte de una cadena de estilo
@ -1338,7 +1380,7 @@ format = 'on [$symbol$account(@$domain)(\($project\))]($style) '
very-long-project-name = "vlpn"
```
## Git Branch
## Rama Git
El módulo `git_branch` muestra la rama activa del repositorio en tu directorio actual.
@ -1353,7 +1395,7 @@ El módulo `git_branch` muestra la rama activa del repositorio en tu directorio
| `truncation_length` | `2^63 - 1` | Trunca una rama git a grafemas `N`. |
| `truncation_symbol` | `"…"` | El símbolo usado para indicar que un nombre de rama fue truncado. Puedes usar `""` para ningún símbolo. |
| `only_attached` | `false` | Mostrar solo el nombre de la rama cuando no esté en un estado `HEAD`. |
| `ignore_branches` | `[]` | Una lista de nombres para evitar mostrar. Útil para "master" o "main". |
| `ignore_branches` | `[]` | Una lista de nombres a evitar ser visualizados. Útil para "master" o "main". |
| `disabled` | `false` | Desactiva el módulo `git_branch`. |
### Variables
@ -1361,7 +1403,7 @@ El módulo `git_branch` muestra la rama activa del repositorio en tu directorio
| Variable | Ejemplo | Descripción |
| ------------- | -------- | -------------------------------------------------------------------------------------------------------------- |
| branch | `master` | El nombre de la rama actual, vuelve a `HEAD` si no hay ninguna rama actual (por ejemplo, git detached `HEAD`). |
| remote_name | `origin` | El nombre remoto. |
| remote_name | `origen` | El nombre remoto. |
| remote_branch | `master` | El nombre de la rama rastreada en `remote_name`. |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
@ -1394,7 +1436,7 @@ El módulo `git_commit` muestra el hash de la confirmación actual y también la
| `only_detached` | `true` | Mostrar solo el hash de la confirmación de git cuando esté en estado "detached `HEAD`" |
| `tag_disabled` | `true` | Deshabilita mostrar información de etiquetas en el módulo `git_commit`. |
| `tag_symbol` | `" 🏷 "` | Símbolo de etiqueta prefijando la información mostrada |
| `disabled` | `false` | Desactiva el módulo `git_commit`. |
| `disabled` | `false` | Deshabilita el módulo `git_commit`. |
### Variables
@ -1421,10 +1463,10 @@ El módulo `git_state` se mostrará en directorios que son parte de un repositor
### Opciones
| Opción | Por defecto | Descripción |
| Opción | Predeterminado | Descripción |
| -------------- | --------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| `rebase` | `"REBASING"` | Una cadena de formato que se muestra cuando un `rebase` está en progreso. |
| `merge` | `"MERGING"` | Una cadena de formato que se muestra cuando un `merge` está en progreso. |
| `fusionar` | `"FUSIONANDO"` | Una cadena de formato que se muestra cuando un `merge` está en progreso. |
| `revert` | `"REVERTING"` | Una cadena de formato mostrada cuando un `revert` está en progreso. |
| `cherry_pick` | `"CHERRY-PICKING"` | Una cadena de formato que se muestra cuando un `cherry-pick` está en progreso. |
| `bisect` | `"BISECTING"` | Una cadena de formato que se muestra cuando un `bisect` está en progreso. |
@ -1432,13 +1474,13 @@ El módulo `git_state` se mostrará en directorios que son parte de un repositor
| `am_or_rebase` | `"AM/REBASE"` | Una cadena de formato que se muestra cuando un ambiguo `apply-builbox` o `rebase` está en progreso. |
| `style` | `"bold yellow"` | El estilo del módulo. |
| `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | El formato del módulo. |
| `disabled` | `false` | Desactiva el módulo `git_state`. |
| `disabled` | `false` | Deshabilita el módulo `git_state`. |
### Variables
| Variable | Ejemplo | Descripción |
| ---------------- | ---------- | ------------------------------------- |
| state | `REBASING` | El estado actual del repositorio |
| state | `REBASING` | The current state of the repo |
| progress_current | `1` | El progreso de la operación actual |
| progress_total | `2` | El progreso total de la operación |
| style\* | | Refleja el valor de la opción `style` |
@ -1479,8 +1521,8 @@ Este módulo está deshabilitado por defecto. Para activarlo, establece `disable
| Variable | Ejemplo | Descripción |
| ----------------- | ------- | --------------------------------------------- |
| added | `1` | El número actual de líneas añadidas |
| deleted | `2` | El número actual de líneas eliminadas |
| añadido | `1` | El número actual de líneas añadidas |
| borrado | `2` | El número actual de líneas eliminadas |
| added_style\* | | Refleja el valor de la opción `added_style` |
| deleted_style\* | | Refleja el valor de la opción `deleted_style` |
@ -1510,18 +1552,18 @@ El módulo Git Status es muy lento en los directorios de Windows (por ejemplo ba
| Opción | Predeterminado | Descripción |
| ------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | El formato por defecto para `git_status` |
| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | El formato predeterminado para `git_status` |
| `conflicted` | `"="` | Esta rama tiene conflictos de fusión. |
| `ahead` | `"⇡"` | El formato de `ahead` |
| `behind` | `"⇣"` | El formato de `behind` |
| `diverged` | `"⇕"` | El formato de `diverged` |
| `up_to_date` | `""` | El formato de `up_to_date` |
| `untracked` | `"?"` | El formato de `untracked` |
| `sin seguimiento` | `"?"` | El formato de `untracked` |
| `stashed` | `"$"` | El formato de `stashed` |
| `modified` | `"!"` | El formato de `modified` |
| `modificado` | `"!"` | El formato de `modified` |
| `staged` | `"+"` | El formato de `staged` |
| `renamed` | `"»"` | El formato de `renamed` |
| `deleted` | `"✘"` | El formato de `deleted` |
| `eliminado` | `"✘"` | El formato de `deleted` |
| `style` | `"bold red"` | El estilo del módulo. |
| `ignore_submodules` | `false` | Ignorar cambios a los submódulos. |
| `disabled` | `false` | Desactiva el módulo `git_status`. |
@ -1531,18 +1573,18 @@ El módulo Git Status es muy lento en los directorios de Windows (por ejemplo ba
Las siguientes variables se pueden utilizar en `format`:
| Variable | Descripción |
| -------------- | ------------------------------------------------------------------------------------------------------------------------ |
| `all_status` | Atajo para `$conflicted$stashed$deleted$renamed$modified$staged$untracked` |
| `ahead_behind` | Muestra la cadena de formato de `diverged` `ahead` o `behind` o `up_to_date` basado en el estado actual del repositorio. |
| `conflicted` | Muestra `conflicted` cuando esta rama tiene conflictos de fusión. |
| `untracked` | Muestra `untracked` cuando hay archivos sin rastrear en el directorio de trabajo. |
| `stashed` | Muestra `stashed` cuando existe un "stash" para el repositorio local. |
| `modified` | Muestra `modified` cuando hay modificaciones de archivo en el directorio de trabajo. |
| `staged` | Muestra `staged` cuando se ha añadido un nuevo archivo al área de "stash". |
| `renamed` | Muestra `renamed` cuando un archivo renombrado ha sido añadido al área de "stash". |
| `deleted` | Muestra `deleted` cuando un archivo ha sido añadido al área de "stash". |
| style\* | Refleja el valor de la opción `style` |
| Variable | Descripción |
| ----------------- | ------------------------------------------------------------------------------------------------------------------------ |
| `all_status` | Atajo para `$conflicted$stashed$deleted$renamed$modified$staged$untracked` |
| `ahead_behind` | Muestra la cadena de formato de `diverged` `ahead` o `behind` o `up_to_date` basado en el estado actual del repositorio. |
| `conflicted` | Muestra `conflicted` cuando esta rama tiene conflictos de fusión. |
| `sin seguimiento` | Muestra `untracked` cuando hay archivos sin rastrear en el directorio de trabajo. |
| `stashed` | Muestra `stashed` cuando existe un "stash" para el repositorio local. |
| `modificado` | Muestra `modified` cuando hay modificaciones de archivo en el directorio de trabajo. |
| `staged` | Muestra `staged` cuando se ha añadido un nuevo archivo al área de "stash". |
| `renamed` | Muestra `renamed` cuando un archivo renombrado ha sido añadido al área de "stash". |
| `borrado` | Muestra `deleted` cuando un archivo ha sido añadido al área de "stash". |
| style\* | Refleja el valor de la opción `style` |
*: Esta variable sólo puede ser usada como parte de una cadena de estilo
@ -1695,7 +1737,7 @@ El módulo `helm` muestra la versión instalada de [Helm](https://helm.sh/). Por
| `detect_folders` | `[]` | Qué carpetas deberían activar estos módulos. |
| `symbol` | `"⎈ "` | Una cadena de formato que representa el símbolo de Helm. |
| `style` | `"bold white"` | El estilo del módulo. |
| `disabled` | `false` | Desactiva el módulo `helm`. |
| `disabled` | `false` | Deshabilita el módulo `helm`. |
### Variables
@ -1722,22 +1764,22 @@ El módulo `hostname` muestra el nombre de host del sistema.
### Opciones
| Opción | Por defecto | Descripción |
| ------------ | -------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ssh_only` | `true` | Mostrar sólo el nombre de host cuando esté conectado a una sesión SSH. |
| `ssh_symbol` | `"🌐 "` | Una cadena de formato que representa el símbolo cuando se conecta a la sesión SSH. |
| `trim_at` | `"."` | Cadena en la que el nombre del host se corta, después de la primera coincidencia. `"."` se detendrá después del primer punto. `""` deshabilitará cualquier truncamiento |
| `format` | `"[$ssh_symbol$nombre de host]($style) en "` | El formato del módulo. |
| `style` | `"negrita oscurecida verde"` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `hostname`. |
| Opción | Por defecto | Descripción |
| ------------ | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ssh_only` | `true` | Mostrar sólo el nombre de host cuando esté conectado a una sesión SSH. |
| `ssh_symbol` | `"🌐 "` | Una cadena de formato que representa el símbolo cuando se conecta a la sesión SSH. |
| `trim_at` | `"."` | Cadena en la que el nombre de host se corta, después de la primera partida. `"."` se detendrá después del primer punto. `""` deshabilitará cualquier truncamiento |
| `format` | `"[$ssh_symbol$hostname]($style) in "` | El formato del módulo. |
| `style` | `"bold dimmed green"` | El estilo del módulo. |
| `disabled` | `false` | Desactiva el módulo `hostname`. |
### Variables
| Variable | Ejemplo | Descripción |
| ---------- | ---------- | -------------------------------------------------------------- |
| hostname | `computer` | El nombre de host del ordenador |
| style\* | | Refleja el valor de la opción `style` |
| ssh_symbol | `"🌏 "` | El símbolo a representar cuando está conectado a la sesión SSH |
| Variable | Ejemplo | Descripción |
| --------------- | ------------- | -------------------------------------------------------------- |
| nombre del host | `computadora` | El nombre de host de la computadora |
| style\* | | Refleja el valor de la opción `style` |
| ssh_symbol | `"🌏 "` | El símbolo a representar cuando está conectado a la sesión SSH |
*: Esta variable sólo puede ser usada como parte de una cadena de estilo
@ -1771,7 +1813,7 @@ El módulo `java` muestra la versión instalada de [Java](https://www.oracle.com
| `detect_folders` | `[]` | Qué carpetas deberían activar estos módulos. |
| `symbol` | `"☕ "` | Una cadena de formato que representa el símbolo de Java |
| `style` | `"red dimmed"` | El estilo del módulo. |
| `disabled` | `false` | Desactiva el módulo `java`. |
| `disabled` | `false` | Deshabilita el módulo `java`. |
### Variables
@ -1798,7 +1840,7 @@ El módulo `jobs` muestra el número actual de tareas en ejecución. El módulo
La funcionalidad por defecto es:
- 0 tareas -> Nada se muestra.
- 0 tareas -> No se muestra nada.
- 1 tarea -> `symbol` se muestra.
- 2 tareas o más -> `symbol` + `number` son mostrados.
@ -1832,7 +1874,7 @@ La opción `threshold` está obsoleta, pero si deseas usarla, el módulo mostrar
| Variable | Ejemplo | Descripción |
| --------- | ------- | -------------------------------------- |
| number | `1` | El número de tareas |
| número | `1` | El número de tareas |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
@ -1859,7 +1901,7 @@ El módulo `julia` muestra la versión instalada de [Julia](https://julialang.or
### Opciones
| Opción | Por defecto | Descripción |
| Opción | Predeterminado | Descripción |
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
| `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` |
@ -1868,7 +1910,7 @@ El módulo `julia` muestra la versión instalada de [Julia](https://julialang.or
| `detect_folders` | `[]` | Qué carpetas deberían activar estos módulos. |
| `symbol` | `"ஃ "` | Una cadena de formato que representa el símbolo de Julia. |
| `style` | `"bold purple"` | El estilo del módulo. |
| `disabled` | `false` | Desactiva el módulo `julia`. |
| `disabled` | `false` | Deshabilita el módulo `julia`. |
### Variables
@ -1954,15 +1996,16 @@ Este módulo está deshabilitado por defecto. Para activarlo, establece `disable
| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | El formato del módulo. |
| `style` | `"cyan bold"` | El estilo del módulo. |
| `context_aliases` | | Tabla de alias de contexto a mostrar. |
| `user_aliases` | | Table of user aliases to display. |
| `disabled` | `true` | Desactiva el módulo `kubernetes`. |
### Variables
| Variable | Ejemplo | Descripción |
| --------- | -------------------- | ----------------------------------------------------------- |
| context | `starship-context` | El nombre del contexto actual de kubernetes |
| contexto | `starship-context` | El nombre del contexto actual de kubernetes |
| namespace | `starship-namespace` | Si se establece, el espacio de nombres actual de kubernetes |
| user | `starship-user` | Si se establece, el espacio de nombres actual de kubernetes |
| usuario | `starship-user` | Si se establece, el espacio de nombres actual de kubernetes |
| cluster | `starship-cluster` | Si se establece, el clúster actual de kubernetes |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
@ -1981,11 +2024,14 @@ disabled = false
"dev.local.cluster.k8s" = "dev"
".*/openshift-cluster/.*" = "openshift"
"gke_.*_(?P<var_cluster>[\\w-]+)" = "gke-$var_cluster"
[kubernetes.user_aliases]
"dev.local.cluster.k8s" = "dev"
"root/.*" = "root"
```
#### Busqueda por Regex
Adicional al alias simple, `context_aliases` también soporta coincidencias extendidas y renombradas usando expresiones regulares.
Additional to simple aliasing, `context_aliases` and `user_aliases` also supports extended matching and renaming using regular expressions.
La expresión regular debe coincidir en todo el contexto de kube. los grupos de captura pueden ser referenciados usando `$name` y `$N` en el reemplazo. Esto está más explicado en la documentación del [crate regex](https://docs.rs/regex/1.5.4/regex/struct.Regex.html#method.replace).
@ -2023,7 +2069,7 @@ El módulo `line_break` separa el indicador en dos líneas.
disabled = true
```
## Local IP
## IP local
El módulo `localip` muestra la dirección IPv4 de la interfaz de red principal.
@ -2097,7 +2143,7 @@ El módulo `lua` muestra la versión instalada de [Lua](http://www.lua.org/). Po
format = "via [🌕 $version](bold blue) "
```
## Memoria utilizada
## Uso de la memoria
El módulo `memory_usage` muestra la memoria del sistema actual y el uso de memoria de intercambio.
@ -2144,7 +2190,7 @@ symbol = " "
style = "bold dimmed green"
```
## Mercurial Branch
## Rama Mercurial
El módulo `hg_branch` muestra la rama activa del repositorio en su directorio actual.
@ -2163,7 +2209,7 @@ El módulo `hg_branch` muestra la rama activa del repositorio en su directorio a
| Variable | Ejemplo | Descripción |
| --------- | -------- | -------------------------------------- |
| branch | `master` | La rama de mercurial activa |
| rama | `master` | La rama mercurial activa |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
@ -2368,8 +2414,8 @@ El módulo `openstack` muestra la nube OpenStack actual y el proyecto. El módul
| Variable | Ejemplo | Descripción |
| --------- | ------- | -------------------------------------- |
| cloud | `corp` | La nube OpenStack actual |
| project | `dev` | El proyecto OpenStack actual |
| nube | `corp` | La nube OpenStack actual |
| proyecto | `dev` | El actual proyecto OpenStack |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
@ -2388,7 +2434,7 @@ symbol = "☁️ "
## Versión del paquete
El módulo `package` se muestra cuando el directorio actual es el repositorio de un paquete, y muestra su versión actual. El módulo actualmente admite los paquetes `npm`, `nimble`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards` y `dart`.
El módulo `package` se muestra cuando el directorio actual es el repositorio de un paquete, y muestra su versión actual. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages.
- [**npm**](https://docs.npmjs.com/cli/commands/npm) La versión del paquete `npm` se extrae del `package.json` presente en el directorio actual
- [**Cargo**](https://doc.rust-lang.org/cargo/) La versión del paquete `cargo` se extrae del `Cargo.toml` presente en el directorio actual
@ -2405,6 +2451,7 @@ El módulo `package` se muestra cuando el directorio actual es el repositorio de
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - La versión del paquete `shards` se extrae de `shard.yml` presente en el directorio actual
- [**V**](https://vlang.io) - La versión del paquete `vlang` se extrae de `v.mod` presente en el directorio actual
- [**SBT**](https://scala-sbt.org) - La versión del paquete `sbt` se extrae del archivo `build.sbt` presente en el directorio actual
- [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory
- [**Dart**](https://pub.dev/) - La versión del paquete `dart` se extrae del archivo `pubspec.yaml` presente en el directorio actual
> ⚠️ La versión que se muestra es la del paquete cuyo código fuente está en tu directorio actual, no en tu gestor de paquetes.
@ -2763,7 +2810,7 @@ Por defecto, el módulo `red` muestra la versión actualmente instalada de [Red]
| `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
| `style` | `"red bold"` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `rojo`. |
| `disabled` | `false` | Deshabilita el módulo `red`. |
### Variables
@ -2942,7 +2989,7 @@ Este módulo está deshabilitado por defecto. Para activarlo, establece `disable
| Variable | Predeterminado | Descripción |
| --------- | -------------- | ------------------------------------------------------------------------------------ |
| indicator | | Ordena el valor de `indicator` para el intérprete de comandos actualmente utilizado. |
| indicador | | Ordena el valor de `indicator` para el intérprete de comandos actualmente utilizado. |
| style\* | | Refleja el valor de la opción `style`. |
*: Esta variable sólo puede ser usada como parte de una cadena de estilo
@ -2971,7 +3018,7 @@ El módulo `shlvl` muestra la variable de entorno [`SHLVL`](https://tldp.org/LDP
| `threshold` | `2` | Mostrar umbral. |
| `format` | `"[$symbol$shlvl]($style) "` | El formato del módulo. |
| `symbol` | `"↕️ "` | El símbolo utilizado para representar el `SHLVL`. |
| `repeat` | `false` | Hace que el `symbol` se repita con la cantidad actual de `SHLVL`. |
| `repetir` | `false` | Hace que el `symbol` se repita con la cantidad actual de `SHLVL`. |
| `style` | `"bold yellow"` | El estilo del módulo. |
| `disabled` | `true` | Desactiva el módulo `shlvl`. |
@ -3007,7 +3054,7 @@ El módulo `singularity` muestra la imagen de [singularity](https://sylabs.io/si
| `format` | `'[$symbol\[$env\]]($style) '` | El formato del módulo. |
| `symbol` | `""` | Una cadena de formato que se muestra antes del nombre de la imagen. |
| `style` | `"bold dimmed blue"` | El estilo del módulo. |
| `disabled` | `false` | Desactiva el módulo `singularity`. |
| `disabled` | `false` | Deshabilita el módulo `singularity`. |
### Variables
@ -3061,7 +3108,7 @@ El módulo `spack` muestra el entorno actual [Spack](https://spack.readthedocs.i
format = "[$symbol$environment](dimmed blue) "
```
## Status
## Estado
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.
@ -3073,28 +3120,28 @@ Este módulo está deshabilitado por defecto. Para activarlo, establece `disable
### Opciones
| Opción | Por defecto | Descripción |
| ----------------------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------- |
| `format` | `"[$symbol$status]($style) "` | El formato del módulo |
| `symbol` | `"✖"` | El símbolo mostrado en el error del programa |
| `success_symbol` | `""` | El símbolo mostrado en el éxito del programa |
| `not_executable_symbol` | `"🚫"` | El símbolo mostrado cuando el archivo no es ejecutable |
| `not_found_symbol` | `"🔍"` | El símbolo mostrado cuando no se encuentra el comando |
| `sigint_symbol` | `"🧱"` | El símbolo mostrado en SIGINT (Ctrl + c) |
| `signal_symbol` | `"⚡"` | El símbolo mostrado en cualquier señal |
| `style` | `"bold red"` | El estilo del módulo. |
| `recognize_signal_code` | `true` | Habilita el mapeo de señales desde el código de salida |
| `map_symbol` | `false` | Habilita el mapeo de símbolos desde el código de salida |
| `pipestatus` | `false` | Habilita el reporte de pipstatus |
| `pipestatus_separator` | `|` | |
| `pipestatus_format` | `\\[$pipestatus\\] => [$symbol$common_meaning$signal_name$maybe_int]($style)` | El formato del módulo cuando el comando es un pipeline |
| `disabled` | `true` | Deshabilita el módulo `status`. |
| Opción | Por defecto | Descripción |
| ----------------------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------ |
| `format` | `"[$symbol$status]($style) "` | El formato del módulo |
| `symbol` | `"✖"` | El símbolo mostrado en error del programa |
| `success_symbol` | `""` | El símbolo mostrado en el éxito del programa |
| `not_executable_symbol` | `"🚫"` | El símbolo mostrado cuando el archivo no es ejecutable |
| `not_found_symbol` | `"🔍"` | El símbolo mostrado cuando no se encuentra el comando |
| `sigint_symbol` | `"🧱"` | El símbolo mostrado en SIGINT (Ctrl + c) |
| `signal_symbol` | `"⚡"` | El símbolo mostrado en cualquier señal |
| `style` | `"bold red"` | El estilo del módulo. |
| `recognize_signal_code` | `true` | Activar mapeo de señales desde el código de salida |
| `map_symbol` | `false` | Activar mapeo de símbolos desde el código de salida |
| `pipestatus` | `false` | Habilita el reporte de pipstatus |
| `pipestatus_separator` | `|` | |
| `pipestatus_format` | `\\[$pipestatus\\] => [$symbol$common_meaning$signal_name$maybe_int]($style)` | El formato del módulo cuando el comando es un pipeline |
| `disabled` | `true` | Desactiva el módulo `status`. |
### Variables
| Variable | Ejemplo | Descripción |
| -------------- | ------- | ------------------------------------------------------------------------------------------------------------------ |
| status | `127` | El código de salida del último comando |
| estado | `127` | El código de salida del último comando |
| hex_status | `0x7F` | El código de salida del último comando en hexadecimal |
| int | `127` | El código de salida del último comando |
| common_meaning | `ERROR` | Comprobación del código si no es una señal |
@ -3133,13 +3180,13 @@ Este módulo está deshabilitado por defecto. Para activarlo, establece `disable
### Opciones
| Opción | Por defecto | Descripción |
| --------------- | ----------------------- | -------------------------------------------------------------------------------- |
| `format` | `[as $symbol]($style)"` | El formato del módulo |
| `symbol` | `"🧙 "` | El símbolo mostrado cuando las credenciales se almacenan en caché |
| `style` | `"bold blue"` | El estilo del módulo. |
| `allow_windows` | `false` | Como Windows no tiene sudo por defecto, el valor por defecto está deshabilitado. |
| `disabled` | `true` | Deshabilita el módulo `sudo`. |
| Opción | Por defecto | Descripción |
| --------------- | ----------------------- | ------------------------------------------------------------------------------------------------ |
| `format` | `[as $symbol]($style)"` | El formato del módulo |
| `symbol` | `"🧙 "` | El símbolo mostrado cuando las credenciales se almacenan en caché |
| `style` | `"bold blue"` | El estilo del módulo. |
| `allow_windows` | `false` | Como Windows no tiene sudo de manera predeterminada, el valor predeterminado está deshabilitado. |
| `disabled` | `true` | Deshabilita el módulo `sudo`. |
### Variables
@ -3162,7 +3209,7 @@ disabled = false
```
```toml
# En Windows
# On windows
# $HOME\.starship\config.toml
[sudo]
@ -3188,7 +3235,7 @@ Por defecto, el módulo `swift` muestra la versión instalada de [Swift](https:/
| `detect_files` | `["Package.swift"]` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. |
| `style` | `"bold 202"` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `swift`. |
| `disabled` | `false` | Desactiva el módulo `swift`. |
### Variables
@ -3230,21 +3277,21 @@ 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. |
| `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 terraform. |
| `symbol` | `"💠"` | Una cadena de formato que se muestra antes del espacio de trabajo de terraform. |
| `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_folders` | `[".terraform"]` | Qué carpetas deberían activar este módulo. |
| `style` | `"bold 105"` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `terraform`. |
| `disabled` | `false` | Desactiva el módulo `terraform`. |
### Variables
| Variable | Ejemplo | Descripción |
| --------- | ---------- | ----------------------------------------- |
| version | `v0.12.24` | La versión de `terraform` |
| workspace | `default` | El espacio de trabajo actual de Terraform |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
| Variable | Ejemplo | Descripción |
| --------- | ---------------- | ----------------------------------------- |
| version | `v0.12.24` | La versión de `terraform` |
| workspace | `predeterminado` | El espacio de trabajo actual de Terraform |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | | Refleja el valor de la opción `style` |
*: Esta variable sólo puede ser usada como parte de una cadena de estilo
@ -3284,11 +3331,11 @@ Este módulo está deshabilitado por defecto. Para activarlo, establece `disable
| ----------------- | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `format` | `"at [$time]($style) "` | La cadena de formato para el módulo. |
| `use_12hr` | `false` | Habilita el formato de 12 horas |
| `time_format` | ver abajo | La [cadena de formato de chrono](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) utilizada para dar formato a la hora. |
| `style` | `"bold yellow"` | El estilo para el módulo de time |
| `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. |
| `style` | `"bold yellow"` | El estilo para la hora del módulo |
| `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. |
| `disabled` | `true` | Deshabilita el módulo `time`. |
| `time_range` | `"-"` | Establece el intervalo de tiempo durante el cual se mostrará el módulo. Las horas deben especificarse en formato de 24 horas |
| `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 |
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`.
@ -3296,7 +3343,7 @@ Si `use_12hr` es `true`, entonces `time_format` por defecto `"%r"`. De lo contra
| Variable | Ejemplo | Descripción |
| --------- | ---------- | ------------------------------------- |
| time | `13:08:10` | La hora actual. |
| hora | `13:08:10` | La hora actual. |
| style\* | | Refleja el valor de la opción `style` |
*: Esta variable sólo puede ser usada como parte de una cadena de estilo
@ -3314,7 +3361,7 @@ utc_time_offset = "-5"
time_range = "10:00:00-14:00:00"
```
## Username
## Nombre de usuario
El módulo `username` muestra el nombre de usuario activo. El módulo se muestra si algunas de las siguientes condiciones se cumplen:
@ -3337,14 +3384,14 @@ La conexión SSH se detecta comprobando las variables de entorno `SSH_CONNECTION
| `style_user` | `"bold yellow"` | El estilo usado para usuarios no root. |
| `format` | `"[$user]($style) in "` | El formato del módulo. |
| `show_always` | `false` | Siempre muestra el módulo `username`. |
| `disabled` | `false` | Deshabilita el módulo `username`. |
| `disabled` | `false` | Desactiva el módulo `username`. |
### Variables
| Variable | Ejemplo | Descripción |
| -------- | ------------ | --------------------------------------------------------------------------------------------------- |
| `style` | `"red bold"` | Refleja el valor de la opción `style_root` cuando root inició sesión y `style_user` por otra parte. |
| `user` | `"matchai"` | El ID de usuario conectado actualmente. |
| 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. |
| `usuario` | `"matchai"` | El ID de usuario conectado actualmente. |
### Ejemplo
@ -3367,7 +3414,7 @@ El módulo `vagrant` muestra la versión instalada de [Vagrant](https://www.vagr
### Opciones
| Opción | Por defecto | Descripción |
| Opción | Predeterminado | Descripción |
| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
| `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` |
@ -3448,11 +3495,11 @@ El módulo `vcsh` muestra el repositorio activo [VCSH](https://github.com/RichiH
### Variables
| Variable | Ejemplo | Descripción |
| --------- | ----------------------------------------------------------- | -------------------------------------- |
| repo | `dotfiles` si está en un repositorio VCSH nombrado dotfiles | El nombre del repositorio activo |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | `black bold dimmed` | Refleja el valor de la opción `style` |
| Variable | Ejemplo | Descripción |
| ----------- | ----------------------------------------------------------- | -------------------------------------- |
| repositorio | `dotfiles` si está en un repositorio VCSH nombrado dotfiles | El nombre del repositorio activo |
| symbol | | Refleja el valor de la opción `symbol` |
| style\* | `black bold dimmed` | Refleja el valor de la opción `style` |
*: Esta variable sólo puede ser usada como parte de una cadena de estilo
@ -3545,28 +3592,28 @@ Las cadenas de formato también pueden contener secuencias específicas del int
| Opción | Predeterminado | Descripción |
| ------------------- | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `command` | `""` | El comando cuya salida debe ser impresa. El comando se pasará en stdin al intérprete de comandos. |
| `command` | `""` | El comando cuya salida debe ser impresa. El comando se pasará en stdin al 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`. |
| `shell` | | [Ver abajo](#custom-command-shell) |
| `description` | `"<custom module>"` | La descripción del módulo que se muestra al ejecutar `starship explain`. |
| `descripción` | `"<custom module>"` | La descripción del módulo que se muestra al ejecutar `starship explain`. |
| `detect_files` | `[]` | Los archivos que se buscarán en el directorio de trabajo para obtener una coincidencia. |
| `detect_folders` | `[]` | Los directorios que se buscarán en el directorio de trabajo para una coincidencia. |
| `detect_extensions` | `[]` | Las extensiones que se buscarán en el directorio de trabajo para obtener una coincidencia. |
| `symbol` | `""` | El símbolo usado antes de mostrar la salida del comando. |
| `style` | `"bold green"` | El estilo del módulo. |
| `format` | `"[$symbol($output )]($style)"` | El formato del módulo. |
| `disabled` | `false` | Deshabilita este `módulo personalizado`. |
| `disabled` | `false` | Deshabilita este módulo `custom`. |
| `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). |
| `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. |
| `ignore_timeout` | `false` | Ignorar la configuración global de `command_timeout` y seguir ejecutando comandos externos, sin importar el tiempo que tarden. |
### Variables
| Variable | Descripción |
| --------- | ----------------------------------------------------------- |
| output | La salida del comando del intérprete de comandos en `shell` |
| symbol | Refleja el valor de la opción `symbol` |
| style\* | Refleja el valor de la opción `style` |
| Variable | Descripción |
| --------- | ----------------------------------------- |
| output | La salida del comando de shell en `shell` |
| symbol | Refleja el valor de la opción `symbol` |
| style\* | Refleja el valor de la opción `style` |
*: Esta variable sólo puede ser usada como parte de una cadena de estilo

View File

@ -251,6 +251,8 @@ Alternativamente, instale Starship usando cualquiera de los siguientes gestores
<details>
<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).
Instalar Starship usando cualquiera de los siguientes gestores de paquetes:
| Repositorio | Instrucciones |

View File

@ -183,7 +183,7 @@ Le `format` par défaut est utilisé pour définir le format de l'invite, si il
```toml
format = "$all"
# Ce qui est équivalent à
# Which is equivalent to
format = """
$username\
$hostname\
@ -206,6 +206,7 @@ $c\
$cmake\
$cobol\
$container\
$daml\
$dart\
$deno\
$dotnet\
@ -268,9 +269,9 @@ format = "$all$directory$character"
## AWS
Le module `aws` affiche la région et le profil AWS actuelle quand des identifiants, un `credential_process` ou une `sso_start_url` ont été configurées. Vous pouvez aussi forcer ce module à afficher la région et le profil, même quand les identifiants nont pas été configurés, avec loption `force_display`. Il se base sur les variables denvironnement `AWS_REGION`, `AWS_DEFAULT_REGION` et `AWS_PROFILE` avec un fichier `~/.aws/config`. Ce module montre aussi un minuteur dexpiration lors de lutilisation didentifiants temporaires.
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.
Le module naffichera un profil que si ses identifiants sont présents dans `~/.aws/credentials` ou si un `credential_process` est définie dans `~/.aws/config`. Sinon, avoir lune des variables denvironnement `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` ou `AWS_SESSION_TOKEN` définie est suffisant. Si loption `force_display` est définie à `true`, toutes les informations disponibles seront affichées même si les conditions ne sont pas respectées.
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.
Lorsque vous utilisez [aws-vault](https://github.com/99designs/aws-vault) le profil est lu à partir de la variable d'environnement `AWS_VAULT` et la date d'expiration des identifiants est lue à partir de la variable d'environnement `AWS_SESSION_EXPIRATION`.
@ -537,19 +538,22 @@ Par défaut, il ne change que la couleur. Si vous désirez également changer sa
::: warning
`vicmd_symbol` nest supporté que dans cmd, fish et zsh.
`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).
:::
### Options
| Option | Défaut | Description |
| ---------------- | ------------------- | ----------------------------------------------------------------------------- |
| `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. |
| `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. |
| `disabled` | `false` | Désactive le module `character`. |
| Option | Défaut | Description |
| -------------------------- | -------------------- | --------------------------------------------------------------------------------------- |
| `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. |
| `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. |
| `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_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. |
| `disabled` | `false` | Désactive le module `character`. |
### Variables
@ -803,13 +807,51 @@ Le module `crystal` affiche la version actuellement installée de [Crystal](http
format = "via [✨ $version](bold blue) "
```
## 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. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- The current directory contains a `daml.yaml` file
### Options
| Option | Défaut | Description |
| ------------------- | ---------------------------------- | ------------------------------------------------------------------------------------------ |
| `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` |
| `symbol` | `"Λ "` | A format string representing the symbol of Daml |
| `style` | `"bold cyan"` | Le style du module. |
| `detect_extensions` | `[]` | Quelles extensions devraient activer ce module. |
| `detect_files` | `["daml.yaml"]` | Les fichiers qui activent ce module. |
| `detect_folders` | `[]` | Les dossiers qui activent ce module. |
| `disabled` | `false` | Disables the `daml` module. |
### Variables
| Variable | Exemple | Description |
| --------- | -------- | -------------------------------------- |
| version | `v2.2.0` | The version of `daml` |
| symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` |
*: Cette variable peut uniquement être utilisée dans une chaine de style
### Exemple
```toml
# ~/.config/starship.toml
[daml]
format = "via [D $version](bold bright-green) "
```
## Dart
Le module `dart` affiche la version actuellement installée de [Dart](https://dart.dev/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le dossier courant contient un fichier avec lextension `.dart`
- Le dossier courant contient un fichier `.dart_tool`
- Le dossier courant contient un fichier `pubsepc.yaml`, `pubspec.yml` ou `pubspec.lock`
- Le répertoire courant contient un fichier `.dart`
- Le répertoire courant contient un répertoire `.dart_tool`
- Le répertoire courant contient un fichier `pubspec.yaml`, `pubspec.yml` ou `pubspec.lock`
### Options
@ -847,7 +889,7 @@ format = "via [🔰 $version](bold red) "
Le module `deno` affiche la version actuellement installée de [Deno](https://deno.land/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le dossier courant contient un fichier `deno.json`, `deno.jsonc`, `mod.ts`, `mod.js`, `deps.ts` ou `deps.js`
- Le répertoire actuel contient un fichier `deno.json`, `deno.jsonc`, `mod.ts`, `mod.ts`, `mod.js`, `deps.ts`, ou `deps.js`
### Options
@ -1056,11 +1098,11 @@ heuristic = false
Le module `elixir` montre la version actuellement installée de [Elixir](https://elixir-lang.org/) et [Erlang/OTP](https://erlang.org/doc/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le dossier courant contient un fichier `mix.exs`.
- Le répertoire courant contient un fichier `mix.exs`.
### Options
| Option | Défaut | Description |
| Option | Défault | Description |
| ------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------------------------ |
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | Format du module elixir. |
| `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` |
@ -1095,15 +1137,15 @@ symbol = "🔮 "
Le module `elm` montre la version actuellement installée de [Elm](https://elm-lang.org/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le dossier courant contient un fichier `elm.json`
- Le dossier courant contient un fichier `elm-package.json`
- Le dossier courant contient un fichier `elm-version`
- Le dossier courant contient un dossier `elm-stuff`
- Le répertoire courant contient un fichier `elm.json`
- Le répertoire courant contient un fichier `elm-package.json`
- Le répertoire courant contient un fichier `elm-version`
- Le répertoire courant contient un dossier `elm-stuff`
- Le dossier courant contient des fichiers `*.elm`
### Options
| Option | Défault | Description |
| Option | Défaut | Description |
| ------------------- | -------------------------------------------------- | ------------------------------------------------------------------------------------------ |
| `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` |
@ -1682,7 +1724,7 @@ Par défaut le module sera activé si au moins l'une des conditions suivantes es
Le module `helm` montre la version actuellement installée de [Helm](https://helm.sh/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le dossier courant contient un fichier `helmfile.yaml`
- Le dossier courant contient un fichier `Chart.yaml`
- Le répertoire courant contient un fichier `Chart.yml`
### Options
@ -1757,8 +1799,8 @@ disabled = false
Le module `java` affiche la version actuellement installée de [Java](https://www.oracle.com/java/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le dossier courant contient un fichier `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `.deps.edn`, `project.clj`ou `build.boot`
- Le dossier courant contient un fichier avec lextension `.java`, `.class`, `.gradle`, `.jar`, `.clj` ou `.cljc`
- Le répertoire actuel contient un fichier `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `.deps.edn`, `project.clj`, ou `build.boot`
- Le répertoire actuel contient un fichier avec l'extension `.java`, `.class`, `. gradle`, `.jar`, `.clj`, ou `.cljc`
### Options
@ -1853,9 +1895,9 @@ symbol_threshold = 0
Le module `julia` affiche la version actuellement installée de [Julia](https://julialang.org/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le dossier courant contient un fichier `Project.toml`
- Le dossier courant contient un fichier `Manifest.toml`
- Le dossier courant contient un fichier `.jl`
- Le répertoire courant contient un fichier `Project.toml`
- Le répertoire courant contient un fichier `Manifest.toml`
- Le répertoire actuel contient un fichier avec l'extension `.jl`
### Options
@ -1893,7 +1935,7 @@ symbol = "∴ "
Le module `kotlin` affiche la version actuellement installée de [Kotlin](https://kotlinlang.org/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le dossier courant contient un fichier `.kt` ou `.kts`
- Le répertoire courant contient un fichier `.kt` ou `.kts`
### Options
@ -1938,7 +1980,7 @@ kotlin_binary = "kotlinc"
## Kubernetes
Afficher le nom du [contexte Kubernetes](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context) courant, et, si défini, lespace de nom, lutilisateur, et le cluster depuis le fichier kubeconfig. L'espace de noms doit être défini dans le fichier kubeconfig, ce qui peut être fait via `kubectl config set-context starship-cluster --namespace astronaut`. De même, l'utilisateur et l'instance peuvent être définies avec `kubectl config set-context starship-context --user starship-user` et `kubectl config set-context starship-context --cluster starship-cluster`. Si la variable d'environnement `$KUBECONFIG` est définie, le module l'utilisera, sinon il utilisera le fichier `~/.kube/config`.
Afficher le nom du [contexte Kubernetes](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context) courant, et, si défini, lespace de nom, lutilisateur, et le cluster depuis le fichier kubeconfig. L'espace de noms doit être défini dans le fichier kubeconfig, ce qui peut être fait via `kubectl config set-context starship-cluster --namespace astronaut`. De même, l'utilisateur et l'instance peuvent être définies avec `kubectl config set-context starship-context --user starship-user` et `kubectl config set-context starship-context --cluster starship-cluster`. Si la variable d'environnement `$KUBECONFIG` est définie, le module l'utilisera sinon il utilisera le fichier `~/.kube/config`.
::: tip
@ -1954,6 +1996,7 @@ Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur
| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | Format du module. |
| `style` | `"cyan bold"` | Le style du module. |
| `context_aliases` | | Tableau des alias de contexte à afficher. |
| `user_aliases` | | Table of user aliases to display. |
| `disabled` | `true` | Désactiver le module `kubernetes`. |
### Variables
@ -1961,7 +2004,7 @@ Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur
| Variable | Exemple | Description |
| --------- | -------------------- | ------------------------------------------------ |
| context | `starship-context` | Le nom du contexte de kubernetes actuel |
| namespace | `starship-namespace` | Si défini, l'espace de noms de kubernetes actuel |
| namespace | `starship-namespace` | Si défini, l'espace de noms actuel de kubernetes |
| user | `starship-user` | Si défini, lutilisateur de kubernetes actuel |
| cluster | `starship-cluster` | Si défini, le cluster de kubernetes actuel |
| symbol | | Reflète la valeur de l'option `symbol` |
@ -1981,11 +2024,14 @@ disabled = false
"dev.local.cluster.k8s" = "dev"
".*/openshift-cluster/.*" = "openshift"
"gke_.*_(?P<var_cluster>[\\w-]+)" = "gke-$var_cluster"
[kubernetes.user_aliases]
"dev.local.cluster.k8s" = "dev"
"root/.*" = "root"
```
#### Filtrage par regex
En plus des alias simples, `context_aliases` gère aussi un filtrage avancé et le renommage en utilisant des expressions rationnelles.
Additional to simple aliasing, `context_aliases` and `user_aliases` also supports extended matching and renaming using regular expressions.
Lexpression rationnelle doit correspondre au contexte kube entier, et des groupes de capture peuvent être référencés en utilisant `$name` et `$N` dans la valeur de remplacement. Ceci est expliqué plus en détails dans la documentation de [la crate regex](https://docs.rs/regex/1.5.4/regex/struct.Regex.html#method.replace).
@ -2060,9 +2106,9 @@ disabled = false
Le module `lua` affiche la version actuellement installée de [Lua](http://www.lua.org/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le dossier courant contient un fichier `.lua-version`
- Le dossier courant contient un dossier `lua`
- Le dossier courant contient un fichier avec lextension `.lua`
- Le répertoire courant contient un fichier `.lua-version`
- Le répertoire courant contient un répertoire `lua`
- Le répertoire actuel contient un fichier avec l'extension `.lua`
### Options
@ -2185,9 +2231,9 @@ truncation_symbol = ""
Le module `nim` affiche la version actuellement installée de [Nim](https://nim-lang.org/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le dossier courant contient un fichier `nim.cfg`
- Le dossier courant contient un fichier avec lextension `.nim`
- Le dossier courant contient un fichier avec lextension `.nims`
- Le dossier courant contient un fichier avec lextension `.nimble`
- Le répertoire actuel contient un fichier avec l'extension `.nim`
- Le répertoire actuel contient un fichier avec l'extension `.nims`
- Le répertoire actuel contient un fichier avec l'extension `.nimble`
### Options
@ -2265,10 +2311,10 @@ format = 'via [☃️ $state( \($name\))](bold blue) '
Le module `nodejs` affiche la version actuellement installée de [Node.js](https://nodejs.org/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le dossier courant contient un fichier `package.json`
- Le dossier courant contient un fichier `.node-version`
- Le dossier courant contient un fichier `.nvmrc`
- Le répertoire courant contient un fichier `.node-version`
- Le répertoire courant contient un fichier `.nvmrc`
- Le répertoire courant contient un répertoire `node_modules`
- Le dossier courant contient un fichier avec lextension `.js`, `.mjs` ou `.cjs`
- Le répertoire actuel contient un fichier avec l'extension `.js`, `.mjs` ou `.cjs`
- Le dossier courant contient un fichier avec lextension `.ts`, `.mts` ou `.cts`
### Options
@ -2308,12 +2354,12 @@ format = "via [🤖 $version](bold green) "
Le module `ocaml` affiche la version actuellement installée de [OCaml](https://ocaml.org/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le dossier courant contient un fichier avec lextension `.opam` ou un dossier `_opam`
- Le répertoire courant contient un fichier avec l'extension `.opam` ou le répertoire `_opam`
- Le répertoire courant contient un répertoire `esy.lock`
- Le dossier courant contient un fichier `dune` ou `dune-project`
- Le dossier courant contient un fichier `jbuild` ou `jbuild-ignore`
- Le dossier courant contient un fichier `.merlin`
- Le dossier courant contient un fichier avec lextension `.ml`, `.mli`, `.re` ou `.rei`
- Le répertoire courant contient un fichier `dune` ou `dune-project`
- Le répertoire courant contient un fichier `jbuild` ou `jbuild-ignore`
- Le répertoire courant contient un fichier `.merlin`
- Le répertoire actuel contient un fichier avec l'extension `.ml`, `.mli`, `.re` ou `.rei`
### Options
@ -2388,7 +2434,7 @@ symbol = "☁️ "
## Version du package
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards` and `dart` packages.
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages.
- [**npm**](https://docs.npmjs.com/cli/commands/npm) La version du paquet `npm` est extraite du `package.json` présent dans le répertoire courant
- [**Cargo**](https://doc.rust-lang.org/cargo/) La version du paquet `cargo` est extraite du `Cargo.toml` présent dans le répertoire courant
@ -2405,6 +2451,7 @@ The `package` module is shown when the current directory is the repository for a
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory
- [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory
- [**SBT**](https://scala-sbt.org) - La version du paquet `sbt` est extraite du `build.sbt` présent dans le dossier courant
- [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory
- [**Dart**](https://pub.dev/) La version du paquet `dart` est extrait du `pubspec.yaml` présent dans le répertoire courant
> ⚠️ La version montrée est celle du paquet dont le code source est dans votre dossier courant, pas votre gestionnaire de paquet.
@ -2443,10 +2490,10 @@ format = "via [🎁 $version](208 bold) "
Le module `perl` affiche la version actuellement installée de [Perl](https://www.perl.org/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le dossier courant contient un fichier `Makefile.PL` ou `Build.PL`
- Le dossier courant contient un fichier `cpanfile` ou `cpanfile.snapshot`
- Le dossier courant contient un fichier `META.json` ou `META.yml`
- Le dossier courant contient un fichier `.perl-version`
- Le répertoire courant contient un fichier `Makefile.PL` ou `Build.PL`
- Le répertoire courant contient un fichier `cpanfile` ou `cpanfile.snapshot`
- Le répertoire courant contient un fichier `META.json` ou `META.yml`
- Le répertoire courant contient un fichier `.perl-version`
- Le répertoire courant contient un fichier `.pl`, `.pm` ou `.pod`
### Options
@ -2484,7 +2531,7 @@ format = "via [🦪 $version]($style) "
Le module `php` affiche la version actuellement installée de [PHP](https://www.php.net/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le dossier courant contient un fichier `composer.json`
- Le dossier courant contient un fichier `.php-version`
- Le répertoire courant contient un fichier `.php-version`
- Le répertoire courant contient un fichier avec l'extension `.php`
### Options
@ -2580,8 +2627,8 @@ format = "[$symbol$stack]($style) "
Le module `purescript` affiche la version actuellement installée de [PureScript](https://www.purescript.org/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le dossier courant contient un fichier `spago.dhall`
- Le dossier courant contient un fichier avec lextension `.purs`
- Le répertoire courant contient un fichier `spago.dhall`
- Le répertoire actuel contient un fichier avec l'extension `.purs`
### Options
@ -2623,14 +2670,14 @@ Si `pyenv_version_name` est défini à `true`, il affichera le nom de la version
Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le dossier courant contient un fichier `.python-version`
- Le dossier courant contient un fichier `Pipfile`
- Le dossier courant contient un fichier `__init__.py`
- Le répertoire courant contient un fichier `.python-version`
- Le répertoire courant contient un fichier `Pipfile`
- Le répertoire courant contient un fichier `__init__.py`
- Le dossier courant contient un fichier `pyproject.toml`
- Le dossier courant contient un fichier `requirements.txt`
- Le dossier courant contient un fichier `setup.py`
- Le dossier courant contient un fichier `tox.ini`
- Le dossier courant contient un fichier avec lextension `.py`.
- Le répertoire actuel contient un fichier avec l'extension `.py`.
- Un environnement virtuel est actuellement activé
### Options
@ -2709,12 +2756,12 @@ python_binary = ["./venv/bin/python", "python", "python3", "python2"]
Le module `rlang` affiche la version de [R](https://www.r-project.org/) actuellement installée. Le module saffiche si lune de ces conditions est remplie :
- Le dossier courant contient un fichier avec lextension `.R`.
- Le dossier courant contient un fichier avec lextension `.Rd`.
- Le dossier courant contient un fichier avec lextension `.Rmd`.
- Le dossier courant contient un fichier avec lextension `.Rproj`.
- Le dossier courant contient un fichier avec lextension `.Rsx`.
- Le dossier courant contient un fichier `.Rprofile`
- Le répertoire actuel contient un fichier avec l'extension `.R`.
- Le répertoire actuel contient un fichier avec l'extension `.Rd`.
- Le répertoire actuel contient un fichier avec l'extension `.Rmd`.
- Le répertoire actuel contient un fichier avec l'extension `.Rproj`.
- Le répertoire actuel contient un fichier avec l'extension `.Rsx`.
- Le répertoire courant contient un fichier `.Rprofile`
- Le répertoire courant contient un dossier `.Rproj.user`
### Options
@ -2749,9 +2796,9 @@ format = "with [📐 $version](blue bold) "
## Red
Par défaut, le module `red` affiche la version actuellement installée de [Red](https://www.red-lang.org/). Le module est affiché si l'une de ces conditions est remplie :
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:
- Le dossier courant contient un fichier avec lextension `.red` ou `.reds`
- Le répertoire actuel contient un fichier avec l'extension `.red` ou `.reds`
### Options
@ -2789,9 +2836,9 @@ symbol = "🔴 "
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:
- Le dossier courant contient un fichier `Gemfile`
- Le dossier courant contient un fichier `.ruby-version`
- Le dossier courant contient un fichier `.rb`
- Le répertoire courant contient un fichier `Gemfile`
- Le répertoire courant contient un fichier `.ruby-version`
- Le répertoire courant contient un fichier `.rb`
- La variable denvironnement `RUBY_VERSION` ou `RBENV_VERSION` est définie
Starship obtient la version actuelle de Ruby en exécutant `ruby -v`.
@ -2831,10 +2878,10 @@ symbol = "🔺 "
## Rust
Par défaut, le module `rust` affiche la version actuellement installée de [Rust](https://www.rust-lang.org/). Le module est affiché si l'une de ces conditions est remplie :
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:
- Le dossier courant contient un fichier `Cargo.toml`
- Le dossier courant contient un fichier avec lextension `.rs`
- Le répertoire courant contient un fichier `Cargo.toml`
- Le répertoire actuel contient un fichier avec l'extension `.rs`
### Options
@ -2874,8 +2921,8 @@ format = "via [⚙️ $version](red bold)"
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:
- Le dossier courant contient un fichier `build.sbt`, `.scalaenv` ou `.sbtenv`
- Le dossier courant contient un fichier avec lextension `.scala` ou `.sbt`
- Le répertoire courant contient un fichier `build.sbt`, `.scalaenv` ou `.sbtenv`
- Le répertoire actuel contient un fichier avec l'extension `.scala` ou `.sbt`
- Le répertoire courant contient un répertoire nommé `.metals`
### Options
@ -2924,13 +2971,13 @@ Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur
| Option | Défaut | Description |
| ---------------------- | ------------------------- | ----------------------------------------------------------- |
| `bash_indicator` | `bsh` | Chaine de formatage utilisée pour représenter bash. |
| `fish_indicator` | `fsh` | Chaine de formatage utilisée pour représenter fish. |
| `zsh_indicator` | `zsh` | Chaine de formatage utilisée pour représenter zsh. |
| `powershell_indicator` | `psh` | Chaine de formatage utilisée pour représenter powershell. |
| `ion_indicator` | `ion` | Chaine de formatage utilisée pour représenter ion. |
| `elvish_indicator` | `esh` | Chaine de formatage utilisée pour représenter elvish. |
| `tcsh_indicator` | `tsh` | Chaine de formatage utilisée pour représenter tcsh. |
| `bash_indicator` | `bsh` | Une chaîne de format utilisée pour représenter bash. |
| `fish_indicator` | `fsh` | Une chaîne de format utilisée pour représenter fish. |
| `zsh_indicator` | `zsh` | Une chaîne de format utilisée pour représenter zsh. |
| `powershell_indicator` | `psh` | Une chaîne de format utilisée pour représenter powershell. |
| `ion_indicator` | `ion` | Une chaîne de format utilisée pour représenter ion. |
| `elvish_indicator` | `esh` | Une chaîne de format utilisée pour représenter elvish. |
| `tcsh_indicator` | `tsh` | Une chaîne de format utilisée pour représenter tcsh. |
| `xonsh_indicator` | `xsh` | Chaine de formatage utilisée pour représenter xonsh. |
| `cmd_indicator` | `cmd` | Chaine de formatage utilisée pour représenter cmd. |
| `nu_indicator` | `nu` | Chaine de formatage utilisée pour représenter nu. |
@ -3173,10 +3220,10 @@ disabled = false
## Swift
Par défaut, le module `swift` affiche la version actuellement installée de [Swift](https://swift.org/). Le module est affiché si l'une de ces conditions est remplie :
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:
- Le dossier courant contient un fichier `Package.swift`
- Le dossier courant contient un fichier avec lextension `.swift`
- Le répertoire courant contient un fichier `Package.swift`
- Le répertoire actuel contient un fichier avec l'extension `.swift`
### Options
@ -3222,8 +3269,8 @@ Par défaut, la version de Terraform nest pas affichée, car elle est lente p
Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- Le dossier courant contient un dossier `.terraform`
- Le dossier courant contient un fichier avec lextension `.tf`, `.tfplan` ou `.tfstate`
- Le répertoire courant contient un dossier `.terraform`
- Le répertoire courant contient un fichier avec lextension `.tf`, `.tfplan` ou `.tfstate`
### Options
@ -3317,7 +3364,7 @@ time_range = "10:00:00-14:00:00"
## Nom d'utilisateur
Le module `username` affiche le nom d'utilisateur de l'utilisateur actif. Le module est affiché si l'une de ces conditions est remplie :
Le module `username` affiche le nom d'utilisateur de l'utilisateur actif. Le module sera affiché si l'une de ces conditions est remplie:
- L'utilisateur courant est root/admin
- L'utilisateur courant est différent de celui connecté
@ -3364,7 +3411,7 @@ show_always = true
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:
- Le dossier courant contient un fichier `Vagrantfile`
- Le répertoire courant contient un fichier `Vagrantfile`
### Options
@ -3402,8 +3449,8 @@ format = "via [⍱ $version](bold white) "
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:
- Le dossier courant contient un fichier avec lextension `.v`
- Le dossier courant contient un fichier `v.mod`, `vpkg.json` ou `.vpkg-lock.json`
- Le répertoire courant contient un fichier avec l'extension `.v`
- Le répertoire courant contient un fichier `v.mod`, `vpkg.json` ou `.vpkg-lock.json`
### Options
@ -3468,9 +3515,9 @@ format = "[🆅 $repo](bold blue) "
## Zig
Par défaut, le module `zig` affiche la version actuellement installée de [Zig](https://ziglang.org/). Le module est affiché si l'une de ces conditions est remplie :
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:
- Le dossier courant contient un fichier `.zip`
- Le répertoire courant contient un fichier `.zig`
### Options

View File

@ -251,6 +251,8 @@ Vous pouvez aussi installer Starship en utilisant lun de ces gestionnaires de
<details>
<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).
Installez Starship en utilisant lun de ces gestionnaires de paquets:
| Dépôt | Instructions |
@ -264,7 +266,7 @@ Installez Starship en utilisant lun de ces gestionnaires de paquets:
### Étape 2. Configurer votre shell pour Starship
Configurez votre shell pour initialiser starship. Sélectionnez le vôtre dans la liste ci-dessous:
Configurez votre shell pour initialiser starship. Sélectionnez le vôtre dans la liste ci-dessous:
<details>
<summary>Bash</summary>
@ -280,7 +282,7 @@ eval "$(starship init bash)"
<details>
<summary>Cmd</summary>
Vous devez utiliser [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) avec Cmd. Créez le fichier `%LocalAppData%\clink\starship.lua` avec le contenu suivant:
Vous devez utiliser [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) avec Cmd. Créez un fichier avec le chemin `%LocalAppData%\clink\starship.lua` et le contenu suivant:
```lua
load(io.popen('starship init cmd'):read("*a"))()

View File

@ -206,6 +206,7 @@ $c\
$cmake\
$cobol\
$container\
$daml\
$dart\
$deno\
$dotnet\
@ -268,9 +269,9 @@ format = "$all$directory$character"
## AWS
The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. Alternatively, you can force this module to show the region and profile even when the credentials have not been setup with the `force_display` option. Diperoleh dari variabel environment `AWS_REGION`, `AWS_DEFAULT_REGION`, dan `AWS_PROFILE` pada file `~/.aws/config`. Modul ini juga menampilkan penghitung waktu mundur kedaluwarsa ketika menggunakan temporer kredensial.
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.
The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is 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 the conditions above are not respected.
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.
Ketika menggunakan [aws-vault](https://github.com/99designs/aws-vault), profil dibaca dari variabel environment `AWS_VAULT` dan tanggal kedaluwarsanya dibaca dari variabel environment `AWS_SESSION_EXPIRATION`.
@ -537,19 +538,22 @@ Secara bawaan karakter hanya dapat mengganti warna. Jika kamu juga ingin menggan
::: warning
`vicmd_symbol` is only supported in cmd, fish and zsh.
`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).
:::
### Opsi
| Opsi | Bawaan | Deskripsi |
| ---------------- | ------------------- | ------------------------------------------------------------------------------------------------- |
| `fromat` | `"$symbol "` | Format string yang digunakan sebelum masukan teks. |
| `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. |
| `vicmd_symbol` | `"[](bold green)"` | Format string yang digunakan sebelum masukan teks jika shell sedang dalam vim dengan mode normal. |
| `disabled` | `false` | Menonaktifkan module `character`. |
| Opsi | Bawaan | Deskripsi |
| -------------------------- | -------------------- | ------------------------------------------------------------------------------------------------- |
| `fromat` | `"$symbol "` | Format string yang digunakan sebelum masukan teks. |
| `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. |
| `vicmd_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_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. |
| `disabled` | `false` | Menonaktifkan module `character`. |
### Variabel
@ -803,6 +807,44 @@ Modul `crystal` menampilkan versi terkini dari [Crystal](https://crystal-lang.or
format = "via [✨ $version](bold blue) "
```
## 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. Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:
- The current directory contains a `daml.yaml` file
### Opsi
| Opsi | Bawaan | Deskripsi |
| ------------------- | ---------------------------------- | ----------------------------------------------------------------------------------- |
| `fromat` | `via [$symbol($version )]($style)` | Format dari modul. |
| `version_format` | `v${raw}` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"Λ "` | A format string representing the symbol of Daml |
| `style` | `"bold cyan"` | Gaya penataan untuk modul. |
| `detect_extensions` | `[]` | Ekstensi mana yang sebaiknya memicu modul ini. |
| `detect_files` | `["daml.yaml"]` | filenames mana yang sebaiknya memicu modul ini. |
| `detect_folders` | `[]` | Folder mana yang sebaiknya memicul modul ini. |
| `disabled` | `false` | Disables the `daml` module. |
### Variabel
| Variabel | Contoh | Deskripsi |
| --------- | -------- | --------------------------------- |
| version | `v2.2.0` | The version of `daml` |
| symbol | | Menyalin nilai dari opsi `symbol` |
| style\* | | Menyalin nilai dari opsi `style` |
*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string
### Contoh
```toml
# ~/.config/starship.toml
[daml]
format = "via [D $version](bold bright-green) "
```
## Dart
Modul `dart` menampilkan versi terkini dari [Dart](https://dart.dev/) yang terpasang. Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi:
@ -855,7 +897,7 @@ Modul `deno` menampilkan versi terkini dari [Deno](https://deno.land/) yang terp
| ------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| `fromat` | `"via [$symbol($version )]($style)"` | Format dari modul. |
| `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
| `symbol` | `🦕 "` | Sebuah format string yang melambangkan simbol Deno |
| `symbol` | `"🦕 "` | Sebuah format string yang melambangkan simbol Deno |
| `detect_extensions` | `[]` | Ekstensi mana yang sebaiknya memicu modul ini. |
| `detect_files` | `["deno.json", "deno.jsonc", "mod.ts", "mod.js", "deps.ts", "deps.js"]` | filenames mana yang sebaiknya memicu modul ini. |
| `detect_folders` | `[]` | Folder mana yang sebaiknya memicul modul ini. |
@ -1954,6 +1996,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| `fromat` | `'[$symbol$context( \($namespace\))]($style) in '` | Format dari modul. |
| `style` | `"cyan bold"` | Gaya penataan untuk modul. |
| `context_aliases` | | Table of context aliases to display. |
| `user_aliases` | | Table of user aliases to display. |
| `disabled` | `true` | Disables the `kubernetes` module. |
### Variabel
@ -1981,11 +2024,14 @@ disabled = false
"dev.local.cluster.k8s" = "dev"
".*/openshift-cluster/.*" = "openshift"
"gke_.*_(?P<var_cluster>[\\w-]+)" = "gke-$var_cluster"
[kubernetes.user_aliases]
"dev.local.cluster.k8s" = "dev"
"root/.*" = "root"
```
#### Regex Matching
Additional to simple aliasing, `context_aliases` also supports extended matching and renaming using regular expressions.
Additional to simple aliasing, `context_aliases` and `user_aliases` also supports extended matching and renaming using regular expressions.
The regular expression must match on the entire kube context, capture groups can be referenced using `$name` and `$N` in the replacement. This is more explained in the [regex crate](https://docs.rs/regex/1.5.4/regex/struct.Regex.html#method.replace) documentation.
@ -2388,7 +2434,7 @@ symbol = "☁️ "
## Package Version
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards` and `dart` packages.
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages.
- [**npm**](https://docs.npmjs.com/cli/commands/npm) The `npm` package version is extracted from the `package.json` present in the current directory
- [**Cargo**](https://doc.rust-lang.org/cargo/) The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
@ -2405,6 +2451,7 @@ The `package` module is shown when the current directory is the repository for a
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory
- [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory
- [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory
- [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory
- [**Dart**](https://pub.dev/) - The `dart` package version is extracted from the `pubspec.yaml` present in the current directory
> ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager.

View File

@ -251,6 +251,8 @@ Alternatively, install Starship using any of the following package managers:
<details>
<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).
Install Starship using any of the following package managers:
| Repository | Instructions |

View File

@ -206,6 +206,7 @@ $c\
$cmake\
$cobol\
$container\
$daml\
$dart\
$deno\
$dotnet\
@ -268,9 +269,9 @@ format = "$all$directory$character"
## AWS
The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. Alternatively, you can force this module to show the region and profile even when the credentials have not been setup with the `force_display` option. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file. This module also shows an expiration timer when using temporary credentials.
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.
The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is 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 the conditions above are not respected.
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.
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.
@ -537,19 +538,22 @@ By default it only changes color. If you also want to change its shape take a lo
::: warning
`vicmd_symbol` is only supported in cmd, fish and zsh.
`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).
:::
### Opzioni
| Opzione | Default | Descrizione |
| ---------------- | ------------------- | -------------------------------------------------------------------------------- |
| `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. |
| `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. |
| `disabled` | `false` | Disables the `character` module. |
| Opzione | Default | Descrizione |
| -------------------------- | -------------------- | --------------------------------------------------------------------------------------- |
| `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. |
| `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. |
| `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_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. |
| `disabled` | `false` | Disables the `character` module. |
### Variables
@ -803,6 +807,44 @@ The `crystal` module shows the currently installed version of [Crystal](https://
format = "via [✨ $version](bold blue) "
```
## 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. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `daml.yaml` file
### Opzioni
| Opzione | Default | Descrizione |
| ------------------- | ---------------------------------- | -------------------------------------------------------------------------------------------- |
| `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` |
| `symbol` | `"Λ "` | A format string representing the symbol of Daml |
| `style` | `"bold cyan"` | Lo stile per il modulo. |
| `detect_extensions` | `[]` | Quali estensioni dovrebbero attivare questo modulo. |
| `detect_files` | `["daml.yaml"]` | Quali nomi di file dovrebbero attivare questo modulo. |
| `detect_folders` | `[]` | Quali cartelle dovrebbero attivare questo modulo. |
| `disabled` | `false` | Disables the `daml` module. |
### Variables
| Variable | Esempio | Descrizione |
| --------- | -------- | ------------------------------------ |
| version | `v2.2.0` | The version of `daml` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
*: This variable can only be used as a part of a style string
### Esempio
```toml
# ~/.config/starship.toml
[daml]
format = "via [D $version](bold bright-green) "
```
## Dart
The `dart` module shows the currently installed version of [Dart](https://dart.dev/). By default the module will be shown if any of the following conditions are met:
@ -1954,6 +1996,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | The format for the module. |
| `style` | `"cyan bold"` | Lo stile per il modulo. |
| `context_aliases` | | Table of context aliases to display. |
| `user_aliases` | | Table of user aliases to display. |
| `disabled` | `true` | Disables the `kubernetes` module. |
### Variables
@ -1981,11 +2024,14 @@ disabled = false
"dev.local.cluster.k8s" = "dev"
".*/openshift-cluster/.*" = "openshift"
"gke_.*_(?P<var_cluster>[\\w-]+)" = "gke-$var_cluster"
[kubernetes.user_aliases]
"dev.local.cluster.k8s" = "dev"
"root/.*" = "root"
```
#### Regex Matching
Additional to simple aliasing, `context_aliases` also supports extended matching and renaming using regular expressions.
Additional to simple aliasing, `context_aliases` and `user_aliases` also supports extended matching and renaming using regular expressions.
The regular expression must match on the entire kube context, capture groups can be referenced using `$name` and `$N` in the replacement. This is more explained in the [regex crate](https://docs.rs/regex/1.5.4/regex/struct.Regex.html#method.replace) documentation.
@ -2388,7 +2434,7 @@ symbol = "☁️ "
## Package Version
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards` and `dart` packages.
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages.
- [**npm**](https://docs.npmjs.com/cli/commands/npm) The `npm` package version is extracted from the `package.json` present in the current directory
- [**Cargo**](https://doc.rust-lang.org/cargo/) The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
@ -2405,6 +2451,7 @@ The `package` module is shown when the current directory is the repository for a
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory
- [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory
- [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory
- [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory
- [**Dart**](https://pub.dev/) - The `dart` package version is extracted from the `pubspec.yaml` present in the current directory
> ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager.

View File

@ -251,6 +251,8 @@ Alternatively, install Starship using any of the following package managers:
<details>
<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).
Install Starship using any of the following package managers:
| Repository | Instructions |

View File

@ -207,6 +207,7 @@ $c\
$cmake\
$cobol\
$container\
$daml\
$dart\
$deno\
$dotnet\
@ -269,9 +270,9 @@ format = "$all$directory$character"
## AWS
`aws`モジュールは、`credential_process`または`sso_start_url`が設定されている場合、現在のAWSリージョンとプロファイルを表示します。 また、認証情報が設定されていない場合でも`force_display`オプションを利用して、このモジュールにリージョンとプロファイルを強制的に表示させることができます。 これは `~/.aws/config` に記述されている `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` 環境変数に基づいています。 This module also shows an expiration timer when using temporary credentials.
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.
The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is 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. 上記の条件を満たさない場合でも、`force_display`を`true`にすると、利用可能なすべての情報が表示されます。
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.
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.
@ -349,16 +350,16 @@ Enterprise_Naming_Scheme-voidstars = 'void**'
## Azure
The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription, as defined in the `~/.azure/azureProfile.json` file.
`azure` モジュールは、現在のAzureサブスクリプションを表示します。 これは、 `~/.azure/azureProfile.json` ファイルで定義されているデフォルトのサブスクリプションの名前の表示に基づいています。
### オプション
| 変数 | デフォルト | 説明 |
| ---------- | ---------------------------------------- | ------------------------------------------ |
| `format` | `"on [$symbol($subscription)]($style) "` | The format for the Azure module to render. |
| `symbol` | `"ﴃ "` | The symbol used in the format. |
| `style` | `"blue bold"` | The style used in the format. |
| `disabled` | `true` | Disables the `azure` module. |
| 変数 | デフォルト | 説明 |
| ---------- | ---------------------------------------- | ----------------------- |
| `format` | `"on [$symbol($subscription)]($style) "` | Azure module のフォーマットです。 |
| `symbol` | `"ﴃ "` | フォーマットで使用される記号です。 |
| `style` | `"blue bold"` | フォーマットで使用されるスタイルです。 |
| `disabled` | `true` | `azure`モジュールを無効にします。 |
### 設定例
@ -536,19 +537,22 @@ format = "via [$name $version]($style)"
::: warning
`vicmd_symbol` はcmd、fish、zshでのみサポートされています。
`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).
:::
### オプション
| オプション | デフォルト | 説明 |
| ---------------- | ------------------- | -------------------------------------------- |
| `format` | `"$symbol"` | テキスト入力の前に使用される書式文字列。 |
| `success_symbol` | `"[](bold green)"` | 前のコマンドが成功した場合にテキスト入力の前に使用される書式文字列です。 |
| `error_symbol` | `"[](bold red)"` | 前のコマンドが失敗した場合にテキスト入力の前に使用される書式文字列です。 |
| `vicmd_symbol` | `"[](bold green)"` | シェルが vim ノーマルモードの場合にテキスト入力の前に使用されるフォーマット文字列。 |
| `disabled` | `false` | `character`モジュールを無効にします。 |
| オプション | デフォルト | 説明 |
| -------------------------- | -------------------- | --------------------------------------------------------------------------------------- |
| `format` | `"$symbol"` | テキスト入力の前に使用される書式文字列。 |
| `success_symbol` | `"[](bold green)"` | 前のコマンドが成功した場合にテキスト入力の前に使用される書式文字列です。 |
| `error_symbol` | `"[](bold red)"` | 前のコマンドが失敗した場合にテキスト入力の前に使用される書式文字列です。 |
| `vicmd_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_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. |
| `disabled` | `false` | `character`モジュールを無効にします。 |
### 変数
@ -693,7 +697,7 @@ format = "underwent [$duration](bold yellow)"
## Conda
The `conda` module shows the current [Conda](https://docs.conda.io/en/latest/) environment, if `$CONDA_DEFAULT_ENV` is set.
`conda` モジュールは、`$CONDA_DEFAULT_ENV` が設定されている場合、現在の[Conda](https://docs.conda.io/en/latest/) 環境を表示します。
::: tip
@ -802,13 +806,51 @@ format = "[$symbol \\[$name\\]]($style) "
format = "via [✨ $version](bold blue) "
```
## 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. デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
- The current directory contains a `daml.yaml` file
### オプション
| オプション | デフォルト | 説明 |
| ------------------- | ---------------------------------- | ------------------------------------------------------ |
| `format` | `via [$symbol($version )]($style)` | module のフォーマットです。 |
| `version_format` | `v${raw}` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 |
| `symbol` | `"Λ "` | A format string representing the symbol of Daml |
| `style` | `"bold cyan"` | モジュールのスタイルです。 |
| `detect_extensions` | `[]` | どの拡張子がこのモジュールをアクティブにするか |
| `detect_files` | `["daml.yaml"]` | どのファイル名がこのモジュールをアクティブにするか |
| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか |
| `disabled` | `false` | Disables the `daml` module. |
### 変数
| 変数 | 設定例 | 説明 |
| --------- | -------- | ---------------------- |
| version | `v2.2.0` | The version of `daml` |
| symbol | | オプション `記号` の値をミラーする |
| style\* | | オプション `style` の値をミラーする |
*: この変数は、スタイル文字列の一部としてのみ使用することができます。
### 設定例
```toml
# ~/.config/starship.toml
[daml]
format = "via [D $version](bold bright-green) "
```
## Dart
`dart`モジュールは、現在インストールされている[Dart](https://dart.dev/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
- カレントディレクトリに`.dart`の拡張子のファイルが含まれている
- カレントディレクトリに`.dart_tool`ディレクトリが含まれている
- カレントディレクトリに`pubspec.yaml`, `pubspec.yml`,もしくは`pubspec.lock`が含まれている
- カレントディレクトリに`pubspec.yaml`、`pubspec.yml`または`pubspec.lock` が含まれている
### オプション
@ -888,20 +930,20 @@ fishスタイルのpwdオプションを使用すると、切り捨てられた
### オプション
| オプション | デフォルト | 説明 |
| ------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| `truncation_length` | `3` | 現在のディレクトリを切り捨てる親フォルダーの数です。 |
| `truncate_to_repo` | `true` | 現在いるgitリポジトリのルートに切り捨てるかどうかです。 |
| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | module のフォーマットです。 |
| `style` | `"bold cyan"` | モジュールのスタイルです。 |
| `disabled` | `false` | `directory`モジュールを無効にします。 |
| `read_only` | `"🔒"` | このシンボルが表示されている時、現在のディレクトリは読み取り専用です。 |
| `read_only_style` | `"red"` | 読み取り専用シンボルのスタイルです。 |
| `truncation_symbol` | `""` | 切り捨てられたパスの接頭辞として付けるシンボルです。 例: "…/" |
| `repo_root_style` | `None` | The style for the root of the git repo. The default value is equivalent to `style`. |
| `repo_root_format` | `"[$before_root_path]($style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) "` | The format of a git repo when `repo_root_style` is defined. |
| `home_symbol` | `"~"` | ホームディレクトリを示すシンボルです。 |
| `use_os_path_sep` | `true` | `/`を使用する代わりに、OS固有のパスの区切り文字を使用します。(例: Windowsの場合`\`) |
| オプション | デフォルト | 説明 |
| ------------------- | ----------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ |
| `truncation_length` | `3` | 現在のディレクトリを切り捨てる親フォルダーの数です。 |
| `truncate_to_repo` | `true` | 現在いるgitリポジトリのルートに切り捨てるかどうかです。 |
| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | module のフォーマットです。 |
| `style` | `"bold cyan"` | モジュールのスタイルです。 |
| `disabled` | `false` | `directory`モジュールを無効にします。 |
| `read_only` | `"🔒"` | このシンボルが表示されている時、現在のディレクトリは読み取り専用です。 |
| `read_only_style` | `"red"` | 読み取り専用シンボルのスタイルです。 |
| `truncation_symbol` | `""` | 切り捨てられたパスの接頭辞として付けるシンボルです。 例: "…/" |
| `repo_root_style` | `None` | gitリポジトリのルートのスタイルです。 デフォルトの値は `style` と同じです。 |
| `repo_root_format` | `"[$before_root_path]($style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) "` | `repo_root_style` が定義されている場合の git リポジトリのフォーマットです。 |
| `home_symbol` | `"~"` | ホームディレクトリを示すシンボルです。 |
| `use_os_path_sep` | `true` | `/`を使用する代わりに、OS固有のパスの区切り文字を使用します。(例: Windowsの場合`\`) |
<details>
<summary>このモジュールは、どのようにディレクトリを表示するかについての高度なオプションをいくつか持っています。</summary>
@ -1013,7 +1055,7 @@ format = "via [🐋 $context](blue bold)"
内部的に、このモジュールは自身のバージョン検知のメカニズムを利用します。 `dotnet --version` を実行するより2倍速く実行できますが、.NET project一般的でないディレクトリlayoutの場合は間違ったバージョンが示されてしまうことがあります。 速度よりも精度が重要な場合は、次の方法でメカニズムを無効にできます。 モジュールオプションで`heuristic = false `を設定します。
The module will also show the Target Framework Moniker (<https://docs.microsoft.com/en-us/dotnet/standard/frameworks#supported-target-frameworks>) when there is a `.csproj` file in the current directory.
このモジュールは、カレントディレクトリに `.csproj` ファイルがある場合、Target Framework Moniker (<https://docs.microsoft.com/en-us/dotnet/standard/frameworks#supported-target-frameworks>) も表示します。
### オプション
@ -1343,17 +1385,17 @@ very-long-project-name = "vlpn"
### オプション
| オプション | デフォルト | 説明 |
| -------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------ |
| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. |
| `format` | `"on [$symbol$branch(:$remote_branch)]($style) "` | module のフォーマットです。 現在のブランチ名を参照するには、`"$branch"`を使用します。 |
| `symbol` | `" "` | gitブランチのシンボルを表すフォーマット文字列。 |
| `style` | `"bold purple"` | モジュールのスタイルです。 |
| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. |
| `truncation_symbol` | `"…"` | ブランチ名切り捨てられていることを示すための記号です。 You can use `""` for no symbol. |
| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. |
| `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for "master" or "main". |
| `disabled` | `false` | `git_branch`モジュールを無効にします。 |
| オプション | デフォルト | 説明 |
| -------------------- | ------------------------------------------------- | ------------------------------------------------------------------- |
| `always_show_remote` | `false` | ローカルブランチ名と等しい場合でも、リモート追跡ブランチ名を表示します。 |
| `format` | `"on [$symbol$branch(:$remote_branch)]($style) "` | module のフォーマットです。 現在のブランチ名を参照するには、`"$branch"`を使用します。 |
| `symbol` | `" "` | gitブランチのシンボルを表すフォーマット文字列。 |
| `style` | `"bold purple"` | モジュールのスタイルです。 |
| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. |
| `truncation_symbol` | `"…"` | ブランチ名切り捨てられていることを示すための記号です。 You can use `""` for no symbol. |
| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. |
| `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for "master" or "main". |
| `disabled` | `false` | `git_branch`モジュールを無効にします。 |
### 変数
@ -1599,7 +1641,7 @@ windows_starship = '/mnt/c/Users/username/scoop/apps/starship/current/starship.e
## Go
The `golang` module shows the currently installed version of [Go](https://golang.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
`golang`モジュールは、現在インストールされている[Go](https://golang.org/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
- カレントディレクトリに`go.mod`ファイルが含まれている
- カレントディレクトリに`go.sum`ファイルが含まれている
@ -1650,7 +1692,7 @@ The `haskell` module finds the current selected GHC version and/or the selected
デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
- カレントディレクトリに`stack.yaml`ファイルが含まれている
- The current directory contains any `.hs`, `.cabal`, or `.hs-boot` file
- カレントディレクトリに`.hs`、`.cabal`または`.hs-boot`のファイルが含まれている
### オプション
@ -1678,10 +1720,10 @@ The `haskell` module finds the current selected GHC version and/or the selected
## Helm
The `helm` module shows the currently installed version of [Helm](https://helm.sh/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
`helm`モジュールは、現在インストールされている[Helm](https://helm.sh/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
- カレントディレクトリに`helmfile.yaml`ファイルが含まれている
- The current directory contains a `Chart.yaml` file
- カレントディレクトリに`Chart.yaml`ファイルが含まれている
### オプション
@ -1754,10 +1796,10 @@ disabled = false
## Java
The `java` module shows the currently installed version of [Java](https://www.oracle.com/java/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
`Java`モジュールは、現在インストールされている[Java](https://www.oracle.com/java/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
- The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `.deps.edn`, `project.clj`, or `build.boot` file
- The current directory contains a file with the `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` extension
- カレントディレクトリに`pom.xml`、`build.gradle.kts`、`build.sbt`、`.java-version`、`.deps.edn`、`project.clj`または`build.boot`が含まれている
- カレントディレクトリに拡張子が`.java`、`.class`、`.gradle`、`.jar`、`.clj`または`.cljc`のファイルが含まれている
### オプション
@ -1850,7 +1892,7 @@ symbol_threshold = 0
## Julia
The `julia` module shows the currently installed version of [Julia](https://julialang.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
`julia`モジュールは、現在インストールされている[Julia](https://julialang.org/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
- カレントディレクトリに`Project.toml`ファイルが含まれている
- カレントディレクトリに`Manifest.toml`ファイルが含まれている
@ -1947,13 +1989,14 @@ Displays the current [Kubernetes context](https://kubernetes.io/docs/concepts/co
### オプション
| オプション | デフォルト | 説明 |
| ----------------- | ---------------------------------------------------- | ------------------------------- |
| `symbol` | `"☸ "` | クラスター名の前に表示されるシンボルを表すフォーマット文字列。 |
| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | module のフォーマットです。 |
| `style` | `"cyan bold"` | モジュールのスタイルです。 |
| `context_aliases` | | コンテキストの表示エイリアスを定義するテーブル。 |
| `disabled` | `true` | `kubernetes` モジュールを無効にする。 |
| オプション | デフォルト | 説明 |
| ----------------- | ---------------------------------------------------- | --------------------------------- |
| `symbol` | `"☸ "` | クラスター名の前に表示されるシンボルを表すフォーマット文字列。 |
| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | module のフォーマットです。 |
| `style` | `"cyan bold"` | モジュールのスタイルです。 |
| `context_aliases` | | コンテキストの表示エイリアスを定義するテーブル。 |
| `user_aliases` | | Table of user aliases to display. |
| `disabled` | `true` | `kubernetes` モジュールを無効にする。 |
### 変数
@ -1980,11 +2023,14 @@ disabled = false
"dev.local.cluster.k8s" = "dev"
".*/openshift-cluster/.*" = "openshift"
"gke_.*_(?P<var_cluster>[\\w-]+)" = "gke-$var_cluster"
[kubernetes.user_aliases]
"dev.local.cluster.k8s" = "dev"
"root/.*" = "root"
```
#### Regex Matching
Additional to simple aliasing, `context_aliases` also supports extended matching and renaming using regular expressions.
Additional to simple aliasing, `context_aliases` and `user_aliases` also supports extended matching and renaming using regular expressions.
The regular expression must match on the entire kube context, capture groups can be referenced using `$name` and `$N` in the replacement. This is more explained in the [regex crate](https://docs.rs/regex/1.5.4/regex/struct.Regex.html#method.replace) documentation.
@ -2181,12 +2227,12 @@ truncation_symbol = ""
## Nim
The `nim` module shows the currently installed version of [Nim](https://nim-lang.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
`nim`モジュールは、現在インストールされている[Nim](https://nim-lang.org/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
- カレントディレクトリに`nim.cfg`ファイルが含まれている
- The current directory contains a file with the `.nim` extension
- The current directory contains a file with the `.nims` extension
- The current directory contains a file with the `.nimble` extension
- カレントディレクトリに拡張子が`.nim`のファイルが含まれている
- カレントディレクトリに拡張子が`.nims`のファイルが含まれている
- カレントディレクトリに拡張子が`.nimble`のファイルが含まれている
### オプション
@ -2223,7 +2269,7 @@ symbol = "🎣 "
## Nix-shell
The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html) environment. このモジュールは、nixシェル環境内にあるときに表示されます。
`nix_shell`モジュールは[nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html)環境を表示します。 このモジュールは、nixシェル環境内にあるときに表示されます。
### オプション
@ -2261,14 +2307,14 @@ format = 'via [☃️ $state( \($name\))](bold blue) '
## Node.js
The `nodejs` module shows the currently installed version of [Node.js](https://nodejs.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
`nodejs`モジュールは、現在インストールされている[Node.js](https://nodejs.org/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
- カレントディレクトリに`package.json`ファイルが含まれている
- The current directory contains a `.node-version` file
- The current directory contains a `.nvmrc` file
- カレントディレクトリに`.node-version`ファイルが含まれている
- カレントディレクトリに`.nvmrc`ファイルが含まれている
- カレントディレクトリに`node_modules`ディレクトリが含まれている
- The current directory contains a file with the `.js`, `.mjs` or `.cjs` extension
- The current directory contains a file with the `.ts`, `.mts` or `.cts` extension
- カレントディレクトリに拡張子が`.js`、`.mjs`または`.cjs`のファイルが含まれている
- カレントディレクトリに拡張子が`.ts`、`.mts`または`.cts`のファイルが含まれている
### オプション
@ -2305,14 +2351,14 @@ format = "via [🤖 $version](bold green) "
## OCaml
The `ocaml` module shows the currently installed version of [OCaml](https://ocaml.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
`ocaml`モジュールは、現在インストールされている[OCaml](https://ocaml.org/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
- The current directory contains a file with `.opam` extension or `_opam` directory
- The current directory contains a `esy.lock` directory
- The current directory contains a `dune` or `dune-project` file
- The current directory contains a `jbuild` or `jbuild-ignore` file
- The current directory contains a `.merlin` file
- The current directory contains a file with `.ml`, `.mli`, `.re` or `.rei` extension
- カレントディレクトリに拡張子`.opam`のファイルまたは`_opam`ディレクトリが含まれている
- カレントディレクトリに`esy.lock`ディレクトリが含まれている
- カレントディレクトリに`dune`または`dune-project`ファイルが含まれている
- カレントディレクトリに`jbuild`または`jbuild-ignore`ファイルが含まれている
- カレントディレクトリに`.merlin`ファイルが含まれている
- カレントディレクトリに拡張子が`.ml`、`.mli`、`.re`または`.rei`のファイルが含まれている
### オプション
@ -2387,7 +2433,7 @@ symbol = "☁️ "
## パッケージのバージョン
`package`モジュールは、現在のディレクトリがパッケージのリポジトリである場合に表示され、現在のバージョンが表示されます。 The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards` and `dart` packages.
`package`モジュールは、現在のディレクトリがパッケージのリポジトリである場合に表示され、現在のバージョンが表示されます。 The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages.
- [**npm**](https://docs.npmjs.com/cli/commands/npm) The `npm` package version is extracted from the `package.json` present in the current directory
- [**Cargo**](https://doc.rust-lang.org/cargo/) The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
@ -2404,6 +2450,7 @@ symbol = "☁️ "
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory
- [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory
- [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory
- [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory
- [**Dart**](https://pub.dev/) - The `dart` package version is extracted from the `pubspec.yaml` present in the current directory
> ⚠️ 表示されるバージョンは、パッケージマネージャーではなく、ソースコードが現在のディレクトリにあるパッケージのバージョンです。
@ -2440,13 +2487,13 @@ format = "via [🎁 $version](208 bold) "
## Perl
The `perl` module shows the currently installed version of [Perl](https://www.perl.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
`perl`モジュールは、現在インストールされている[Perl](https://www.perl.org/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
- The current directory contains a `Makefile.PL` or `Build.PL` file
- The current directory contains a `cpanfile` or `cpanfile.snapshot` file
- The current directory contains a `META.json` file or `META.yml` file
- The current directory contains a `.perl-version` file
- The current directory contains a `.pl`, `.pm` or `.pod`
- カレントディレクトリに`Makefile.PL`または`Build.PL`ファイルが含まれている
- カレントディレクトリに`cpanfile`または`cpanfile.snapshot`ファイルが含まれている
- カレントディレクトリに`META.json`または`META.yml`ファイルが含まれている
- カレントディレクトリに`.perl-version`ファイルが含まれている
- カレントディレクトリに拡張子が`.pl`、`.pm`または`.pod`のファイルが含まれている
### オプション
@ -2480,11 +2527,11 @@ format = "via [🦪 $version]($style) "
## PHP
The `php` module shows the currently installed version of [PHP](https://www.php.net/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
`php`モジュールは、現在インストールされている[PHP](https://www.php.net/) のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
- カレントディレクトリに`composer.json`ファイルが含まれている
- The current directory contains a `.php-version` file
- The current directory contains a `.php` extension
- カレントディレクトリに`.php-version`ファイルが含まれている
- カレントディレクトリに拡張子が`.php`のファイルが含まれている
### オプション
@ -2530,8 +2577,8 @@ By default the Pulumi version is not shown, since it takes an order of magnitude
デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
- The current directory contains either `Pulumi.yaml` or `Pulumi.yml`
- A parent directory contains either `Pulumi.yaml` or `Pulumi.yml`
- カレントディレクトリに`Pulumi.yaml`または`Pulumi.yml`ファイルが含まれている
- 親ディレクトリに`Pulumi.yaml`または`Pulumi.yml`ファイルが含まれている
### オプション
@ -2577,10 +2624,10 @@ format = "[$symbol$stack]($style) "
## PureScript
The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
`purescript`モジュールは、現在インストールされている[PureScript](https://www.purescript.org/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
- カレントディレクトリに`spago.dhall`ファイルが含まれている
- The current directory contains a file with the `.purs` extension
- カレントディレクトリに拡張子が`.purs`のファイルが含まれている
### オプション
@ -2705,15 +2752,15 @@ python_binary = ["./venv/bin/python", "python", "python3", "python2"]
## R
The `rlang` module shows the currently installed version of [R](https://www.r-project.org/). The module will be shown if any of the following conditions are met:
`rlang`モジュールは、現在インストールされている[R](https://www.r-project.org/)のバージョンを表示します。 次の条件のいずれかが満たされると、モジュールが表示されます。
- The current directory contains a file with the `.R` extension.
- The current directory contains a file with the `.Rd` extension.
- The current directory contains a file with the `.Rmd` extension.
- The current directory contains a file with the `.Rproj` extension.
- The current directory contains a file with the `.Rsx` extension.
- The current directory contains a `.Rprofile` file
- The current directory contains a `.Rproj.user` folder
- カレントディレクトリに拡張子が`.R`のファイルが含まれている
- カレントディレクトリに拡張子が`.Rd`のファイルが含まれている
- カレントディレクトリに拡張子が`.Rmd`のファイルが含まれている
- カレントディレクトリに拡張子が`.Rproj`のファイルが含まれている
- カレントディレクトリに拡張子が`.Rsx`のファイルが含まれている
- カレントディレクトリに`.Rprofile`ファイルが含まれている
- カレントディレクトリに`.Rproj.user`フォルダが含まれている
### オプション
@ -2747,15 +2794,15 @@ format = "with [📐 $version](blue bold) "
## Red
By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). 次の条件のいずれかが満たされると、モジュールが表示されます:
デフォルトでは`red`モジュールは、現在インストールされている[Red](https://www.red-lang.org/)のバージョンを表示します。 次の条件のいずれかが満たされると、モジュールが表示されます:
- The current directory contains a file with `.red` or `.reds` extension
- カレントディレクトリに拡張子が`.red` or `.reds`のファイルが含まれている
### オプション
| オプション | デフォルト | 説明 |
| ------------------- | ------------------------------------ | ------------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 |
| `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 |
| `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 |
| `symbol` | `"🔺 "` | A format string representing the symbol of Red. |
| `detect_extensions` | `["red"]` | どの拡張子がこのモジュールをアクティブにするか |
@ -2790,7 +2837,7 @@ symbol = "🔴 "
- カレントディレクトリに`Gemfile`ファイルが含まれている
- カレントディレクトリに `.ruby-version` ファイルが含まれている
- カレントディレクトリに`.rb`の拡張子のファイルが含まれている
- The environment variables `RUBY_VERSION` or `RBENV_VERSION` are set
- 環境変数に`RUBY_VERSION`または`RBENV_VERSION`が設定されている
Starship gets the current Ruby version by running `ruby -v`.
@ -2870,11 +2917,11 @@ format = "via [⚙️ $version](red bold)"
## Scala
The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
`scala` モジュールは、現在インストールされている[Scala](https://www.scala-lang.org/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
- The current directory contains a `build.sbt`, `.scalaenv` or `.sbtenv` file
- The current directory contains a file with the `.scala` or `.sbt` extension
- The current directory contains a directory named `.metals`
- カレントディレクトリに`build.sbt`、`.scalaenv`または`.sbtenv`ファイルが含まれている
- カレントディレクトリに拡張子が`.scala`または`.sbt`のファイルが含まれている
- カレントディレクトリに`.metals`ディレクトリが含まれている
### オプション
@ -3171,10 +3218,10 @@ disabled = false
## Swift
By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). 次の条件のいずれかが満たされると、モジュールが表示されます:
デフォルトでは`swift` モジュールは、現在インストールされている[Swift](https://swift.org/)のバージョンを表示します。 次の条件のいずれかが満たされると、モジュールが表示されます:
- The current directory contains a `Package.swift` file
- The current directory contains a file with the `.swift` extension
- カレントディレクトリに`Package.swift`ファイルが含まれている
- カレントディレクトリに拡張子が`.swift`のファイルが含まれている
### オプション
@ -3360,9 +3407,9 @@ show_always = true
## Vagrant
The `vagrant` module shows the currently installed version of [Vagrant](https://www.vagrantup.com/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
`vagrant`モジュールは、現在インストールされている[Vagrant](https://www.vagrantup.com/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
- The current directory contains a `Vagrantfile` file
- カレントディレクトリに`Vagrantfile`ファイルが含まれている
### オプション
@ -3398,10 +3445,10 @@ format = "via [⍱ $version](bold white) "
## V
The `vlang` module shows you your currently installed version of [V](https://vlang.io/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
`vlang`モジュールは、現在インストールされている[V](https://vlang.io/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
- The current directory contains a file with `.v` extension
- The current directory contains a `v.mod`, `vpkg.json` or `.vpkg-lock.json` file
- カレントディレクトリに拡張子が`.v`のファイルが含まれている
- カレントディレクトリに`v.mod`、`vpkg.json`または`.vpkg-lock.json`ファイルが含まれている
### オプション
@ -3466,9 +3513,9 @@ format = "[🆅 $repo](bold blue) "
## Zig
By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). 次の条件のいずれかが満たされると、モジュールが表示されます:
デフォルトでは`zig`モジュールは、現在インストールされている[Zig](https://ziglang.org/)のバージョンを表示します。 次の条件のいずれかが満たされると、モジュールが表示されます:
- The current directory contains a `.zig` file
- カレントディレクトリに拡張子が`.zig`のファイルが含まれている
### オプション

View File

@ -251,6 +251,8 @@ curl -sS https://starship.rs/install.sh | sh
<details>
<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).
以下のいずれかのパッケージマネージャーを使用して、Starshipをインストールします。
| リポジトリ | 手順 |
@ -326,14 +328,14 @@ eval $(starship init ion)
<details>
<summary>Nushell</summary>
そして、Nushellの設定ファイルの最後に以下を追加してください `$nu.config-path` を実行してください):
Nushellの環境ファイルの最後に以下を追記してください ( `$nu.env-path` を実行してください):
```sh
mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu
```
そして、Nushellの設定ファイルの最後に以下を追加してください( `$nu.config-path` を実行してください)。
そして、Nushellの設定ファイルの最後に以下を追記してください (`$nu.config-path` を実行してください):
```sh
source ~/.cache/starship/init.nu
@ -346,7 +348,7 @@ source ~/.cache/starship/init.nu
<details>
<summary>PowerShell</summary>
そして、Nushellの設定ファイルの最後に以下を追加してください `$PROFILE.config-path` を実行してください):
PowerShellの設定ファイルの最後に以下を追記してください (`$PROFILE` を実行してください):
```powershell
Invoke-Expression (&starship init powershell)

View File

@ -206,6 +206,7 @@ $c\
$cmake\
$cobol\
$container\
$daml\
$dart\
$deno\
$dotnet\
@ -268,9 +269,9 @@ format = "$all$directory$character"
## AWS
The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. Alternatively, you can force this module to show the region and profile even when the credentials have not been setup with the `force_display` option. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file. This module also shows an expiration timer when using temporary credentials.
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.
The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is 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 the conditions above are not respected.
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.
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.
@ -537,19 +538,22 @@ By default it only changes color. If you also want to change its shape take a lo
::: warning
`vicmd_symbol` is only supported in cmd, fish and zsh.
`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).
:::
### Options
| Option | Default | Description |
| ---------------- | ------------------- | -------------------------------------------------------------------------------- |
| `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. |
| `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. |
| `disabled` | `false` | Disables the `character` module. |
| Option | Default | Description |
| -------------------------- | -------------------- | --------------------------------------------------------------------------------------- |
| `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. |
| `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. |
| `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_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. |
| `disabled` | `false` | Disables the `character` module. |
### Variables
@ -803,6 +807,44 @@ The `crystal` module shows the currently installed version of [Crystal](https://
format = "via [✨ $version](bold blue) "
```
## 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. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `daml.yaml` file
### Options
| Option | Default | Description |
| ------------------- | ---------------------------------- | ------------------------------------------------------------------------- |
| `format` | `via [$symbol($version )]($style)` | The format for the module. |
| `version_format` | `v${raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"Λ "` | A format string representing the symbol of Daml |
| `style` | `"bold cyan"` | The style for the module. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `detect_files` | `["daml.yaml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `disabled` | `false` | Disables the `daml` module. |
### Variables
| Variable | Example | Description |
| --------- | -------- | ------------------------------------ |
| version | `v2.2.0` | The version of `daml` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
*: This variable can only be used as a part of a style string
### Example
```toml
# ~/.config/starship.toml
[daml]
format = "via [D $version](bold bright-green) "
```
## Dart
The `dart` module shows the currently installed version of [Dart](https://dart.dev/). By default the module will be shown if any of the following conditions are met:
@ -1954,6 +1996,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | The format for the module. |
| `style` | `"cyan bold"` | The style for the module. |
| `context_aliases` | | Table of context aliases to display. |
| `user_aliases` | | Table of user aliases to display. |
| `disabled` | `true` | Disables the `kubernetes` module. |
### Variables
@ -1981,11 +2024,14 @@ disabled = false
"dev.local.cluster.k8s" = "dev"
".*/openshift-cluster/.*" = "openshift"
"gke_.*_(?P<var_cluster>[\\w-]+)" = "gke-$var_cluster"
[kubernetes.user_aliases]
"dev.local.cluster.k8s" = "dev"
"root/.*" = "root"
```
#### Regex Matching
Additional to simple aliasing, `context_aliases` also supports extended matching and renaming using regular expressions.
Additional to simple aliasing, `context_aliases` and `user_aliases` also supports extended matching and renaming using regular expressions.
The regular expression must match on the entire kube context, capture groups can be referenced using `$name` and `$N` in the replacement. This is more explained in the [regex crate](https://docs.rs/regex/1.5.4/regex/struct.Regex.html#method.replace) documentation.
@ -2388,7 +2434,7 @@ symbol = "☁️ "
## Package Version
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards` and `dart` packages.
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages.
- [**npm**](https://docs.npmjs.com/cli/commands/npm) The `npm` package version is extracted from the `package.json` present in the current directory
- [**Cargo**](https://doc.rust-lang.org/cargo/) The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
@ -2405,6 +2451,7 @@ The `package` module is shown when the current directory is the repository for a
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory
- [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory
- [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory
- [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory
- [**Dart**](https://pub.dev/) - The `dart` package version is extracted from the `pubspec.yaml` present in the current directory
> ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager.

View File

@ -251,6 +251,8 @@ Alternatively, install Starship using any of the following package managers:
<details>
<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).
다음 패키지 관리자 중 하나를 사용해 Starship 을 설치하세요:
| Repository | Instructions |

View File

@ -206,6 +206,7 @@ $c\
$cmake\
$cobol\
$container\
$daml\
$dart\
$deno\
$dotnet\
@ -268,9 +269,9 @@ format = "$all$directory$character"
## AWS
The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. Alternatively, you can force this module to show the region and profile even when the credentials have not been setup with the `force_display` option. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file. This module also shows an expiration timer when using temporary credentials.
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.
The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is 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 the conditions above are not respected.
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.
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.
@ -537,19 +538,22 @@ By default it only changes color. If you also want to change its shape take a lo
::: warning
`vicmd_symbol` is only supported in cmd, fish and zsh.
`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).
:::
### Options
| Option | Default | Description |
| ---------------- | ------------------- | -------------------------------------------------------------------------------- |
| `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. |
| `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. |
| `disabled` | `false` | Disables the `character` module. |
| Option | Default | Description |
| -------------------------- | -------------------- | --------------------------------------------------------------------------------------- |
| `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. |
| `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. |
| `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_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. |
| `disabled` | `false` | Disables the `character` module. |
### Variables
@ -803,6 +807,44 @@ The `crystal` module shows the currently installed version of [Crystal](https://
format = "via [✨ $version](bold blue) "
```
## 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. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `daml.yaml` file
### Options
| Option | Default | Description |
| ------------------- | ---------------------------------- | ------------------------------------------------------------------------- |
| `format` | `via [$symbol($version )]($style)` | The format for the module. |
| `version_format` | `v${raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"Λ "` | A format string representing the symbol of Daml |
| `style` | `"bold cyan"` | The style for the module. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `detect_files` | `["daml.yaml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `disabled` | `false` | Disables the `daml` module. |
### Variables
| Variable | Example | Description |
| --------- | -------- | ------------------------------------ |
| version | `v2.2.0` | The version of `daml` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
*: This variable can only be used as a part of a style string
### Example
```toml
# ~/.config/starship.toml
[daml]
format = "via [D $version](bold bright-green) "
```
## Dart
The `dart` module shows the currently installed version of [Dart](https://dart.dev/). By default the module will be shown if any of the following conditions are met:
@ -1954,6 +1996,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | The format for the module. |
| `style` | `"cyan bold"` | The style for the module. |
| `context_aliases` | | Table of context aliases to display. |
| `user_aliases` | | Table of user aliases to display. |
| `disabled` | `true` | Disables the `kubernetes` module. |
### Variables
@ -1981,11 +2024,14 @@ disabled = false
"dev.local.cluster.k8s" = "dev"
".*/openshift-cluster/.*" = "openshift"
"gke_.*_(?P<var_cluster>[\\w-]+)" = "gke-$var_cluster"
[kubernetes.user_aliases]
"dev.local.cluster.k8s" = "dev"
"root/.*" = "root"
```
#### Regex Matching
Additional to simple aliasing, `context_aliases` also supports extended matching and renaming using regular expressions.
Additional to simple aliasing, `context_aliases` and `user_aliases` also supports extended matching and renaming using regular expressions.
The regular expression must match on the entire kube context, capture groups can be referenced using `$name` and `$N` in the replacement. This is more explained in the [regex crate](https://docs.rs/regex/1.5.4/regex/struct.Regex.html#method.replace) documentation.
@ -2388,7 +2434,7 @@ symbol = "☁️ "
## Package Version
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards` and `dart` packages.
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages.
- [**npm**](https://docs.npmjs.com/cli/commands/npm) The `npm` package version is extracted from the `package.json` present in the current directory
- [**Cargo**](https://doc.rust-lang.org/cargo/) The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
@ -2405,6 +2451,7 @@ The `package` module is shown when the current directory is the repository for a
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory
- [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory
- [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory
- [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory
- [**Dart**](https://pub.dev/) - The `dart` package version is extracted from the `pubspec.yaml` present in the current directory
> ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager.

View File

@ -249,6 +249,8 @@ Alternatively, install Starship using any of the following package managers:
<details>
<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).
Install Starship using any of the following package managers:
| Repository | Instructions |

View File

@ -206,6 +206,7 @@ $c\
$cmake\
$cobol\
$container\
$daml\
$dart\
$deno\
$dotnet\
@ -268,9 +269,9 @@ format = "$all$directory$character"
## AWS
The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. Alternatively, you can force this module to show the region and profile even when the credentials have not been setup with the `force_display` option. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file. This module also shows an expiration timer when using temporary credentials.
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.
The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is 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 the conditions above are not respected.
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.
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.
@ -537,19 +538,22 @@ By default it only changes color. If you also want to change its shape take a lo
::: warning
`vicmd_symbol` is only supported in cmd, fish and zsh.
`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).
:::
### Options
| Option | Default | Description |
| ---------------- | ------------------- | -------------------------------------------------------------------------------- |
| `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. |
| `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. |
| `disabled` | `false` | Disables the `character` module. |
| Option | Default | Description |
| -------------------------- | -------------------- | --------------------------------------------------------------------------------------- |
| `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. |
| `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. |
| `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_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. |
| `disabled` | `false` | Disables the `character` module. |
### Variables
@ -803,6 +807,44 @@ The `crystal` module shows the currently installed version of [Crystal](https://
format = "via [✨ $version](bold blue) "
```
## 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. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `daml.yaml` file
### Options
| Option | Default | Description |
| ------------------- | ---------------------------------- | ------------------------------------------------------------------------- |
| `format` | `via [$symbol($version )]($style)` | The format for the module. |
| `version_format` | `v${raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"Λ "` | A format string representing the symbol of Daml |
| `style` | `"bold cyan"` | The style for the module. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `detect_files` | `["daml.yaml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `disabled` | `false` | Disables the `daml` module. |
### Variables
| Zmienne | Example | Description |
| --------- | -------- | ------------------------------------ |
| version | `v2.2.0` | The version of `daml` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
*: This variable can only be used as a part of a style string
### Example
```toml
# ~/.config/starship.toml
[daml]
format = "via [D $version](bold bright-green) "
```
## Dart
The `dart` module shows the currently installed version of [Dart](https://dart.dev/). By default the module will be shown if any of the following conditions are met:
@ -1954,6 +1996,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | The format for the module. |
| `style` | `"cyan bold"` | The style for the module. |
| `context_aliases` | | Table of context aliases to display. |
| `user_aliases` | | Table of user aliases to display. |
| `disabled` | `true` | Disables the `kubernetes` module. |
### Variables
@ -1981,11 +2024,14 @@ disabled = false
"dev.local.cluster.k8s" = "dev"
".*/openshift-cluster/.*" = "openshift"
"gke_.*_(?P<var_cluster>[\\w-]+)" = "gke-$var_cluster"
[kubernetes.user_aliases]
"dev.local.cluster.k8s" = "dev"
"root/.*" = "root"
```
#### Regex Matching
Additional to simple aliasing, `context_aliases` also supports extended matching and renaming using regular expressions.
Additional to simple aliasing, `context_aliases` and `user_aliases` also supports extended matching and renaming using regular expressions.
The regular expression must match on the entire kube context, capture groups can be referenced using `$name` and `$N` in the replacement. This is more explained in the [regex crate](https://docs.rs/regex/1.5.4/regex/struct.Regex.html#method.replace) documentation.
@ -2388,7 +2434,7 @@ symbol = "☁️ "
## Package Version
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards` and `dart` packages.
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages.
- [**npm**](https://docs.npmjs.com/cli/commands/npm) The `npm` package version is extracted from the `package.json` present in the current directory
- [**Cargo**](https://doc.rust-lang.org/cargo/) The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
@ -2405,6 +2451,7 @@ The `package` module is shown when the current directory is the repository for a
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory
- [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory
- [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory
- [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory
- [**Dart**](https://pub.dev/) - The `dart` package version is extracted from the `pubspec.yaml` present in the current directory
> ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager.

View File

@ -251,6 +251,8 @@ Alternatively, install Starship using any of the following package managers:
<details>
<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).
Install Starship using any of the following package managers:
| Repository | Instructions |

View File

@ -183,7 +183,7 @@ O `formato` padrão é usado para definir o formato do prompt, se um valor vazio
```toml
format = "$all"
# O que equivale a
# Which is equivalent to
format = """
$username\
$hostname\
@ -206,6 +206,7 @@ $c\
$cmake\
$cobol\
$container\
$daml\
$dart\
$deno\
$dotnet\
@ -268,9 +269,9 @@ format = "$all$directory$character"
## AWS
O módulo `aws` exibe a região e perfil atual do AWS quando as credenciais, um `credential_process` ou um `sso_start_url` foram configurados. Como alternativa, você pode forçar este módulo a mostrar a região e o perfil mesmo quando as credenciais não foram configuradas com a opção `force_display`. Isto é baseado nas variáveis de env `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` contidas no arquivo `~/.aws/config`. Este módulo exibe também o tempo de expiração de credenciais temporárias.
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.
O módulo vai exibir o perfil somente se as credenciais estiverem presentes em `~/.aws/credentials` ou se `credentials_process` constar no arquivo `~/.aws/config`. Como alternativa, basta ter uma ou mais das seguintes variáveis definidas: `AWS_ACCESS_KEY_ID`, `AWS_ACCESS_KEY` ou `AWS_SESSION_TOKEN`. Se a opção `force_display` estiver definida como `true`, todas as informações disponíveis serão exibidas mesmo que as condições acima não sejam respeitadas.
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.
Quando usar [aws-vault](https://github.com/99designs/aws-vault), o perfil é lido da variável de ambiente `AWS_VAULT` e o tempo de expiração de credenciais é lido da variável de ambiente `AWS_SESSION_EXPIRATION`.
@ -537,19 +538,22 @@ Por padrão ele apenas muda de cor. Se você deseja alterar o formato de uma olh
::: atenção
`vicmd_symbol` só é suportado no cmd, fish e zsh.
`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).
:::
### Opções
| Opções | Padrão | Descrição |
| ---------------- | ------------------- | ------------------------------------------------------------------------------------------- |
| `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. |
| `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. |
| `disabled` | `false` | Desabilita o módulo `character`. |
| Opções | Padrão | Descrição |
| -------------------------- | -------------------- | ------------------------------------------------------------------------------------------- |
| `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. |
| `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. |
| `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_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. |
| `disabled` | `false` | Desabilita o módulo `character`. |
### Variáveis
@ -803,6 +807,44 @@ O módulo `crystal` exibe a versão instalada atual do [Crystal](https://crystal
format = "via [✨ $version](bold blue) "
```
## 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. Por padrão o módulo vai exibir se uma das condições a seguir for atendida:
- The current directory contains a `daml.yaml` file
### Opções
| Opções | Padrão | Descrição |
| ------------------- | ---------------------------------- | ------------------------------------------------------------------------------------ |
| `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` |
| `symbol` | `"Λ "` | A format string representing the symbol of Daml |
| `style` | `"bold cyan"` | O estilo do módulo. |
| `detect_extensions` | `[]` | Quais extensões devem ativar este módulo. |
| `detect_files` | `["daml.yaml"]` | Quais nomes de arquivos devem ativar este módulo. |
| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. |
| `disabled` | `false` | Disables the `daml` module. |
### Variáveis
| Variável | Exemplo | Descrição |
| --------- | -------- | --------------------------------- |
| version | `v2.2.0` | The version of `daml` |
| symbol | | Espelha o valor da opção `symbol` |
| style\* | | Espelha o valor da opção `style` |
*: Esta variável só pode ser usada como parte de uma string de estilo
### Exemplo
```toml
# ~/.config/starship.toml
[daml]
format = "via [D $version](bold bright-green) "
```
## Dart
O módulo `dart` exibe a versão atual instalada do [Dart](https://dart.dev/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida:
@ -1056,7 +1098,7 @@ heuristic = false
O módulo `elixir` exibe a versão instalada do [Elixir](https://elixir-lang.org/) e [Erlang/OTP](https://erlang.org/doc/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida:
- O diretório atual conter um arquivo `mix.exs`.
- O diretório atual contem um arquivo `mix.exs`.
### Opções
@ -1199,8 +1241,8 @@ default = "unknown user"
O módulo de `erlang` exibe a versão atual instalada do [Erlang/OTP](https://erlang.org/doc/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida:
- O diretório atual contém um arquivo `rebar.config`.
- O diretório atual contém um arquivo `erlang.mk`.
- O diretório atual contem um arquivo `rebar.config`.
- O diretório atual contem um arquivo `erlang.mk`.
### Opções
@ -1952,6 +1994,7 @@ Este módulo é desabilitado por padrão. Para habilitar, defina `disabled` para
| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | O formato do módulo. |
| `style` | `"cyan bold"` | O estilo do módulo. |
| `context_aliases` | | Tabela de aliases de contexto para exibir. |
| `user_aliases` | | Table of user aliases to display. |
| `disabled` | `true` | Desabilita o módulo `kubernetes`. |
### Variáveis
@ -1979,11 +2022,14 @@ disabled = false
"dev.local.cluster.k8s" = "dev"
".*/openshift-cluster/.*" = "openshift"
"gke_.*_(?P<var_cluster>[\\w-]+)" = "gke-$var_cluster"
[kubernetes.user_aliases]
"dev.local.cluster.k8s" = "dev"
"root/.*" = "root"
```
#### Correspondência Regex
Adicional para aliasing simples, `context_aliases` também suporta correspondência estendida e renomeação usando expressão regular.
Additional to simple aliasing, `context_aliases` and `user_aliases` also supports extended matching and renaming using regular expressions.
A expressão regular deve coincidir com todo o contexto kube, Grupos de captura podem ser referenciados usando `$name` e `$N` na substituição. Isto esta mais explicado na documentação do [regex crate](https://docs.rs/regex/1.5.4/regex/struct.Regex.html#method.replace).
@ -2319,7 +2365,7 @@ O módulo `ocaml` exibe a versão atual instalada do [OCaml](https://ocaml.org/)
| ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
| `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($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` | `"🐫 "` | O símbolo usado antes de exibir a versão do OCaml. |
| `symbol` | `"🐫 "` | O simbolo usado antes de exibir a versão do OCaml. |
| `global_switch_indicator` | `""` | A string usada para representar a mudança global OPAM. |
| `local_switch_indicator` | `"*"` | A string usada para representar as mudanças locais do OPAM. |
| `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | Quais extensões devem ativar este módulo. |
@ -2386,7 +2432,7 @@ symbol = "☁️ "
## Package Version
O módulo `package` é exibido quando o diretório atual é um repositorio para um pacote e exibe sua versão atual. Atualmente o módulo dá suporte aos pacotes `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards` e `dart`.
O módulo `package` é exibido quando o diretório atual é um repositorio para um pacote e exibe sua versão atual. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages.
- [**npm**](https://docs.npmjs.com/cli/commands/npm) O versionamento de pacotes `npm` é extraído do `package.json` presente no diretório atual
- [**Cargo**](https://doc.rust-lang.org/cargo/) O versionamento de pacotes `cargo`é extraído do arquivo `Cargo.toml` presente no diretório atual
@ -2403,6 +2449,7 @@ O módulo `package` é exibido quando o diretório atual é um repositorio para
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory
- [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory
- [**SBT**](https://scala-sbt.org) - O versionamento de pacotes `sbt` pé extraído do arquivo `build.sbt` presente no diretório atual
- [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory
- [**Dart**](https://pub.dev/) - O versionamento de pacotes `dart` pé extraído do arquivo `pubspec.yaml` presente no diretório atual
> ⚠️ A versão exibida é a que esta presente no código fonte do diretório atual e não do gerenciador de pacotes.
@ -2587,7 +2634,7 @@ O módulo `purescript` exibe a versão atual instalada do [PureScript](https://w
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ |
| `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` |
| `symbol` | `"<=> "` | O simbolo usado antes de exibir a versão do PureScript. |
| `symbol` | `"<=> "` | O símbolo usado antes de exibir a versão do PureScript. |
| `detect_extensions` | `["purs"]` | Quais extensões devem ativar este módulo. |
| `detect_files` | `["spago.dhall"]` | Quais nomes de arquivos devem ativar este módulo. |
| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. |
@ -2704,7 +2751,7 @@ python_binary = ["./venv/bin/python", "python", "python3", "python2"]
## R
O módulo `rlang` exibe a versão atual instalada do [R](https://www.r-project.org/). O módulo vai exibir se algumas das condições a seguir for atendida:
O módulo `rlang` mostra a versão atualmente instalada do [R](https://www.r-project.org/). O módulo será mostrado se qualquer uma das seguintes condições for atendida:
- O diretório atual tenha um arquivo com a extensão `.R`.
- O diretório atual tenha um arquivo com a extensão `.Rd`.
@ -2881,7 +2928,7 @@ 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. |
| `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` |
| `detect_extensions` | `["sbt", "scala"]` | Quais extensões devem ativar este módulo. |
| `detect_extensions` | `["sbt", "escala"]` | Quais extensões 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. |
| `symbol` | `"🆂 "` | Uma string que representa o simbolo do Scala. |
@ -3465,7 +3512,7 @@ format = "[🆅 $repo](bold blue) "
## Zig
Por padrão o módulo `zig` exibe a versão atual instalada do [Zig](https://ziglang.org/). O módulo vai exibir se algumas das condições a seguir for atendida:
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:
- O diretório atual contém arquivo com a extensão `.zig`
@ -3475,7 +3522,7 @@ Por padrão o módulo `zig` exibe a versão atual instalada do [Zig](https://zig
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ |
| `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` |
| `symbol` | `"↯ "` | O simbolo usado antes de exibir a versão do Zig. |
| `symbol` | `"↯ "` | O símbolo usado antes de exibir a versão do Zig. |
| `style` | `"bold yellow"` | O estilo do módulo. |
| `disabled` | `false` | Desabilita o módulo `zig`. |
| `detect_extensions` | `["zig"]` | Quais extensões devem ativar este módulo. |

View File

@ -251,6 +251,8 @@ Ou instale o Starship usando qualquer um dos seguintes gerenciadores de pacotes:
<details>
<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).
Instale o Starship usando qualquer um dos seguintes gerenciadores de pacotes:
| Repositório | Instruções |

View File

@ -206,6 +206,7 @@ $c\
$cmake\
$cobol\
$container\
$daml\
$dart\
$deno\
$dotnet\
@ -268,9 +269,9 @@ format = "$all$directory$character"
## AWS
The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. Alternatively, you can force this module to show the region and profile even when the credentials have not been setup with the `force_display` option. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file. This module also shows an expiration timer when using temporary credentials.
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.
The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is 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 the conditions above are not respected.
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.
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.
@ -537,19 +538,22 @@ By default it only changes color. If you also want to change its shape take a lo
::: warning
`vicmd_symbol` is only supported in cmd, fish and zsh.
`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).
:::
### Options
| Option | Default | Description |
| ---------------- | ------------------- | -------------------------------------------------------------------------------- |
| `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. |
| `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. |
| `disabled` | `false` | Disables the `character` module. |
| Option | Default | Description |
| -------------------------- | -------------------- | --------------------------------------------------------------------------------------- |
| `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. |
| `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. |
| `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_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. |
| `disabled` | `false` | Disables the `character` module. |
### Variables
@ -803,6 +807,44 @@ The `crystal` module shows the currently installed version of [Crystal](https://
format = "via [✨ $version](bold blue) "
```
## 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. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `daml.yaml` file
### Options
| Option | Default | Description |
| ------------------- | ---------------------------------- | ------------------------------------------------------------------------- |
| `format` | `via [$symbol($version )]($style)` | The format for the module. |
| `version_format` | `v${raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"Λ "` | A format string representing the symbol of Daml |
| `style` | `"bold cyan"` | The style for the module. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `detect_files` | `["daml.yaml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `disabled` | `false` | Disables the `daml` module. |
### Variables
| Variable | Example | Description |
| --------- | -------- | ------------------------------------ |
| version | `v2.2.0` | The version of `daml` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
*: This variable can only be used as a part of a style string
### Example
```toml
# ~/.config/starship.toml
[daml]
format = "via [D $version](bold bright-green) "
```
## Dart
The `dart` module shows the currently installed version of [Dart](https://dart.dev/). By default the module will be shown if any of the following conditions are met:
@ -1954,6 +1996,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | The format for the module. |
| `style` | `"cyan bold"` | The style for the module. |
| `context_aliases` | | Table of context aliases to display. |
| `user_aliases` | | Table of user aliases to display. |
| `disabled` | `true` | Disables the `kubernetes` module. |
### Variables
@ -1981,11 +2024,14 @@ disabled = false
"dev.local.cluster.k8s" = "dev"
".*/openshift-cluster/.*" = "openshift"
"gke_.*_(?P<var_cluster>[\\w-]+)" = "gke-$var_cluster"
[kubernetes.user_aliases]
"dev.local.cluster.k8s" = "dev"
"root/.*" = "root"
```
#### Regex Matching
Additional to simple aliasing, `context_aliases` also supports extended matching and renaming using regular expressions.
Additional to simple aliasing, `context_aliases` and `user_aliases` also supports extended matching and renaming using regular expressions.
The regular expression must match on the entire kube context, capture groups can be referenced using `$name` and `$N` in the replacement. This is more explained in the [regex crate](https://docs.rs/regex/1.5.4/regex/struct.Regex.html#method.replace) documentation.
@ -2388,7 +2434,7 @@ symbol = "☁️ "
## Package Version
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards` and `dart` packages.
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages.
- [**npm**](https://docs.npmjs.com/cli/commands/npm) The `npm` package version is extracted from the `package.json` present in the current directory
- [**Cargo**](https://doc.rust-lang.org/cargo/) The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
@ -2405,6 +2451,7 @@ The `package` module is shown when the current directory is the repository for a
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory
- [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory
- [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory
- [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory
- [**Dart**](https://pub.dev/) - The `dart` package version is extracted from the `pubspec.yaml` present in the current directory
> ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager.

View File

@ -251,6 +251,8 @@ Alternatively, install Starship using any of the following package managers:
<details>
<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).
Install Starship using any of the following package managers:
| Repository | Instructions |

View File

@ -206,6 +206,7 @@ $c\
$cmake\
$cobol\
$container\
$daml\
$dart\
$deno\
$dotnet\
@ -268,9 +269,9 @@ format = "$all$directory$character"
## AWS
The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. Alternatively, you can force this module to show the region and profile even when the credentials have not been setup with the `force_display` option. Основано на `AWS_REGION`, `AWS_DEFAULT_REGION`, и `AWS_PROFILE` переменных окружения и файле`~/.aws/config`. This module also shows an expiration timer when using temporary credentials.
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.
The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is 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 the conditions above are not respected.
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.
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.
@ -537,19 +538,22 @@ By default it only changes color. If you also want to change its shape take a lo
::: warning
`vicmd_symbol` is only supported in cmd, fish and zsh.
`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).
:::
### Опции
| Параметр | По умолчанию | Описание |
| ---------------- | ------------------- | -------------------------------------------------------------------------------- |
| `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. |
| `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. |
| `disabled` | `false` | Отключает модуль `character`. |
| Параметр | По умолчанию | Описание |
| -------------------------- | -------------------- | --------------------------------------------------------------------------------------- |
| `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. |
| `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. |
| `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_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. |
| `disabled` | `false` | Отключает модуль `character`. |
### Переменные
@ -803,6 +807,44 @@ The `crystal` module shows the currently installed version of [Crystal](https://
format = "via [✨ $version](bold blue) "
```
## 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. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `daml.yaml` file
### Опции
| Параметр | По умолчанию | Описание |
| ------------------- | ---------------------------------- | ------------------------------------------------------------------------- |
| `format` | `via [$symbol($version )]($style)` | Формат модуля. |
| `version_format` | `v${raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"Λ "` | A format string representing the symbol of Daml |
| `style` | `"bold cyan"` | Стиль модуля. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `detect_files` | `["daml.yaml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `disabled` | `false` | Disables the `daml` module. |
### Переменные
| Переменная | Пример | Описание |
| ---------- | -------- | ------------------------------------ |
| version | `v2.2.0` | The version of `daml` |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style
### Пример
```toml
# ~/.config/starship.toml
[daml]
format = "via [D $version](bold bright-green) "
```
## Dart
The `dart` module shows the currently installed version of [Dart](https://dart.dev/). By default the module will be shown if any of the following conditions are met:
@ -1954,7 +1996,8 @@ Displays the current [Kubernetes context](https://kubernetes.io/docs/concepts/co
| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | Формат модуля. |
| `style` | `"cyan bold"` | Стиль модуля. |
| `context_aliases` | | Table of context aliases to display. |
| `disabled` | `true` | Отключает модуль `kubernetes`. |
| `user_aliases` | | Table of user aliases to display. |
| `disabled` | `true` | Disables the `kubernetes` module. |
### Переменные
@ -1981,11 +2024,14 @@ disabled = false
"dev.local.cluster.k8s" = "dev"
".*/openshift-cluster/.*" = "openshift"
"gke_.*_(?P<var_cluster>[\\w-]+)" = "gke-$var_cluster"
[kubernetes.user_aliases]
"dev.local.cluster.k8s" = "dev"
"root/.*" = "root"
```
#### Regex Matching
Additional to simple aliasing, `context_aliases` also supports extended matching and renaming using regular expressions.
Additional to simple aliasing, `context_aliases` and `user_aliases` also supports extended matching and renaming using regular expressions.
The regular expression must match on the entire kube context, capture groups can be referenced using `$name` and `$N` in the replacement. This is more explained in the [regex crate](https://docs.rs/regex/1.5.4/regex/struct.Regex.html#method.replace) documentation.
@ -2388,7 +2434,7 @@ symbol = "☁️ "
## Версия пакета
Модуль `package` отображается, когда текущий каталог является репозиторием для пакета и показывает его текущую версию. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards` and `dart` packages.
Модуль `package` отображается, когда текущий каталог является репозиторием для пакета и показывает его текущую версию. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages.
- [**npm**](https://docs.npmjs.com/cli/commands/npm) The `npm` package version is extracted from the `package.json` present in the current directory
- [**Cargo**](https://doc.rust-lang.org/cargo/) The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
@ -2405,6 +2451,7 @@ symbol = "☁️ "
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory
- [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory
- [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory
- [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory
- [**Dart**](https://pub.dev/) - The `dart` package version is extracted from the `pubspec.yaml` present in the current directory
> ⚠ Показана версия пакета, исходный код которого находится в текущем каталоге, а не в менеджере пакетов.

View File

@ -251,6 +251,8 @@ Alternatively, install Starship using any of the following package managers:
<details>
<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).
Install Starship using any of the following package managers:
| Repository | Instructions |

View File

@ -206,6 +206,7 @@ $c\
$cmake\
$cobol\
$container\
$daml\
$dart\
$deno\
$dotnet\
@ -268,9 +269,9 @@ format = "$all$directory$character"
## AWS
The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. Alternatively, you can force this module to show the region and profile even when the credentials have not been setup with the `force_display` option. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file. This module also shows an expiration timer when using temporary credentials.
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.
The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is 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 the conditions above are not respected.
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.
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.
@ -537,19 +538,22 @@ By default it only changes color. If you also want to change its shape take a lo
::: uyarı
`vicmd_symbol` is only supported in cmd, fish and zsh.
`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).
:::
### Options
| Option | Default | Description |
| ---------------- | ------------------- | -------------------------------------------------------------------------------- |
| `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. |
| `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. |
| `disabled` | `false` | Disables the `character` module. |
| Option | Default | Description |
| -------------------------- | -------------------- | --------------------------------------------------------------------------------------- |
| `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. |
| `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. |
| `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_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. |
| `disabled` | `false` | Disables the `character` module. |
### Variables
@ -803,6 +807,44 @@ The `crystal` module shows the currently installed version of [Crystal](https://
format = "via [✨ $version](bold blue) "
```
## 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. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `daml.yaml` file
### Options
| Option | Default | Description |
| ------------------- | ---------------------------------- | ------------------------------------------------------------------------- |
| `format` | `via [$symbol($version )]($style)` | The format for the module. |
| `version_format` | `v${raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"Λ "` | A format string representing the symbol of Daml |
| `stil` | `"bold cyan"` | The style for the module. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `detect_files` | `["daml.yaml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `disabled` | `false` | Disables the `daml` module. |
### Variables
| Variable | Example | Description |
| --------- | -------- | ------------------------------------ |
| version | `v2.2.0` | The version of `daml` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
*: This variable can only be used as a part of a style string
### Example
```toml
# ~/.config/starship.toml
[daml]
format = "via [D $version](bold bright-green) "
```
## Dart
The `dart` module shows the currently installed version of [Dart](https://dart.dev/). By default the module will be shown if any of the following conditions are met:
@ -1954,6 +1996,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | The format for the module. |
| `stil` | `"cyan bold"` | The style for the module. |
| `context_aliases` | | Table of context aliases to display. |
| `user_aliases` | | Table of user aliases to display. |
| `disabled` | `true` | Disables the `kubernetes` module. |
### Variables
@ -1981,11 +2024,14 @@ disabled = false
"dev.local.cluster.k8s" = "dev"
".*/openshift-cluster/.*" = "openshift"
"gke_.*_(?P<var_cluster>[\\w-]+)" = "gke-$var_cluster"
[kubernetes.user_aliases]
"dev.local.cluster.k8s" = "dev"
"root/.*" = "root"
```
#### Regex Matching
Additional to simple aliasing, `context_aliases` also supports extended matching and renaming using regular expressions.
Additional to simple aliasing, `context_aliases` and `user_aliases` also supports extended matching and renaming using regular expressions.
The regular expression must match on the entire kube context, capture groups can be referenced using `$name` and `$N` in the replacement. This is more explained in the [regex crate](https://docs.rs/regex/1.5.4/regex/struct.Regex.html#method.replace) documentation.
@ -2388,7 +2434,7 @@ symbol = "☁️ "
## Package Version
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards` and `dart` packages.
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages.
- [**npm**](https://docs.npmjs.com/cli/commands/npm) The `npm` package version is extracted from the `package.json` present in the current directory
- [**Cargo**](https://doc.rust-lang.org/cargo/) The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
@ -2405,6 +2451,7 @@ The `package` module is shown when the current directory is the repository for a
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory
- [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory
- [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory
- [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory
- [**Dart**](https://pub.dev/) - The `dart` package version is extracted from the `pubspec.yaml` present in the current directory
> ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager.

View File

@ -251,6 +251,8 @@ Alternatif olarak aşağıdaki paket yöneticileri ile de Starship'i yükleyebil
<details>
<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).
Starship'i herhangi bir paket yöneticisi ile yükleyin:
| Repository | Instructions |

View File

@ -206,6 +206,7 @@ $c\
$cmake\
$cobol\
$container\
$daml\
$dart\
$deno\
$dotnet\
@ -268,9 +269,9 @@ format = "$all$directory$character"
## AWS
The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. Alternatively, you can force this module to show the region and profile even when the credentials have not been setup with the `force_display` option. Cái này dựa trên các biến môi trường `AWS_REGION`, `AWS_DEFAULT_REGION`, và `AWS_PROFILE` với tập tin `~/.aws/config`. This module also shows an expiration timer when using temporary credentials.
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.
The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is 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 the conditions above are not respected.
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.
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.
@ -537,19 +538,22 @@ Mặc định, nó chỉ thay đổi màu. If you also want to change its shape
::: cảnh báo
`vicmd_symbol` is only supported in cmd, fish and zsh.
`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).
:::
### Các tuỳ chọn
| 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. |
| `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. |
| `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. |
| `disabled` | `false` | Vô hiệu module `character`. |
| 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. |
| `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. |
| `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. |
| `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_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. |
| `disabled` | `false` | Vô hiệu module `character`. |
### Các biến
@ -803,6 +807,44 @@ The `crystal` module shows the currently installed version of [Crystal](https://
format = "via [✨ $version](bold blue) "
```
## 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. 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 `daml.yaml` file
### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ---------------------------------- | ------------------------------------------------------------------------- |
| `format` | `via [$symbol($version )]($style)` | Định dạng cho module. |
| `version_format` | `v${raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"Λ "` | A format string representing the symbol of Daml |
| `style` | `"bold cyan"` | Kiểu cho module. |
| `detect_extensions` | `[]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `["daml.yaml"]` | 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. |
| `disabled` | `false` | Disables the `daml` module. |
### Các biến
| Biến | Ví dụ | Mô tả |
| --------- | -------- | -------------------------------- |
| version | `v2.2.0` | The version of `daml` |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` |
| 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
### Ví dụ
```toml
# ~/.config/starship.toml
[daml]
format = "via [D $version](bold bright-green) "
```
## Dart
The `dart` module shows the currently installed version of [Dart](https://dart.dev/). 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:
@ -1954,6 +1996,7 @@ Mặc định, mô đun này được vô hiệu. Để kích hoạt nó, thiế
| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | Định dạng cho module. |
| `style` | `"cyan bold"` | Kiểu cho module. |
| `context_aliases` | | Table of context aliases to display. |
| `user_aliases` | | Table of user aliases to display. |
| `disabled` | `true` | Disables the `kubernetes` module. |
### Các biến
@ -1981,11 +2024,14 @@ disabled = false
"dev.local.cluster.k8s" = "dev"
".*/openshift-cluster/.*" = "openshift"
"gke_.*_(?P<var_cluster>[\\w-]+)" = "gke-$var_cluster"
[kubernetes.user_aliases]
"dev.local.cluster.k8s" = "dev"
"root/.*" = "root"
```
#### Regex Matching
Additional to simple aliasing, `context_aliases` also supports extended matching and renaming using regular expressions.
Additional to simple aliasing, `context_aliases` and `user_aliases` also supports extended matching and renaming using regular expressions.
The regular expression must match on the entire kube context, capture groups can be referenced using `$name` and `$N` in the replacement. This is more explained in the [regex crate](https://docs.rs/regex/1.5.4/regex/struct.Regex.html#method.replace) documentation.
@ -2388,7 +2434,7 @@ symbol = "☁️ "
## Package Version
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards` and `dart` packages.
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages.
- [**npm**](https://docs.npmjs.com/cli/commands/npm) The `npm` package version is extracted from the `package.json` present in the current directory
- [**Cargo**](https://doc.rust-lang.org/cargo/) The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
@ -2405,6 +2451,7 @@ The `package` module is shown when the current directory is the repository for a
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory
- [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory
- [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory
- [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory
- [**Dart**](https://pub.dev/) - The `dart` package version is extracted from the `pubspec.yaml` present in the current directory
> ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager.

View File

@ -251,6 +251,8 @@ Alternatively, install Starship using any of the following package managers:
<details>
<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).
Install Starship using any of the following package managers:
| Repository | Instructions |

View File

@ -2,8 +2,8 @@
home: true
heroImage: /logo.svg
heroText:
tagline: 轻量级、反应迅速,可定制的高颜值终端!
actionText: 入门
tagline: 轻量级、反应迅速、可无限定制的高颜值终端!
actionText: 快速上手
actionLink: ./guide/
features:
-
@ -15,10 +15,10 @@ features:
-
title: 可自定义
details: 每个小细节都可以按您喜欢的自定义,不论是最小化以求速度,还是最大化以获得最完善的功能。
footer: ISC Licensed | Copyright © 2019-present Starship Contributors
footer: ISC 许可 | 版权所有 © 2019 - 目前 Starship 贡献者
#Used for the description meta tag, for SEO
metaTitle: "Starship可用于各种 Shell 的提示符"
description: Starship是一款轻量级、反应迅速、可自定义的高颜值终端 Shows the information you need, while staying sleek and minimal. 可以为Bash、Fish、ZSH、Ion、Tcsh、Elvish、Nu、Xonsh、Cmd和PowerShell执行快速安装。
description: Starship是一款轻量级、反应迅速、可自定义的高颜值终端 只显示所需要的信息,将优雅和轻量化合二为一。 可以为Bash、Fish、ZSH、Ion、Tcsh、Elvish、Nu、Xonsh、Cmd和PowerShell执行快速安装。
---
<div class="center">
@ -122,7 +122,7 @@ description: Starship是一款轻量级、反应迅速、可自定义的高颜
::: warning
Only elvish v0.18 or higher is supported.
仅支持 elvish 0.18 及更高的版本。
:::
@ -150,17 +150,17 @@ description: Starship是一款轻量级、反应迅速、可自定义的高颜
::: warning
This will change in the future. Only Nushell v0.61+ is supported.
这部分今后可能会改变。 仅支持 Nushell v0.61+。
:::
Add the following to to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
将以下内容添加到您 Nushell 环境文件的末尾(使用 `$nu.env-path` 来获取它的路径):
```sh
mkdir ~/.cache/starship
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`):
然后将以下内容添加到您 Nushell 配置文件的末尾(使用 `$nu.config-path` 来获取它的路径):
```sh
source ~/.cache/starship/init.nu

View File

@ -1,6 +1,6 @@
# 高级配置
`Starship 功能繁多,有时您必须在编辑 <code>starship.toml` 之外做更多工作才能实现某些效果。 此页面详细介绍了一些在 starship 中使用的高级配置技巧。
Starship 功能繁多,有时您必须在编辑 `starship.toml` 之外做更多工作才能实现某些效果。 此页面详细介绍了一些在 starship 中使用的高级配置技巧。
::: warning
@ -8,7 +8,7 @@
:::
## 在 Cmd 中自定义提示和执行前命令
## 在 Cmd 中自定义提示符显示前和执行前命令
Clink 提供了很灵活的 API能在 Cmd shell 中运行预提示和执行前命令。 在 Starship 中使用这些 API 很容易。 对你的 `starship.lua` 按需做出如下修改:
@ -32,11 +32,11 @@ end
load(io.popen('starship init cmd'):read("*a"))()
```
## 在 Bash 中自定义提示和执行命令
## 在 Bash 中自定义提示符显示前和执行前的命令
Bash 并没有类似大多数其它 shell 的正式预执行/预命令框架。 因此,很难在 `bash` 中提供完全可自定义的 hook 机制。 然而Starship 确实能使您有限地在提示符渲染过程中插入自己的函数执行:
Bash 不像多数其他的 Shell 有成体系的预执行框架。 因此,很难在 `bash` 中提供完全可自定义的 hook 机制。 然而Starship 确实能使您有限地在提示符渲染过程中插入自己的函数执行:
- 若要在提示符显示之前运行自定义函数,需要定义此函数,然后将函数名赋值给 `starship_reserved_user_func`。 例如,要在提示符之前绘制一枚火箭,您应该写
- 若要在提示符显示之前运行自定义函数,需要定义此函数,然后将函数名赋值给 `starship_reserved_user_func`。 例如,如果想在提示符前绘制一个火箭,可以这样写:
```bash
function blastoff(){
@ -57,11 +57,11 @@ eval $(starship init bash)
set +o functrace
```
## Custom pre-prompt and pre-execution Commands in PowerShell
## 在 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`. 然而Starship 确实能使您有限地在提示符渲染过程中插入自己的函数执行:
Powershell 不像多数其他的 Shell 有成体系的预执行框架。 因此,很难在 `Powershell` 中提供完全可自定义的 hook 机制。 然而Starship 确实能使您有限地在提示符渲染过程中插入自己的函数执行:
Create a function named `Invoke-Starship-PreCommand`
创建一个名为 `Invoke-Starship-PreCommand` 的函数
```powershell
function Invoke-Starship-PreCommand {
@ -71,7 +71,7 @@ function Invoke-Starship-PreCommand {
## 更改窗口标题
一些 shell 会自动更改您的窗口标题(比如改成您的工作目录)。 Fish 甚至默认会执行此功能。 Starship does not do this, but it's fairly straightforward to add this functionality to `bash`, `zsh`, `cmd` or `powershell`.
一些 shell 会自动更改您的窗口标题(比如改成您的工作目录)。 Fish 甚至默认会执行此功能。 Starship 没有实现此功能,但将这个功能添加到 `bash`、`zsh`、`cmd` 或 `powershell` 是相当简单的。
首先,定义窗口标题更改函数(在 bash 和 zsh 中相同):
@ -106,7 +106,7 @@ function 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.
对于 Cmd您可以使用 `starship_preprompt_user_func` 函数修改窗口标题。
```lua
function starship_preprompt_user_func(prompt)
@ -116,7 +116,7 @@ end
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`.
您也可以为 Powershell 创建一个函数 `Invoke-Starship-PreCommand`,来设置类似的输出。
```powershell
# edit $PROFILE

View File

@ -206,6 +206,7 @@ $c\
$cmake\
$cobol\
$container\
$daml\
$dart\
$deno\
$dotnet\
@ -268,9 +269,9 @@ format = "$all$directory$character"
## AWS
The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. Alternatively, you can force this module to show the region and profile even when the credentials have not been setup with the `force_display` option. 各组件基于 `AWS_REGION``AWS_DEFAULT_REGION` 和 `AWS_PROFILE` 环境变量与 `~/.aws/config` 文件。 This module also shows an expiration timer when using temporary credentials.
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.
The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is 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 the conditions above are not respected.
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.
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.
@ -537,19 +538,22 @@ By default it only changes color. If you also want to change its shape take a lo
::: warning
`vicmd_symbol` is only supported in cmd, fish and zsh.
`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).
:::
### 配置项
| 选项 | 默认值 | 描述 |
| ---------------- | ------------------- | -------------------------------------------------------------------------------- |
| `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. |
| `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. |
| `disabled` | `false` | 禁用 `character` 组件。 |
| 选项 | 默认值 | 描述 |
| -------------------------- | -------------------- | --------------------------------------------------------------------------------------- |
| `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. |
| `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. |
| `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_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. |
| `disabled` | `false` | 禁用 `character` 组件。 |
### Variables
@ -803,13 +807,51 @@ The `crystal` module shows the currently installed version of [Crystal](https://
format = "via [✨ $version](bold blue) "
```
## 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. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `daml.yaml` file
### 配置项
| 选项 | 默认值 | 描述 |
| ------------------- | ---------------------------------- | ------------------------------------------------------------------------- |
| `format` | `via [$symbol($version )]($style)` | 组件格式化模板。 |
| `version_format` | `v${raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"Λ "` | A format string representing the symbol of Daml |
| `style` | `"bold cyan"` | 此组件的样式。 |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `detect_files` | `["daml.yaml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `disabled` | `false` | Disables the `daml` module. |
### Variables
| 字段 | 示例 | 描述 |
| --------- | -------- | --------------------- |
| version | `v2.2.0` | The version of `daml` |
| symbol | | `symbol`对应值 |
| style\* | | `style`对应值 |
*: This variable can only be used as a part of a style string
### 示例
```toml
# ~/.config/starship.toml
[daml]
format = "via [D $version](bold bright-green) "
```
## Dart
The `dart` module shows the currently installed version of [Dart](https://dart.dev/). By default the module will be shown if any of the following conditions are met:
- The current directory contains a file with `.dart` extension
- The current directory contains a `.dart_tool` directory
- 当前目录包含 `pubspec.yaml``pubspec.yml` 或 `pubspec.lock` 文件
- The current directory contains a `pubspec.yaml`, `pubspec.yml` or `pubspec.lock` file
### 配置项
@ -1954,6 +1996,7 @@ Displays the current [Kubernetes context](https://kubernetes.io/docs/concepts/co
| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | 组件格式化模板。 |
| `style` | `"cyan bold"` | 此组件的样式。 |
| `context_aliases` | | Table of context aliases to display. |
| `user_aliases` | | Table of user aliases to display. |
| `disabled` | `true` | Disables the `kubernetes` module. |
### Variables
@ -1981,11 +2024,14 @@ disabled = false
"dev.local.cluster.k8s" = "dev"
".*/openshift-cluster/.*" = "openshift"
"gke_.*_(?P<var_cluster>[\\w-]+)" = "gke-$var_cluster"
[kubernetes.user_aliases]
"dev.local.cluster.k8s" = "dev"
"root/.*" = "root"
```
#### Regex Matching
Additional to simple aliasing, `context_aliases` also supports extended matching and renaming using regular expressions.
Additional to simple aliasing, `context_aliases` and `user_aliases` also supports extended matching and renaming using regular expressions.
The regular expression must match on the entire kube context, capture groups can be referenced using `$name` and `$N` in the replacement. This is more explained in the [regex crate](https://docs.rs/regex/1.5.4/regex/struct.Regex.html#method.replace) documentation.
@ -2388,7 +2434,7 @@ symbol = "☁️ "
## Package Version
当前目录是软件包的代码仓库时,将显示 `package` 组件,并显示软件包当前版本。 The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards` and `dart` packages.
当前目录是软件包的代码仓库时,将显示 `package` 组件,并显示软件包当前版本。 The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages.
- [**npm**](https://docs.npmjs.com/cli/commands/npm) The `npm` package version is extracted from the `package.json` present in the current directory
- [**Cargo**](https://doc.rust-lang.org/cargo/) The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
@ -2405,6 +2451,7 @@ symbol = "☁️ "
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory
- [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory
- [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory
- [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory
- [**Dart**](https://pub.dev/) - The `dart` package version is extracted from the `pubspec.yaml` present in the current directory
> ⚠ 此组件显示的是源代码在当前目录中的软件包的版本,而不是包管理器的版本。

View File

@ -1,4 +1,4 @@
# Frequently Asked Questions
# 常见问题
## 主页示例图中的效果用的是什么配置?
@ -12,29 +12,29 @@
## 如何实现示例图中自动补全的功能?
Completion support, or autocomplete, is provided by your shell of choice. In the case of the demo, the demo was done with [Fish Shell](https://fishshell.com/), which provides completions by default. If you use Z Shell (zsh), I'd suggest taking a look at [zsh-autosuggestions](https://github.com/zsh-users/zsh-autosuggestions).
命令自动补全功能是由您选择的 Shell 提供。 演示中的自动补全由 [Fish Shell](https://fishshell.com/) 完成,它默认开启自动补全。 若您使用 Z Shell (zsh),推荐您查看 [zsh-autosuggestions](https://github.com/zsh-users/zsh-autosuggestions)。
## Do top level `format` and `<module>.disabled` do the same thing?
## 顶层配置 `format``<module>.disabled` 的功能是相同的吗?
是的,他们都可以用来禁用提示符中的组件。 如果你只是想禁用组件,推荐使用 `<module>.disabled`,原因如下:
- Disabling modules is more explicit than omitting them from the top level `format`
- 在顶层配置 `format` 里忽略组件与禁用组件相比较,后者更加明确
- 当 Starship 升级后,新组件将能够自动被加入提示符中
## The docs say Starship is cross-shell. Why isn't my preferred shell supported?
## 文档中写 Starship 适用于任何 Shell。 为什么我常用的 Shell 不支持?
Starship 的构建方式决定了它应当能够增加对几乎所有 shell 的支持。 Starship 的二进制文件是无状态、不知道当前 shell 的,所以只要你的 shell 支持自定义提示符和 shell 扩展,就能使用 Starship。
这是一个在 bash 上使用 Starship 的简单例子:
```sh
# Get the status code from the last command executed
# 获取最后执行命令的返回值
STATUS=$?
# Get the number of jobs running.
# 获取运行后台程序的数量
NUM_JOBS=$(jobs -p | wc -l)
# Set the prompt to the output of `starship prompt`
# 设置提示符为 `starship prompt` 的输出
PS1="$(starship prompt --status=$STATUS --jobs=$NUM_JOBS)"
```
@ -48,53 +48,53 @@ starship prompt --help
Starship 会处理所提供的全部上下文参数并在提示符中显示,但没有参数是“必需”的。
## How do I run Starship on Linux distributions with older versions of glibc?
## 我如何在 Linux 发行版上使用旧版本 glibc 运行 Starship
If you get an error like "_version 'GLIBC_2.18' not found (required by starship)_" when using the prebuilt binary (for example, on CentOS 6 or 7), you can use a binary compiled with `musl` instead of `glibc`:
若您在使用预构建的程序时遇到类似“_version 'GLIBC_2.18' not found (required by starship)_”的错误例如在 CentOS 6 或 7 里运行)您可以使用 `musl` 的编译版本,而非 `glibc` 版本。
```sh
curl -sS https://starship.rs/install.sh | sh -s -- --platform unknown-linux-musl
```
## Why do I see `Executing command "..." timed out.` warnings?
## 为什么我会遇到 `Executing command "..." timed out.` 警告?
Starship executes different commands to get information to display in the prompt, for example the version of a program or the current git status. To make sure starship doesn't hang while trying to execute these commands we set a time limit, if a command takes longer than this limit starship will stop the execution of the command and output the above warning, this is expected behaviour. This time limit is configurable using the [`command_timeout`key](/config/#prompt) so if you want you can increase the time limit. You can also follow the debugging steps below to see which command is being slow and see if you can optimise it. Finally you can set the `STARSHIP_LOG` env var to `error` to hide these warnings.
Starship 会执行数个不同的命令来获取应该显示的信息,例如某个程序的版本号、现在 Git 的工作树状态。 为保证 Starship 不会在执行某条命令时卡住Starship 会终止执行时间过长的命令并且输出以上警告。这是正常现象。 若希望增加时长限制,它可以在 [`command_timeout` 设置](/config/#prompt) 处自定义。 您也可以按照下文的调试步骤查看并优化运行慢的命令。 最后,您也可以设置环境变量 `STARSHIP_LOG``error` 来隐藏这些警告。
## I see symbols I don't understand or expect, what do they mean?
## 我不理解某些符号,它们是什么意思?
If you see symbols that you don't recognise you can use `starship explain` to explain the currently showing modules.
若您不清楚某些符号,可以使用 `starship explain` 查看正在显示的组件。
## Starship is doing something unexpected, how can I debug it?
## Starship 运行不正常,我该如何调试?
You can enable the debug logs by using the `STARSHIP_LOG` env var. These logs can be very verbose so it is often useful to use the `module` command if you are trying to debug a particular module, for example, if you are trying to debug the `rust` module you could run the following command to get the trace logs and output from the module.
您可以使用环境变量 `STARSHIP_LOG` 来开启调试日志。 这些日志可能过于详细,所以更常使用 `module` 来调试特定的组件。例如要调试 `rust` 组件,您可以使用下列命令来获取它的日志和输出。
```sh
env STARSHIP_LOG=trace starship module rust
```
If starship is being slow you can try using the `timings` command to see if there is a particular module or command that to blame.
若 Starship 运行缓慢,您可以使用 `timings` 命令查看运行缓慢的组件或命令。
```sh
env STARSHIP_LOG=trace starship timings
```
This will output the trace log and a breakdown of all modules that either took more than 1ms to execute or produced some output.
它会输出日志,并且记录有输出的组件、运行时长超过 1 毫秒的组件。
Finally if you find a bug you can use the `bug-report` command to create a Github issue.
最后,如果您发现了错误,可以使用 `bug-report` 命令创建 GitHub Issue。
```sh
starship bug-report
```
## Why don't I see a glyph symbol in my prompt?
## 为什么我在提示符中看不到某个字符?
最常见的原因是系统配置有问题。 有个别Linux发行版不自带对字体的支持。 请确保:
- Your locale is set to a UTF-8 value, like `de_DE.UTF-8` or `ja_JP.UTF-8`. If `LC_ALL` is not a UTF-8 value, [you will need to change it](https://www.tecmint.com/set-system-locales-in-linux/).
- 您的字符集应设置为 UTF-8例如 `de_DE.UTF-8``ja_JP.UTF-8`。 若 `LC_ALL` 不是 UTF-8 [你需要手动设置它](https://www.tecmint.com/set-system-locales-in-linux/)。
- 安装了 emoji 字体。 大部分系统都会自带 emoji 字体,但有些系统(例如 Arch Linux则没有。 字体一般可以用系统的包管理器安装,常见的字体有 [Noto emoji](https://www.google.com/get/noto/help/emoji/) 等。
- You are using a [Nerd Font](https://www.nerdfonts.com/).
- 您正在使用 [Nerd Font](https://www.nerdfonts.com/)。
To test your system, run the following commands in a terminal:
在终端内运行以下命令来测试:
```sh
echo -e "\xf0\x9f\x90\x8d"
@ -103,7 +103,7 @@ echo -e "\xee\x82\xa0"
第一行应该显示出一个[蛇的 emoji](https://emojipedia.org/snake/),第二行应该显示出 [powerline 的分支符号e0a0](https://github.com/ryanoasis/powerline-extra-symbols#glyphs).
If either symbol fails to display correctly, your system is still misconfigured. Unfortunately, getting font configuration correct is sometimes difficult. Users on the Discord may be able to help. If both symbols display correctly, but you still don't see them in starship, [file a bug report!](https://github.com/starship/starship/issues/new/choose)
若任一符号显示错误,则您的系统配置不正确。 有些时候正确配置字体并不简单。 Discord 里的用户或许能提供帮助。 若两个字符显示正确,但您仍然不能在 Starship 中看到那个字符,请 [提交错误报告](https://github.com/starship/starship/issues/new/choose)
## 如何卸载 Starship
@ -117,6 +117,6 @@ Starship 的卸载过程与安装过程一样简单。
如果 Starship 是用安装脚本安装的,可以用以下命令删除二进制文件:
```sh
# Locate and delete the starship binary
# 找到并且删除 Starship 二进制文件
sh -c 'rm "$(command -v 'starship')"'
```

View File

@ -150,7 +150,7 @@
align="right"
/>
**轻量级、反应迅速,可定制的高颜值终端!**
**轻量级、反应迅速、可无限定制的高颜值终端!**
- **快:** 很快 —— 真的真的非常快! 🚀
- **定制化:** 可定制各种各样的提示符。
@ -251,6 +251,8 @@ curl -sS https://starship.rs/install.sh | sh
<details>
<summary>Windows</summary>
在 [发布页](https://github.com/starship/starship/releases/latest) 下载 MSI 包来安装最新版。
使用下列软件包管理器安装Starship
| 软件包来源 | 指令 |
@ -326,20 +328,20 @@ eval $(starship init ion)
<details>
<summary>Nushell</summary>
Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
将以下内容添加到您 Nushell 环境文件的末尾(使用 `$nu.env-path` 来获取它的路径):
```sh
mkdir ~/.cache/starship
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`):
然后将以下内容添加到您 Nushell 配置文件的末尾(使用 `$nu.config-path` 来获取它的路径):
```sh
source ~/.cache/starship/init.nu
```
Note: Only Nushell v0.61+ is supported
注意:仅支持 Nushell v0.61+
</details>
@ -389,7 +391,7 @@ eval "$(starship init zsh)"
### 步骤 3. 配置 Starship
打开一个新的 Shell 实例,你应该就能看到漂亮的 Shell 新提示符了。 如果你对默认配置感到满意,那么开始使用吧
打开一个新的 Shell 实例,你应该就能看到漂亮的 Shell 新提示符了。 如果你对默认配置感到满意,就可以开始享用了
如果你想进一步配置 Starship查阅下列内容
@ -409,17 +411,17 @@ eval "$(starship init zsh)"
请参考这些曾经为 Starship 提供启发的工程。 🙏
- **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** A ZSH prompt for astronauts.
- **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** 为宇航员准备的 ZSH 提示符。
- **[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)** 可用于所有 Shell 的 Robbyrussell 主题,使用 JavaScript 编写。
- **[reujab/silver](https://github.com/reujab/silver)** A cross-shell customizable powerline-like prompt with icons.
- **[reujab/silver](https://github.com/reujab/silver)** 带图标且可定制的类 Powerline 提示符,适用于所有 Shell。
<p align="center">
<br>
<img width="100" src="https://raw.githubusercontent.com/starship/starship/master/media/icon.png" alt="Starship 图标">
</p>
## 📝 License
## 📝 许可证
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.
版权所有 © 2019 - 目前, [Starship 贡献者](https://github.com/starship/starship/graphs/contributors).<br /> 此项目使用 [ISC](https://github.com/starship/starship/blob/master/LICENSE) 许可.

View File

@ -2,23 +2,23 @@
这里有一系列社区提供的 Starship 预设。 如果您想分享一套配置,请 [提交 PR](https://github.com/starship/starship/edit/master/docs/presets/README.md) 来更新此文件! 😊
To get details on how to use a preset, simply click on the image.
单击图像以获取使用预设的详细方法。
## [Nerd 字体符号](./nerd-font.md)
This preset changes the symbols for each module to use Nerd Font symbols.
此预设使用 Nerd 字体的符号显示所有组件。
[![Screenshot of Nerd Font Symbols preset](/presets/img/nerd-font-symbols.png "Click to view Nerd Font Symbols preset")](./nerd-font)
[![Nerd 字体符号预设截图](/presets/img/nerd-font-symbols.png "Click to view Nerd Font Symbols preset")](./nerd-font)
## [Bracketed Segments](./bracketed-segments.md)
This preset changes the format of all the built-in modules to show their segment in brackets instead of using the default Starship wording ("via", "on", etc.).
此预设使用括号来分隔所有组件的提示符,不使用 Starship 默认的分隔词“via”“on” 等等)。
[![Screenshot of Bracketed Segments preset](/presets/img/bracketed-segments.png "Click to view Bracketed Segments preset")](./bracketed-segments)
## [纯文本符号](./plain-text.md)
This preset changes the symbols for each module into plain text. Great if you don't have access to Unicode.
此预设将所有组件的符号改为纯文本。 适合没有 Unicode 的环境。
[![Screenshot of Plain Text Symbols preset](/presets/img/plain-text-symbols.png "Click to view Plain Text Symbols preset")](./plain-text)
@ -36,6 +36,6 @@ This preset changes the symbols for each module into plain text. Great if you do
## [Pastel Powerline](./pastel-powerline.md)
This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). It also shows how path substitution works in starship.
此预设的灵感来自于 [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json)。 它同时也演示了 Starship 的路径替换功能。
[![Screenshot of Pastel Powerline preset](/presets/img/pastel-powerline.png "Click to view Pure Prompt preset")](./pastel-powerline)

View File

@ -2,7 +2,7 @@
# Bracketed Segments Preset
This preset changes the format of all the built-in modules to show their segment in brackets instead of using the default Starship wording ("via", "on", etc.).
此预设使用括号来分隔所有组件的提示符,不使用 Starship 默认的分隔词“via”“on” 等等)。
![Screenshot of Bracketed Segments preset](/presets/img/bracketed-segments.png)

View File

@ -1,10 +1,10 @@
[Return to Presets](./README.md#nerd-font-symbols)
[返回全部预设](./README.md#nerd-font-symbols)
# Nerd Font Symbols Preset
# Nerd 字体符号预设
This preset changes the symbols for each module to use Nerd Font symbols.
此预设使用 Nerd 字体的符号显示所有组件。
![Screenshot of Nerd Font Symbols preset](/presets/img/nerd-font-symbols.png)
![Nerd 字体符号预设截图](/presets/img/nerd-font-symbols.png)
### 前置要求
@ -12,6 +12,6 @@ This preset changes the symbols for each module to use Nerd Font symbols.
### 配置
[Click to download TOML](/presets/toml/nerd-font-symbols.toml)
[点击下载 TOML 文件](/presets/toml/nerd-font-symbols.toml)
<<< @/.vuepress/public/presets/toml/nerd-font-symbols.toml

View File

@ -2,7 +2,7 @@
# Pastel Powerline Preset
This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). It also shows how path substitution works in starship.
此预设的灵感来自于 [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json)。 它同时也演示了 Starship 的路径替换功能。
![Screenshot of Pastel Powerline preset](/presets/img/pastel-powerline.png)

View File

@ -2,7 +2,7 @@
## Plain Text Symbols Preset
This preset changes the symbols for each module into plain text. Great if you don't have access to Unicode.
此预设将所有组件的符号改为纯文本。 适合没有 Unicode 的环境。
![Screenshot of Plain Text Symbols preset](/presets/img/plain-text-symbols.png)

View File

@ -206,6 +206,7 @@ $c\
$cmake\
$cobol\
$container\
$daml\
$dart\
$deno\
$dotnet\
@ -268,9 +269,9 @@ format = "$all$directory$character"
## AWS
The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. Alternatively, you can force this module to show the region and profile even when the credentials have not been setup with the `force_display` option. 這是根據 `AWS_REGION`、`AWS_DEFAULT_REGION` 與 `AWS_PROFILE` 環境變數及 `~/.aws/config` 檔案。 This module also shows an expiration timer when using temporary credentials.
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.
The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is 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 the conditions above are not respected.
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.
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.
@ -537,19 +538,22 @@ By default it only changes color. If you also want to change its shape take a lo
::: warning
`vicmd_symbol` is only supported in cmd, fish and zsh.
`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).
:::
### 選項
| Option | 預設 | 說明 |
| ---------------- | ------------------- | -------------------------------------------------------------------------------- |
| `format` | `"$symbol "` | The format string used before the text input. |
| `success_symbol` | `"[](bold green)"` | The format string used before the text input if the previous command succeeded. |
| `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. |
| `disabled` | `false` | 停用 `character` 模組。 |
| Option | 預設 | 說明 |
| -------------------------- | -------------------- | --------------------------------------------------------------------------------------- |
| `format` | `"$symbol "` | The format string used before the text input. |
| `success_symbol` | `"[](bold green)"` | The format string used before the text input if the previous command succeeded. |
| `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. |
| `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_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. |
| `disabled` | `false` | 停用 `character` 模組。 |
### Variables
@ -803,13 +807,51 @@ The `crystal` module shows the currently installed version of [Crystal](https://
format = "via [✨ $version](bold blue) "
```
## 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. By default the module will be shown if any of the following conditions are met:
- The current directory contains a `daml.yaml` file
### 選項
| Option | 預設 | 說明 |
| ------------------- | ---------------------------------- | ------------------------------------------------------------------------- |
| `format` | `via [$symbol($version )]($style)` | The format for the module. |
| `version_format` | `v${raw}` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"Λ "` | A format string representing the symbol of Daml |
| `style` | `"bold cyan"` | 這個模組的風格。 |
| `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `detect_files` | `["daml.yaml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. |
| `disabled` | `false` | Disables the `daml` module. |
### Variables
| 變數 | 範例 | 說明 |
| --------- | -------- | ------------------------------------ |
| version | `v2.2.0` | The version of `daml` |
| symbol | | Mirrors the value of option `symbol` |
| style\* | | Mirrors the value of option `style` |
*: This variable can only be used as a part of a style string
### 範例
```toml
# ~/.config/starship.toml
[daml]
format = "via [D $version](bold bright-green) "
```
## Dart
The `dart` module shows the currently installed version of [Dart](https://dart.dev/). By default the module will be shown if any of the following conditions are met:
- The current directory contains a file with `.dart` extension
- The current directory contains a `.dart_tool` directory
- 現在資料夾中包含一個 `pubspec.yaml`、`pubspec.yml` 或 `pubspec.lock` 檔案
- The current directory contains a `pubspec.yaml`, `pubspec.yml` or `pubspec.lock` file
### 選項
@ -1954,6 +1996,7 @@ Displays the current [Kubernetes context](https://kubernetes.io/docs/concepts/co
| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | The format for the module. |
| `style` | `"cyan bold"` | 這個模組的風格。 |
| `context_aliases` | | Table of context aliases to display. |
| `user_aliases` | | Table of user aliases to display. |
| `disabled` | `true` | Disables the `kubernetes` module. |
### Variables
@ -1981,11 +2024,14 @@ disabled = false
"dev.local.cluster.k8s" = "dev"
".*/openshift-cluster/.*" = "openshift"
"gke_.*_(?P<var_cluster>[\\w-]+)" = "gke-$var_cluster"
[kubernetes.user_aliases]
"dev.local.cluster.k8s" = "dev"
"root/.*" = "root"
```
#### Regex Matching
Additional to simple aliasing, `context_aliases` also supports extended matching and renaming using regular expressions.
Additional to simple aliasing, `context_aliases` and `user_aliases` also supports extended matching and renaming using regular expressions.
The regular expression must match on the entire kube context, capture groups can be referenced using `$name` and `$N` in the replacement. This is more explained in the [regex crate](https://docs.rs/regex/1.5.4/regex/struct.Regex.html#method.replace) documentation.
@ -2388,7 +2434,7 @@ symbol = "☁️ "
## 套件版本
The `package` 模組在現在資料夾是一個套件的儲藏庫時出現,並顯示他的現在版本。 The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards` and `dart` packages.
The `package` 模組在現在資料夾是一個套件的儲藏庫時出現,並顯示他的現在版本。 The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages.
- [**npm**](https://docs.npmjs.com/cli/commands/npm) The `npm` package version is extracted from the `package.json` present in the current directory
- [**Cargo**](https://doc.rust-lang.org/cargo/) The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
@ -2405,6 +2451,7 @@ The `package` 模組在現在資料夾是一個套件的儲藏庫時出現,並
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present in the current directory
- [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present in the current directory
- [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory
- [**Daml**](https://www.digitalasset.com/developers) - The `daml` package version is extracted from the `daml.yaml` present in the current directory
- [**Dart**](https://pub.dev/) - The `dart` package version is extracted from the `pubspec.yaml` present in the current directory
> ⚠️ 顯示出來的版本是從你的現在資料夾之中擷取出來的,並非從套件管理員取得。

View File

@ -251,6 +251,8 @@ Alternatively, install Starship using any of the following package managers:
<details>
<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).
Install Starship using any of the following package managers:
| Repository | Instructions |