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

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

Browse Source
This commit is contained in:
Matan Kushner 2022-05-24 17:19:44 -04:00 committed by GitHub
parent fda3ed8cdf
commit b9a6b66d6e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
57 changed files with 2204 additions and 1954 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/ar-SA/README.md
View File

@ -120,7 +120,11 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
#### Elvish #### Elvish
::: warning يدعم فقط elvish v0.18 أو أعلى. ::: ::: تحذير
Only elvish v0.18 or higher is supported.
:::
أضف ما يلي إلى نهاية `~/.elvish/rc.elv`: أضف ما يلي إلى نهاية `~/.elvish/rc.elv`:
@ -144,7 +148,13 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
#### Nushell #### Nushell
::: تحذير هذا سوف يتغير في المستقبل. Only Nushell v0.60+ is supported. ::: Run the following: ::: تحذير
This will change in the future. Only Nushell v0.61+ is supported.
:::
Add the following to to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu starship init nu | save ~/.cache/starship/init.nu
@ -153,8 +163,6 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`): And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):
```sh ```sh
mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```

125
docs/ar-SA/config/README.md
View File

@ -280,16 +280,16 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL
### Options ### Options
| Option | الافتراضي | الوصف | | Option | الافتراضي | الوصف |
| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | | ------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | The format for the module. | | `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)'` | The format for the module. |
| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. | | `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
| `region_aliases` | | Table of region aliases to display in addition to the AWS name. | | `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | | `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. |
| `style` | `"bold yellow"` | The style for the module. | | `style` | `"bold yellow"` | The style for the module. |
| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. | | `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. |
| `disabled` | `false` | Disables the `AWS` module. | | `disabled` | `false` | Disables the `AWS` module. |
| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. | | `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. |
### Variables ### Variables
@ -1140,7 +1140,9 @@ The `env_var` module displays the current value of a selected environment variab
- The `variable` configuration option matches an existing environment variable - The `variable` configuration option matches an existing environment variable
- The `variable` configuration option is not defined, but the `default` configuration option is - The `variable` configuration option is not defined, but the `default` configuration option is
::: tip Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. ::: tip
Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character.
Example: following configuration will display value of USER environment variable Example: following configuration will display value of USER environment variable
@ -1342,17 +1344,17 @@ The `git_branch` module shows the active branch of the repo in your current dire
### Options ### Options
| Option | الافتراضي | الوصف | | Option | الافتراضي | الوصف |
| -------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | | -------------------- | ------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | | `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. |
| `format` | `"on [$symbol$branch]($style) "` | The format for the module. Use `"$branch"` to refer to the current branch name. | | `format` | `"on [$symbol$branch(:$remote_branch)]($style) "` | The format for the module. Use `"$branch"` to refer to the current branch name. |
| `symbol` | `" "` | A format string representing the symbol of git branch. | | `symbol` | `" "` | A format string representing the symbol of git branch. |
| `style` | `"bold purple"` | The style for the module. | | `style` | `"bold purple"` | The style for the module. |
| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | | `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. |
| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. | | `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. |
| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | | `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". | | `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for "master" or "main". |
| `disabled` | `false` | Disables the `git_branch` module. | | `disabled` | `false` | Disables the `git_branch` module. |
### Variables ### Variables
@ -1602,6 +1604,7 @@ The `golang` module shows the currently installed version of [Go](https://golang
- The current directory contains a `go.mod` file - The current directory contains a `go.mod` file
- The current directory contains a `go.sum` file - The current directory contains a `go.sum` file
- The current directory contains a `go.work` file
- The current directory contains a `glide.yaml` file - The current directory contains a `glide.yaml` file
- The current directory contains a `Gopkg.yml` file - The current directory contains a `Gopkg.yml` file
- The current directory contains a `Gopkg.lock` file - The current directory contains a `Gopkg.lock` file
@ -1611,16 +1614,16 @@ The `golang` module shows the currently installed version of [Go](https://golang
### Options ### Options
| Option | الافتراضي | الوصف | | Option | الافتراضي | الوصف |
| ------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. | | `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
| `detect_extensions` | `["go"]` | Which extensions should trigger this module. | | `detect_extensions` | `["go"]` | Which extensions should trigger this module. |
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. | | `detect_files` | `["go.mod", "go.sum", "go.work", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `["Godeps"]` | Which folders should trigger this module. | | `detect_folders` | `["Godeps"]` | Which folders should trigger this module. |
| `style` | `"bold cyan"` | The style for the module. | | `style` | `"bold cyan"` | The style for the module. |
| `disabled` | `false` | Disables the `golang` module. | | `disabled` | `false` | Disables the `golang` module. |
### Variables ### Variables
@ -1719,20 +1722,22 @@ The `hostname` module shows the system hostname.
### Options ### Options
| Option | الافتراضي | الوصف | | Option | الافتراضي | الوصف |
| ---------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | | ------------ | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `ssh_only` | `true` | Only show hostname when connected to an SSH session. | | `ssh_only` | `true` | Only show hostname when connected to an SSH session. |
| `trim_at` | `"."` | String that the hostname is cut off at, after the first match. `"."` will stop after the first dot. `""` will disable any truncation | | `ssh_symbol` | `"🌐 "` | A format string representing the symbol when connected to SSH session. |
| `format` | `"[$hostname]($style) in "` | The format for the module. | | `trim_at` | `"."` | String that the hostname is cut off at, after the first match. `"."` will stop after the first dot. `""` will disable any truncation |
| `style` | `"bold dimmed green"` | The style for the module. | | `format` | `"[$ssh_symbol$hostname]($style) in "` | The format for the module. |
| `disabled` | `false` | Disables the `hostname` module. | | `style` | `"bold dimmed green"` | The style for the module. |
| `disabled` | `false` | Disables the `hostname` module. |
### Variables ### Variables
| Variable | مثال | الوصف | | Variable | مثال | الوصف |
| --------- | ---------- | ----------------------------------- | | ---------- | ---------- | ----------------------------------------------------- |
| hostname | `computer` | The hostname of the computer | | hostname | `computer` | The hostname of the computer |
| style\* | | Mirrors the value of option `style` | | style\* | | Mirrors the value of option `style` |
| ssh_symbol | `"🌏 "` | The symbol to represent when connected to SSH session |
*: This variable can only be used as a part of a style string *: This variable can only be used as a part of a style string
@ -1743,7 +1748,7 @@ The `hostname` module shows the system hostname.
[hostname] [hostname]
ssh_only = false ssh_only = false
format = "on [$hostname](bold red) " format = "[$ssh_symbol](bold blue) on [$hostname](bold red) "
trim_at = ".companyname.com" trim_at = ".companyname.com"
disabled = false disabled = false
``` ```
@ -2383,22 +2388,22 @@ symbol = "☁️ "
## Package Version ## Package Version
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `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` 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 - [**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 - [**Cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
- [**Nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command - [**Nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command
- [**Poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory - [**Poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
- [**Python**](https://www.python.org) - The `python` package version is extracted from the `setup.cfg` present in the current directory - [**Python**](https://www.python.org) - The `python` package version is extracted from a [PEP 621](https://peps.python.org/pep-0621/) compliant `pyproject.toml` or a `setup.cfg` present in the current directory
- [**Composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory - [**Composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory
- [**Gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present - [**Gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present in the current directory
- [**Julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present - [**Julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present in the current directory
- [**Mix**](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present - [**Mix**](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present in the current directory
- [**Helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present - [**Helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present in the current directory
- [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present - [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory
- [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present - [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present - [**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 - [**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 - [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory
- [**Dart**](https://pub.dev/) - The `dart` package version is extracted from the `pubspec.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
@ -2845,11 +2850,13 @@ By default the `rust` module shows the currently installed version of [Rust](htt
### Variables ### Variables
| Variable | مثال | الوصف | | Variable | مثال | الوصف |
| --------- | ----------------- | ------------------------------------ | | --------- | ----------------- | -------------------------------------------- |
| version | `v1.43.0-nightly` | The version of `rustc` | | version | `v1.43.0-nightly` | The version of `rustc` |
| symbol | | Mirrors the value of option `symbol` | | numver | `1.51.0` | The numeric component of the `rustc` version |
| style\* | | Mirrors the value of option `style` | | toolchain | `beta` | The toolchain version |
| 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 *: This variable can only be used as a part of a style string

5
docs/ar-SA/guide/README.md
View File

@ -326,7 +326,7 @@ eval $(starship init ion)
<details> <details>
<summary>Nushell</summary> <summary>Nushell</summary>
Run the following: Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
@ -336,11 +336,10 @@ 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`): And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):
```sh ```sh
starship init nu | save ~/.cache/starship/init.nu
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```
Note: Only Nushell v0.60+ is supported Note: Only Nushell v0.61+ is supported
</details> </details>

16
docs/ckb-IR/README.md
View File

@ -120,7 +120,11 @@ description: 'Starship: یەکێ لە promptـە سوکەڵە، خێرا، و ب
#### Elvish #### Elvish
::: warning تەنها elvish v0.18 یان بەرزتر پشتگیری کراوە. ::: ::: ئاگادارکردنەوە
Only elvish v0.18 or higher is supported.
:::
ئەمەی خوارەوە زیادبکە لە کۆتایی `~/.elvish/rc.elv`: ئەمەی خوارەوە زیادبکە لە کۆتایی `~/.elvish/rc.elv`:
@ -144,7 +148,13 @@ description: 'Starship: یەکێ لە promptـە سوکەڵە، خێرا، و ب
#### Nushell #### Nushell
::: warning This will change in the future. Only Nushell v0.60+ is supported. ::: Run the following: ::: ئاگادارکردنەوە
This will change in the future. Only Nushell v0.61+ is supported.
:::
Add the following to to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu starship init nu | save ~/.cache/starship/init.nu
@ -153,8 +163,6 @@ description: 'Starship: یەکێ لە promptـە سوکەڵە، خێرا، و ب
And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`): And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):
```sh ```sh
mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```

125
docs/ckb-IR/config/README.md
View File

@ -280,16 +280,16 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | | ------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | The format for the module. | | `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)'` | The format for the module. |
| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. | | `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
| `region_aliases` | | Table of region aliases to display in addition to the AWS name. | | `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | | `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. |
| `style` | `"bold yellow"` | The style for the module. | | `style` | `"bold yellow"` | The style for the module. |
| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. | | `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. |
| `disabled` | `false` | Disables the `AWS` module. | | `disabled` | `false` | Disables the `AWS` module. |
| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. | | `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. |
### Variables ### Variables
@ -1140,7 +1140,9 @@ The `env_var` module displays the current value of a selected environment variab
- The `variable` configuration option matches an existing environment variable - The `variable` configuration option matches an existing environment variable
- The `variable` configuration option is not defined, but the `default` configuration option is - The `variable` configuration option is not defined, but the `default` configuration option is
::: tip Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. ::: tip
Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character.
Example: following configuration will display value of USER environment variable Example: following configuration will display value of USER environment variable
@ -1342,17 +1344,17 @@ The `git_branch` module shows the active branch of the repo in your current dire
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| -------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | | -------------------- | ------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | | `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. |
| `format` | `"on [$symbol$branch]($style) "` | The format for the module. Use `"$branch"` to refer to the current branch name. | | `format` | `"on [$symbol$branch(:$remote_branch)]($style) "` | The format for the module. Use `"$branch"` to refer to the current branch name. |
| `symbol` | `" "` | A format string representing the symbol of git branch. | | `symbol` | `" "` | A format string representing the symbol of git branch. |
| `style` | `"bold purple"` | The style for the module. | | `style` | `"bold purple"` | The style for the module. |
| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | | `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. |
| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. | | `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. |
| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | | `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". | | `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for "master" or "main". |
| `disabled` | `false` | Disables the `git_branch` module. | | `disabled` | `false` | Disables the `git_branch` module. |
### Variables ### Variables
@ -1602,6 +1604,7 @@ The `golang` module shows the currently installed version of [Go](https://golang
- The current directory contains a `go.mod` file - The current directory contains a `go.mod` file
- The current directory contains a `go.sum` file - The current directory contains a `go.sum` file
- The current directory contains a `go.work` file
- The current directory contains a `glide.yaml` file - The current directory contains a `glide.yaml` file
- The current directory contains a `Gopkg.yml` file - The current directory contains a `Gopkg.yml` file
- The current directory contains a `Gopkg.lock` file - The current directory contains a `Gopkg.lock` file
@ -1611,16 +1614,16 @@ The `golang` module shows the currently installed version of [Go](https://golang
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. | | `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
| `detect_extensions` | `["go"]` | Which extensions should trigger this module. | | `detect_extensions` | `["go"]` | Which extensions should trigger this module. |
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. | | `detect_files` | `["go.mod", "go.sum", "go.work", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `["Godeps"]` | Which folders should trigger this module. | | `detect_folders` | `["Godeps"]` | Which folders should trigger this module. |
| `style` | `"bold cyan"` | The style for the module. | | `style` | `"bold cyan"` | The style for the module. |
| `disabled` | `false` | Disables the `golang` module. | | `disabled` | `false` | Disables the `golang` module. |
### Variables ### Variables
@ -1719,20 +1722,22 @@ The `hostname` module shows the system hostname.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | | ------------ | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `ssh_only` | `true` | Only show hostname when connected to an SSH session. | | `ssh_only` | `true` | Only show hostname when connected to an SSH session. |
| `trim_at` | `"."` | String that the hostname is cut off at, after the first match. `"."` will stop after the first dot. `""` will disable any truncation | | `ssh_symbol` | `"🌐 "` | A format string representing the symbol when connected to SSH session. |
| `format` | `"[$hostname]($style) in "` | The format for the module. | | `trim_at` | `"."` | String that the hostname is cut off at, after the first match. `"."` will stop after the first dot. `""` will disable any truncation |
| `style` | `"bold dimmed green"` | The style for the module. | | `format` | `"[$ssh_symbol$hostname]($style) in "` | The format for the module. |
| `disabled` | `false` | Disables the `hostname` module. | | `style` | `"bold dimmed green"` | The style for the module. |
| `disabled` | `false` | Disables the `hostname` module. |
### Variables ### Variables
| گۆڕاو | نموونە | Description | | گۆڕاو | نموونە | Description |
| --------- | ---------- | ----------------------------------- | | ---------- | ---------- | ----------------------------------------------------- |
| hostname | `computer` | The hostname of the computer | | hostname | `computer` | The hostname of the computer |
| style\* | | Mirrors the value of option `style` | | style\* | | Mirrors the value of option `style` |
| ssh_symbol | `"🌏 "` | The symbol to represent when connected to SSH session |
*: This variable can only be used as a part of a style string *: This variable can only be used as a part of a style string
@ -1743,7 +1748,7 @@ The `hostname` module shows the system hostname.
[hostname] [hostname]
ssh_only = false ssh_only = false
format = "on [$hostname](bold red) " format = "[$ssh_symbol](bold blue) on [$hostname](bold red) "
trim_at = ".companyname.com" trim_at = ".companyname.com"
disabled = false disabled = false
``` ```
@ -2383,22 +2388,22 @@ symbol = "☁️ "
## Package Version ## Package Version
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `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` 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 - [**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 - [**Cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
- [**Nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command - [**Nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command
- [**Poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory - [**Poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
- [**Python**](https://www.python.org) - The `python` package version is extracted from the `setup.cfg` present in the current directory - [**Python**](https://www.python.org) - The `python` package version is extracted from a [PEP 621](https://peps.python.org/pep-0621/) compliant `pyproject.toml` or a `setup.cfg` present in the current directory
- [**Composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory - [**Composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory
- [**Gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present - [**Gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present in the current directory
- [**Julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present - [**Julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present in the current directory
- [**Mix**](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present - [**Mix**](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present in the current directory
- [**Helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present - [**Helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present in the current directory
- [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present - [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory
- [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present - [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present - [**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 - [**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 - [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory
- [**Dart**](https://pub.dev/) - The `dart` package version is extracted from the `pubspec.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
@ -2845,11 +2850,13 @@ By default the `rust` module shows the currently installed version of [Rust](htt
### Variables ### Variables
| گۆڕاو | نموونە | Description | | گۆڕاو | نموونە | Description |
| --------- | ----------------- | ------------------------------------ | | --------- | ----------------- | -------------------------------------------- |
| version | `v1.43.0-nightly` | The version of `rustc` | | version | `v1.43.0-nightly` | The version of `rustc` |
| symbol | | Mirrors the value of option `symbol` | | numver | `1.51.0` | The numeric component of the `rustc` version |
| style\* | | Mirrors the value of option `style` | | toolchain | `beta` | The toolchain version |
| 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 *: This variable can only be used as a part of a style string

5
docs/ckb-IR/guide/README.md
View File

@ -322,7 +322,7 @@ eval $(starship init ion)
<details> <details>
<summary>Nushell</summary> <summary>Nushell</summary>
Run the following: Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
@ -332,11 +332,10 @@ 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`): And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):
```sh ```sh
starship init nu | save ~/.cache/starship/init.nu
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```
Note: Only Nushell v0.60+ is supported Note: Only Nushell v0.61+ is supported
</details> </details>

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

@ -120,7 +120,11 @@ description: Starship ist eine minimale, super schnelle, und extrem anpassbare P
#### Elvish #### Elvish
::: warning Nur elvish v0.18 oder höher ist unterstützt. ::: ::: warning
Only elvish v0.18 or higher is supported.
:::
Trage folgendes am Ende von `~/.config/fish/rc.elv` ein: Trage folgendes am Ende von `~/.config/fish/rc.elv` ein:
@ -144,7 +148,13 @@ description: Starship ist eine minimale, super schnelle, und extrem anpassbare P
#### Nushell #### Nushell
::: warning Dies wird sich in der Zukunft ändern. Only Nushell v0.60+ is supported. ::: Run the following: ::: warning
This will change in the future. Only Nushell v0.61+ is supported.
:::
Add the following to to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu starship init nu | save ~/.cache/starship/init.nu
@ -153,8 +163,6 @@ description: Starship ist eine minimale, super schnelle, und extrem anpassbare P
And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`): And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):
```sh ```sh
mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```

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

@ -280,16 +280,16 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL
### Optionen ### Optionen
| Option | Standardwert | Beschreibung | | Option | Standardwert | Beschreibung |
| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | | ------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | Das Format für das Modul. | | `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)'` | Das Format für das Modul. |
| `symbol` | `"☁️ "` | Symbol das vor dem aktuellen AWS-Profil angezeigt wird. | | `symbol` | `"☁️ "` | Symbol das vor dem aktuellen AWS-Profil angezeigt wird. |
| `region_aliases` | | Tabelle der Regionaliasen, die zusätzlich zum AWS-Namen angezeigt werden sollen. | | `region_aliases` | | Tabelle der Regionaliasen, die zusätzlich zum AWS-Namen angezeigt werden sollen. |
| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | | `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. |
| `style` | `"bold yellow"` | Stil für dieses Modul. | | `style` | `"bold yellow"` | Stil für dieses Modul. |
| `expiration_symbol` | `X` | Das Symbol, das angezeigt wird, wenn die temporären Anmeldeinformationen abgelaufen sind. | | `expiration_symbol` | `X` | Das Symbol, das angezeigt wird, wenn die temporären Anmeldeinformationen abgelaufen sind. |
| `disabled` | `false` | Deaktiviert das `aws`-Modul. | | `disabled` | `false` | Deaktiviert das `aws`-Modul. |
| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. | | `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. |
### Variables ### Variables
@ -1140,7 +1140,9 @@ The `env_var` module displays the current value of a selected environment variab
- The `variable` configuration option matches an existing environment variable - The `variable` configuration option matches an existing environment variable
- The `variable` configuration option is not defined, but the `default` configuration option is - The `variable` configuration option is not defined, but the `default` configuration option is
::: tip Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. ::: tip
Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character.
Example: following configuration will display value of USER environment variable Example: following configuration will display value of USER environment variable
@ -1342,17 +1344,17 @@ Das `git_branch`-Modul zeigt den aktiven Git-Branch des Repositories im aktuelle
### Optionen ### Optionen
| Option | Standardwert | Beschreibung | | Option | Standardwert | Beschreibung |
| -------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | | -------------------- | ------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | | `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. |
| `format` | `"on [$symbol$branch]($style) "` | Das Format für das Modul. Use `"$branch"` to refer to the current branch name. | | `format` | `"on [$symbol$branch(:$remote_branch)]($style) "` | Das Format für das Modul. Use `"$branch"` to refer to the current branch name. |
| `symbol` | `" "` | A format string representing the symbol of git branch. | | `symbol` | `" "` | A format string representing the symbol of git branch. |
| `style` | `"bold purple"` | Stil für dieses Modul. | | `style` | `"bold purple"` | Stil für dieses Modul. |
| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | | `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. |
| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. | | `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. |
| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | | `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". | | `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for "master" or "main". |
| `disabled` | `false` | Deaktiviert das `git_branch`-Modul. | | `disabled` | `false` | Deaktiviert das `git_branch`-Modul. |
### Variables ### Variables
@ -1602,6 +1604,7 @@ The `golang` module shows the currently installed version of [Go](https://golang
- Das aktuelle Verzeichnis enthält eine `go.mod`-Datei - Das aktuelle Verzeichnis enthält eine `go.mod`-Datei
- Das aktuelle Verzeichnis enthält eine `go.sum`-Datei - Das aktuelle Verzeichnis enthält eine `go.sum`-Datei
- Das aktuelle Verzeichnis enthält eine `go.work`-Datei
- Das aktuelle Verzeichnis enthält eine `glide.yaml`-Datei - Das aktuelle Verzeichnis enthält eine `glide.yaml`-Datei
- Das aktuelle Verzeichnis enthält eine `Gopkg.yml`-Datei - Das aktuelle Verzeichnis enthält eine `Gopkg.yml`-Datei
- Das aktuelle Verzeichnis enthält eine `Gopkg.lock`-Datei - Das aktuelle Verzeichnis enthält eine `Gopkg.lock`-Datei
@ -1611,16 +1614,16 @@ The `golang` module shows the currently installed version of [Go](https://golang
### Optionen ### Optionen
| Option | Standardwert | Beschreibung | | Option | Standardwert | Beschreibung |
| ------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Das Format für das Modul. | | `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` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. | | `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
| `detect_extensions` | `["go"]` | Which extensions should trigger this module. | | `detect_extensions` | `["go"]` | Which extensions should trigger this module. |
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. | | `detect_files` | `["go.mod", "go.sum", "go.work", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `["Godeps"]` | Which folders should trigger this module. | | `detect_folders` | `["Godeps"]` | Which folders should trigger this module. |
| `style` | `"bold cyan"` | Stil für dieses Modul. | | `style` | `"bold cyan"` | Stil für dieses Modul. |
| `disabled` | `false` | Deaktiviert das `golang`-Modul. | | `disabled` | `false` | Deaktiviert das `golang`-Modul. |
### Variables ### Variables
@ -1719,20 +1722,22 @@ Das `hostname`-Modul zeigt den Hostnamen des Systems an.
### Optionen ### Optionen
| Option | Standardwert | Beschreibung | | Option | Standardwert | Beschreibung |
| ---------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | | ------------ | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `ssh_only` | `true` | Zeigt den Hostnamen nur, wenn via SSH-Sitzung verbunden. | | `ssh_only` | `true` | Zeigt den Hostnamen nur, wenn via SSH-Sitzung verbunden. |
| `trim_at` | `"."` | String that the hostname is cut off at, after the first match. `"."` will stop after the first dot. `""` will disable any truncation | | `ssh_symbol` | `"🌐 "` | A format string representing the symbol when connected to SSH session. |
| `format` | `"[$hostname]($style) in "` | Das Format für das Modul. | | `trim_at` | `"."` | String that the hostname is cut off at, after the first match. `"."` will stop after the first dot. `""` will disable any truncation |
| `style` | `"bold dimmed green"` | Stil für dieses Modul. | | `format` | `"[$ssh_symbol$hostname]($style) in "` | Das Format für das Modul. |
| `disabled` | `false` | Deaktiviert das `hostname`-Modul. | | `style` | `"bold dimmed green"` | Stil für dieses Modul. |
| `disabled` | `false` | Deaktiviert das `hostname`-Modul. |
### Variables ### Variables
| Variable | Beispiel | Beschreibung | | Variable | Beispiel | Beschreibung |
| --------- | ---------- | ------------------------------------ | | ---------- | ---------- | ----------------------------------------------------- |
| hostname | `computer` | The hostname of the computer | | hostname | `computer` | The hostname of the computer |
| style\* | | Spiegelt den Wert der Option `style` | | style\* | | Spiegelt den Wert der Option `style` |
| ssh_symbol | `"🌏 "` | The symbol to represent when connected to SSH session |
*: This variable can only be used as a part of a style string *: This variable can only be used as a part of a style string
@ -1743,7 +1748,7 @@ Das `hostname`-Modul zeigt den Hostnamen des Systems an.
[hostname] [hostname]
ssh_only = false ssh_only = false
format = "on [$hostname](bold red) " format = "[$ssh_symbol](bold blue) on [$hostname](bold red) "
trim_at = ".companyname.com" trim_at = ".companyname.com"
disabled = false disabled = false
``` ```
@ -2383,22 +2388,22 @@ symbol = "☁️ "
## Paketversion ## 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`, `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` 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 - [**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 - [**Cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
- [**Nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command - [**Nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command
- [**Poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory - [**Poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
- [**Python**](https://www.python.org) - The `python` package version is extracted from the `setup.cfg` present in the current directory - [**Python**](https://www.python.org) - The `python` package version is extracted from a [PEP 621](https://peps.python.org/pep-0621/) compliant `pyproject.toml` or a `setup.cfg` present in the current directory
- [**Composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory - [**Composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory
- [**Gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present - [**Gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present in the current directory
- [**Julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present - [**Julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present in the current directory
- [**Mix**](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present - [**Mix**](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present in the current directory
- [**Helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present - [**Helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present in the current directory
- [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present - [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory
- [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present - [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present - [**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 - [**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 - [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory
- [**Dart**](https://pub.dev/) - The `dart` package version is extracted from the `pubspec.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
@ -2845,11 +2850,13 @@ By default the `rust` module shows the currently installed version of [Rust](htt
### Variables ### Variables
| Variable | Beispiel | Beschreibung | | Variable | Beispiel | Beschreibung |
| --------- | ----------------- | ------------------------------------- | | --------- | ----------------- | -------------------------------------------- |
| version | `v1.43.0-nightly` | The version of `rustc` | | version | `v1.43.0-nightly` | The version of `rustc` |
| symbol | | Spiegelt den Wert der Option `symbol` | | numver | `1.51.0` | The numeric component of the `rustc` version |
| style\* | | Spiegelt den Wert der Option `style` | | toolchain | `beta` | The toolchain version |
| 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 *: This variable can only be used as a part of a style string

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

@ -326,7 +326,7 @@ eval $(starship init ion)
<details> <details>
<summary>Nushell</summary> <summary>Nushell</summary>
Run the following: Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
@ -336,11 +336,10 @@ 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`): And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):
```sh ```sh
starship init nu | save ~/.cache/starship/init.nu
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```
Note: Only Nushell v0.60+ is supported Note: Only Nushell v0.61+ is supported
</details> </details>

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

@ -120,7 +120,11 @@ description: '¡Starship es el prompt minimalista, ultrarápido e infinitamente
#### Elvish #### Elvish
::: warning Solo se admite Elvish v0.18 o superior. ::: ::: warning
Sólo se admite elvish v0.18 o superior.
:::
Añade el siguiente código al final de `~/.elvish/rc.elv`: Añade el siguiente código al final de `~/.elvish/rc.elv`:
@ -144,7 +148,13 @@ description: '¡Starship es el prompt minimalista, ultrarápido e infinitamente
#### Nushell #### Nushell
::: advertencia Esto cambiará en el futuro. Sólo se admite Nushell v0.60+. ::: Ejecuta lo siguiente: ::: warning
Esto cambiará en el futuro. Sólo se admite Nushell v0.61+.
:::
Añade lo siguiente al final de tu archivo Nushell env (encuéntralo ejecutando `$nu.env-path` en Nushell):
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu starship init nu | save ~/.cache/starship/init.nu
@ -153,8 +163,6 @@ description: '¡Starship es el prompt minimalista, ultrarápido e infinitamente
Añade lo siguiente al final de tu configuración de Nushell (encuéntrala ejecutando `$nu.config-path`): Añade lo siguiente al final de tu configuración de Nushell (encuéntrala ejecutando `$nu.config-path`):
```sh ```sh
mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```

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

@ -19,7 +19,7 @@ add_newline = true
[character] # El nombre del módulo que estamos configurando es "character" [character] # El nombre del módulo que estamos configurando es "character"
success_symbol = "[➜](bold green)" # El segmento "success_symbol" se está oonfigurando es "➜" con el color "bold green" success_symbol = "[➜](bold green)" # El segmento "success_symbol" se está oonfigurando es "➜" con el color "bold green"
# Deshabilta el módulo "package", ocultándolo del prompt completamente # Deshabilita el módulo "package", ocultándolo del prompt completamente
[package] [package]
disabled = true disabled = true
``` ```
@ -280,16 +280,16 @@ Cuando se utiliza [AWSume](https://awsu.me), el perfil se lee de la variable de
### Opciones ### Opciones
| Opción | Por defecto | Descripción | | Opción | Por defecto | Descripción |
| ------------------- | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | | ------------------- | --------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ |
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | El formato del módulo. | | `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)'` | El formato del módulo. |
| `symbol` | `"☁️ "` | El símbolo que se muestra antes del perfil de AWS. | | `symbol` | `"☁️ "` | El símbolo que se muestra antes del perfil de AWS. |
| `region_aliases` | | Tabla de alias de región para mostrar además del nombre AWS. | | `region_aliases` | | Tabla de alias de región para mostrar además del nombre AWS. |
| `profile_aliases` | | Tabla de alias de región para mostrar además del nombre AWS. | | `profile_aliases` | | Tabla de alias de región para mostrar además del nombre AWS. |
| `style` | `"bold yellow"` | El estilo del módulo. | | `style` | `"bold yellow"` | El estilo del módulo. |
| `expiration_symbol` | `X` | El símbolo mostrado cuando las credenciales temporales han caducado. | | `expiration_symbol` | `X` | El símbolo mostrado cuando las credenciales temporales han caducado. |
| `disabled` | `false` | Desactiva el módulo AWS. | | `disabled` | `false` | Desactiva el módulo AWS. |
| `force_display` | `false` | Si `true` muestra información incluso si `credentials`, `credential_process` o `sso_start_url` no han sido configuradas. | | `force_display` | `false` | Si `true` muestra información incluso si `credentials`, `credential_process` o `sso_start_url` no han sido configuradas. |
### Variables ### Variables
@ -1140,7 +1140,9 @@ El módulo `env_var` muestra el valor actual de una variable de entorno seleccio
- La opción de configuración de `variable` coincide con una variable de entorno existente - La opción de configuración de `variable` coincide con una variable de entorno existente
- La opción de configuración de `variable` no está definida, pero la opción de configuración `predeterminada` se encuentra - La opción de configuración de `variable` no está definida, pero la opción de configuración `predeterminada` se encuentra
::: tip Múltiples variables de entorno pueden mostrarse usando un `.`. (ver ejemplo) Si la opción de configuración de la `variable` no está definida, el módulo mostrará el valor de la variable bajo el nombre del texto después del caracter `.`. ::: tip
Múltiples variables de entorno pueden mostrarse usando una `.`. (ver ejemplo) Si la opción de configuración de la `variable` no está definida, el módulo mostrará el valor de la variable bajo el nombre del texto después del caracter `.`.
Ejemplo: la siguiente configuración mostrará el valor de la variable de entorno USER Ejemplo: la siguiente configuración mostrará el valor de la variable de entorno USER
@ -1342,17 +1344,17 @@ El módulo `git_branch` muestra la rama activa del repositorio en tu directorio
### Opciones ### Opciones
| Opción | Por defecto | Descripción | | Opción | Por defecto | Descripción |
| -------------------- | -------------------------------- | ------------------------------------------------------------------------------------------------------- | | -------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------------- |
| `always_show_remote` | `false` | Muestra el nombre de la rama de seguimiento remoto, incluso si es igual al nombre de la rama local. | | `always_show_remote` | `false` | Muestra el nombre de la rama de seguimiento remoto, incluso si es igual al nombre de la rama local. |
| `format` | `"on [$symbol$branch]($style) "` | El formato del módulo. Use `"$branch"` para referirse al nombre de la rama actual. | | `format` | `"on [$symbol$branch(:$remote_branch)]($style) "` | El formato del módulo. Use `"$branch"` para referirse al nombre de la rama actual. |
| `symbol` | `" "` | Una cadena de formato que representa el símbolo de la rama git. | | `symbol` | `" "` | Una cadena de formato que representa el símbolo de la rama git. |
| `style` | `"bold purple"` | El estilo del módulo. | | `style` | `"bold purple"` | El estilo del módulo. |
| `truncation_length` | `2^63 - 1` | Trunca una rama git a grafemas `N`. | | `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. | | `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`. | | `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 para evitar mostrar. Útil para "master" o "main". |
| `disabled` | `false` | Desactiva el módulo `git_branch`. | | `disabled` | `false` | Desactiva el módulo `git_branch`. |
### Variables ### Variables
@ -1602,6 +1604,7 @@ El módulo `golang` muestra la versión instalada de [Go](https://golang.org/).
- El directorio actual contiene un archivo `go.mod` - El directorio actual contiene un archivo `go.mod`
- El directorio actual contiene un archivo `go.sum` - El directorio actual contiene un archivo `go.sum`
- El directorio actual contiene un archivo `go.work`
- El directorio actual contiene un archivo `glide.yaml` - El directorio actual contiene un archivo `glide.yaml`
- El directorio actual contiene un archivo `Gopkg.yml` - El directorio actual contiene un archivo `Gopkg.yml`
- El directorio actual contiene un archivo `Gopkg.lock` - El directorio actual contiene un archivo `Gopkg.lock`
@ -1611,16 +1614,16 @@ El módulo `golang` muestra la versión instalada de [Go](https://golang.org/).
### Opciones ### Opciones
| Opción | Por defecto | Descripción | | Opción | Por defecto | Descripción |
| ------------------- | ------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | | `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. |
| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🐹 "` | Una cadena de formato que representa el símbolo de Go. | | `symbol` | `"🐹 "` | Una cadena de formato que representa el símbolo de Go. |
| `detect_extensions` | `["go"]` | Qué extensiones deberían activar este módulo. | | `detect_extensions` | `["go"]` | Qué extensiones deberían activar este módulo. |
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Qué nombres de archivo deberían activar este módulo. | | `detect_files` | `["go.mod", "go.sum", "go.work", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Qué nombres de archivo deberían activar este módulo. |
| `detect_folders` | `["Godeps"]` | Qué carpetas deberían activar este módulo. | | `detect_folders` | `["Godeps"]` | Qué carpetas deberían activar este módulo. |
| `style` | `"bold cyan"` | El estilo del módulo. | | `style` | `"bold cyan"` | El estilo del módulo. |
| `disabled` | `false` | Desactiva el módulo de `golang`. | | `disabled` | `false` | Desactiva el módulo de `golang`. |
### Variables ### Variables
@ -1719,20 +1722,22 @@ El módulo `hostname` muestra el nombre de host del sistema.
### Opciones ### Opciones
| Opción | Por defecto | Descripción | | 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_only` | `true` | Mostrar sólo el nombre de host cuando esté conectado a una sesión SSH. |
| `trim_at` | `"."` | Cadena en la que el nombre de host se corta, después de la primera partida. `"."` se detendrá después del primer punto. `""` deshabilitará cualquier truncamiento | | `ssh_symbol` | `"🌐 "` | Una cadena de formato que representa el símbolo cuando se conecta a la sesión SSH. |
| `format` | `"[$hostname]($style) in "` | El formato del módulo. | | `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 |
| `style` | `"bold dimmed green"` | El estilo del módulo. | | `format` | `"[$ssh_symbol$nombre de host]($style) en "` | El formato del módulo. |
| `disabled` | `false` | Desactiva el módulo `hostname`. | | `style` | `"negrita oscurecida verde"` | El estilo del módulo. |
| `disabled` | `false` | Deshabilita el módulo `hostname`. |
### Variables ### Variables
| Variable | Ejemplo | Descripción | | Variable | Ejemplo | Descripción |
| --------- | ---------- | ------------------------------------- | | ---------- | ---------- | -------------------------------------------------------------- |
| hostname | `computer` | El nombre de host del ordenador | | hostname | `computer` | El nombre de host del ordenador |
| style\* | | Refleja el valor de la opción `style` | | 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 *: Esta variable sólo puede ser usada como parte de una cadena de estilo
@ -1743,7 +1748,7 @@ El módulo `hostname` muestra el nombre de host del sistema.
[hostname] [hostname]
ssh_only = false ssh_only = false
format = "on [$hostname](bold red) " format = "[$ssh_symbol](bold blue) on [$hostname](bold red) "
trim_at = ".companyname.com" trim_at = ".companyname.com"
disabled = false disabled = false
``` ```
@ -2389,16 +2394,16 @@ El módulo `package` se muestra cuando el directorio actual es el repositorio de
- [**Cargo**](https://doc.rust-lang.org/cargo/) – La versión del paquete `cargo` se extrae del `Cargo.toml` 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
- [**Nimble**](https://github.com/nim-lang/nimble) - La versión del paquete `nimble` se extrae del archivo `*.nimble` presente en el directorio actual con el comando `nimble dump` - [**Nimble**](https://github.com/nim-lang/nimble) - La versión del paquete `nimble` se extrae del archivo `*.nimble` presente en el directorio actual con el comando `nimble dump`
- [**Poetry**](https://python-poetry.org/) – La versión del paquete `poetry` se extrae del `pyproject.toml` presente en el directorio actual - [**Poetry**](https://python-poetry.org/) – La versión del paquete `poetry` se extrae del `pyproject.toml` presente en el directorio actual
- [**Python**](https://www.python.org) – La versión del paquete `python` se extrae del `setup.cfg` presente en el directorio actual - [**Python**](https://www.python.org) – La versión del paquete `python` se extrae del [pyproject.toml](https://peps.python.org/pep-0621/) presente en el directorio actual
- [**Composer**](https://getcomposer.org/) – La versión del paquete `composer` se extrae del `composer.json` presente en el directorio actual - [**Composer**](https://getcomposer.org/) – La versión del paquete `composer` se extrae del `composer.json` presente en el directorio actual
- [**Gradle**](https://gradle.org/) – La versión del paquete `gradle` se extrae del `build.gradle` presente en directorio actual - [**Gradle**](https://gradle.org/) – La versión `gradle` del paquete se extrae de `build.gradle` presente en el directorio actual
- [**Julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - La versión del paquete se extrae del `Project.toml` presente en el directorio actual - [**Julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - La versión del paquete se extrae de `Project.toml` presente en el directorio actual
- [**Mix**](https://hexdocs.pm/mix/) - La versión del paquete `mix` se extrae del `mix.exs` presente en el directorio actual - [**Mix**](https://hexdocs.pm/mix/) - La versión del paquete `mix` es extraída del `mix.exs` presente en el directorio actual
- [**Help**](https://helm.sh/docs/helm/helm_package/) - La versión del paquete `helm` se extrae del `Chart.yaml` presente en el directorio actual - [**Helm**](https://helm.sh/docs/helm/helm_package/) - La versión del paquete `helm` se extrae de `Chart.yaml` presente en el directorio actual
- [**Maven**](https://maven.apache.org/) - La versión de paquete `maven` se extrae del `pom.xml` presente en el directorio actual - [**Maven**](https://maven.apache.org/) - La versión de paquete `maven` se extrae de `pom.xml` presente en el directorio actual
- [**Meson**](https://mesonbuild.com/) - La versión del paquete `meson` se extrae del `meson.build` presente en el directorio actual - [**Meson**](https://mesonbuild.com/) - La versión del paquete `meson` se extrae de `meson.build` presente en el directorio actual
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - La version del paquete `shards` se extrae del archivo `shard.yml` presente - [**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 del `v.mod` 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 - [**SBT**](https://scala-sbt.org) - La versión del paquete `sbt` se extrae del archivo `build.sbt` presente en el directorio actual
- [**Dart**](https://pub.dev/) - La versión del paquete `dart` se extrae del archivo `pubspec.yaml` presente en el directorio actual - [**Dart**](https://pub.dev/) - La versión del paquete `dart` se extrae del archivo `pubspec.yaml` presente en el directorio actual
@ -2845,11 +2850,13 @@ Por defecto, el módulo `rust` muestra la versión instalada de [Rust](https://w
### Variables ### Variables
| Variable | Ejemplo | Descripción | | Variable | Ejemplo | Descripción |
| --------- | ----------------- | -------------------------------------- | | --------- | ----------------- | -------------------------------------------- |
| version | `v1.43.0-nightly` | La versión de `rustc` | | version | `v1.43.0-nightly` | La versión de `rustc` |
| symbol | | Refleja el valor de la opción `symbol` | | numver | `1.51.0` | El componente numérico de la versión `rustc` |
| style\* | | Refleja el valor de la opción `style` | | toolchain | `beta` | La versión de toolchain |
| 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 *: Esta variable sólo puede ser usada como parte de una cadena de estilo
@ -3204,11 +3211,11 @@ format = "via [🏎 $version](red bold)"
## Terraform ## Terraform
El módulo `Terraform` muestra el [espacio de trabajo de Terraform](https://www.terraform.io/docs/language/state/workspaces.html) y la versión seleccionados actualmente. El módulo `Terraform` muestra el espacio de trabajo de [Terraform](https://www.terraform.io/docs/language/state/workspaces.html) y la versión seleccionados actualmente.
::: tip ::: tip
Por defecto no se muestra la versión de Terraform, ya que esto es lento para las versiones actuales de Terraform cuando hay muchos plugins en uso. Si aún deseas activarlo, [sigue el ejemplo que se muestra a continuación](#with-terraform-version). Por defecto no se muestra la versión de Terraform, ya que esto es lento para las versiones actuales de Terraform cuando hay muchos complementos en uso. Si aún deseas activarlo, [sigue el ejemplo que se muestra a continuación](#with-terraform-version).
::: :::
@ -3283,7 +3290,7 @@ Este módulo está deshabilitado por defecto. Para activarlo, establece `disable
| `disabled` | `true` | Deshabilita el módulo `time`. | | `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 se mostrará el módulo. Las horas deben especificarse en formato de 24 horas |
Si `use_12hr` es `true`, entonces `time_format` por defecto es `"%r"`. De lo contrario, el valor por defecto es `"%T"`. Configurar manualmente `time_format` sobrescribirá la configuración `use_12hr`. Si `use_12hr` es `true`, entonces `time_format` por defecto `"%r"`. De lo contrario, el valor por defecto es `"%T"`. Configurar manualmente `time_format` sobrescribirá la configuración `use_12hr`.
### Variables ### Variables
@ -3318,7 +3325,7 @@ El módulo `username` muestra el nombre de usuario activo. El módulo se muestra
::: tip ::: tip
La conexión SSH se detecta comprobando las variables de entorno `SSH_CONNECTION`, `SSH_CLIENT`, y `SSH_TTY`. Si tu host SSH no configura estas variables, una solución es establecer una de ellas con un valor tonto. La conexión SSH se detecta comprobando las variables de entorno `SSH_CONNECTION`, `SSH_CLIENT`, y `SSH_TTY`. Si su host SSH no configura estas variables, una solución es establecer una de ellas con un valor tonto.
::: :::
@ -3502,15 +3509,15 @@ Los módulos `personalizados` muestran la salida de algunos comandos arbitrarios
Estos módulos se mostrarán si se cumplen alguna de las siguientes condiciones: Estos módulos se mostrarán si se cumplen alguna de las siguientes condiciones:
- The current directory contains a file whose name is in `detect_files` - El directorio actual contiene un archivo cuyo nombre está en `detect_files`
- The current directory contains a directory whose name is in `detect_folders` - El directorio actual contiene un directorio cuyo nombre está en `detect_folders`
- The current directory contains a file whose extension is in `detect_extensions` - El directorio actual contiene un archivo cuya extensión está en `detect_extensions`
- El comando `when` devuelve 0 - El comando `when` devuelve 0
- El sistema operativo actual (std::env::consts::OS) coincide con el campo `os` si está definido. - El sistema operativo actual (std::env::consts::OS) coincide con el campo `os` si está definido.
::: tip ::: tip
Múltiples módulos personalizados pueden definirse usando un `.` (un punto). Múltiples módulos personalizados pueden definirse usando una `.`.
::: :::
@ -3522,7 +3529,7 @@ El orden en el que se muestran los módulos personalizados se puede establecer i
::: tip ::: tip
[El problema #1252](https://github.com/starship/starship/discussions/1252) contiene ejemplos de módulos personalizados. ¡Si tienes un ejemplo interesante no cubierto, siéntete libre de compartirlo ahí! [El issue #1252](https://github.com/starship/starship/discussions/1252) contiene ejemplos de módulos personalizados. Si tiene un ejemplo interesante no cubierto allí, no dude en compartirlo allí!
::: :::
@ -3536,22 +3543,22 @@ Las cadenas de formato también pueden contener secuencias específicas del int
### Opciones ### Opciones
| Opción | Predeterminado | Descripción | | Opción | Predeterminado | Descripción |
| ------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------- | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `command` | `""` | El comando cuya salida debe ser impresa. El comando se pasará en stdin al intérprete de comandos. | | `command` | `""` | El comando cuya salida debe ser impresa. El comando se pasará en stdin al intérprete de comandos. |
| `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. | | `when` | `false` | 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) | | `shell` | | [Ver abajo](#custom-command-shell) |
| `description` | `"<custom module>"` | La descripción del módulo que se muestra al ejecutar `starship explain`. | | `description` | `"<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_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_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. | | `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. | | `symbol` | `""` | El símbolo usado antes de mostrar la salida del comando. |
| `style` | `"bold green"` | El estilo del módulo. | | `style` | `"bold green"` | El estilo del módulo. |
| `format` | `"[$symbol($output )]($style)"` | El formato del módulo. | | `format` | `"[$symbol($output )]($style)"` | El formato del módulo. |
| `disabled` | `false` | Deshabilita este `módulo personalizado`. | | `disabled` | `false` | Deshabilita este `módulo personalizado`. |
| `os` | | Nombre del sistema operativo en el que se mostrará el módulo (unix, linux, macos, windows, ... ) [Ver valores posibles](https://doc.rust-lang.org/std/env/consts/constant.OS.html). | | `os` | | 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` | | An optional boolean value that overrides whether commands should be forwarded to the shell via the standard input or as an argument. If unset standard input is used by default, unless the shell does not support it (cmd, nushell). Setting this disables shell-specific argument handling. | | `use_stdin` | | 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` | Ignore global `command_timeout` setting and keep running external commands, no matter how long they take. | | `ignore_timeout` | `false` | Ignorar la configuración global de `command_timeout` y seguir ejecutando comandos externos, sin importar el tiempo que tarden. |
### Variables ### Variables
@ -3574,7 +3581,7 @@ Si no está activado, se retornará a STARSHIP_SHELL y luego a "sh" en Linux, y
El `comando` será pasado en stdin. El `comando` será pasado en stdin.
Si no se da el `shell` o solo contiene un elemento y Starship detecta PowerShell los siguientes argumentos se añadirán automáticamente: `-NoProfile -Command -`. If `shell` is not given or only contains one element and Starship detects Cmd will be used, the following argument will automatically be added: `/C` and `stdin` will be set to `false`. If `shell` is not given or only contains one element and Starship detects Nushell will be used, the following arguments will automatically be added: `-c` and `stdin` will be set to `false`. This behavior can be avoided by explicitly passing arguments to the shell, e.g. Si no se da el `shell` o solo contiene un elemento y Starship detecta PowerShell los siguientes argumentos se añadirán automáticamente: `-NoProfile -Command -`. If `shell` is not given or only contains one element and Starship detects Cmd will be used, the following argument will automatically be added: `/C` and `stdin` will be set to `false`. If `shell` is not given or only contains one element and Starship detects Nushell will be used, the following arguments will automatically be added: `-c` and `stdin` will be set to `false`. Este comportamiento puede evitarse pasando explícitamente argumentos al intérprete, p.ej.
```toml ```toml
shell = ["pwsh", "-Command", "-"] shell = ["pwsh", "-Command", "-"]
@ -3582,13 +3589,13 @@ shell = ["pwsh", "-Command", "-"]
::: warning Asegúrate de que tu configuración personalizada del intérprete de comandos salga con éxito ::: warning Asegúrate de que tu configuración personalizada del intérprete de comandos salga con éxito
Si estableces un comando personalizado, asegúrate de que el intérprete de comandos por defecto usado por Starship ejecutará correctamente el comando con una salida elegante (a través de la opción `shell`). Si establece un comando personalizado, asegúrese de que el Shell por defecto usado por starship ejecutará correctamente el comando con una salida elgante (a través de la opción `shell`).
Por ejemplo, PowerShell requiere el parámetro `-Command` para ejecutar una sola línea. Omitir este parámetro puede arrojar a Starship a un bucle recursivo donde el intérprete de comandos podría intentar cargar un entorno de perfil completo con Starship en sí misma y volver a ejecutar el comando personalizado, entrando en un bucle infinito. Por ejemplo, PowerShell requiere el parámetro `-Command` para ejecutar una sola línea. Omitir este parámetro puede arrojar a starchip a un bucle recursivo donde el shell podría intentar cargar un entorno de perfil completo con starship en sí misma y volver a ejecutar el comando personalizado, entrando en un bucle infinito.
Se recomiendan parámetros similares a `-NoProfile` en PowerShell para otros intérprete de comandos también para evitar tiempo extra de carga de un perfil personalizado en cada invocación de Starship. Se recomiendan parámetros similares a `-NoProfile` en PowerShell para otros shells para evitar tiempo extra de carga de un perfil personalizado en cada invocación de starship.
La detección automática de intérpretes de comandos y la adición adecuada de parámetros están actualmente implementados, pero es posible que no todos los intérpretes de comandos estén cubiertos. Por favor, [abre un problema](https://github.com/starship/starship/issues/new/choose) con los detalles del intérprete de comandos y la configuración de Starship si te encuentras en tal escenario. La detección automática de shells y la adición adecuada de parámetros están actualmente implementados, pero es posible que no todos los shells estén cubiertos. Por favor, [abre un issue](https://github.com/starship/starship/issues/new/choose) con los detalles del intérprete de comandos y la configuración de Starship si te encuentras en tal escenario.
::: :::

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

@ -326,7 +326,7 @@ eval $(starship init ion)
<details> <details>
<summary>Nushell</summary> <summary>Nushell</summary>
Ejecuta lo siguiente: Añade lo siguiente al final de tu archivo Nushell env (encuéntralo ejecutando `$nu.env-path` en Nushell):
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
@ -336,11 +336,10 @@ starship init nu | save ~/.cache/starship/init.nu
Añade lo siguiente al final de tu configuración de Nushell (encuéntrala ejecutando `$nu.config-path`): Añade lo siguiente al final de tu configuración de Nushell (encuéntrala ejecutando `$nu.config-path`):
```sh ```sh
starship init nu | save ~/.cache/starship/init.nu
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```
Nota: Solo se admite Nushell v0.60+ Nota: Sólo se admite Nushell v0.61+
</details> </details>

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

@ -120,7 +120,11 @@ description: Starship est une invite minimaliste, ultra-rapide et hautement pers
#### Elvish #### Elvish
::: warning Seul elvish v0.18 ou supérieur est pris en charge. ::: ::: warning
Seul elvish v0.18 ou supérieur est pris en charge.
:::
Ajoutez ce qui suit à la fin de `~/.elvish/rc.elv`: Ajoutez ce qui suit à la fin de `~/.elvish/rc.elv`:
@ -144,7 +148,13 @@ description: Starship est une invite minimaliste, ultra-rapide et hautement pers
#### Nushell #### Nushell
::: warning Cela va changer dans le futur. Seul Nushell v0.60+ est supporté. ::: Exécutez les commandes suivantes: ::: warning
Ceci va changer dans le futur. Seul Nushell v0.61+ est supporté.
:::
Add the following to to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu starship init nu | save ~/.cache/starship/init.nu
@ -153,8 +163,6 @@ description: Starship est une invite minimaliste, ultra-rapide et hautement pers
Ajoutez le code suivant à la fin de votre configuration Nushell (trouvez-la en exécutant `$nu.config path`): Ajoutez le code suivant à la fin de votre configuration Nushell (trouvez-la en exécutant `$nu.config path`):
```sh ```sh
mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```

2
docs/fr-FR/advanced-config/README.md
View File

@ -131,7 +131,7 @@ Invoke-Expression (&starship init powershell)
Certains shells peuvent gérer une invite de commande à droite, sur la même ligne que l’entrée utilisateur. Starship peut définir le contenu de cet invite à droite en utilisant l’option `right_format`. N’importe quel module qui peut être utilisé dans `format` est aussi géré dans `right_format`. La variable `$all` va seulement contenir les modules qui ne sont explicitement utilisés ni dans `format`, ni dans `right_format`. Certains shells peuvent gérer une invite de commande à droite, sur la même ligne que l’entrée utilisateur. Starship peut définir le contenu de cet invite à droite en utilisant l’option `right_format`. N’importe quel module qui peut être utilisé dans `format` est aussi géré dans `right_format`. La variable `$all` va seulement contenir les modules qui ne sont explicitement utilisés ni dans `format`, ni dans `right_format`.
Note: l’invite à droite est une seule ligne, sur la même ligne que l’entrée. To right align modules above the input line in a multi-line prompt, see the [`fill` module](/config/#fill). Note: l’invite à droite est une seule ligne, sur la même ligne que l’entrée. Pour aligner à droite les modules au-dessus de la ligne d’entrée d’une invite multiligne, voir le [module `fill`](/config/#fill).
`right_format` est actuellement géré pour les shells suivants: elvish, fish, zsh, xonsh, cmd. `right_format` est actuellement géré pour les shells suivants: elvish, fish, zsh, xonsh, cmd.

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

@ -9,17 +9,17 @@ mkdir -p ~/.config && touch ~/.config/starship.toml
Toute la configuration de starship est effectuée dans ce fichier [TOML](https://github.com/toml-lang/toml) : Toute la configuration de starship est effectuée dans ce fichier [TOML](https://github.com/toml-lang/toml) :
```toml ```toml
# Get editor completions based on the config schema # Pour avoir des complétions dans votre éditeur basées sur le schéma de la config
"$schema" = 'https://starship.rs/config-schema.json' "$schema" = 'https://starship.rs/config-schema.json'
# Inserts a blank line between shell prompts # Insère un ligne vide entre les invites de shells
add_newline = true add_newline = true
# Replace the "❯" symbol in the prompt with "➜" # Remplace le symbole «❯» dans l’invite par «➜»
[character] # The name of the module we are configuring is "character" [character] # Le nom du module que nous configurons est «character»
success_symbol = "[➜](bold green)" # The "success_symbol" segment is being set to "➜" with the color "bold green" success_symbol = "[➜](bold green)" # Le segment «success_symbol» est mis défini à «➜» avec la couleur «bold green»
# Disable the package module, hiding it from the prompt completely # Désactive le module «package», le cachant complètement de l’invite
[package] [package]
disabled = true disabled = true
``` ```
@ -183,7 +183,7 @@ Le `format` par défaut est utilisé pour définir le format de l'invite, si il
```toml ```toml
format = "$all" format = "$all"
# Which is equivalent to # Ce qui est équivalent à
format = """ format = """
$username\ $username\
$hostname\ $hostname\
@ -268,7 +268,7 @@ format = "$all$directory$character"
## AWS ## 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. 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. Il se base sur les variables d’environnement `AWS_REGION`, `AWS_DEFAULT_REGION` et `AWS_PROFILE` avec un fichier `~/.aws/config`. Ce module montre aussi un minuteur d’expiration lors de l’utilisation d’identifiants temporaires. 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 n’ont pas été configurés, avec l’option `force_display`. Il se base sur les variables d’environnement `AWS_REGION`, `AWS_DEFAULT_REGION` et `AWS_PROFILE` avec un fichier `~/.aws/config`. Ce module montre aussi un minuteur d’expiration lors de l’utilisation d’identifiants temporaires.
Le module n’affichera 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 l’une des variables d’environnement `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` ou `AWS_SESSION_TOKEN` définie est suffisant. Si l’option `force_display` est définie à `true`, toutes les informations disponibles seront affichées même si les conditions ne sont pas respectées. Le module n’affichera 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 l’une des variables d’environnement `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` ou `AWS_SESSION_TOKEN` définie est suffisant. Si l’option `force_display` est définie à `true`, toutes les informations disponibles seront affichées même si les conditions ne sont pas respectées.
@ -280,16 +280,16 @@ Lorsque vous utilisez [AWSume](https://awsu.me) le profil est lu à partir de la
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | | ------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | Format du module. | | `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)'` | Format du module. |
| `symbol` | `"☁️ "` | Le symbole est affiché avant le profil AWS actuel. | | `symbol` | `"☁️ "` | Le symbole est affiché avant le profil AWS actuel. |
| `region_aliases` | | Table des alias de région à afficher en plus du nom AWS. | | `region_aliases` | | Tableau des alias de région à afficher en plus du nom AWS. |
| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | | `profile_aliases` | | Tableau des alias de profil à afficher en plus du nom AWS. |
| `style` | `"bold yellow"` | Le style du module. | | `style` | `"bold yellow"` | Le style du module. |
| `expiration_symbol` | `X` | Le symbole est affiché lorsque les identifiants temporaires ont expiré. | | `expiration_symbol` | `X` | Le symbole est affiché lorsque les identifiants temporaires ont expiré. |
| `disabled` | `false` | Désactive le module `AWS`. | | `disabled` | `false` | Désactive le module `AWS`. |
| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. | | `force_display` | `false` | Si `true`, affiche les informations même si `credentials`, `credential_process` ou `sso_start_url` n'ont pas été configurées. |
### Variables ### Variables
@ -511,7 +511,7 @@ Notez que `version` n’est pas dans le format par défaut.
L’option `commands` accepte une liste de commandes pour déterminer la version du compilateur et son nom. L’option `commands` accepte une liste de commandes pour déterminer la version du compilateur et son nom.
Each command is represented as a list of the executable name, followed by its arguments, usually something like `["mycc", "--version"]`. Starship will try executing each command until it gets a result on STDOUT. Chaque commande est représentée par une liste du nom de l'exécutable suivie de ses arguments, généralement quelque chose comme `["mycc", "--version"]`. Starship essayera d'exécuter chaque commande jusqu'à obtenir un résultat sur STDOUT.
Si un compilateur C n’est pas supporté par ce module, vous pouvez demander son ajout en [créant un ticket sur GitHub](https://github.com/starship/starship/). Si un compilateur C n’est pas supporté par ce module, vous pouvez demander son ajout en [créant un ticket sur GitHub](https://github.com/starship/starship/).
@ -1014,7 +1014,7 @@ Vous aurez également besoin du SDK .NET Core pour pouvoir l'utiliser correcteme
En interne, ce module utilise son propre mécanisme de détection de version. Généralement, il est deux fois plus rapide que d'exécuter `dotnet --version`, mais il peut afficher une version incorrecte si votre projet .NET a une arborescence inhabituelle. Si la précision est plus importante que la vitesse, vous pouvez désactiver le mécanisme en définissant `heuristic = false` dans les options du module. En interne, ce module utilise son propre mécanisme de détection de version. Généralement, il est deux fois plus rapide que d'exécuter `dotnet --version`, mais il peut afficher une version incorrecte si votre projet .NET a une arborescence inhabituelle. Si la précision est plus importante que la vitesse, vous pouvez désactiver le mécanisme en définissant `heuristic = false` dans les options du module.
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. Le module affichera aussi le Moniker de Framework Cible (<https://docs.microsoft.com/en-us/dotnet/standard/frameworks#supported-target-frameworks>) quand il y a un fichier `.csproj` dans le dossier courant.
### Options ### Options
@ -1140,7 +1140,9 @@ Le module `env_var` affiche la valeur actuelle de la variable d’environnement
- L'option `variable` correspond à une variable d'environnement existante - L'option `variable` correspond à une variable d'environnement existante
- L'option `variable` n'est pas définie, mais l'option `default` l'est - L'option `variable` n'est pas définie, mais l'option `default` l'est
::: tip Plusieurs variables d’environnement peuvent être affichées en utilisant un `.` (voir exemple). Si l’option de configuration `variable` n’est pas définie, le module affichera la valeur de la variable dont le nom est le texte après le caractère `.`. ::: tip
Plusieurs variables d’environnement peuvent être affichées en utilisant un `.`. (voir exemple). Si l’option de configuration `variable` n’est pas définie, le module affichera la valeur de la variable dont le nom est le texte après le caractère `.`.
Exemple : la configuration suivante va afficher la valeur de la variable d’environnement UTILISATEUR Exemple : la configuration suivante va afficher la valeur de la variable d’environnement UTILISATEUR
@ -1342,17 +1344,17 @@ Le module `git_branch` affiche la branche active du dépôt dans votre répertoi
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| -------------------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | | -------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
| `always_show_remote` | `false` | Affiche le nom de la branche suivie distante, même si elle est égale au nom de la branche locale. | | `always_show_remote` | `false` | Affiche le nom de la branche suivie distante, même si elle est égale au nom de la branche locale. |
| `format` | `"on [$symbol$branch]($style) "` | Format du module. Utilisez `"$branch"` pour vous référer au nom de la branche courante. | | `format` | `"on [$symbol$branch(:$remote_branch)]($style) "` | Format du module. Utilisez `"$branch"` pour vous référer au nom de la branche courante. |
| `symbol` | `" "` | Une chaîne de format représentant le symbole de la branche git. | | `symbol` | `" "` | Une chaîne de format représentant le symbole de la branche git. |
| `style` | `"bold purple"` | Le style du module. | | `style` | `"bold purple"` | Le style du module. |
| `truncation_length` | `2^63 - 1` | Tronque une branche git à `N` graphèmes. | | `truncation_length` | `2^63 - 1` | Tronque une branche git à `N` graphèmes. |
| `truncation_symbol` | `"…"` | Le symbole utilisé pour indiquer qu'un nom de branche a été tronqué. Vous pouvez utiliser `""` pour ne pas afficher de symbole. | | `truncation_symbol` | `"…"` | Le symbole utilisé pour indiquer qu'un nom de branche a été tronqué. Vous pouvez utiliser `""` pour ne pas afficher de symbole. |
| `only_attached` | `false` | Ne montrer le nom de la branche que si elle n'est pas dans un état `HEAD` détachée. | | `only_attached` | `false` | Ne montrer le nom de la branche que si elle n'est pas dans un état `HEAD` détachée. |
| `ignore_branches` | `[]` | Une liste de noms à ne pas afficher. Utile pour "master" ou "main". | | `ignore_branches` | `[]` | Une liste de noms à ne pas afficher. Utile pour "master" ou "main". |
| `disabled` | `false` | Désactive le module `git_branch`. | | `disabled` | `false` | Désactive le module `git_branch`. |
### Variables ### Variables
@ -1602,25 +1604,26 @@ Par défaut, le module `go` affiche la version de [Go](https://golang.org/) inst
- Le dossier courant contient un fichier `go.mod` - Le dossier courant contient un fichier `go.mod`
- Le dossier courant contient un fichier `go.sum` - Le dossier courant contient un fichier `go.sum`
- Le répertoire courant contient un fichier `go.work`
- Le dossier courant contient un fichier `glide.yaml` - Le dossier courant contient un fichier `glide.yaml`
- Le dossier courant contient un fichier `Gopkg.yml` - Le répertoire courant contient un fichier `Gopkg.yml`
- Le dossier courant contient un fichier `Gopkg.lock` - Le répertoire courant contient un fichier `Gopkg.lock`
- Le dossier courant contient un fichier `.go-version` - Le répertoire courant contient un fichier `.go-version`
- Le dossier courant contient un dossier `Godeps` - Le répertoire courant contient un répertoire `Godeps`
- Le dossier courant contient un fichier avec l’extension `.go` - Le répertoire actuel contient un fichier avec l'extension `.go`
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| ------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | | ------------------- | ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `format` | `"via [$symbol($version )]($style)"` | Format du module. |
| `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🐹 "` | Une chaîne de caractères représentant le symbole de Go. | | `symbol` | `"🐹 "` | Une chaîne de caractères représentant le symbole de Go. |
| `detect_extensions` | `["go"]` | Quelles extensions devraient activer ce module. | | `detect_extensions` | `["go"]` | Quelles extensions devraient activer ce module. |
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Les fichiers qui activent ce module. | | `detect_files` | `["go.mod", "go.sum", "go.work", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Les fichiers qui activent ce module. |
| `detect_folders` | `["Godeps"]` | Les dossiers qui activent ce module. | | `detect_folders` | `["Godeps"]` | Les dossiers qui activent ce module. |
| `style` | `"bold cyan"` | Le style du module. | | `style` | `"bold cyan"` | Le style du module. |
| `disabled` | `false` | Désactive le module `golang`. | | `disabled` | `false` | Désactive le module `golang`. |
### Variables ### Variables
@ -1719,20 +1722,22 @@ Le module `hostname` affiche le nom d'hôte du système.
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| ---------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------ | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ssh_only` | `true` | Afficher uniquement le nom d'hôte lorsque vous êtes connecté à une session SSH. | | `ssh_only` | `true` | Afficher uniquement le nom d'hôte lorsque vous êtes connecté à une session SSH. |
| `trim_at` | `"."` | Chaîne à laquelle le nom d'hôte est coupé, après la première correspondance. `"."` s'arrêtera après le premier point. `""` désactivera toute troncature | | `ssh_symbol` | `"🌐 "` | A format string representing the symbol when connected to SSH session. |
| `format` | `"[$hostname]($style) in "` | Format du module. | | `trim_at` | `"."` | Chaîne à laquelle le nom d'hôte est coupé, après la première correspondance. `"."` s'arrêtera après le premier point. `""` désactivera toute troncature |
| `style` | `"bold dimmed green"` | Le style du module. | | `format` | `"[$ssh_symbol$hostname]($style) in "` | Format du module. |
| `disabled` | `false` | Désactive le module `hostname`. | | `style` | `"bold dimmed green"` | Le style du module. |
| `disabled` | `false` | Désactive le module `hostname`. |
### Variables ### Variables
| Variable | Exemple | Description | | Variable | Exemple | Description |
| ---------- | ---------- | ------------------------------------- | | ---------- | ---------- | ----------------------------------------------------- |
| nom d'hôte | `computer` | Le nom d’hôte de l’ordinateur | | nom d'hôte | `computer` | Le nom d’hôte de l’ordinateur |
| style\* | | Reflète la valeur de l'option `style` | | style\* | | Reflète la valeur de l'option `style` |
| ssh_symbol | `"🌏 "` | The symbol to represent when connected to SSH session |
*: Cette variable peut uniquement être utilisée dans une chaine de style *: Cette variable peut uniquement être utilisée dans une chaine de style
@ -1743,8 +1748,8 @@ Le module `hostname` affiche le nom d'hôte du système.
[hostname] [hostname]
ssh_only = false ssh_only = false
format = "on [$hostname](bold red) " format = "[$ssh_symbol](bold blue) on [$hostname](bold red) "
trim_at = ".nom-entreprise.com" trim_at = ".companyname.com"
disabled = false disabled = false
``` ```
@ -1933,7 +1938,7 @@ kotlin_binary = "kotlinc"
## Kubernetes ## Kubernetes
Displays the current [Kubernetes context](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context) name and, if set, the namespace, user and cluster from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via `kubectl config set-context starship-context --namespace astronaut`. Similarly the user and cluster can be set with `kubectl config set-context starship-context --user starship-user` and `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, l’espace de nom, l’utilisateur, 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 ::: tip
@ -1978,13 +1983,13 @@ disabled = false
"gke_.*_(?P<var_cluster>[\\w-]+)" = "gke-$var_cluster" "gke_.*_(?P<var_cluster>[\\w-]+)" = "gke-$var_cluster"
``` ```
#### Regex Matching #### Filtrage par regex
Additional to simple aliasing, `context_aliases` also supports extended matching and renaming using regular expressions. En plus des alias simples, `context_aliases` gère aussi un filtrage avancé et le renommage en utilisant des expressions rationnelles.
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. L’expression 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).
Long and automatically generated cluster names can be identified and shortened using regular expressions: Les noms de cluster long ou générés automatiquement peuvent être identifiés et raccourcis en utilisant des expressions rationnelles:
```toml ```toml
[kubernetes.context_aliases] [kubernetes.context_aliases]
@ -2268,17 +2273,17 @@ Le module `nodejs` affiche la version actuellement installée de [Node.js](https
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| ------------------- | ------------------------------------------ | ----------------------------------------------------------------------------------------------------- | | ------------------- | ------------------------------------------ | ----------------------------------------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `format` | `"via [$symbol($version )]($style)"` | Format du module. |
| `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` |
| `symbol` | `" "` | Une chaîne de caractères représentant le symbole de Node.js. | | `symbol` | `" "` | Une chaîne de caractères représentant le symbole de Node.js. |
| `detect_extensions` | `["js", "mjs", "cjs", "ts", "mts", "cts"]` | Quelles extensions devraient activer ce module. | | `detect_extensions` | `["js", "mjs", "cjs", "ts", "mts", "cts"]` | Quelles extensions devraient activer ce module. |
| `detect_files` | `["package.json", ".node-version"]` | Les fichiers qui activent ce module. | | `detect_files` | `["package.json", ".node-version"]` | Les fichiers qui activent ce module. |
| `detect_folders` | `["node_modules"]` | Les dossiers qui activent ce module. | | `detect_folders` | `["node_modules"]` | Les dossiers qui activent ce module. |
| `style` | `"bold green"` | Le style du module. | | `style` | `"bold green"` | Le style du module. |
| `disabled` | `false` | Désactive le module `nodejs`. | | `disabled` | `false` | Désactive le module `nodejs`. |
| `not_capable_style` | `bold red` | The style for the module when an engines property in package.json does not match the Node.js version. | | `not_capable_style` | `bold red` | Le style du module quand une propriété engines dans le package.json ne correspond pas à la version Node.js. |
### Variables ### Variables
@ -2363,8 +2368,8 @@ The `openstack` module shows the current OpenStack cloud and project. The module
| Variable | Exemple | Description | | Variable | Exemple | Description |
| --------- | ------- | -------------------------------------- | | --------- | ------- | -------------------------------------- |
| cloud | `corp` | The current OpenStack cloud | | cloud | `corp` | Le cloud OpenStack courant |
| project | `dev` | The current OpenStack project | | project | `dev` | Le projet OpenStack courant |
| symbol | | Reflète la valeur de l'option `symbol` | | symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` | | style\* | | Reflète la valeur de l'option `style` |
@ -2383,23 +2388,23 @@ symbol = "☁️ "
## Version du package ## Version du package
The `package` module is shown when the current directory is the repository for a package, and shows its current version. Le module gère actuellement les paquets `npm`, `nimble`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards` et `dart`. 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.
- [**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 - [**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 - [**Cargo**](https://doc.rust-lang.org/cargo/) – La version du paquet `cargo` est extraite du `Cargo.toml` présent dans le répertoire courant
- [**Nimble**](https://github.com/nim-lang/nimble) - La version du paquet `nimble` est extraite du fichier `*.nimble` dans le répertoire courant avec la commande `nimble dump` - [**Nimble**](https://github.com/nim-lang/nimble) - La version du paquet `nimble` est extraite du fichier `*.nimble` dans le répertoire courant avec la commande `nimble dump`
- [**Poetry**](https://python-poetry.org/) – La version du paquet `poetry` est extraite du `pyproject.toml` présent dans le répertoire courant - [**Poetry**](https://python-poetry.org/) – La version du paquet `poetry` est extraite du `pyproject.toml` présent dans le répertoire courant
- [**Python**](https://www.python.org) - La version du paquet `python` est extraite du `setup.cfg` présent dans le répertoire courant - [**Python**](https://www.python.org) - The `python` package version is extracted from a [PEP 621](https://peps.python.org/pep-0621/) compliant `pyproject.toml` or a `setup.cfg` present in the current directory
- [**Composer**](https://getcomposer.org/) – La version du paquet `composer` est extraite du `composer.json` présent dans le répertoire courant - [**Composer**](https://getcomposer.org/) – La version du paquet `composer` est extraite du `composer.json` présent dans le répertoire courant
- [**Gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present - [**Gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present in the current directory
- [**Julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present - [**Julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present in the current directory
- [**Mix**](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present - [**Mix**](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present in the current directory
- [**Helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present - [**Helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present in the current directory
- [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present - [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory
- [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present - [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present - [**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 - [**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 - [**SBT**](https://scala-sbt.org) - La version du paquet `sbt` est extraite du `build.sbt` présent dans le dossier courant
- [**Dart**](https://pub.dev/) – La version du paquet `dart` est extrait du `pubspec.yaml` présent dans le répertoire courant - [**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. > ⚠️ La version montrée est celle du paquet dont le code source est dans votre dossier courant, pas votre gestionnaire de paquet.
@ -2412,7 +2417,7 @@ The `package` module is shown when the current directory is the repository for a
| `symbol` | `"📦 "` | Le symbole utilisé avant d'afficher la version du paquet. | | `symbol` | `"📦 "` | Le symbole utilisé avant d'afficher la version du paquet. |
| `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` |
| `style` | `"bold 208"` | Le style du module. | | `style` | `"bold 208"` | Le style du module. |
| `display_private` | `false` | Enable displaying version for packages marked as private. | | `display_private` | `false` | Active l’affichage des versions des paquets marqués comme privés. |
| `disabled` | `false` | Désactive le module `package`. | | `disabled` | `false` | Désactive le module `package`. |
### Variables ### Variables
@ -2520,14 +2525,14 @@ The `pulumi` module shows the current username, selected [Pulumi Stack](https://
::: tip ::: tip
By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, [follow the example shown below](#with-pulumi-version). Par défaut, la version de Pulumi n'est pas affichée, car cela prendre un ordre de magnitude plus de temps à charger que la plupart des plugins (~70ms). Si vous voulez quand même l’activer, [suivez l’exemple montré plus bas](#with-pulumi-version).
::: :::
Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie:
- The current directory contains either `Pulumi.yaml` or `Pulumi.yml` - Le dossier courant contient soit un `Pulumi.yaml`, soit un `Pulumi.yml`
- A parent directory contains either `Pulumi.yaml` or `Pulumi.yml` - Un dossier parent contient soit un `Pulumi.yaml`, soit un `Pulumi.yml`
### Options ### Options
@ -2782,7 +2787,7 @@ symbol = "🔴 "
## Ruby ## Ruby
Par défaut, le module `ruby` affiche la version actuellement installée de [Ruby](https://www.ruby-lang.org/). Le module est affiché si l'une de ces conditions est remplie : 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 `Gemfile`
- Le dossier courant contient un fichier `.ruby-version` - Le dossier courant contient un fichier `.ruby-version`
@ -2846,11 +2851,13 @@ Par défaut, le module `rust` affiche la version actuellement installée de [Rus
### Variables ### Variables
| Variable | Exemple | Description | | Variable | Exemple | Description |
| --------- | ----------------- | -------------------------------------- | | --------- | ----------------- | -------------------------------------------- |
| version | `v1.43.0-nightly` | La version de `rustc` | | version | `v1.43.0-nightly` | La version de `rustc` |
| symbol | | Reflète la valeur de l'option `symbol` | | numver | `1.51.0` | The numeric component of the `rustc` version |
| style\* | | Reflète la valeur de l'option `style` | | toolchain | `beta` | The toolchain version |
| 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 *: Cette variable peut uniquement être utilisée dans une chaine de style
@ -2934,10 +2941,10 @@ Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur
### Variables ### Variables
| Variable | Défaut | Description | | Variable | Défaut | Description |
| --------- | ------ | ---------------------------------------------------------- | | --------- | ------ | ------------------------------------------------- |
| indicator | | Mirrors the value of `indicator` for currently used shell. | | indicator | | Reflète la valeur de `indicator` du shell actuel. |
| style\* | | Reflète la valeur de l'option `style`. | | style\* | | Reflète la valeur de l'option `style`. |
*: Cette variable peut uniquement être utilisée dans une chaine de style *: Cette variable peut uniquement être utilisée dans une chaine de style
@ -2956,18 +2963,18 @@ disabled = false
## SHLVL ## SHLVL
The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold. Le module `shlvl` montre la variable d’environnement [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) («niveau de shell») actuelle, si elle a une valeur numérique qui est égale ou dépasse le seuil défini.
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| ----------- | ---------------------------- | ------------------------------------------------------------- | | ----------- | ---------------------------- | ----------------------------------------------------------------------- |
| `threshold` | `2` | Display threshold. | | `threshold` | `2` | Seuil d’affichage. |
| `format` | `"[$symbol$shlvl]($style) "` | Format du module. | | `format` | `"[$symbol$shlvl]($style) "` | Format du module. |
| `symbol` | `"↕️ "` | The symbol used to represent the `SHLVL`. | | `symbol` | `"↕️ "` | Le symbole utilisée pour représenter le `SHLVL`. |
| `repeat` | `false` | Causes `symbol` to be repeated by the current `SHLVL` amount. | | `repeat` | `false` | Fait répéter `symbol` autant de fois que la valeur actuelle de `SHLVL`. |
| `style` | `"bold yellow"` | Le style du module. | | `style` | `"bold yellow"` | Le style du module. |
| `disabled` | `true` | Désactive le module `shlvl`. | | `disabled` | `true` | Désactive le module `shlvl`. |
### Variables ### Variables
@ -2992,7 +2999,7 @@ threshold = 3
## Singularity ## Singularity
The `singularity` module shows the current [Singularity](https://sylabs.io/singularity/) image, if inside a container and `$SINGULARITY_NAME` is set. Le module `singularity` affiche l’image [Singularity](https://sylabs.io/singularity/) courante, quand vous êtes à l’intérieur d’un conteneur et que `$SINGULARITY_NAME` est définie.
### Options ### Options
@ -3024,23 +3031,23 @@ format = '[📦 \[$env\]]($style) '
## Spack ## Spack
The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set. Le module `spack` affiche l’environnement [Spack](https://spack.readthedocs.io/en/latest/) courant, si `$SPACK_ENV` est définie.
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| ------------------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `truncation_length` | `1` | The number of directories the environment path should be truncated to. `0` ne signifie pas de troncature. Regardez aussi le module [`directory`](#directory). | | `truncation_length` | `1` | Le nombre de dossiers auxquels le chemin d’environnement doit être tronqué. `0` ne signifie pas de troncature. Regardez aussi le module [`directory`](#directory). |
| `symbol` | `"🅢 "` | Le symbole utilisé avant le nom d'environnement. | | `symbol` | `"🅢 "` | Le symbole utilisé avant le nom d'environnement. |
| `style` | `"bold blue"` | Le style du module. | | `style` | `"bold blue"` | Le style du module. |
| `format` | `"via [$symbol$environment]($style) "` | Format du module. | | `format` | `"via [$symbol$environment]($style) "` | Format du module. |
| `disabled` | `false` | Disables the `spack` module. | | `disabled` | `false` | Désactive le module `spack`. |
### Variables ### Variables
| Variable | Exemple | Description | | Variable | Exemple | Description |
| ------------- | ------------ | -------------------------------------- | | ------------- | ------------ | -------------------------------------- |
| environnement | `astronauts` | The current spack environment | | environnement | `astronauts` | L’environnement de spack courant |
| symbol | | Reflète la valeur de l'option `symbol` | | symbol | | Reflète la valeur de l'option `symbol` |
| style\* | | Reflète la valeur de l'option `style` | | style\* | | Reflète la valeur de l'option `style` |
@ -3117,7 +3124,7 @@ disabled = false
## Sudo ## Sudo
The `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached. Le moduel `sudo` affiche si les identifiants sudo sont actuellement en cache. Le module sera uniquement affiché si les identifiants sont en cache.
::: tip ::: tip
@ -3127,13 +3134,13 @@ Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| --------------- | ----------------------- | ------------------------------------------------------- | | --------------- | ----------------------- | ----------------------------------------------------------------- |
| `format` | `[as $symbol]($style)"` | Le format du module | | `format` | `[as $symbol]($style)"` | Le format du module |
| `symbol` | `"🧙 "` | The symbol displayed when credentials are cached | | `symbol` | `"🧙 "` | Le symbole affiché quand les identifiants sont en cache |
| `style` | `"bold blue"` | Le style du module. | | `style` | `"bold blue"` | Le style du module. |
| `allow_windows` | `false` | Since windows has no default sudo, default is disabled. | | `allow_windows` | `false` | Puisque Windows n’a pas de sudo par défaut, désactivé par défaut. |
| `disabled` | `true` | Désactive le module `sudo`. | | `disabled` | `true` | Désactive le module `sudo`. |
### Variables ### Variables
@ -3209,7 +3216,7 @@ Le module `terraform` affiche [l’espace de travail Terraform](https://www.terr
::: tip ::: tip
By default the Terraform version is not shown, since this is slow for current versions of Terraform when a lot of plugins are in use. If you still want to enable it, [follow the example shown below](#with-terraform-version). Par défaut, la version de Terraform n’est pas affichée, car elle est lente pour les versions actuelles de Terraform quand beaucoup de plugins sont utilisés. Si vous voulez quand même l’activer, [suivez l’exemple montré plus bas](#with-terraform-version).
::: :::
@ -3282,7 +3289,7 @@ Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur
| `style` | `"bold yellow"` | Le style utilisé par le module | | `style` | `"bold yellow"` | Le style utilisé par le module |
| `utc_time_offset` | `"local"` | Définir le décalage horaire UTC à utiliser. Intervalle de -24 &lt; x &lt; 24. Accepte des nombres décimaux pour s'adapter aux décalages de 30/45 minutes. | | `utc_time_offset` | `"local"` | Définir le décalage horaire UTC à utiliser. Intervalle de -24 &lt; x &lt; 24. Accepte des nombres décimaux pour s'adapter aux décalages de 30/45 minutes. |
| `disabled` | `true` | Désactiver le module `time`. | | `disabled` | `true` | Désactiver le module `time`. |
| `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | | `time_range` | `"-"` | Définit la plage de temps pendant laquelle le module sera affiché. Les heures doivent être spécifiées au format 24 heures |
Si `use_12hr` est à `true`, alors `time_format` vaut `"%r"`. Sinon, il est défini comme `"%T"`. Définir manuellement `time_format` outrepasse le paramètre `use_12hr`. Si `use_12hr` est à `true`, alors `time_format` vaut `"%r"`. Sinon, il est défini comme `"%T"`. Définir manuellement `time_format` outrepasse le paramètre `use_12hr`.
@ -3312,7 +3319,7 @@ time_range = "10:00:00-14:00:00"
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 est affiché si l'une de ces conditions est remplie :
- The current user is root/admin - L'utilisateur courant est root/admin
- L'utilisateur courant est différent de celui connecté - L'utilisateur courant est différent de celui connecté
- L'utilisateur est actuellement connecté à une session SSH - L'utilisateur est actuellement connecté à une session SSH
- La variable `show_always` a comme valeur true - La variable `show_always` a comme valeur true
@ -3325,13 +3332,13 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, `
### Options ### Options
| Option | Défaut | Description | | Option | Défaut | Description |
| ------------- | ----------------------- | ------------------------------------------------ | | ------------- | ----------------------- | ---------------------------------------------------- |
| `style_root` | `"bold green"` | The style used when the user is root/admin. | | `style_root` | `"bold green"` | Le style utilisé quand l'utilisateur est root/admin. |
| `style_user` | `"bold yellow"` | Le style utilisé pour les utilisateurs non-root. | | `style_user` | `"bold yellow"` | Le style utilisé pour les utilisateurs non-root. |
| `format` | `"[$user]($style) in "` | Format du module. | | `format` | `"[$user]($style) in "` | Format du module. |
| `show_always` | `false` | Toujours afficher le module `username`. | | `show_always` | `false` | Toujours afficher le module `username`. |
| `disabled` | `false` | Désactiver le module `username`. | | `disabled` | `false` | Désactiver le module `username`. |
### Variables ### Variables
@ -3503,15 +3510,15 @@ Les modules `custom` affichent la sortie d’une commande arbitaitre.
Ces modules seront affichés si l'une de ces conditions est remplie: Ces modules seront affichés si l'une de ces conditions est remplie:
- The current directory contains a file whose name is in `detect_files` - Le dossier courant contient un fichier dont le nom est dans `detect_files`
- The current directory contains a directory whose name is in `detect_folders` - Le dossier courant contient un dossier dont le nom est dans `detect_folders`
- The current directory contains a file whose extension is in `detect_extensions` - Le dossier courant contient un fichier dont l’extension est dans `detect_extensions`
- La commande `when` retourne 0 - La commande `when` retourne 0
- The current Operating System (std::env::consts::OS) matchs with `os` field if defined. - Le système d’exploitation courant (std::env::consts::OS) correspond au champ `os` si défini.
::: tip ::: tip
Multiple custom modules can be defined by using a `.`. Plusieurs modules personnalisés peuvent être définis en utilisant un `.`.
::: :::
@ -3539,10 +3546,10 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt
| Option | Défaut | Description | | Option | Défaut | Description |
| ------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `command` | `""` | The command whose output should be printed. The command will be passed on stdin to the shell. | | `command` | `""` | La commande dont la sortie doit être affichée. La commande sera transmise au shell sur l’entrée standard. |
| `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. | | `when` | `false` | Soit une valeur booléenne (`true` ou `false`, sans guillemets) ou une commande shell utilisée comme condition pour afficher le module. Dans le cas d’une chaine, le module sera affiché si la commande renvoie un code de statut `0`. |
| `shell` | | [See below](#custom-command-shell) | | `shell` | | [Voir plus bas](#custom-command-shell) |
| `description` | `"<custom module>"` | The description of the module that is shown when running `starship explain`. | | `description` | `"<custom module>"` | La description du module qui est affichée lors de l’exécution de `starship explain`. |
| `detect_files` | `[]` | The files that will be searched in the working directory for a match. | | `detect_files` | `[]` | The files that will be searched in the working directory for a match. |
| `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. | | `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. |
| `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. | | `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. |
@ -3550,9 +3557,9 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt
| `style` | `"bold green"` | Le style du module. | | `style` | `"bold green"` | Le style du module. |
| `format` | `"[$symbol($output )]($style)"` | Format du module. | | `format` | `"[$symbol($output )]($style)"` | Format du module. |
| `disabled` | `false` | Désactive le module `custom`. | | `disabled` | `false` | Désactive le module `custom`. |
| `os` | | Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) [See possible values](https://doc.rust-lang.org/std/env/consts/constant.OS.html). | | `os` | | Nom du système d'exploitation sur lequel le module sera affiché (unix, linux, macos, windows, ... ) [Voir les valeurs possibles](https://doc.rust-lang.org/std/env/consts/constant.OS.html). |
| `use_stdin` | | An optional boolean value that overrides whether commands should be forwarded to the shell via the standard input or as an argument. If unset standard input is used by default, unless the shell does not support it (cmd, nushell). Setting this disables shell-specific argument handling. | | `use_stdin` | | An optional boolean value that overrides whether commands should be forwarded to the shell via the standard input or as an argument. If unset standard input is used by default, unless the shell does not support it (cmd, nushell). Setting this disables shell-specific argument handling. |
| `ignore_timeout` | `false` | Ignore global `command_timeout` setting and keep running external commands, no matter how long they take. | | `ignore_timeout` | `false` | Ignore le paramètre global `command_timeout` et continuer à exécuter des commandes externes, peu importe le temps qu'elles prennent. |
### Variables ### Variables

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

@ -326,7 +326,7 @@ eval $(starship init ion)
<details> <details>
<summary>Nushell</summary> <summary>Nushell</summary>
Exécutez les commandes suivantes: Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
@ -336,11 +336,10 @@ starship init nu | save ~/.cache/starship/init.nu
Ajoutez le code suivant à la fin de votre configuration Nushell (trouvez-la en exécutant `$nu.config path`): Ajoutez le code suivant à la fin de votre configuration Nushell (trouvez-la en exécutant `$nu.config path`):
```sh ```sh
starship init nu | save ~/.cache/starship/init.nu
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```
Note: Seul Nushell v0.60+ est supporté Note: Seul Nushell v0.61+ est supporté
</details> </details>

20
docs/id-ID/README.md
View File

@ -120,7 +120,11 @@ description: Starship merupakan sebuah prompt yang minimal, super cepat, dan san
#### Elvish #### Elvish
::: warning Hanya elvish v0.18 atau versi yang lebih baru yang mendapat dukungan pengembangan. ::: ::: warning
Only elvish v0.18 or higher is supported.
:::
Tambahkan skrip berikut pada baris akhir `~/.elvish/rc.elv`: Tambahkan skrip berikut pada baris akhir `~/.elvish/rc.elv`:
@ -144,17 +148,21 @@ description: Starship merupakan sebuah prompt yang minimal, super cepat, dan san
#### Nushell #### Nushell
::: peringatan Hal ini dapat berubah di kemudian hari. Only Nushell v0.60+ is supported. ::: Run the following: ::: warning
This will change in the future. Hanya Nushell v0.61+ yang menerima dukungan.
:::
Add the following to to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu starship init nu | save ~/.cache/starship/init.nu
``` ```
And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`): Lalu tambahkan baris berikut di baris terakhir konfigurasi Nushell (temukan dengan menjalankan `$nu.config-path`):
```sh ```sh
mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```
@ -171,7 +179,7 @@ description: Starship merupakan sebuah prompt yang minimal, super cepat, dan san
#### Cmd #### Cmd
You need to use [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) with Cmd. Add the following to a file `starship.lua` and place this file in Clink scripts directory: Kamu perlu menggunakan [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) pada Cmd. Tambahkan baris berikut ke dalam `starship.lua` lalu taruhlah file berikut ke dalam direktori Clink:
```lua ```lua
-- starship.lua -- starship.lua

137
docs/id-ID/config/README.md
View File

@ -280,16 +280,16 @@ Ketika menggunakan [AWSume](https://awsu.me) profil dibaca dari variabel environ
### Opsi ### Opsi
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | | ------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `fromat` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | Format dari modul. | | `fromat` | `'on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)'` | Format dari modul. |
| `symbol` | `"☁️ "` | Simbol yang digunakan sebelum menampilkan profil AWS terkini. | | `symbol` | `"☁️ "` | Simbol yang digunakan sebelum menampilkan profil AWS terkini. |
| `region_aliases` | | Tabel alias dari region yang ditampilan selain nama AWS. | | `region_aliases` | | Tabel alias dari region yang ditampilan selain nama AWS. |
| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | | `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. |
| `style` | `"bold yellow"` | Gaya penataan untuk modul. | | `style` | `"bold yellow"` | Gaya penataan untuk modul. |
| `expiration_symbol` | `X` | Simbol ditampilkan ketika temporer kredensial telah kedaluwarsa. | | `expiration_symbol` | `X` | Simbol ditampilkan ketika temporer kredensial telah kedaluwarsa. |
| `disabled` | `false` | Menonaktifkan modul `AWS`. | | `disabled` | `false` | Menonaktifkan modul `AWS`. |
| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. | | `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. |
### Variabel ### Variabel
@ -1140,7 +1140,9 @@ Modul `env_var` menampilkan nilai terkini dari variabel environment yang dipilih
- Opsi konfigurasi `variable` cocok dengan variabel environment yang ada - Opsi konfigurasi `variable` cocok dengan variabel environment yang ada
- Opsi konfigurasi `variable` tidak didefinisikan, tapi opsi konfigurasi `default` yang didefinisikan - Opsi konfigurasi `variable` tidak didefinisikan, tapi opsi konfigurasi `default` yang didefinisikan
Multi-variabel environment dapat ditampilkan dengan menggunakan `.`. (lihat contoh) Jika opsi konfigurasi `variable` tidak diset, modul akan menampilkan nilai variabel di bawah teks nama setelah karakter `.`. ::: tip
Multiple environmental variables can be displayed by using a `.`. (lihat contoh) Jika opsi konfigurasi `variable` tidak diset, modul akan menampilkan nilai variabel di bawah teks nama setelah karakter `.`.
Contoh: konfigurasi berikut akan menampilkan nilai dari variabel USER environment Contoh: konfigurasi berikut akan menampilkan nilai dari variabel USER environment
@ -1342,17 +1344,17 @@ The `git_branch` module shows the active branch of the repo in your current dire
### Opsi ### Opsi
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| -------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | | -------------------- | ------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | | `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. |
| `fromat` | `"on [$symbol$branch]($style) "` | Format dari modul. Use `"$branch"` to refer to the current branch name. | | `fromat` | `"on [$symbol$branch(:$remote_branch)]($style) "` | Format dari modul. Use `"$branch"` to refer to the current branch name. |
| `symbol` | `" "` | A format string representing the symbol of git branch. | | `symbol` | `" "` | A format string representing the symbol of git branch. |
| `style` | `"bold purple"` | Gaya penataan untuk modul. | | `style` | `"bold purple"` | Gaya penataan untuk modul. |
| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | | `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. |
| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. | | `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. |
| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | | `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". | | `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for "master" or "main". |
| `disabled` | `false` | Disables the `git_branch` module. | | `disabled` | `false` | Disables the `git_branch` module. |
### Variabel ### Variabel
@ -1602,25 +1604,26 @@ The `golang` module shows the currently installed version of [Go](https://golang
- Direktori terkini yang berisikan sebuah file `go.mod` - Direktori terkini yang berisikan sebuah file `go.mod`
- Direktori terkini yang berisikan sebuah file `go.sum` - Direktori terkini yang berisikan sebuah file `go.sum`
- Direktori terkini yang berisikan sebuah file `glide.yaml` - Direktori ini memiliki berkas `go.work`
- The current directory contains a `Gopkg.yml` file - Direktori ini memiliki berkas `glide.yaml`
- The current directory contains a `Gopkg.lock` file - Direktori ini memiliki berkas `Gopkg.yml`
- The current directory contains a `.go-version` file - Direktori ini memiliki berkas `Gopkg.lock`
- The current directory contains a `Godeps` directory - Direktori ini memiliki berkas `.go-version`
- The current directory contains a file with the `.go` extension - Direktori ini memiliki berkas `Godeps`
- Direktori ini memiliki berkas dengan ekstensi `.go`
### Opsi ### Opsi
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ------------------- | ------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| `fromat` | `"via [$symbol($version )]($style)"` | Format dari modul. | | `fromat` | `"via [$symbol($version )]($style)"` | Format dari modul. |
| `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. | | `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
| `detect_extensions` | `["go"]` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_extensions` | `["go"]` | Ekstensi mana yang sebaiknya memicu modul ini. |
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | filenames mana yang sebaiknya memicu modul ini. | | `detect_files` | `["go.mod", "go.sum", "go.work", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | filenames mana yang sebaiknya memicu modul ini. |
| `detect_folders` | `["Godeps"]` | Folder mana yang sebaiknya memicul modul ini. | | `detect_folders` | `["Godeps"]` | Folder mana yang sebaiknya memicul modul ini. |
| `style` | `"bold cyan"` | Gaya penataan untuk modul. | | `style` | `"bold cyan"` | Gaya penataan untuk modul. |
| `disabled` | `false` | Disables the `golang` module. | | `disabled` | `false` | Disables the `golang` module. |
### Variabel ### Variabel
@ -1719,20 +1722,22 @@ The `hostname` module shows the system hostname.
### Opsi ### Opsi
| Opsi | Bawaan | Deskripsi | | Opsi | Bawaan | Deskripsi |
| ---------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | | ------------ | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `ssh_only` | `true` | Only show hostname when connected to an SSH session. | | `ssh_only` | `true` | Only show hostname when connected to an SSH session. |
| `trim_at` | `"."` | String that the hostname is cut off at, after the first match. `"."` will stop after the first dot. `""` will disable any truncation | | `ssh_symbol` | `"🌐 "` | A format string representing the symbol when connected to SSH session. |
| `fromat` | `"[$hostname]($style) in "` | Format dari modul. | | `trim_at` | `"."` | String that the hostname is cut off at, after the first match. `"."` will stop after the first dot. `""` will disable any truncation |
| `style` | `"bold dimmed green"` | Gaya penataan untuk modul. | | `fromat` | `"[$ssh_symbol$hostname]($style) in "` | Format dari modul. |
| `disabled` | `false` | Disables the `hostname` module. | | `style` | `"bold dimmed green"` | Gaya penataan untuk modul. |
| `disabled` | `false` | Disables the `hostname` module. |
### Variabel ### Variabel
| Variabel | Contoh | Deskripsi | | Variabel | Contoh | Deskripsi |
| --------- | ---------- | -------------------------------- | | ---------- | ---------- | ----------------------------------------------------- |
| hostname | `computer` | The hostname of the computer | | hostname | `computer` | The hostname of the computer |
| style\* | | Menyalin nilai dari opsi `style` | | style\* | | Menyalin nilai dari opsi `style` |
| ssh_symbol | `"🌏 "` | The symbol to represent when connected to SSH session |
*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string *: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string
@ -1743,7 +1748,7 @@ The `hostname` module shows the system hostname.
[hostname] [hostname]
ssh_only = false ssh_only = false
format = "on [$hostname](bold red) " format = "[$ssh_symbol](bold blue) on [$hostname](bold red) "
trim_at = ".companyname.com" trim_at = ".companyname.com"
disabled = false disabled = false
``` ```
@ -2383,22 +2388,22 @@ symbol = "☁️ "
## Package Version ## Package Version
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `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` 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 - [**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 - [**Cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
- [**Nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command - [**Nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command
- [**Poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory - [**Poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
- [**Python**](https://www.python.org) - The `python` package version is extracted from the `setup.cfg` present in the current directory - [**Python**](https://www.python.org) - The `python` package version is extracted from a [PEP 621](https://peps.python.org/pep-0621/) compliant `pyproject.toml` or a `setup.cfg` present in the current directory
- [**Composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory - [**Composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory
- [**Gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present - [**Gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present in the current directory
- [**Julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present - [**Julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present in the current directory
- [**Mix**](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present - [**Mix**](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present in the current directory
- [**Helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present - [**Helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present in the current directory
- [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present - [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory
- [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present - [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present - [**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 - [**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 - [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory
- [**Dart**](https://pub.dev/) - The `dart` package version is extracted from the `pubspec.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
@ -2845,11 +2850,13 @@ By default the `rust` module shows the currently installed version of [Rust](htt
### Variabel ### Variabel
| Variabel | Contoh | Deskripsi | | Variabel | Contoh | Deskripsi |
| --------- | ----------------- | --------------------------------- | | --------- | ----------------- | -------------------------------------------- |
| version | `v1.43.0-nightly` | The version of `rustc` | | version | `v1.43.0-nightly` | The version of `rustc` |
| symbol | | Menyalin nilai dari opsi `symbol` | | numver | `1.51.0` | The numeric component of the `rustc` version |
| style\* | | Menyalin nilai dari opsi `style` | | toolchain | `beta` | The toolchain version |
| symbol | | Menyalin nilai dari opsi `symbol` |
| style\* | | Menyalin nilai dari opsi `style` |
*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string *: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string

9
docs/id-ID/guide/README.md
View File

@ -280,7 +280,7 @@ eval "$(starship init bash)"
<details> <details>
<summary>Cmd</summary> <summary>Cmd</summary>
You need to use [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) with Cmd. Create a file at this path `%LocalAppData%\clink\starship.lua` with the following contents: Kamu perlu menggunakan [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) pada Cmd. Create a file at this path `%LocalAppData%\clink\starship.lua` with the following contents:
```lua ```lua
load(io.popen('starship init cmd'):read("*a"))() load(io.popen('starship init cmd'):read("*a"))()
@ -326,21 +326,20 @@ eval $(starship init ion)
<details> <details>
<summary>Nushell</summary> <summary>Nushell</summary>
Run the following: Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu starship init nu | save ~/.cache/starship/init.nu
``` ```
And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`): Lalu tambahkan baris berikut di baris terakhir konfigurasi Nushell (temukan dengan menjalankan `$nu.config-path`):
```sh ```sh
starship init nu | save ~/.cache/starship/init.nu
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```
Note: Only Nushell v0.60+ is supported Note: Only Nushell v0.61+ is supported
</details> </details>

16
docs/it-IT/README.md
View File

@ -120,7 +120,11 @@ description: Starship è il prompt minimalista, super veloce ed estremamente per
#### Elvish #### Elvish
::: warning È supportato solo elvish v0.18 o superiore. ::: ::: warning
Only elvish v0.18 or higher is supported.
:::
Aggiungi quanto segue alla fine di `~/.elvish/rc.elv`: Aggiungi quanto segue alla fine di `~/.elvish/rc.elv`:
@ -144,7 +148,13 @@ description: Starship è il prompt minimalista, super veloce ed estremamente per
#### Nushell #### Nushell
::: warning Questo cambierà in futuro. Only Nushell v0.60+ is supported. ::: Run the following: ::: warning
This will change in the future. Only Nushell v0.61+ is supported.
:::
Add the following to to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu starship init nu | save ~/.cache/starship/init.nu
@ -153,8 +163,6 @@ description: Starship è il prompt minimalista, super veloce ed estremamente per
And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`): And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):
```sh ```sh
mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```

125
docs/it-IT/config/README.md
View File

@ -280,16 +280,16 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL
### Opzioni ### Opzioni
| Opzione | Default | Descrizione | | Opzione | Default | Descrizione |
| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | | ------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | The format for the module. | | `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)'` | The format for the module. |
| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. | | `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
| `region_aliases` | | Table of region aliases to display in addition to the AWS name. | | `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | | `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. |
| `style` | `"bold yellow"` | Lo stile per il modulo. | | `style` | `"bold yellow"` | Lo stile per il modulo. |
| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. | | `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. |
| `disabled` | `false` | Disables the `AWS` module. | | `disabled` | `false` | Disables the `AWS` module. |
| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. | | `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. |
### Variables ### Variables
@ -1140,7 +1140,9 @@ The `env_var` module displays the current value of a selected environment variab
- The `variable` configuration option matches an existing environment variable - The `variable` configuration option matches an existing environment variable
- The `variable` configuration option is not defined, but the `default` configuration option is - The `variable` configuration option is not defined, but the `default` configuration option is
::: tip Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. ::: tip
Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character.
Example: following configuration will display value of USER environment variable Example: following configuration will display value of USER environment variable
@ -1342,17 +1344,17 @@ The `git_branch` module shows the active branch of the repo in your current dire
### Opzioni ### Opzioni
| Opzione | Default | Descrizione | | Opzione | Default | Descrizione |
| -------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | | -------------------- | ------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | | `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. |
| `format` | `"on [$symbol$branch]($style) "` | The format for the module. Use `"$branch"` to refer to the current branch name. | | `format` | `"on [$symbol$branch(:$remote_branch)]($style) "` | The format for the module. Use `"$branch"` to refer to the current branch name. |
| `symbol` | `" "` | A format string representing the symbol of git branch. | | `symbol` | `" "` | A format string representing the symbol of git branch. |
| `style` | `"bold purple"` | Lo stile per il modulo. | | `style` | `"bold purple"` | Lo stile per il modulo. |
| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | | `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. |
| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. | | `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. |
| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | | `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". | | `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for "master" or "main". |
| `disabled` | `false` | Disables the `git_branch` module. | | `disabled` | `false` | Disables the `git_branch` module. |
### Variables ### Variables
@ -1602,6 +1604,7 @@ The `golang` module shows the currently installed version of [Go](https://golang
- The current directory contains a `go.mod` file - The current directory contains a `go.mod` file
- The current directory contains a `go.sum` file - The current directory contains a `go.sum` file
- The current directory contains a `go.work` file
- The current directory contains a `glide.yaml` file - The current directory contains a `glide.yaml` file
- The current directory contains a `Gopkg.yml` file - The current directory contains a `Gopkg.yml` file
- The current directory contains a `Gopkg.lock` file - The current directory contains a `Gopkg.lock` file
@ -1611,16 +1614,16 @@ The `golang` module shows the currently installed version of [Go](https://golang
### Opzioni ### Opzioni
| Opzione | Default | Descrizione | | Opzione | Default | Descrizione |
| ------------------- | ------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `version_format` | `"v${raw}"` | Il formato della versione. Le variabili disponibili sono `raw`, `major`, `minore`, & `patch` | | `version_format` | `"v${raw}"` | Il formato della versione. Le variabili disponibili sono `raw`, `major`, `minore`, & `patch` |
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. | | `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
| `detect_extensions` | `["go"]` | Quali estensioni dovrebbero attivare questo modulo. | | `detect_extensions` | `["go"]` | Quali estensioni dovrebbero attivare questo modulo. |
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Quali nomi di file dovrebbero attivare questo modulo. | | `detect_files` | `["go.mod", "go.sum", "go.work", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Quali nomi di file dovrebbero attivare questo modulo. |
| `detect_folders` | `["Godeps"]` | Quali cartelle dovrebbero attivare questo modulo. | | `detect_folders` | `["Godeps"]` | Quali cartelle dovrebbero attivare questo modulo. |
| `style` | `"bold cyan"` | Lo stile per il modulo. | | `style` | `"bold cyan"` | Lo stile per il modulo. |
| `disabled` | `false` | Disables the `golang` module. | | `disabled` | `false` | Disables the `golang` module. |
### Variables ### Variables
@ -1719,20 +1722,22 @@ The `hostname` module shows the system hostname.
### Opzioni ### Opzioni
| Opzione | Default | Descrizione | | Opzione | Default | Descrizione |
| ---------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | | ------------ | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `ssh_only` | `true` | Only show hostname when connected to an SSH session. | | `ssh_only` | `true` | Only show hostname when connected to an SSH session. |
| `trim_at` | `"."` | String that the hostname is cut off at, after the first match. `"."` will stop after the first dot. `""` will disable any truncation | | `ssh_symbol` | `"🌐 "` | A format string representing the symbol when connected to SSH session. |
| `format` | `"[$hostname]($style) in "` | The format for the module. | | `trim_at` | `"."` | String that the hostname is cut off at, after the first match. `"."` will stop after the first dot. `""` will disable any truncation |
| `style` | `"bold dimmed green"` | Lo stile per il modulo. | | `format` | `"[$ssh_symbol$hostname]($style) in "` | The format for the module. |
| `disabled` | `false` | Disables the `hostname` module. | | `style` | `"bold dimmed green"` | Lo stile per il modulo. |
| `disabled` | `false` | Disables the `hostname` module. |
### Variables ### Variables
| Variable | Esempio | Descrizione | | Variable | Esempio | Descrizione |
| --------- | ---------- | ----------------------------------- | | ---------- | ---------- | ----------------------------------------------------- |
| hostname | `computer` | The hostname of the computer | | hostname | `computer` | The hostname of the computer |
| style\* | | Mirrors the value of option `style` | | style\* | | Mirrors the value of option `style` |
| ssh_symbol | `"🌏 "` | The symbol to represent when connected to SSH session |
*: This variable can only be used as a part of a style string *: This variable can only be used as a part of a style string
@ -1743,7 +1748,7 @@ The `hostname` module shows the system hostname.
[hostname] [hostname]
ssh_only = false ssh_only = false
format = "on [$hostname](bold red) " format = "[$ssh_symbol](bold blue) on [$hostname](bold red) "
trim_at = ".companyname.com" trim_at = ".companyname.com"
disabled = false disabled = false
``` ```
@ -2383,22 +2388,22 @@ symbol = "☁️ "
## Package Version ## Package Version
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `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` 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 - [**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 - [**Cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
- [**Nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command - [**Nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command
- [**Poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory - [**Poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
- [**Python**](https://www.python.org) - The `python` package version is extracted from the `setup.cfg` present in the current directory - [**Python**](https://www.python.org) - The `python` package version is extracted from a [PEP 621](https://peps.python.org/pep-0621/) compliant `pyproject.toml` or a `setup.cfg` present in the current directory
- [**Composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory - [**Composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory
- [**Gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present - [**Gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present in the current directory
- [**Julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present - [**Julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present in the current directory
- [**Mix**](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present - [**Mix**](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present in the current directory
- [**Helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present - [**Helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present in the current directory
- [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present - [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory
- [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present - [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present - [**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 - [**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 - [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory
- [**Dart**](https://pub.dev/) - The `dart` package version is extracted from the `pubspec.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
@ -2845,11 +2850,13 @@ By default the `rust` module shows the currently installed version of [Rust](htt
### Variables ### Variables
| Variable | Esempio | Descrizione | | Variable | Esempio | Descrizione |
| --------- | ----------------- | ------------------------------------ | | --------- | ----------------- | -------------------------------------------- |
| version | `v1.43.0-nightly` | The version of `rustc` | | version | `v1.43.0-nightly` | The version of `rustc` |
| symbol | | Mirrors the value of option `symbol` | | numver | `1.51.0` | The numeric component of the `rustc` version |
| style\* | | Mirrors the value of option `style` | | toolchain | `beta` | The toolchain version |
| 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 *: This variable can only be used as a part of a style string

5
docs/it-IT/guide/README.md
View File

@ -326,7 +326,7 @@ eval $(starship init ion)
<details> <details>
<summary>Nushell</summary> <summary>Nushell</summary>
Run the following: Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
@ -336,11 +336,10 @@ 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`): And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):
```sh ```sh
starship init nu | save ~/.cache/starship/init.nu
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```
Note: Only Nushell v0.60+ is supported Note: Only Nushell v0.61+ is supported
</details> </details>

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

@ -120,7 +120,11 @@ description: Starship はミニマルで、非常に高速で、カスタマイ
#### Elvish #### Elvish
::: warning elvish v0.18以上のみサポートされています。 ::: ::: warning
elvish v0.18 以降のみサポートされます。
:::
`~/.elvish/rc.elv` の最後に以下を追記してください。 `~/.elvish/rc.elv` の最後に以下を追記してください。
@ -144,7 +148,13 @@ description: Starship はミニマルで、非常に高速で、カスタマイ
#### Nushell #### Nushell
::: 警告 これは将来的に変更されます。 Only Nushell v0.60+ is supported. 以下を実行します: ::: 警告
これは将来的に変更される可能性があります。 Nushell v0.61+ のみサポートされています。
:::
そして、Nushellの設定ファイルの最後に以下を追加してください（ `$nu.env-path` を実行してください）:
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu starship init nu | save ~/.cache/starship/init.nu
@ -153,8 +163,6 @@ description: Starship はミニマルで、非常に高速で、カスタマイ
そして、Nushellの設定ファイルの最後に以下を追加してください（ `$nu.config-path` を実行してください）。 そして、Nushellの設定ファイルの最後に以下を追加してください（ `$nu.config-path` を実行してください）。
```sh ```sh
mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```

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

@ -90,7 +90,7 @@ os.setenv('STARSHIP_CACHE', 'C:\\Users\\user\\AppData\\Local\\Temp')
`[]`で囲まれている最初の部分は、 [フォーマット文字列](#format-strings) です。 テキスト、変数、または入れ子になったテキストグループを追加できます。 `[]`で囲まれている最初の部分は、 [フォーマット文字列](#format-strings) です。 テキスト、変数、または入れ子になったテキストグループを追加できます。
2 番目の部分では、 `()`で囲まれている [スタイル文字列](#style-strings) です。 This can be used to style the first part. 2 番目の部分は、 `()`で囲まれている [スタイル文字列](#style-strings) です。 これは、最初のフォーマット文字列のスタイルを設定するために使用できます。
例： 例：
@ -150,13 +150,13 @@ format = '''
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ----------------- | ------------------------------ | ---------------------------------------------------------------- | | ----------------- | ------------------------------ | ------------------------------------------------------------- |
| `format` | [link](#default-prompt-format) | プロンプトの形式を設定します。 | | `format` | [link](#default-prompt-format) | プロンプトの形式を設定します。 |
| `right_format` | `""` | See [Enable Right Prompt](/advanced-config/#enable-right-prompt) | | `right_format` | `""` | [右プロンプトの有効化](/advanced-config/#enable-right-prompt)を参照してください。 |
| `scan_timeout` | `30` | ファイルをスキャンする際のタイムアウト時間 (milliseconds) です。 | | `scan_timeout` | `30` | ファイルをスキャンする際のタイムアウト時間 (milliseconds) です。 |
| `command_timeout` | `500` | Starshipによって実行されたコマンドのタイムアウト時間 (milliseconds) です。 | | `command_timeout` | `500` | Starshipによって実行されたコマンドのタイムアウト時間 (milliseconds) です。 |
| `add_newline` | `true` | シェルプロンプトの間に空行を挿入します。 | | `add_newline` | `true` | シェルプロンプトの間に空行を挿入します。 |
### 設定例 ### 設定例
@ -260,18 +260,18 @@ $shell\
$character""" $character"""
``` ```
If you just want to extend the default format, you can use `$all`; modules you explicitly add to the format will not be duplicated. Eg. If you just want to extend the default format, you can use `$all`; modules you explicitly add to the format will not be duplicated. 例:
```toml ```toml
# Move the directory to the second line # ディレクトリを2行目に移動
format = "$all$directory$character" format = "$all$directory$character"
``` ```
## AWS ## 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/config` に記述されている `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` 環境変数に基づいています。 This module also shows an expiration timer when using temporary credentials. `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 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 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`にすると、利用可能なすべての情報が表示されます。
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. 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.
@ -281,16 +281,16 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | | ------------------- | --------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | module のフォーマットです。 | | `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)'` | module のフォーマットです。 |
| `symbol` | `"☁️ "` | 現在のAWSプロファイルを表示する前に表示される記号です。 | | `symbol` | `"☁️ "` | 現在のAWSプロファイルを表示する前に表示される記号です。 |
| `region_aliases` | | AWS名に加えて表示するリージョンのエイリアスです。 | | `region_aliases` | | AWS名に加えて表示するリージョンのエイリアスです。 |
| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | | `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. |
| `style` | `"bold yellow"` | モジュールのスタイルです。 | | `style` | `"bold yellow"` | モジュールのスタイルです。 |
| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. | | `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. |
| `disabled` | `false` | `aws`モジュールを無効にします。 | | `disabled` | `false` | `aws`モジュールを無効にします。 |
| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. | | `force_display` | `false` | `true`の場合、`credentials`、`credential_process`または`sso_start_url`が設定されていない場合でも情報を表示します。 |
### 変数 ### 変数
@ -309,8 +309,6 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL
#### すべてを表示 #### すべてを表示
```toml ```toml
# ~/.config/starship.toml
[aws] [aws]
format = 'on [$symbol($profile )(\($region\) )]($style)' format = 'on [$symbol($profile )(\($region\) )]($style)'
style = "bold blue" style = "bold blue"
@ -442,23 +440,23 @@ discharging_symbol = "💦"
## Buf ## Buf
The `buf` module shows the currently installed version of [Buf](https://buf.build). By default, the module is shown if all of the following conditions are met: `buf`モジュールは、現在インストールされている[Buf](https://buf.build)のバージョンを表示します。 デフォルトでは次のすべての条件が満たされると、モジュールが表示されます。
- The [`buf`](https://github.com/bufbuild/buf) CLI is installed. - [`buf`](https://github.com/bufbuild/buf)CLI がインストールされている
- The current directory contains a [`buf.yaml`](https://docs.buf.build/configuration/v1/buf-yaml), [`buf.gen.yaml`](https://docs.buf.build/configuration/v1/buf-gen-yaml), or [`buf.work.yaml`](https://docs.buf.build/configuration/v1/buf-work-yaml) configuration file. - カレントディレクトリに、[`buf.yaml`](https://docs.buf.build/configuration/v1/buf-yaml)、[`buf.gen.yaml`](https://docs.buf.build/configuration/v1/buf-gen-yaml)または[`buf.work.yaml`](https://docs.buf.build/configuration/v1/buf-work-yaml)が含まれている
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ------------------- | ------------------------------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------------------------------ | -------------------------- |
| `format` | `'with [$symbol($version \(Buf $buf_version\) )]($style)'` | The format for the `buf` module. | | `format` | `'with [$symbol($version \(Buf $buf_version\) )]($style)'` | `buf`モジュールの形式。 |
| `version_format` | `"v${raw}"` | バージョンのフォーマット。 | | `version_format` | `"v${raw}"` | バージョンのフォーマット。 |
| `symbol` | `"🦬 "` | The symbol used before displaying the version of Buf. | | `symbol` | `"🦬 "` | Bufのバージョンを表示する前に使用される記号です。 |
| `detect_extensions` | `[]` | どの拡張子がこのモジュールをアクティブにするか | | `detect_extensions` | `[]` | どの拡張子がこのモジュールをアクティブにするか |
| `detect_files` | `["buf.yaml", "buf.gen.yaml", "buf.work.yaml"]` | どのファイル名がこのモジュールをアクティブにするか | | `detect_files` | `["buf.yaml", "buf.gen.yaml", "buf.work.yaml"]` | どのファイル名がこのモジュールをアクティブにするか |
| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | | `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか |
| `style` | `"bold blue"` | モジュールのスタイルです。 | | `style` | `"bold blue"` | モジュールのスタイルです。 |
| `disabled` | `false` | Disables the `elixir` module. | | `disabled` | `false` | `elixir`モジュールを無効にします。 |
### 変数 ### 変数
@ -481,7 +479,7 @@ symbol = "🦬 "
## C ## C
The `c` module shows some information about your C compiler. By default the module will be shown if the current directory contains a `.c` or `.h` file. `c` モジュールは、利用しているCコンパイラに関するいくつかの情報を表示します。 デフォルトでは、カレントディレクトリに`.c`または`.h`ファイルが含まれている場合、モジュールが表示されます。
### オプション ### オプション
@ -489,7 +487,7 @@ The `c` module shows some information about your C compiler. By default the modu
| ------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------ | | ------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------ |
| `format` | `"via [$symbol($version(-$name) )]($style)"` | モジュールのフォーマット文字列。 | | `format` | `"via [$symbol($version(-$name) )]($style)"` | モジュールのフォーマット文字列。 |
| `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | | `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 |
| `symbol` | `"C "` | The symbol used before displaying the compiler details | | `symbol` | `"C "` | コンパイラの詳細を表示する前に使用される記号です。 |
| `detect_extensions` | `["c", "h"]` | どの拡張子がこのモジュールをアクティブにするか | | `detect_extensions` | `["c", "h"]` | どの拡張子がこのモジュールをアクティブにするか |
| `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか | | `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか |
| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | | `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか |
@ -499,12 +497,12 @@ The `c` module shows some information about your C compiler. By default the modu
### 変数 ### 変数
| 変数 | 設定例 | 説明 | | 変数 | 設定例 | 説明 |
| ------- | ------ | --------------------------- | | ------- | ------ | ---------------------- |
| name | clang | The name of the compiler | | name | clang | コンパイラ名 |
| version | 13.0.0 | The version of the compiler | | version | 13.0.0 | コンパイラのバージョン |
| symbol | | オプション `記号` の値をミラーする | | symbol | | オプション `記号` の値をミラーする |
| style | | オプション `style` の値をミラーする | | style | | オプション `style` の値をミラーする |
NB that `version` is not in the default format. NB that `version` is not in the default format.
@ -538,7 +536,7 @@ format = "via [$name $version]($style)"
::: warning ::: warning
`vicmd_symbol` is only supported in cmd, fish and zsh. `vicmd_symbol` はcmd、fish、zshでのみサポートされています。
::: :::
@ -621,29 +619,29 @@ vicmd_symbol = "[V](bold green) "
## COBOL / GNUCOBOL ## COBOL / GNUCOBOL
`COBOL` モジュールは、現在インストールされているCOBOLのバージョンを表示します。 By default, the module will be shown if any of the following conditions are met: `COBOL` モジュールは、現在インストールされているCOBOLのバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
- The current directory contains any files ending in `.cob` or `.COB` - カレントディレクトリに、`.cob`または`.COB`の拡張子のファイルが含まれている
- The current directory contains any files ending in `.cbl` or `.CBL` - カレントディレクトリに、`.cbl`または`.CBL`の拡張子のファイルが含まれている
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ------------------- | ------------------------------------ | ------------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------------ |
| `symbol` | `"⚙️ "` | The symbol used before displaying the version of COBOL. | | `symbol` | `"⚙️ "` | COBOLのバージョンを表示する前に使用される記号です。 |
| `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 | | `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 |
| `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | | `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 |
| `style` | `"bold blue"` | モジュールのスタイルです。 | | `style` | `"bold blue"` | モジュールのスタイルです。 |
| `detect_extensions` | `["cbl", "cob", "CBL", "COB"]` | どの拡張子がこのモジュールをアクティブにするか | | `detect_extensions` | `["cbl", "cob", "CBL", "COB"]` | どの拡張子がこのモジュールをアクティブにするか |
| `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか | | `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか |
| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | | `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか |
| `disabled` | `false` | Disables the `cobol` module. | | `disabled` | `false` | `cobol`モジュールを無効にします。 |
### 変数 ### 変数
| 変数 | 設定例 | 説明 | | 変数 | 設定例 | 説明 |
| --------- | ---------- | ---------------------- | | --------- | ---------- | ---------------------- |
| version | `v3.1.2.0` | The version of `cobol` | | version | `v3.1.2.0` | `cobol`のバージョン |
| symbol | | オプション `記号` の値をミラーする | | symbol | | オプション `記号` の値をミラーする |
| style\* | | オプション `style` の値をミラーする | | style\* | | オプション `style` の値をミラーする |
@ -733,26 +731,26 @@ Note: これはconda自身の プロンプト修飾子 を抑制しません。`
format = "[$symbol$environment](dimmed green) " format = "[$symbol$environment](dimmed green) "
``` ```
## Container ## コンテナ
The `container` module displays a symbol and container name, if inside a container. `container`モジュールは、コンテナ内の場合、シンボルとコンテナ名を表示します。
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ---------- | -------------------------------------- | ----------------------------------------- | | ---------- | -------------------------------------- | ------------------------- |
| `symbol` | `"⬢"` | The symbol shown, when inside a container | | `symbol` | `"⬢"` | コンテナ内にいる場合、このシンボルが表示されます。 |
| `style` | `"bold red dimmed"` | モジュールのスタイルです。 | | `style` | `"bold red dimmed"` | モジュールのスタイルです。 |
| `format` | `"[$symbol \\[$name\\]]($style) "` | module のフォーマットです。 | | `format` | `"[$symbol \\[$name\\]]($style) "` | module のフォーマットです。 |
| `disabled` | `false` | Disables the `container` module. | | `disabled` | `false` | `container`モジュールを無効にします。 |
### 変数 ### 変数
| 変数 | 設定例 | 説明 | | 変数 | 設定例 | 説明 |
| --------- | ------------------- | ------------------------- | | --------- | ------------------- | ---------------------- |
| name | `fedora-toolbox:35` | The name of the container | | name | `fedora-toolbox:35` | コンテナ名 |
| symbol | | オプション `記号` の値をミラーする | | symbol | | オプション `記号` の値をミラーする |
| style\* | | オプション `style` の値をミラーする | | style\* | | オプション `style` の値をミラーする |
*: この変数は、スタイル文字列の一部としてのみ使用することができます。 *: この変数は、スタイル文字列の一部としてのみ使用することができます。
@ -848,7 +846,7 @@ format = "via [🔰 $version](bold red) "
`deno`モジュールは、現在インストールされている[Deno](https://deno.land/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 `deno`モジュールは、現在インストールされている[Deno](https://deno.land/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
- The current directory contains a `deno.json`, `deno.jsonc`, `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file - カレントディレクトリに`deno.json`、`deno.jsonc`、`mod.ts`、`mod.js`、`deps.ts`もしくは`deps.js`が含まれている
### オプション ### オプション
@ -890,20 +888,20 @@ fishスタイルのpwdオプションを使用すると、切り捨てられた
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ------------------- | ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| `truncation_length` | `3` | 現在のディレクトリを切り捨てる親フォルダーの数です。 | | `truncation_length` | `3` | 現在のディレクトリを切り捨てる親フォルダーの数です。 |
| `truncate_to_repo` | `true` | 現在いるgitリポジトリのルートに切り捨てるかどうかです。 | | `truncate_to_repo` | `true` | 現在いるgitリポジトリのルートに切り捨てるかどうかです。 |
| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | module のフォーマットです。 | | `format` | `"[$path]($style)[$read_only]($read_only_style) "` | module のフォーマットです。 |
| `style` | `"bold cyan"` | モジュールのスタイルです。 | | `style` | `"bold cyan"` | モジュールのスタイルです。 |
| `disabled` | `false` | `directory`モジュールを無効にします。 | | `disabled` | `false` | `directory`モジュールを無効にします。 |
| `read_only` | `"🔒"` | このシンボルが表示されている時、現在のディレクトリは読み取り専用です。 | | `read_only` | `"🔒"` | このシンボルが表示されている時、現在のディレクトリは読み取り専用です。 |
| `read_only_style` | `"red"` | 読み取り専用シンボルのスタイルです。 | | `read_only_style` | `"red"` | 読み取り専用シンボルのスタイルです。 |
| `truncation_symbol` | `""` | The symbol to prefix to truncated paths. 例: "…/" | | `truncation_symbol` | `""` | 切り捨てられたパスの接頭辞として付けるシンボルです。 例: "…/" |
| `repo_root_style` | `None` | The style for the root of the git repo. The default value is equivalent to `style`. | | `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. | | `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` | `"~"` | ホームディレクトリを示すシンボルです。 | | `home_symbol` | `"~"` | ホームディレクトリを示すシンボルです。 |
| `use_os_path_sep` | `true` | Use the OS specific path separator instead of always using `/` (e.g. `\` on Windows) | | `use_os_path_sep` | `true` | `/`を使用する代わりに、OS固有のパスの区切り文字を使用します。(例: Windowsの場合`\`) |
<details> <details>
<summary>このモジュールは、どのようにディレクトリを表示するかについての高度なオプションをいくつか持っています。</summary> <summary>このモジュールは、どのようにディレクトリを表示するかについての高度なオプションをいくつか持っています。</summary>
@ -1011,7 +1009,7 @@ format = "via [🐋 $context](blue bold)"
- `*.fsproj` - `*.fsproj`
- `*.xproj` - `*.xproj`
You'll also need the .NET Core SDK installed in order to use it correctly. 正しく使用するには、.NET Core SDKもインストールする必要があります。
内部的に、このモジュールは自身のバージョン検知のメカニズムを利用します。 `dotnet --version` を実行するより2倍速く実行できますが、.NET project一般的でないディレクトリlayoutの場合は間違ったバージョンが示されてしまうことがあります。 速度よりも精度が重要な場合は、次の方法でメカニズムを無効にできます。 モジュールオプションで`heuristic = false `を設定します。 内部的に、このモジュールは自身のバージョン検知のメカニズムを利用します。 `dotnet --version` を実行するより2倍速く実行できますが、.NET project一般的でないディレクトリlayoutの場合は間違ったバージョンが示されてしまうことがあります。 速度よりも精度が重要な場合は、次の方法でメカニズムを無効にできます。 モジュールオプションで`heuristic = false `を設定します。
@ -1033,12 +1031,12 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
### 変数 ### 変数
| 変数 | 設定例 | 説明 | | 変数 | 設定例 | 説明 |
| --------- | ---------------- | ------------------------------------------------------------------ | | --------- | ---------------- | ----------------------------------- |
| version | `v3.1.201` | `dotnet sdk` のバージョンです | | version | `v3.1.201` | `dotnet sdk` のバージョンです |
| tfm | `netstandard2.0` | The Target Framework Moniker that the current project is targeting | | tfm | `netstandard2.0` | 現在のプロジェクトが対象としているターゲット フレームワーク モニカー |
| symbol | | オプション `記号` の値をミラーする | | symbol | | オプション `記号` の値をミラーする |
| style\* | | オプション `style` の値をミラーする | | style\* | | オプション `style` の値をミラーする |
*: この変数は、スタイル文字列の一部としてのみ使用することができます。 *: この変数は、スタイル文字列の一部としてのみ使用することができます。
@ -1055,28 +1053,28 @@ heuristic = false
## Elixir ## Elixir
The `elixir` module shows the currently installed version of [Elixir](https://elixir-lang.org/) and [Erlang/OTP](https://erlang.org/doc/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 `elixir` モジュールは、現在インストールされている[Elixir](https://elixir-lang.org/)と[Erlang/OTP](https://erlang.org/doc/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
- カレントディレクトリに`mix.exs`ファイルが含まれている. - カレントディレクトリに`mix.exs`ファイルが含まれている.
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ------------------- | ----------------------------------------------------------- | --------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------- | ------------------------------------------------------ |
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. | | `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | module elixirのフォーマットです。 |
| `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | | `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 |
| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. | | `symbol` | `"💧 "` | Elixir/Erlangのバージョンを表示する前に使用される記号です。 |
| `detect_extensions` | `[]` | どの拡張子がこのモジュールをアクティブにするか | | `detect_extensions` | `[]` | どの拡張子がこのモジュールをアクティブにするか |
| `detect_files` | `["mix.exs"]` | どのファイル名がこのモジュールをアクティブにするか | | `detect_files` | `["mix.exs"]` | どのファイル名がこのモジュールをアクティブにするか |
| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | | `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか |
| `style` | `"bold purple"` | モジュールのスタイルです。 | | `style` | `"bold purple"` | モジュールのスタイルです。 |
| `disabled` | `false` | Disables the `elixir` module. | | `disabled` | `false` | `elixir`モジュールを無効にします。 |
### 変数 ### 変数
| 変数 | 設定例 | 説明 | | 変数 | 設定例 | 説明 |
| ----------- | ------- | --------------------------- | | ----------- | ------- | --------------------------- |
| version | `v1.10` | The version of `elixir` | | version | `v1.10` | `elixir`のバージョン |
| otp_version | | The otp version of `elixir` | | otp_version | | The otp version of `elixir` |
| symbol | | オプション `記号` の値をミラーする | | symbol | | オプション `記号` の値をミラーする |
| style\* | | オプション `style` の値をミラーする | | style\* | | オプション `style` の値をミラーする |
@ -1094,13 +1092,13 @@ symbol = "🔮 "
## Elm ## Elm
The `elm` module shows the currently installed version of [Elm](https://elm-lang.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 `elm`モジュールは、現在インストールされている[Elm](https://elm-lang.org/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
- カレントディレクトリに`elm.json`ファイルが含まれている - カレントディレクトリに`elm.json`ファイルが含まれている
- カレントディレクトリに`elm-package.json`ファイルが含まれている - カレントディレクトリに`elm-package.json`ファイルが含まれている
- カレントディレクトリに`.elm-version`ファイルが含まれている - カレントディレクトリに`.elm-version`ファイルが含まれている
- カレントディレクトリに`elm-stuff`フォルダが含まれている - カレントディレクトリに`elm-stuff`フォルダが含まれている
- The current directory contains `*.elm` files - カレントディレクトリに`*.elm`ファイルが含まれている
### オプション ### オプション
@ -1108,7 +1106,7 @@ The `elm` module shows the currently installed version of [Elm](https://elm-lang
| ------------------- | -------------------------------------------------- | ------------------------------------------------------ | | ------------------- | -------------------------------------------------- | ------------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 | | `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 |
| `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | | `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 |
| `symbol` | `"🌳 "` | A format string representing the symbol of Elm. | | `symbol` | `"🌳 "` | Elmのシンボルを表すフォーマット文字列 |
| `detect_extensions` | `["elm"]` | どの拡張子がこのモジュールをアクティブにするか | | `detect_extensions` | `["elm"]` | どの拡張子がこのモジュールをアクティブにするか |
| `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | どのファイル名がこのモジュールをアクティブにするか | | `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | どのファイル名がこのモジュールをアクティブにするか |
| `detect_folders` | `["elm-stuff"]` | どのフォルダーがこのモジュールをアクティブにするか | | `detect_folders` | `["elm-stuff"]` | どのフォルダーがこのモジュールをアクティブにするか |
@ -1119,7 +1117,7 @@ The `elm` module shows the currently installed version of [Elm](https://elm-lang
| 変数 | 設定例 | 説明 | | 変数 | 設定例 | 説明 |
| --------- | --------- | ---------------------- | | --------- | --------- | ---------------------- |
| version | `v0.19.1` | The version of `elm` | | version | `v0.19.1` | `elm`のバージョン |
| symbol | | オプション `記号` の値をミラーする | | symbol | | オプション `記号` の値をミラーする |
| style\* | | オプション `style` の値をミラーする | | style\* | | オプション `style` の値をミラーする |
@ -1136,12 +1134,14 @@ format = "via [ $version](cyan bold) "
## 環境変数 ## 環境変数
The `env_var` module displays the current value of a selected environment variables. 次の条件のいずれかが満たされると、モジュールが表示されます。 `env_var`モジュールは、選択された環境変数の現在の値を表示します。 次の条件のいずれかが満たされると、モジュールが表示されます。
- `variable`オプションが、既存の環境変数と一致する - `variable`オプションが、既存の環境変数と一致する
- `variable`オプションが定義されておらず、`default`オプションが定義されている - `variable`オプションが定義されておらず、`default`オプションが定義されている
::: tip Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. ::: tip
Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character.
Example: following configuration will display value of USER environment variable Example: following configuration will display value of USER environment variable
@ -1166,11 +1166,11 @@ default = "unknown user"
### 変数 ### 変数
| 変数 | 設定例 | 説明 | | 変数 | 設定例 | 説明 |
| --------- | ------------------------------------------- | ------------------------------------------ | | --------- | ------------------------------------------- | ---------------------- |
| env_value | `Windows NT` (if _variable_ would be `$OS`) | The environment value of option `variable` | | env_value | `Windows NT` (if _variable_ would be `$OS`) | オプション`variable`の値 |
| symbol | | オプション `記号` の値をミラーする | | symbol | | オプション `記号` の値をミラーする |
| style\* | `black bold dimmed` | オプション `style` の値をミラーする | | style\* | `black bold dimmed` | オプション `style` の値をミラーする |
*: この変数は、スタイル文字列の一部としてのみ使用することができます。 *: この変数は、スタイル文字列の一部としてのみ使用することができます。
@ -1198,23 +1198,23 @@ default = "unknown user"
## Erlang ## Erlang
The `erlang` module shows the currently installed version of [Erlang/OTP](https://erlang.org/doc/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 `erlang`モジュールは、現在インストールされている[Erlang/OTP](https://erlang.org/doc/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
- カレントディレクトリに`rebar.config`ファイルが含まれている. - カレントディレクトリに`rebar.config`ファイルが含まれている.
- カレントディレクトリに`erlang.mk`ファイルが含まれている. - カレントディレクトリに`erlang.mk`ファイルが含まれている.
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ------------------- | ------------------------------------ | -------------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 | | `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 |
| `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | | `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 |
| `symbol` | `" "` | The symbol used before displaying the version of erlang. | | `symbol` | `" "` | Erlangのバージョンを表示する前に使用される記号です。 |
| `style` | `"bold red"` | モジュールのスタイルです。 | | `style` | `"bold red"` | モジュールのスタイルです。 |
| `detect_extensions` | `[]` | どの拡張子がこのモジュールをアクティブにするか | | `detect_extensions` | `[]` | どの拡張子がこのモジュールをアクティブにするか |
| `detect_files` | `["rebar.config", "elang.mk"]` | どのファイル名がこのモジュールをアクティブにするか | | `detect_files` | `["rebar.config", "elang.mk"]` | どのファイル名がこのモジュールをアクティブにするか |
| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | | `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか |
| `disabled` | `false` | `erlang`モジュールを無効にします。 | | `disabled` | `false` | `erlang`モジュールを無効にします。 |
### 変数 ### 変数
@ -1245,7 +1245,7 @@ format = "via [e $version](bold red) "
| ---------- | -------------- | --------------------------------- | | ---------- | -------------- | --------------------------------- |
| `symbol` | `"."` | The symbol used to fill the line. | | `symbol` | `"."` | The symbol used to fill the line. |
| `style` | `"bold black"` | モジュールのスタイルです。 | | `style` | `"bold black"` | モジュールのスタイルです。 |
| `disabled` | `false` | Disables the `fill` module | | `disabled` | `false` | `fill`モジュールを無効にします。 |
### 設定例 ### 設定例
@ -1270,14 +1270,14 @@ AA -------------------------------------------- BB -----------------------------
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ----------------- | ---------------------------------------------------------- | ---------------------------------------------------------------- | | ----------------- | ---------------------------------------------------------- | ----------------------------- |
| `format` | `'on [$symbol$account(@$domain)(\($region\))]($style) '` | module のフォーマットです。 | | `format` | `'on [$symbol$account(@$domain)(\($region\))]($style) '` | module のフォーマットです。 |
| `symbol` | `"☁️ "` | 現在のGCPプロファイルを表示する前に表示される記号です。 | | `symbol` | `"☁️ "` | 現在のGCPプロファイルを表示する前に表示される記号です。 |
| `region_aliases` | | GCP名に加えて表示するリージョンのエイリアスです。 | | `region_aliases` | | GCP名に加えて表示するリージョンのエイリアスです。 |
| `project_aliases` | | Table of project aliases to display in addition to the GCP name. | | `project_aliases` | | GCP名に加えて表示するプロジェクトのエイリアスです。 |
| `style` | `"bold blue"` | モジュールのスタイルです。 | | `style` | `"bold blue"` | モジュールのスタイルです。 |
| `disabled` | `false` | `gcloud`モジュールを無効にします。 | | `disabled` | `false` | `gcloud`モジュールを無効にします。 |
### 変数 ### 変数
@ -1343,27 +1343,27 @@ 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. | | `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. |
| `format` | `"on [$symbol$branch]($style) "` | module のフォーマットです。 Use `"$branch"` to refer to the current branch name. | | `format` | `"on [$symbol$branch(:$remote_branch)]($style) "` | module のフォーマットです。 現在のブランチ名を参照するには、`"$branch"`を使用します。 |
| `symbol` | `" "` | A format string representing the symbol of git branch. | | `symbol` | `" "` | gitブランチのシンボルを表すフォーマット文字列。 |
| `style` | `"bold purple"` | モジュールのスタイルです。 | | `style` | `"bold purple"` | モジュールのスタイルです。 |
| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | | `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. |
| `truncation_symbol` | `"…"` | ブランチ名切り捨てられていることを示すための記号です。 You can use `""` for no symbol. | | `truncation_symbol` | `"…"` | ブランチ名切り捨てられていることを示すための記号です。 You can use `""` for no symbol. |
| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | | `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". | | `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for "master" or "main". |
| `disabled` | `false` | `git_branch`モジュールを無効にします。 | | `disabled` | `false` | `git_branch`モジュールを無効にします。 |
### 変数 ### 変数
| 変数 | 設定例 | 説明 | | 変数 | 設定例 | 説明 |
| ------------- | -------- | ------------------------------------------------------------------------------------------------------ | | ------------- | -------- | ---------------------------------------------------------- |
| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached `HEAD`). | | branch | `master` | 現在のブランチがない場合は、現在のブランチ名は`HEAD`に戻ります(例: git detached `HEAD`) |
| remote_name | `origin` | The remote name. | | remote_name | `origin` | リモート名 |
| remote_branch | `master` | The name of the branch tracked on `remote_name`. | | remote_branch | `master` | `remote_name`で追跡されたブランチ名 |
| symbol | | オプション `記号` の値をミラーする | | symbol | | オプション `記号` の値をミラーする |
| style\* | | オプション `style` の値をミラーする | | style\* | | オプション `style` の値をミラーする |
*: この変数は、スタイル文字列の一部としてのみ使用することができます。 *: この変数は、スタイル文字列の一部としてのみ使用することができます。
@ -1420,27 +1420,27 @@ tag_symbol = "🔖 "
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| -------------- | --------------------------------------------------------------- | --------------------------------------------------------------------------------------- | | -------------- | --------------------------------------------------------------- | -------------------------------------------------------- |
| `rebase` | `"REBASING"` | A format string displayed when a `rebase` is in progress. | | `rebase` | `"REBASING"` | `rebase`進行中に表示されるフォーマット文字列です。 |
| `merge` | `"MERGING"` | A format string displayed when a `merge` is in progress. | | `merge` | `"MERGING"` | `merge`進行中に表示されるフォーマット文字列です。 |
| `revert` | `"REVERTING"` | A format string displayed when a `revert` is in progress. | | `revert` | `"REVERTING"` | `revert`進行中に表示されるフォーマット文字列です。 |
| `cherry_pick` | `"CHERRY-PICKING"` | A format string displayed when a `cherry-pick` is in progress. | | `cherry_pick` | `"CHERRY-PICKING"` | `cherry-pick`進行中に表示されるフォーマット文字列です。 |
| `bisect` | `"BISECTING"` | A format string displayed when a `bisect` is in progress. | | `bisect` | `"BISECTING"` | `bisect`進行中に表示されるフォーマット文字列です。 |
| `am` | `"AM"` | A format string displayed when an `apply-mailbox` (`git am`) is in progress. | | `am` | `"AM"` | `apply-mailbox` (`git am`) 進行中に表示されるフォーマット文字列です。 |
| `am_or_rebase` | `"AM/REBASE"` | A format string displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. | | `am_or_rebase` | `"AM/REBASE"` | あいまいな`apply-mailbox`または`rebase`が進行中のときに表示されるフォーマット文字列です。 |
| `style` | `"bold yellow"` | モジュールのスタイルです。 | | `style` | `"bold yellow"` | モジュールのスタイルです。 |
| `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | module のフォーマットです。 | | `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | module のフォーマットです。 |
| `disabled` | `false` | `git_state`モジュールを無効にします。 | | `disabled` | `false` | `git_state`モジュールを無効にします。 |
### 変数 ### 変数
| 変数 | 設定例 | 説明 | | 変数 | 設定例 | 説明 |
| ---------------- | ---------- | ------------------------------ | | ---------------- | ---------- | ---------------------- |
| state | `REBASING` | The current state of the repo | | state | `REBASING` | 現在のリポジトリの状態 |
| progress_current | `1` | The current operation progress | | progress_current | `1` | 現在の進行状態 |
| progress_total | `2` | The total operation progress | | progress_total | `2` | 全体の進行状態 |
| style\* | | オプション `style` の値をミラーする | | style\* | | オプション `style` の値をミラーする |
*: この変数は、スタイル文字列の一部としてのみ使用することができます。 *: この変数は、スタイル文字列の一部としてのみ使用することができます。
@ -1501,30 +1501,30 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) '
::: tip ::: tip
The Git Status module is very slow in Windows directories (for example under `/mnt/c/`) when in a WSL environment. You can disable the module or use the `windows_starship` option to use a Windows-native Starship executable to compute `git_status` for those paths. WSL環境のWindowsディレクトリ(例: `/mnt/c/`以下) では、Git Statusモジュールは動作が非常に遅いです。 モジュールを無効にするか、`windows_starship`オプションを使用することで、WindowsネイティブのStarshipを使用し、対象の`git_status`を計算できます。
::: :::
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------- | ---------------------------------------------------------------------- |
| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | `git_status` のデフォルトフォーマット | | `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | `git_status` のデフォルトフォーマット |
| `conflicted` | `"="` | このブランチにはマージの競合があります。 | | `conflicted` | `"="` | このブランチにはマージの競合があります。 |
| `ahead` | `"⇡"` | `ahead`のフォーマット | | `ahead` | `"⇡"` | `ahead`のフォーマット |
| `behind` | `"⇣"` | `behind`のフォーマット | | `behind` | `"⇣"` | `behind`のフォーマット |
| `diverged` | `"⇕"` | `diverged`のフォーマット | | `diverged` | `"⇕"` | `diverged`のフォーマット |
| `up_to_date` | `""` | The format of `up_to_date` | | `up_to_date` | `""` | `up_to_date`のフォーマット |
| `untracked` | `"?"` | The format of `untracked` | | `untracked` | `"?"` | `untracked`のフォーマット |
| `stashed` | `"$"` | The format of `stashed` | | `stashed` | `"$"` | `stashed`のフォーマット |
| `modified` | `"!"` | The format of `modified` | | `modified` | `"!"` | `modified`のフォーマット |
| `staged` | `"+"` | The format of `staged` | | `staged` | `"+"` | `staged`のフォーマット |
| `renamed` | `"»"` | The format of `renamed` | | `renamed` | `"»"` | `renamed`のフォーマット |
| `deleted` | `"✘"` | The format of `deleted` | | `deleted` | `"✘"` | `deleted`のフォーマット |
| `style` | `"bold red"` | モジュールのスタイルです。 | | `style` | `"bold red"` | モジュールのスタイルです。 |
| `ignore_submodules` | `false` | Ignore changes to submodules. | | `ignore_submodules` | `false` | サブモジュールの変更を無視します。 |
| `disabled` | `false` | `git_status`モジュールを無効にします。 | | `disabled` | `false` | `git_status`モジュールを無効にします。 |
| `windows_starship` | | Use this (Linux) path to a Windows Starship executable to render `git_status` when on Windows paths in WSL. | | `windows_starship` | | WSLでWindowsディレクトリの`git_status`で使用するWindows Starshipの実行ファイルのLinux上でのパス。 |
### 変数 ### 変数
@ -1603,6 +1603,7 @@ The `golang` module shows the currently installed version of [Go](https://golang
- カレントディレクトリに`go.mod`ファイルが含まれている - カレントディレクトリに`go.mod`ファイルが含まれている
- カレントディレクトリに`go.sum`ファイルが含まれている - カレントディレクトリに`go.sum`ファイルが含まれている
- カレントディレクトリに`go.work`ファイルが含まれている
- カレントディレクトリに`glide.yaml`ファイルが含まれている - カレントディレクトリに`glide.yaml`ファイルが含まれている
- カレントディレクトリに`Gopkg.yml`ファイルが含まれている - カレントディレクトリに`Gopkg.yml`ファイルが含まれている
- カレントディレクトリに`Gopkg.lock`ファイルが含まれている - カレントディレクトリに`Gopkg.lock`ファイルが含まれている
@ -1612,16 +1613,16 @@ The `golang` module shows the currently installed version of [Go](https://golang
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------ | | ------------------- | ----------------------------------------------------------------------------------------- | ------------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 | | `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 |
| `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | | `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 |
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. | | `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
| `detect_extensions` | `["go"]` | どの拡張子がこのモジュールをアクティブにするか | | `detect_extensions` | `["go"]` | どの拡張子がこのモジュールをアクティブにするか |
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | どのファイル名がこのモジュールをアクティブにするか | | `detect_files` | `["go.mod", "go.sum", "go.work", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | どのファイル名がこのモジュールをアクティブにするか |
| `detect_folders` | `["Godeps"]` | どのフォルダーがこのモジュールをアクティブにするか | | `detect_folders` | `["Godeps"]` | どのフォルダーがこのモジュールをアクティブにするか |
| `style` | `"bold cyan"` | モジュールのスタイルです。 | | `style` | `"bold cyan"` | モジュールのスタイルです。 |
| `disabled` | `false` | `golang`モジュールを無効にします。 | | `disabled` | `false` | `golang`モジュールを無効にします。 |
### 変数 ### 変数
@ -1720,20 +1721,22 @@ format = "via [⎈ $version](bold white) "
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ---------- | --------------------------- | --------------------------------------------------------------------------- | | ------------ | -------------------------------------- | --------------------------------------------------------------------------- |
| `ssh_only` | `true` | SSHセッションに接続されている場合にのみホスト名を表示します。 | | `ssh_only` | `true` | SSHセッションに接続されている場合にのみホスト名を表示します。 |
| `trim_at` | `"."` | この文字が最初にマッチするまでをホスト名と認識します。 `"."`は最初の. までをホスト名として認識します。 `""`を指定した場合トリムしません。 | | `ssh_symbol` | `"🌐 "` | A format string representing the symbol when connected to SSH session. |
| `format` | `"[$hostname]($style) in "` | module のフォーマットです。 | | `trim_at` | `"."` | この文字が最初にマッチするまでをホスト名と認識します。 `"."`は最初の. までをホスト名として認識します。 `""`を指定した場合トリムしません。 |
| `style` | `"bold dimmed green"` | モジュールのスタイルです。 | | `format` | `"[$ssh_symbol$hostname]($style) in "` | module のフォーマットです。 |
| `disabled` | `false` | `hostname`モジュールを無効にします。 | | `style` | `"bold dimmed green"` | モジュールのスタイルです。 |
| `disabled` | `false` | `hostname`モジュールを無効にします。 |
### 変数 ### 変数
| 変数 | 設定例 | 説明 | | 変数 | 設定例 | 説明 |
| --------- | ---------- | ---------------------------- | | ---------- | ---------- | ----------------------------------------------------- |
| ホスト名 | `computer` | The hostname of the computer | | ホスト名 | `computer` | The hostname of the computer |
| style\* | | オプション `style` の値をミラーする | | style\* | | オプション `style` の値をミラーする |
| ssh_symbol | `"🌏 "` | The symbol to represent when connected to SSH session |
*: この変数は、スタイル文字列の一部としてのみ使用することができます。 *: この変数は、スタイル文字列の一部としてのみ使用することができます。
@ -1744,7 +1747,7 @@ format = "via [⎈ $version](bold white) "
[hostname] [hostname]
ssh_only = false ssh_only = false
format = "on [$hostname](bold red) " format = "[$ssh_symbol](bold blue) on [$hostname](bold red) "
trim_at = ".companyname.com" trim_at = ".companyname.com"
disabled = false disabled = false
``` ```
@ -2019,25 +2022,25 @@ Long and automatically generated cluster names can be identified and shortened u
disabled = true disabled = true
``` ```
## Local IP ## ローカルIP
The `localip` module shows the IPv4 address of the primary network interface. `localip`モジュールは、プライマリネットワークインターフェイスのIPv4アドレスを表示します。
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ---------- | ------------------------- | ------------------------------------------------------ | | ---------- | ------------------------- | ----------------------------------- |
| `ssh_only` | `true` | Only show IP address when connected to an SSH session. | | `ssh_only` | `true` | SSHセッションに接続されている場合にのみ、IPアドレスを表示します。 |
| `format` | `"[$localipv4]($style) "` | module のフォーマットです。 | | `format` | `"[$localipv4]($style) "` | module のフォーマットです。 |
| `style` | `"bold yellow"` | モジュールのスタイルです。 | | `style` | `"bold yellow"` | モジュールのスタイルです。 |
| `disabled` | `true` | Disables the `localip` module. | | `disabled` | `true` | `localip`モジュールを無効にします。 |
### 変数 ### 変数
| 変数 | 設定例 | 説明 | | 変数 | 設定例 | 説明 |
| --------- | ------------ | --------------------------------- | | --------- | ------------ | ---------------------- |
| localipv4 | 192.168.1.13 | Contains the primary IPv4 address | | localipv4 | 192.168.1.13 | プライマリIPv4アドレスが含まれています |
| style\* | | オプション `style` の値をミラーする | | style\* | | オプション `style` の値をミラーする |
*: この変数は、スタイル文字列の一部としてのみ使用することができます。 *: この変数は、スタイル文字列の一部としてのみ使用することができます。
@ -2054,25 +2057,25 @@ disabled = false
## Lua ## Lua
The `lua` module shows the currently installed version of [Lua](http://www.lua.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 `lua`モジュールは、現在インストールされている[Lua](http://www.lua.org/) のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。
- The current directory contains a `.lua-version` file - カレントディレクトリに`.lua-version`ファイルが含まれている
- The current directory contains a `lua` directory - カレントディレクトリに`lua`ディレクトリが含まれている
- The current directory contains a file with the `.lua` extension - カレントディレクトリに`.lua`の拡張子のファイルが含まれている
### オプション ### オプション
| オプション | デフォルト | 説明 | | オプション | デフォルト | 説明 |
| ------------------- | ------------------------------------ | -------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 | | `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 |
| `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | | `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 |
| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. | | `symbol` | `"🌙 "` | Luaのシンボルを表すフォーマット文字列 |
| `detect_extensions` | `["lua"]` | どの拡張子がこのモジュールをアクティブにするか | | `detect_extensions` | `["lua"]` | どの拡張子がこのモジュールをアクティブにするか |
| `detect_files` | `[".lua-version"]` | どのファイル名がこのモジュールをアクティブにするか | | `detect_files` | `[".lua-version"]` | どのファイル名がこのモジュールをアクティブにするか |
| `detect_folders` | `["lua"]` | どのフォルダーがこのモジュールをアクティブにするか | | `detect_folders` | `["lua"]` | どのフォルダーがこのモジュールをアクティブにするか |
| `style` | `"bold blue"` | モジュールのスタイルです。 | | `style` | `"bold blue"` | モジュールのスタイルです。 |
| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. | | `lua_binary` | `"lua"` | Starshipがバージョンを取得するときに実行するLuaバイナリを設定します。 |
| `disabled` | `false` | Disables the `lua` module. | | `disabled` | `false` | `lua`モジュールを無効にします。 |
### 変数 ### 変数
@ -2384,22 +2387,22 @@ symbol = "☁️ "
## パッケージのバージョン ## パッケージのバージョン
`package`モジュールは、現在のディレクトリがパッケージのリポジトリである場合に表示され、現在のバージョンが表示されます。 The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `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` 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 - [**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 - [**Cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
- [**Nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command - [**Nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command
- [**Poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory - [**Poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
- [**Python**](https://www.python.org) - The `python` package version is extracted from the `setup.cfg` present in the current directory - [**Python**](https://www.python.org) - The `python` package version is extracted from a [PEP 621](https://peps.python.org/pep-0621/) compliant `pyproject.toml` or a `setup.cfg` present in the current directory
- [**Composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory - [**Composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory
- [**Gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present - [**Gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present in the current directory
- [**Julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present - [**Julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present in the current directory
- [**Mix**](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present - [**Mix**](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present in the current directory
- [**Helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present - [**Helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present in the current directory
- [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present - [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory
- [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present - [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present - [**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 - [**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 - [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory
- [**Dart**](https://pub.dev/) - The `dart` package version is extracted from the `pubspec.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
@ -2546,7 +2549,7 @@ By default the Pulumi version is not shown, since it takes an order of magnitude
| --------- | ---------- | --------------------------- | | --------- | ---------- | --------------------------- |
| version | `v0.12.24` | The version of `pulumi` | | version | `v0.12.24` | The version of `pulumi` |
| stack | `dev` | The current Pulumi stack | | stack | `dev` | The current Pulumi stack |
| ユーザ名 | `alice` | The current Pulumi username | | username | `alice` | The current Pulumi username |
| symbol | | オプション `記号` の値をミラーする | | symbol | | オプション `記号` の値をミラーする |
| style\* | | オプション `style` の値をミラーする | | style\* | | オプション `style` の値をミラーする |
@ -2846,11 +2849,13 @@ symbol = "🔺 "
### 変数 ### 変数
| 変数 | 設定例 | 説明 | | 変数 | 設定例 | 説明 |
| --------- | ----------------- | ---------------------- | | --------- | ----------------- | -------------------------------------------- |
| version | `v1.43.0-nightly` | `rustc`のバージョン | | version | `v1.43.0-nightly` | `rustc`のバージョン |
| symbol | | オプション `記号` の値をミラーする | | numver | `1.51.0` | The numeric component of the `rustc` version |
| style\* | | オプション `style` の値をミラーする | | toolchain | `beta` | The toolchain version |
| symbol | | オプション `記号` の値をミラーする |
| style\* | | オプション `style` の値をミラーする |
*: この変数は、スタイル文字列の一部としてのみ使用することができます。 *: この変数は、スタイル文字列の一部としてのみ使用することができます。

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

@ -171,7 +171,7 @@
- [Nerd Font](https://www.nerdfonts.com/)がインストールされ、端末にて有効になっている（例えば、[Fira Code Nerd Font](https://www.nerdfonts.com/font-downloads)を試してみてください）。 - [Nerd Font](https://www.nerdfonts.com/)がインストールされ、端末にて有効になっている（例えば、[Fira Code Nerd Font](https://www.nerdfonts.com/font-downloads)を試してみてください）。
### Step 1. Install Starship ### Step 1. Starshipをインストール
以下のリストからお使いのOSを選択し、インストール方法をご確認ください。 以下のリストからお使いのOSを選択し、インストール方法をご確認ください。
@ -180,7 +180,7 @@
以下のいずれかのパッケージマネージャーを使用して、Starshipをインストールします。 以下のいずれかのパッケージマネージャーを使用して、Starshipをインストールします。
| Repository | Instructions | | リポジトリ | 手順 |
| --------------------------------------------------------------------------------- | ---------------------- | | --------------------------------------------------------------------------------- | ---------------------- |
| [Termux](https://github.com/termux/termux-packages/tree/master/packages/starship) | `pkg install starship` | | [Termux](https://github.com/termux/termux-packages/tree/master/packages/starship) | `pkg install starship` |
@ -191,11 +191,11 @@
以下のいずれかのパッケージマネージャーを使用して、Starshipをインストールします。 以下のいずれかのパッケージマネージャーを使用して、Starshipをインストールします。
| Distribution | Repository | Instructions | | ディストリビューション | リポジトリ | 手順 |
| ------------ | -------------------------------------------------------- | --------------------------------- | | ----------- | -------------------------------------------------------- | --------------------------------- |
| **_Any_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | | **_Any_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
| FreeBSD | [FreshPorts](https://www.freshports.org/shells/starship) | `pkg install starship` | | FreeBSD | [FreshPorts](https://www.freshports.org/shells/starship) | `pkg install starship` |
| NetBSD | [pkgsrc](https://pkgsrc.se/shells/starship) | `pkgin install starship` | | NetBSD | [pkgsrc](https://pkgsrc.se/shells/starship) | `pkgin install starship` |
</details> </details>
@ -210,7 +210,7 @@ curl -sS https://starship.rs/install.sh | sh
または、以下のパッケージマネージャを使用して、Starshipをインストールします。 または、以下のパッケージマネージャを使用して、Starshipをインストールします。
| Distribution | Repository | Instructions | | ディストリビューション | リポジトリ | 手順 |
| ------------------ | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | | ------------------ | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
| **_Any_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | | **_Any_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
| _Any_ | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` | | _Any_ | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
@ -239,7 +239,7 @@ curl -sS https://starship.rs/install.sh | sh
または、以下のパッケージマネージャを使用して、Starshipをインストールします。 または、以下のパッケージマネージャを使用して、Starshipをインストールします。
| Repository | Instructions | | リポジトリ | 手順 |
| -------------------------------------------------------- | --------------------------------------- | | -------------------------------------------------------- | --------------------------------------- |
| **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
| [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` | | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` |
@ -253,7 +253,7 @@ curl -sS https://starship.rs/install.sh | sh
以下のいずれかのパッケージマネージャーを使用して、Starshipをインストールします。 以下のいずれかのパッケージマネージャーを使用して、Starshipをインストールします。
| Repository | Instructions | | リポジトリ | 手順 |
| -------------------------------------------------------------------------------- | --------------------------------------- | | -------------------------------------------------------------------------------- | --------------------------------------- |
| **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` |
| [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` | | [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` |
@ -262,7 +262,7 @@ curl -sS https://starship.rs/install.sh | sh
</details> </details>
### Step 2. Setup your shell to use Starship ### Step 2. Starshipをシェルにセットアップ
Starshipを初期化するためのシェルの設定。 以下のリストからお使いのシェルを選択してください。 Starshipを初期化するためのシェルの設定。 以下のリストからお使いのシェルを選択してください。
@ -297,7 +297,7 @@ load(io.popen('starship init cmd'):read("*a"))()
eval (starship init elvish) eval (starship init elvish)
``` ```
Note: Only Elvish v0.18+ is supported 注意: Elvish v0.18以降でサポートされています
</details> </details>
@ -326,7 +326,7 @@ eval $(starship init ion)
<details> <details>
<summary>Nushell</summary> <summary>Nushell</summary>
Run the following: そして、Nushellの設定ファイルの最後に以下を追加してください（ `$nu.config-path` を実行してください）:
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
@ -336,18 +336,17 @@ starship init nu | save ~/.cache/starship/init.nu
そして、Nushellの設定ファイルの最後に以下を追加してください（ `$nu.config-path` を実行してください）。 そして、Nushellの設定ファイルの最後に以下を追加してください（ `$nu.config-path` を実行してください）。
```sh ```sh
starship init nu | save ~/.cache/starship/init.nu
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```
Note: Only Nushell v0.60+ is supported 注意: Elvish v0.61以降でサポートされています
</details> </details>
<details> <details>
<summary>PowerShell</summary> <summary>PowerShell</summary>
Add the following to the end of your PowerShell configuration (find it by running `$PROFILE`): そして、Nushellの設定ファイルの最後に以下を追加してください（ `$PROFILE.config-path` を実行してください）:
```powershell ```powershell
Invoke-Expression (&starship init powershell) Invoke-Expression (&starship init powershell)
@ -388,15 +387,15 @@ eval "$(starship init zsh)"
</details> </details>
### Step 3. Configure Starship ### Step 3. Starshipの設定
新しいシェルインスタンスを起動すると、美しくて新しいシェルプロンプトが表示されるはずです。 デフォルトで問題なければ、お楽しみください！ 新しいシェルインスタンスを起動すると、美しくて新しいシェルプロンプトが表示されるはずです。 デフォルトで問題なければ、お楽しみください！
Starshipのさらなるカスタマイズを目指すなら以下を参考にしてみてください。 Starshipのさらなるカスタマイズを目指すなら以下を参考にしてみてください。
- **[Configuration](https://starship.rs/config/)** – learn how to configure Starship to tweak your prompt to your liking - **[設定](https://starship.rs/config/)** - あなたの好みに応じてプロンプトを調整するためにStarshipを設定する方法を学ぶ
- **[Presets](https://starship.rs/presets/)** – get inspired by the pre-built configuration of others - **[プリセット](https://starship.rs/presets/)** - コミュニティのために用意されたコンフィグから刺激を受ける
## 🤝 貢献 ## 🤝 貢献
@ -410,11 +409,11 @@ Starshipのさらなるカスタマイズを目指すなら以下を参考にし
よければStarship の作成に影響を与えた、これまでのプロジェクトをチェックしてください 🙏 よければ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)** – JavaScript で書かれた Cross-shell 対応の robbyrussell テーマ。
- **[reujab/silver](https://github.com/reujab/silver)** – A cross-shell customizable powerline-like prompt with icons. - **[reujab/silver](https://github.com/reujab/silver)** – アイコンと cross-shell 対応のカスタマイズ可能な powerline ライクなプロンプト。
<p align="center"> <p align="center">
<br> <br>

16
docs/ko-KR/README.md
View File

@ -120,7 +120,11 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
#### Elvish #### Elvish
::: warning elvish v0.18 이상만 지원. ::: ::: warning
Only elvish v0.18 or higher is supported.
:::
`~/.elvish/rc.elv` 의 끝부분에 아래 라인을 추가: `~/.elvish/rc.elv` 의 끝부분에 아래 라인을 추가:
@ -144,7 +148,13 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
#### Nushell #### Nushell
::: 주의 이는 추후 변경될 예정입니다. Only Nushell v0.60+ is supported. ::: Run the following: ::: warning
This will change in the future. Only Nushell v0.61+ is supported.
:::
Add the following to to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu starship init nu | save ~/.cache/starship/init.nu
@ -153,8 +163,6 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`): And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):
```sh ```sh
mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```

125
docs/ko-KR/config/README.md
View File

@ -280,16 +280,16 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | | ------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | The format for the module. | | `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)'` | The format for the module. |
| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. | | `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
| `region_aliases` | | Table of region aliases to display in addition to the AWS name. | | `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | | `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. |
| `style` | `"bold yellow"` | The style for the module. | | `style` | `"bold yellow"` | The style for the module. |
| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. | | `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. |
| `disabled` | `false` | Disables the `AWS` module. | | `disabled` | `false` | Disables the `AWS` module. |
| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. | | `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. |
### Variables ### Variables
@ -1140,7 +1140,9 @@ The `env_var` module displays the current value of a selected environment variab
- The `variable` configuration option matches an existing environment variable - The `variable` configuration option matches an existing environment variable
- The `variable` configuration option is not defined, but the `default` configuration option is - The `variable` configuration option is not defined, but the `default` configuration option is
::: tip Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. ::: tip
Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character.
Example: following configuration will display value of USER environment variable Example: following configuration will display value of USER environment variable
@ -1342,17 +1344,17 @@ The `git_branch` module shows the active branch of the repo in your current dire
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| -------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | | -------------------- | ------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | | `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. |
| `format` | `"on [$symbol$branch]($style) "` | The format for the module. Use `"$branch"` to refer to the current branch name. | | `format` | `"on [$symbol$branch(:$remote_branch)]($style) "` | The format for the module. Use `"$branch"` to refer to the current branch name. |
| `symbol` | `" "` | A format string representing the symbol of git branch. | | `symbol` | `" "` | A format string representing the symbol of git branch. |
| `style` | `"bold purple"` | The style for the module. | | `style` | `"bold purple"` | The style for the module. |
| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | | `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. |
| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. | | `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. |
| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | | `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". | | `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for "master" or "main". |
| `disabled` | `false` | Disables the `git_branch` module. | | `disabled` | `false` | Disables the `git_branch` module. |
### Variables ### Variables
@ -1602,6 +1604,7 @@ The `golang` module shows the currently installed version of [Go](https://golang
- The current directory contains a `go.mod` file - The current directory contains a `go.mod` file
- The current directory contains a `go.sum` file - The current directory contains a `go.sum` file
- The current directory contains a `go.work` file
- The current directory contains a `glide.yaml` file - The current directory contains a `glide.yaml` file
- The current directory contains a `Gopkg.yml` file - The current directory contains a `Gopkg.yml` file
- The current directory contains a `Gopkg.lock` file - The current directory contains a `Gopkg.lock` file
@ -1611,16 +1614,16 @@ The `golang` module shows the currently installed version of [Go](https://golang
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. | | `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
| `detect_extensions` | `["go"]` | Which extensions should trigger this module. | | `detect_extensions` | `["go"]` | Which extensions should trigger this module. |
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. | | `detect_files` | `["go.mod", "go.sum", "go.work", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `["Godeps"]` | Which folders should trigger this module. | | `detect_folders` | `["Godeps"]` | Which folders should trigger this module. |
| `style` | `"bold cyan"` | The style for the module. | | `style` | `"bold cyan"` | The style for the module. |
| `disabled` | `false` | Disables the `golang` module. | | `disabled` | `false` | Disables the `golang` module. |
### Variables ### Variables
@ -1719,20 +1722,22 @@ The `hostname` module shows the system hostname.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | | ------------ | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `ssh_only` | `true` | Only show hostname when connected to an SSH session. | | `ssh_only` | `true` | Only show hostname when connected to an SSH session. |
| `trim_at` | `"."` | String that the hostname is cut off at, after the first match. `"."` will stop after the first dot. `""` will disable any truncation | | `ssh_symbol` | `"🌐 "` | A format string representing the symbol when connected to SSH session. |
| `format` | `"[$hostname]($style) in "` | The format for the module. | | `trim_at` | `"."` | String that the hostname is cut off at, after the first match. `"."` will stop after the first dot. `""` will disable any truncation |
| `style` | `"bold dimmed green"` | The style for the module. | | `format` | `"[$ssh_symbol$hostname]($style) in "` | The format for the module. |
| `disabled` | `false` | Disables the `hostname` module. | | `style` | `"bold dimmed green"` | The style for the module. |
| `disabled` | `false` | Disables the `hostname` module. |
### Variables ### Variables
| Variable | Example | Description | | Variable | Example | Description |
| --------- | ---------- | ----------------------------------- | | ---------- | ---------- | ----------------------------------------------------- |
| hostname | `computer` | The hostname of the computer | | hostname | `computer` | The hostname of the computer |
| style\* | | Mirrors the value of option `style` | | style\* | | Mirrors the value of option `style` |
| ssh_symbol | `"🌏 "` | The symbol to represent when connected to SSH session |
*: This variable can only be used as a part of a style string *: This variable can only be used as a part of a style string
@ -1743,7 +1748,7 @@ The `hostname` module shows the system hostname.
[hostname] [hostname]
ssh_only = false ssh_only = false
format = "on [$hostname](bold red) " format = "[$ssh_symbol](bold blue) on [$hostname](bold red) "
trim_at = ".companyname.com" trim_at = ".companyname.com"
disabled = false disabled = false
``` ```
@ -2383,22 +2388,22 @@ symbol = "☁️ "
## Package Version ## Package Version
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `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` 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 - [**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 - [**Cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
- [**Nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command - [**Nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command
- [**Poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory - [**Poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
- [**Python**](https://www.python.org) - The `python` package version is extracted from the `setup.cfg` present in the current directory - [**Python**](https://www.python.org) - The `python` package version is extracted from a [PEP 621](https://peps.python.org/pep-0621/) compliant `pyproject.toml` or a `setup.cfg` present in the current directory
- [**Composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory - [**Composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory
- [**Gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present - [**Gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present in the current directory
- [**Julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present - [**Julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present in the current directory
- [**Mix**](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present - [**Mix**](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present in the current directory
- [**Helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present - [**Helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present in the current directory
- [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present - [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory
- [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present - [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present - [**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 - [**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 - [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory
- [**Dart**](https://pub.dev/) - The `dart` package version is extracted from the `pubspec.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
@ -2845,11 +2850,13 @@ By default the `rust` module shows the currently installed version of [Rust](htt
### Variables ### Variables
| Variable | Example | Description | | Variable | Example | Description |
| --------- | ----------------- | ------------------------------------ | | --------- | ----------------- | -------------------------------------------- |
| version | `v1.43.0-nightly` | The version of `rustc` | | version | `v1.43.0-nightly` | The version of `rustc` |
| symbol | | Mirrors the value of option `symbol` | | numver | `1.51.0` | The numeric component of the `rustc` version |
| style\* | | Mirrors the value of option `style` | | toolchain | `beta` | The toolchain version |
| 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 *: This variable can only be used as a part of a style string

5
docs/ko-KR/guide/README.md
View File

@ -326,7 +326,7 @@ eval $(starship init ion)
<details> <details>
<summary>Nushell</summary> <summary>Nushell</summary>
Run the following: Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
@ -336,11 +336,10 @@ 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`): And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):
```sh ```sh
starship init nu | save ~/.cache/starship/init.nu
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```
Note: Only Nushell v0.60+ is supported Note: Only Nushell v0.61+ is supported
</details> </details>

16
docs/nl-NL/README.md
View File

@ -120,7 +120,11 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
#### Elvish #### Elvish
::: warning Only elvish v0.18 or higher is supported. ::: ::: warning
Only elvish v0.18 or higher is supported.
:::
Add the following to the end of `~/.elvish/rc.elv`: Add the following to the end of `~/.elvish/rc.elv`:
@ -144,7 +148,13 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
#### Nushell #### Nushell
::: warning This will change in the future. Only Nushell v0.60+ is supported. ::: Run the following: ::: warning
This will change in the future. Only Nushell v0.61+ is supported.
:::
Add the following to to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu starship init nu | save ~/.cache/starship/init.nu
@ -153,8 +163,6 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`): And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):
```sh ```sh
mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```

125
docs/nl-NL/config/README.md
View File

@ -280,16 +280,16 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | | ------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | The format for the module. | | `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)'` | The format for the module. |
| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. | | `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
| `region_aliases` | | Table of region aliases to display in addition to the AWS name. | | `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | | `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. |
| `style` | `"bold yellow"` | The style for the module. | | `style` | `"bold yellow"` | The style for the module. |
| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. | | `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. |
| `disabled` | `false` | Disables the `AWS` module. | | `disabled` | `false` | Disables the `AWS` module. |
| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. | | `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. |
### Variables ### Variables
@ -1140,7 +1140,9 @@ The `env_var` module displays the current value of a selected environment variab
- The `variable` configuration option matches an existing environment variable - The `variable` configuration option matches an existing environment variable
- The `variable` configuration option is not defined, but the `default` configuration option is - The `variable` configuration option is not defined, but the `default` configuration option is
::: tip Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. ::: tip
Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character.
Example: following configuration will display value of USER environment variable Example: following configuration will display value of USER environment variable
@ -1342,17 +1344,17 @@ The `git_branch` module shows the active branch of the repo in your current dire
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| -------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | | -------------------- | ------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | | `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. |
| `format` | `"on [$symbol$branch]($style) "` | The format for the module. Use `"$branch"` to refer to the current branch name. | | `format` | `"on [$symbol$branch(:$remote_branch)]($style) "` | The format for the module. Use `"$branch"` to refer to the current branch name. |
| `symbol` | `" "` | A format string representing the symbol of git branch. | | `symbol` | `" "` | A format string representing the symbol of git branch. |
| `style` | `"bold purple"` | The style for the module. | | `style` | `"bold purple"` | The style for the module. |
| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | | `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. |
| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. | | `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. |
| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | | `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". | | `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for "master" or "main". |
| `disabled` | `false` | Disables the `git_branch` module. | | `disabled` | `false` | Disables the `git_branch` module. |
### Variables ### Variables
@ -1602,6 +1604,7 @@ The `golang` module shows the currently installed version of [Go](https://golang
- The current directory contains a `go.mod` file - The current directory contains a `go.mod` file
- The current directory contains a `go.sum` file - The current directory contains a `go.sum` file
- The current directory contains a `go.work` file
- The current directory contains a `glide.yaml` file - The current directory contains a `glide.yaml` file
- The current directory contains a `Gopkg.yml` file - The current directory contains a `Gopkg.yml` file
- The current directory contains a `Gopkg.lock` file - The current directory contains a `Gopkg.lock` file
@ -1611,16 +1614,16 @@ The `golang` module shows the currently installed version of [Go](https://golang
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. | | `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
| `detect_extensions` | `["go"]` | Which extensions should trigger this module. | | `detect_extensions` | `["go"]` | Which extensions should trigger this module. |
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. | | `detect_files` | `["go.mod", "go.sum", "go.work", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `["Godeps"]` | Which folders should trigger this module. | | `detect_folders` | `["Godeps"]` | Which folders should trigger this module. |
| `style` | `"bold cyan"` | The style for the module. | | `style` | `"bold cyan"` | The style for the module. |
| `disabled` | `false` | Disables the `golang` module. | | `disabled` | `false` | Disables the `golang` module. |
### Variables ### Variables
@ -1719,20 +1722,22 @@ The `hostname` module shows the system hostname.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | | ------------ | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `ssh_only` | `true` | Only show hostname when connected to an SSH session. | | `ssh_only` | `true` | Only show hostname when connected to an SSH session. |
| `trim_at` | `"."` | String that the hostname is cut off at, after the first match. `"."` will stop after the first dot. `""` will disable any truncation | | `ssh_symbol` | `"🌐 "` | A format string representing the symbol when connected to SSH session. |
| `format` | `"[$hostname]($style) in "` | The format for the module. | | `trim_at` | `"."` | String that the hostname is cut off at, after the first match. `"."` will stop after the first dot. `""` will disable any truncation |
| `style` | `"bold dimmed green"` | The style for the module. | | `format` | `"[$ssh_symbol$hostname]($style) in "` | The format for the module. |
| `disabled` | `false` | Disables the `hostname` module. | | `style` | `"bold dimmed green"` | The style for the module. |
| `disabled` | `false` | Disables the `hostname` module. |
### Variables ### Variables
| Variable | Example | Description | | Variable | Example | Description |
| --------- | ---------- | ----------------------------------- | | ---------- | ---------- | ----------------------------------------------------- |
| hostname | `computer` | The hostname of the computer | | hostname | `computer` | The hostname of the computer |
| style\* | | Mirrors the value of option `style` | | style\* | | Mirrors the value of option `style` |
| ssh_symbol | `"🌏 "` | The symbol to represent when connected to SSH session |
*: This variable can only be used as a part of a style string *: This variable can only be used as a part of a style string
@ -1743,7 +1748,7 @@ The `hostname` module shows the system hostname.
[hostname] [hostname]
ssh_only = false ssh_only = false
format = "on [$hostname](bold red) " format = "[$ssh_symbol](bold blue) on [$hostname](bold red) "
trim_at = ".companyname.com" trim_at = ".companyname.com"
disabled = false disabled = false
``` ```
@ -2383,22 +2388,22 @@ symbol = "☁️ "
## Package Version ## Package Version
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `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` 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 - [**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 - [**Cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
- [**Nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command - [**Nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command
- [**Poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory - [**Poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
- [**Python**](https://www.python.org) - The `python` package version is extracted from the `setup.cfg` present in the current directory - [**Python**](https://www.python.org) - The `python` package version is extracted from a [PEP 621](https://peps.python.org/pep-0621/) compliant `pyproject.toml` or a `setup.cfg` present in the current directory
- [**Composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory - [**Composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory
- [**Gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present - [**Gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present in the current directory
- [**Julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present - [**Julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present in the current directory
- [**Mix**](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present - [**Mix**](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present in the current directory
- [**Helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present - [**Helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present in the current directory
- [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present - [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory
- [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present - [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present - [**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 - [**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 - [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory
- [**Dart**](https://pub.dev/) - The `dart` package version is extracted from the `pubspec.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
@ -2845,11 +2850,13 @@ By default the `rust` module shows the currently installed version of [Rust](htt
### Variables ### Variables
| Variable | Example | Description | | Variable | Example | Description |
| --------- | ----------------- | ------------------------------------ | | --------- | ----------------- | -------------------------------------------- |
| version | `v1.43.0-nightly` | The version of `rustc` | | version | `v1.43.0-nightly` | The version of `rustc` |
| symbol | | Mirrors the value of option `symbol` | | numver | `1.51.0` | The numeric component of the `rustc` version |
| style\* | | Mirrors the value of option `style` | | toolchain | `beta` | The toolchain version |
| 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 *: This variable can only be used as a part of a style string

5
docs/nl-NL/guide/README.md
View File

@ -324,7 +324,7 @@ eval $(starship init ion)
<details> <details>
<summary>Nushell</summary> <summary>Nushell</summary>
Run the following: Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
@ -334,11 +334,10 @@ 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`): And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):
```sh ```sh
starship init nu | save ~/.cache/starship/init.nu
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```
Note: Only Nushell v0.60+ is supported Note: Only Nushell v0.61+ is supported
</details> </details>

16
docs/pl-PL/README.md
View File

@ -120,7 +120,11 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
#### Elvish #### Elvish
::: warning Only elvish v0.18 or higher is supported. ::: ::: warning
Only elvish v0.18 or higher is supported.
:::
Dodaj na koniec pliku `~/.elvish/rc.elv`: Dodaj na koniec pliku `~/.elvish/rc.elv`:
@ -144,7 +148,13 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
#### Nushell #### Nushell
::: warning This will change in the future. Only Nushell v0.60+ is supported. ::: Run the following: ::: warning
This will change in the future. Only Nushell v0.61+ is supported.
:::
Add the following to to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu starship init nu | save ~/.cache/starship/init.nu
@ -153,8 +163,6 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`): And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):
```sh ```sh
mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```

125
docs/pl-PL/config/README.md
View File

@ -280,16 +280,16 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | | ------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | The format for the module. | | `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)'` | The format for the module. |
| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. | | `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
| `region_aliases` | | Table of region aliases to display in addition to the AWS name. | | `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | | `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. |
| `style` | `"bold yellow"` | The style for the module. | | `style` | `"bold yellow"` | The style for the module. |
| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. | | `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. |
| `disabled` | `false` | Disables the `AWS` module. | | `disabled` | `false` | Disables the `AWS` module. |
| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. | | `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. |
### Variables ### Variables
@ -1140,7 +1140,9 @@ The `env_var` module displays the current value of a selected environment variab
- The `variable` configuration option matches an existing environment variable - The `variable` configuration option matches an existing environment variable
- The `variable` configuration option is not defined, but the `default` configuration option is - The `variable` configuration option is not defined, but the `default` configuration option is
::: tip Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. ::: tip
Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character.
Example: following configuration will display value of USER environment variable Example: following configuration will display value of USER environment variable
@ -1342,17 +1344,17 @@ The `git_branch` module shows the active branch of the repo in your current dire
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| -------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | | -------------------- | ------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | | `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. |
| `format` | `"on [$symbol$branch]($style) "` | The format for the module. Use `"$branch"` to refer to the current branch name. | | `format` | `"on [$symbol$branch(:$remote_branch)]($style) "` | The format for the module. Use `"$branch"` to refer to the current branch name. |
| `symbol` | `" "` | A format string representing the symbol of git branch. | | `symbol` | `" "` | A format string representing the symbol of git branch. |
| `style` | `"bold purple"` | The style for the module. | | `style` | `"bold purple"` | The style for the module. |
| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | | `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. |
| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. | | `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. |
| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | | `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". | | `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for "master" or "main". |
| `disabled` | `false` | Disables the `git_branch` module. | | `disabled` | `false` | Disables the `git_branch` module. |
### Variables ### Variables
@ -1602,6 +1604,7 @@ The `golang` module shows the currently installed version of [Go](https://golang
- The current directory contains a `go.mod` file - The current directory contains a `go.mod` file
- The current directory contains a `go.sum` file - The current directory contains a `go.sum` file
- The current directory contains a `go.work` file
- The current directory contains a `glide.yaml` file - The current directory contains a `glide.yaml` file
- The current directory contains a `Gopkg.yml` file - The current directory contains a `Gopkg.yml` file
- The current directory contains a `Gopkg.lock` file - The current directory contains a `Gopkg.lock` file
@ -1611,16 +1614,16 @@ The `golang` module shows the currently installed version of [Go](https://golang
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. | | `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
| `detect_extensions` | `["go"]` | Which extensions should trigger this module. | | `detect_extensions` | `["go"]` | Which extensions should trigger this module. |
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. | | `detect_files` | `["go.mod", "go.sum", "go.work", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `["Godeps"]` | Which folders should trigger this module. | | `detect_folders` | `["Godeps"]` | Which folders should trigger this module. |
| `style` | `"bold cyan"` | The style for the module. | | `style` | `"bold cyan"` | The style for the module. |
| `disabled` | `false` | Disables the `golang` module. | | `disabled` | `false` | Disables the `golang` module. |
### Variables ### Variables
@ -1719,20 +1722,22 @@ The `hostname` module shows the system hostname.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | | ------------ | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `ssh_only` | `true` | Only show hostname when connected to an SSH session. | | `ssh_only` | `true` | Only show hostname when connected to an SSH session. |
| `trim_at` | `"."` | String that the hostname is cut off at, after the first match. `"."` will stop after the first dot. `""` will disable any truncation | | `ssh_symbol` | `"🌐 "` | A format string representing the symbol when connected to SSH session. |
| `format` | `"[$hostname]($style) in "` | The format for the module. | | `trim_at` | `"."` | String that the hostname is cut off at, after the first match. `"."` will stop after the first dot. `""` will disable any truncation |
| `style` | `"bold dimmed green"` | The style for the module. | | `format` | `"[$ssh_symbol$hostname]($style) in "` | The format for the module. |
| `disabled` | `false` | Disables the `hostname` module. | | `style` | `"bold dimmed green"` | The style for the module. |
| `disabled` | `false` | Disables the `hostname` module. |
### Variables ### Variables
| Zmienne | Example | Description | | Zmienne | Example | Description |
| --------- | ---------- | ----------------------------------- | | ---------- | ---------- | ----------------------------------------------------- |
| hostname | `computer` | The hostname of the computer | | hostname | `computer` | The hostname of the computer |
| style\* | | Mirrors the value of option `style` | | style\* | | Mirrors the value of option `style` |
| ssh_symbol | `"🌏 "` | The symbol to represent when connected to SSH session |
*: This variable can only be used as a part of a style string *: This variable can only be used as a part of a style string
@ -1743,7 +1748,7 @@ The `hostname` module shows the system hostname.
[hostname] [hostname]
ssh_only = false ssh_only = false
format = "on [$hostname](bold red) " format = "[$ssh_symbol](bold blue) on [$hostname](bold red) "
trim_at = ".companyname.com" trim_at = ".companyname.com"
disabled = false disabled = false
``` ```
@ -2383,22 +2388,22 @@ symbol = "☁️ "
## Package Version ## Package Version
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `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` 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 - [**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 - [**Cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
- [**Nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command - [**Nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command
- [**Poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory - [**Poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
- [**Python**](https://www.python.org) - The `python` package version is extracted from the `setup.cfg` present in the current directory - [**Python**](https://www.python.org) - The `python` package version is extracted from a [PEP 621](https://peps.python.org/pep-0621/) compliant `pyproject.toml` or a `setup.cfg` present in the current directory
- [**Composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory - [**Composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory
- [**Gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present - [**Gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present in the current directory
- [**Julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present - [**Julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present in the current directory
- [**Mix**](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present - [**Mix**](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present in the current directory
- [**Helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present - [**Helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present in the current directory
- [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present - [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory
- [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present - [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present - [**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 - [**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 - [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory
- [**Dart**](https://pub.dev/) - The `dart` package version is extracted from the `pubspec.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
@ -2845,11 +2850,13 @@ By default the `rust` module shows the currently installed version of [Rust](htt
### Variables ### Variables
| Zmienne | Example | Description | | Zmienne | Example | Description |
| --------- | ----------------- | ------------------------------------ | | --------- | ----------------- | -------------------------------------------- |
| version | `v1.43.0-nightly` | The version of `rustc` | | version | `v1.43.0-nightly` | The version of `rustc` |
| symbol | | Mirrors the value of option `symbol` | | numver | `1.51.0` | The numeric component of the `rustc` version |
| style\* | | Mirrors the value of option `style` | | toolchain | `beta` | The toolchain version |
| 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 *: This variable can only be used as a part of a style string

5
docs/pl-PL/guide/README.md
View File

@ -326,7 +326,7 @@ eval $(starship init ion)
<details> <details>
<summary>Nushell</summary> <summary>Nushell</summary>
Run the following: Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
@ -336,11 +336,10 @@ 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`): And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):
```sh ```sh
starship init nu | save ~/.cache/starship/init.nu
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```
Note: Only Nushell v0.60+ is supported Note: Only Nushell v0.61+ is supported
</details> </details>

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

@ -120,7 +120,11 @@ description: O Starship é o prompt minimalista, extremamente rápido e extremam
#### Elvish #### Elvish
::: warning Somente a versão v0.18 ou superior do elvish é suportada. ::: ::: atenção
Only elvish v0.18 or higher is supported.
:::
Adicione o comando a seguir ao final do arquivo `~/.elvish/rc.elv`: Adicione o comando a seguir ao final do arquivo `~/.elvish/rc.elv`:
@ -144,17 +148,21 @@ description: O Starship é o prompt minimalista, extremamente rápido e extremam
#### Nushell #### Nushell
::: Atenção Isto vai mudar no futuro. Somente Nushell v0.60+ é suportado. ::: Execute os seguintes comandos: ::: atenção
This will change in the future. Somente Nushell v0.61+ é suportado.
:::
Add the following to to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu starship init nu | save ~/.cache/starship/init.nu
``` ```
And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`): E adicione o seguinte ao final da sua configuração do Nushell (encontre-o executando `$nu.config-path`):
```sh ```sh
mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```

2
docs/pt-BR/advanced-config/README.md
View File

@ -131,7 +131,7 @@ Invoke-Expression (&starship init powershell)
Alguns shells suportam um prompt no lado direito que renderiza na mesma linha do input. Starship consegue definir o conteúdo do prompt direito usando a opção `right_format`. Qualquer módulo pode ser usado no `format` é suportado o `right_format`. A variável `$all` só irá alterar os módulos que não usaram de forma explicita o `format` ou `right_format`. Alguns shells suportam um prompt no lado direito que renderiza na mesma linha do input. Starship consegue definir o conteúdo do prompt direito usando a opção `right_format`. Qualquer módulo pode ser usado no `format` é suportado o `right_format`. A variável `$all` só irá alterar os módulos que não usaram de forma explicita o `format` ou `right_format`.
Nota: O prompt direito é uma linha única seguindo o local de entrada. To right align modules above the input line in a multi-line prompt, see the [`fill` module](/config/#fill). Nota: O prompt direito é uma linha única seguindo o local de entrada. Para alinhar módulos à direita acima da linha de entrada em um prompt de várias linhas, consulte o [módulo `fill`](/config/#fill).
`right_format` é atualmente compatível com os seguintes shells: elvish, fish, zsh, xonsh, cmd. `right_format` é atualmente compatível com os seguintes shells: elvish, fish, zsh, xonsh, cmd.

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

@ -9,17 +9,17 @@ mkdir -p ~/.config && touch ~/.config/starship.toml
Todas as configurações do starship são feitas neste arquivo [TOML](https://github.com/toml-lang/toml): Todas as configurações do starship são feitas neste arquivo [TOML](https://github.com/toml-lang/toml):
```toml ```toml
# Get editor completions based on the config schema # Obtém os preenchimentos automáticos do editor com base em um esquema de configuração
"$schema" = 'https://starship.rs/config-schema.json' "$schema" = 'https://starship.rs/config-schema.json'
# Inserts a blank line between shell prompts # Insere uma quebra de linha entre os prompts do shell
add_newline = true add_newline = true
# Replace the "❯" symbol in the prompt with "➜" # Substitui o símbolo "❯" no prompt por "➜"
[character] # The name of the module we are configuring is "character" [character] # O nome do módulo que estamos configurando é "character"
success_symbol = "[➜](bold green)" # The "success_symbol" segment is being set to "➜" with the color "bold green" success_symbol = "[➜](bold green)" # O segmento "success_symbol" está sendo definido como "➜" com a cor verde em negrito
# Disable the package module, hiding it from the prompt completely # Desativa o módulo do pacote, ocultando-o completamente do prompt
[package] [package]
disabled = true disabled = true
``` ```
@ -183,7 +183,7 @@ O `formato` padrão é usado para definir o formato do prompt, se um valor vazio
```toml ```toml
format = "$all" format = "$all"
# Which is equivalent to # O que equivale a
format = """ format = """
$username\ $username\
$hostname\ $hostname\
@ -268,9 +268,9 @@ format = "$all$directory$character"
## AWS ## 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. 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. 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. 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.
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`. If the option `force_display` is set to `true`, all available information will be displayed even if the conditions above are not respected. 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.
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`. 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`.
@ -280,16 +280,16 @@ Quando usar [AWSume](https://awsu.me) o perfil é lido da variável `AWSUME_PROF
### Opções ### Opções
| Opções | Padrão | Descrição | | Opções | Padrão | Descrição |
| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | | ------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | O formato do módulo. | | `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)'` | O formato do módulo. |
| `symbol` | `"☁️ "` | O símbolo usado antes de exibir o perfil atual da AWS. | | `symbol` | `"☁️ "` | O símbolo usado antes de exibir o perfil atual da AWS. |
| `region_aliases` | | Tabela de aleases de regiões a serem exibidas, além do nome da AWS. | | `region_aliases` | | Tabela de aleases de regiões a serem exibidas, além do nome da AWS. |
| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | | `profile_aliases` | | Tabela de apelidos de perfil a serem exibidos além do nome da AWS. |
| `style` | `"bold yellow"` | O estilo do módulo. | | `style` | `"bold yellow"` | O estilo do módulo. |
| `expiration_symbol` | `X` | O simbolo exibido quando as credenciais temporárias estão expiradas. | | `expiration_symbol` | `X` | O simbolo exibido quando as credenciais temporárias estão expiradas. |
| `disabled` | `false` | Desabilita o módulo `AWS`. | | `disabled` | `false` | Desabilita o módulo `AWS`. |
| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. | | `force_display` | `false` | Se `true` exibe as informações mesmo que `credentials`, `credential_process` ou `sso_start_url` não tenham sido configurados. |
### Variáveis ### Variáveis
@ -318,7 +318,7 @@ symbol = "🅰 "
ap-southeast-2 = "au" ap-southeast-2 = "au"
us-east-1 = "va" us-east-1 = "va"
[aws.profile_aliases] [aws.profile_aliases]
CompanyGroupFrobozzOnCallAccess = 'Frobozz' ChamadaDeAcessoDoGrupoDaEmpresaFrobozz = 'Frobozz'
``` ```
#### Exibir região #### Exibir região
@ -345,7 +345,7 @@ format = "on [$symbol$profile]($style) "
style = "bold blue" style = "bold blue"
symbol = "🅰 " symbol = "🅰 "
[aws.profile_aliases] [aws.profile_aliases]
Enterprise_Naming_Scheme-voidstars = 'void**' Esquema_De_Nomenclatura_Empresarial-voidstars = 'void**'
``` ```
## Azure ## Azure
@ -427,43 +427,43 @@ A opção `display` é um array da seguinte tabela.
#### Exemplo #### Exemplo
```toml ```toml
[[battery.display]] # "bold red" style and discharging_symbol when capacity is between 0% and 10% [[battery.display]] # estilo negrito com vermelho e discharging_symbol quando a capacidade está entre 0% e 10%
threshold = 10 threshold = 10
style = "bold red" style = "bold red"
[[battery.display]] # "bold yellow" style and 💦 symbol when capacity is between 10% and 30% [[battery.display]] # estilo negrito com amarelo e símbolo 💦 quando a capacidade está entre 10% e 30%
threshold = 30 threshold = 30
style = "bold yellow" style = "bold yellow"
discharging_symbol = "💦" discharging_symbol = "💦"
# when capacity is over 30%, the battery indicator will not be displayed # quando a capacidade for superior a 30%, o indicador da bateria não será exibido
``` ```
## Buf ## Buf
The `buf` module shows the currently installed version of [Buf](https://buf.build). By default, the module is shown if all of the following conditions are met: O módulo `buf` mostra a versão instalada do [Buf](https://buf.build). Por padrão, o módulo é mostrado se todas as seguintes condições forem atendidas:
- The [`buf`](https://github.com/bufbuild/buf) CLI is installed. - A CLI [`buf`](https://github.com/bufbuild/buf) está instalada.
- The current directory contains a [`buf.yaml`](https://docs.buf.build/configuration/v1/buf-yaml), [`buf.gen.yaml`](https://docs.buf.build/configuration/v1/buf-gen-yaml), or [`buf.work.yaml`](https://docs.buf.build/configuration/v1/buf-work-yaml) configuration file. - O atual diretório contém um [`buf.yaml`](https://docs.buf.build/configuration/v1/buf-yaml), [`buf.gen.yaml`](https://docs.buf.build/configuration/v1/buf-gen-yaml) ou arquivo de configuração [`buf.work.yaml`](https://docs.buf.build/configuration/v1/buf-work-yaml).
### Opções ### Opções
| Opções | Padrão | Descrição | | Opções | Padrão | Descrição |
| ------------------- | ------------------------------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------------------------------ | ------------------------------------------------- |
| `format` | `'with [$symbol($version \(Buf $buf_version\) )]($style)'` | The format for the `buf` module. | | `format` | `'with [$symbol($version \(Buf $buf_version\) )]($style)'` | O formato do módulo `buf`. |
| `version_format` | `"v${raw}"` | O formato da versão. | | `version_format` | `"v${raw}"` | O formato da versão. |
| `symbol` | `"🦬 "` | The symbol used before displaying the version of Buf. | | `symbol` | `"🦬 "` | O símbolo usado antes de exibir a versão do Buf. |
| `detect_extensions` | `[]` | Quais extensões devem ativar este módulo. | | `detect_extensions` | `[]` | Quais extensões devem ativar este módulo. |
| `detect_files` | `["buf.yaml", "buf.gen.yaml", "buf.work.yaml"]` | Quais nomes de arquivos devem ativar este módulo. | | `detect_files` | `["buf.yaml", "buf.gen.yaml", "buf.work.yaml"]` | Quais nomes de arquivos devem ativar este módulo. |
| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | | `detect_folders` | `[]` | Quais pastas devem ativar este módulo. |
| `style` | `"bold blue"` | O estilo do módulo. | | `style` | `"bold blue"` | O estilo do módulo. |
| `disabled` | `false` | Desabilita o módulo `elixir`. | | `disabled` | `false` | Desabilita o módulo `elixir`. |
### Variáveis ### Variáveis
| Variável | Exemplo | Descrição | | Variável | Exemplo | Descrição |
| ------------- | -------- | --------------------------------- | | ------------- | -------- | --------------------------------- |
| `buf_version` | `v1.0.0` | The version of `buf` | | `buf_version` | `v1.0.0` | A versão do `buf` |
| `symbol` | | Espelha o valor da opção `symbol` | | `symbol` | | Espelha o valor da opção `symbol` |
| `style`* | | Espelha o valor da opção `style` | | `style`* | | Espelha o valor da opção `style` |
@ -480,7 +480,7 @@ symbol = "🦬 "
## C ## C
The `c` module shows some information about your C compiler. By default the module will be shown if the current directory contains a `.c` or `.h` file. O módulo `c` mostra algumas informações sobre o seu compilador de C. Por padrão o módulo será exibido se o diretório atual contém um arquivo `.c` ou `.h`.
### Opções ### Opções
@ -488,32 +488,32 @@ The `c` module shows some information about your C compiler. By default the modu
| ------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | | ------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
| `format` | `"via [$symbol($version(-$name) )]($style)"` | A string de formato do módulo. | | `format` | `"via [$symbol($version(-$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` | | `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"C "` | The symbol used before displaying the compiler details | | `symbol` | `"C "` | O símbolo utilizado antes de exibir os detalhes do compilador |
| `detect_extensions` | `["c", "h"]` | Quais extensões devem ativar este módulo. | | `detect_extensions` | `["c", "h"]` | Quais extensões devem ativar este módulo. |
| `detect_files` | `[]` | Quais nomes de arquivos devem ativar este módulo. | | `detect_files` | `[]` | Quais nomes de arquivos devem ativar este módulo. |
| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | | `detect_folders` | `[]` | Quais pastas devem ativar este módulo. |
| `commands` | [ [ "cc", "--version" ], [ "gcc", "--version" ], [ "clang", "--version" ] ] | How to detect what the compiler is | | `commands` | [ [ "cc", "--version" ], [ "gcc", "--version" ], [ "clang", "--version" ] ] | Como detectar qual é o compilador |
| `style` | `"bold 149"` | O estilo do módulo. | | `style` | `"bold 149"` | O estilo do módulo. |
| `disabled` | `false` | Disables the `c` module. | | `disabled` | `false` | Desabilita o módulo `c`. |
### Variáveis ### Variáveis
| Variável | Exemplo | Descrição | | Variável | Exemplo | Descrição |
| -------- | ------- | --------------------------------- | | -------- | ------- | --------------------------------- |
| name | clang | The name of the compiler | | name | clang | O nome do compilador |
| version | 13.0.0 | The version of the compiler | | version | 13.0.0 | A versão do compilador |
| symbol | | Espelha o valor da opção `symbol` | | symbol | | Espelha o valor da opção `symbol` |
| style | | Espelha o valor da opção `style` | | style | | Espelha o valor da opção `style` |
NB that `version` is not in the default format. Note que `version` não está no formato padrão.
### Commands ### Comandos
The `commands` option accepts a list of commands to determine the compiler version and name. A opção `commands` aceita uma lista de comandos para determinar a versão e o nome do compilador.
Each command is represented as a list of the executable name, followed by its arguments, usually something like `["mycc", "--version"]`. Starship will try executing each command until it gets a result on STDOUT. Cada comando é representado como uma lista do nome do executável, seguido de seus argumentos, geralmente algo como `["mycc", "--version"]`. Starship tentará executar cada comando até que obtenha um resultado no STDOUT.
If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). Se um compilador C não é suportado por este módulo, você pode solicitá-lo [criando uma issue no GitHub](https://github.com/starship/starship/).
### Exemplo ### Exemplo
@ -537,7 +537,7 @@ Por padrão ele apenas muda de cor. Se você deseja alterar o formato de uma olh
::: atenção ::: atenção
`vicmd_symbol` is only supported in cmd, fish and zsh. `vicmd_symbol` só é suportado no cmd, fish e zsh.
::: :::
@ -662,16 +662,16 @@ Usuários do bash que precisam de funções pre-executadas podem usar [rcaloras'
### Opções ### Opções
| Opções | Padrão | Descrição | | Opções | Padrão | Descrição |
| ---------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ---------------------- | ----------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `min_time` | `2_000` | Duração mais curta para exibir o tempo (em milissegundos). | | `min_time` | `2_000` | Duração mais curta para exibir o tempo (em milissegundos). |
| `show_milliseconds` | `false` | Exibir milissegundos ou invés de segundos para duração. | | `show_milliseconds` | `false` | Exibir milissegundos ou invés de segundos para duração. |
| `format` | `"took [$duration]($style) "` | O formato do módulo. | | `format` | `"took [$duration]($style) "` | O formato do módulo. |
| `style` | `"bold yellow"` | O estilo do módulo. | | `style` | `"bold yellow"` | O estilo do módulo. |
| `disabled` | `false` | Desabilita o módulo `cmd_duration`. | | `disabled` | `false` | Desabilita o módulo `cmd_duration`. |
| `show_notifications` | `false` | Exibi notificações no desktop quando o comando for concluído. | | `show_notifications` | `false` | Exibi notificações no desktop quando o comando for concluído. |
| `min_time_to_notify` | `45_000` | Tempo minimo para notificação (em milissegundos). | | `min_time_to_notify` | `45_000` | Tempo minimo para notificação (em milissegundos). |
| `notification_timeout` | | Duration to show notification for (in milliseconds). If unset, notification timeout will be determined by daemon. Not all notification daemons honor this option. | | `notification_timeout` | | Duração para mostrar a notificação (em milissegundos). Se não estiver definido, o tempo limite de notificação será determinado pelo daemon. Nem todos os daemons de notificação aceitam essa opção. |
### Variáveis ### Variáveis
@ -734,22 +734,22 @@ format = "[$symbol$environment](dimmed green) "
## Container ## Container
The `container` module displays a symbol and container name, if inside a container. O módulo `container` exibe um símbolo e nome do contêiner, se dentro de um container.
### Opções ### Opções
| Opções | Padrão | Descrição | | Opções | Padrão | Descrição |
| ---------- | -------------------------------------- | ----------------------------------------- | | ---------- | -------------------------------------- | ------------------------------------------------- |
| `symbol` | `"⬢"` | The symbol shown, when inside a container | | `symbol` | `"⬢"` | O símbolo mostrado, quando dentro de um contêiner |
| `style` | `"bold red dimmed"` | O estilo do módulo. | | `style` | `"bold red dimmed"` | O estilo do módulo. |
| `format` | `"[$symbol \\[$name\\]]($style) "` | O formato do módulo. | | `format` | `"[$symbol \\[$name\\]]($style) "` | O formato do módulo. |
| `disabled` | `false` | Desabilita o módulo `container`. | | `disabled` | `false` | Desabilita o módulo `container`. |
### Variáveis ### Variáveis
| Variável | Exemplo | Descrição | | Variável | Exemplo | Descrição |
| --------- | ------------------- | --------------------------------- | | --------- | ------------------- | --------------------------------- |
| name | `fedora-toolbox:35` | The name of the container | | name | `fedora-toolbox:35` | O nome do contêiner |
| symbol | | Espelha o valor da opção `symbol` | | symbol | | Espelha o valor da opção `symbol` |
| style\* | | Espelha o valor da opção `style` | | style\* | | Espelha o valor da opção `style` |
@ -889,20 +889,20 @@ Por exemplo, dado `~/Dev/Nix/nixpkgs/pkgs` onde `nixpkgs` é o repositório raiz
### Opções ### Opções
| Opções | Padrão | Descrição | | Opções | Padrão | Descrição |
| ------------------- | ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
| `truncation_length` | `3` | O número de pastas pais do diretório atual que serão truncadas. | | `truncation_length` | `3` | O número de pastas pais do diretório atual que serão truncadas. |
| `truncate_to_repo` | `true` | Seu diretório será truncado ou não para a raiz do repositório git atual. | | `truncate_to_repo` | `true` | Seu diretório será truncado ou não para a raiz do repositório git atual. |
| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | O formato do módulo. | | `format` | `"[$path]($style)[$read_only]($read_only_style) "` | O formato do módulo. |
| `style` | `"bold cyan"` | O estilo do módulo. | | `style` | `"bold cyan"` | O estilo do módulo. |
| `disabled` | `false` | Desabilita o módulo `directory`. | | `disabled` | `false` | Desabilita o módulo `directory`. |
| `read_only` | `"🔒"` | O simbolo que indica que o diretório atual é somente leitura. | | `read_only` | `"🔒"` | O simbolo que indica que o diretório atual é somente leitura. |
| `read_only_style` | `"red"` | O estilo para o simbolo de somente leitura. | | `read_only_style` | `"red"` | O estilo para o simbolo de somente leitura. |
| `truncation_symbol` | `""` | O simbolo para prefixo de caminhos truncados. ex: "…/" | | `truncation_symbol` | `""` | O simbolo para prefixo de caminhos truncados. ex: "…/" |
| `repo_root_style` | `None` | The style for the root of the git repo. The default value is equivalent to `style`. | | `repo_root_style` | `None` | O estilo para a raiz do repositório git. O valor padrão é equivalente a `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. | | `repo_root_format` | `"[$before_root_path]($style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) "` | O formato de um repositório git quando `repo_root_style` é definido. |
| `home_symbol` | `"~"` | O simbolo para indicar o diretório home. | | `home_symbol` | `"~"` | O simbolo para indicar o diretório home. |
| `use_os_path_sep` | `true` | Use the OS specific path separator instead of always using `/` (e.g. `\` on Windows) | | `use_os_path_sep` | `true` | Use o separador de caminho específico do sistema opracional em vez de sempre usar `/` (por exemplo, `\` no Windows) |
<details> <details>
<summary>Este módulo tem algumas configurações avançadas que controlam como o diretório é exibido.</summary> <summary>Este módulo tem algumas configurações avançadas que controlam como o diretório é exibido.</summary>
@ -935,17 +935,17 @@ Por exemplo, dado `~/Dev/Nix/nixpkgs/pkgs` onde `nixpkgs` é o repositório raiz
*: Esta variável só pode ser usada como parte de uma string de estilo *: Esta variável só pode ser usada como parte de uma string de estilo
<details> <details>
<summary>The git repos have additional variables.</summary> <summary>Os repositórios git têm variáveis adicionais.</summary>
Let us consider the path `/path/to/home/git_repo/src/lib` Vamos considerar o caminho `/caminho/para/home/git_repo/src/lib`
| Variável | Exemplo | Descrição | | Variável | Exemplo | Descrição |
| ------------------ | --------------------- | --------------------------------------- | | ------------------ | ----------------------- | --------------------------------------------------- |
| before_root_path | `"/path/to/home/"` | The path before git root directory path | | before_root_path | `"/caminho/para/home/"` | O caminho antes do caminho do diretório raiz do git |
| repo_root | `"git_repo"` | The git root directory name | | repo_root | `"git_repo"` | O nome do diretório raiz do git |
| path | `"/src/lib"` | The remaining path | | path | `"/src/lib"` | O caminho restante |
| style | `"black bold dimmed"` | Espelha o valor da opção `style` | | style | `"black bold dimmed"` | Espelha o valor da opção `style` |
| repo_root_style | `"underline white"` | Style for git root directory name | | repo_root_style | `"underline white"` | Estilo para o nome do diretório raiz do git |
</details> </details>
@ -1014,7 +1014,7 @@ Você também precisa do .NET Core SDK instalado para usá-lo corretamente.
Internamente, este módulo usa seu próprio mecanismo de detecção de versão. Normalmente é duas vezes mais rápido que executar `dotnet --version`, mas pode exibir uma versão errado se o projeto .NET tiver o layout de diretório incomum. Se a precisão é mais importante que velocidade, você pode desabilitar o mecanismo definindo `heuristic = false` nas opções do modulo. Internamente, este módulo usa seu próprio mecanismo de detecção de versão. Normalmente é duas vezes mais rápido que executar `dotnet --version`, mas pode exibir uma versão errado se o projeto .NET tiver o layout de diretório incomum. Se a precisão é mais importante que velocidade, você pode desabilitar o mecanismo definindo `heuristic = false` nas opções do modulo.
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. O módulo também mostrará o Target Framework Moniker (<https://docs.microsoft.com/en-us/dotnet/standard/frameworks#supported-target-frameworks>) quando houver um arquivo `.csproj` no diretório atual.
### Opções ### Opções
@ -1099,7 +1099,7 @@ O módulo `elm` exibe a versão instalada do [Elm](https://elm-lang.org/). Por p
- O diretório atual contem o arquivo `elm-package.json` - O diretório atual contem o arquivo `elm-package.json`
- O diretório atual contem um arquivo `.elm-version` - O diretório atual contem um arquivo `.elm-version`
- O diretório atual contem uma pasta `elm-stuff` - O diretório atual contem uma pasta `elm-stuff`
- The current directory contains `*.elm` files - O diretório atual contém arquivos `*.elm`
### Opções ### Opções
@ -1138,7 +1138,9 @@ O módulo `env_var` exibe o valor atual de uma variável de ambiente selecionada
- A opção de configuração da `variable` corresponde a uma variável existente - A opção de configuração da `variable` corresponde a uma variável existente
- A configuração `variable` não está definida, mas a `default` está - A configuração `variable` não está definida, mas a `default` está
::: tip Varias variáveis podem ser exibidas usando um `.`. (Veja o exemplo) se a configuração `variable` não é definida, o módulo irá exibir o valor da variável após o caractere `.`. ::: tip
Múltiplas variáveis de ambiente podem ser exibidas usando um `.`. (Veja o exemplo) se a configuração `variable` não é definida, o módulo irá exibir o valor da variável após o caractere `.`.
Exemplo: a configuração a seguir irá mostrar o valor da variável de ambiente USER Exemplo: a configuração a seguir irá mostrar o valor da variável de ambiente USER
@ -1267,14 +1269,14 @@ O módulo `gcloud` exibe a configuração atual para o [`gcloud`](https://cloud.
### Opções ### Opções
| Opções | Padrão | Descrição | | Opções | Padrão | Descrição |
| ----------------- | ---------------------------------------------------------- | ---------------------------------------------------------------- | | ----------------- | ---------------------------------------------------------- | ------------------------------------------------------------------- |
| `format` | `'on [$symbol$account(@$domain)(\($region\))]($style) '` | O formato do módulo. | | `format` | `'on [$symbol$account(@$domain)(\($region\))]($style) '` | O formato do módulo. |
| `symbol` | `"☁️ "` | O simbolo usado antes de exibir o perfil atual do GCP. | | `symbol` | `"☁️ "` | O simbolo usado antes de exibir o perfil atual do GCP. |
| `region_aliases` | | Tabela de aliases de região para exibir além do nome do GCP. | | `region_aliases` | | Tabela de aliases de região para exibir além do nome do GCP. |
| `project_aliases` | | Table of project aliases to display in addition to the GCP name. | | `project_aliases` | | Tabela de apelidos do projeto a serem exibidos além do nome do GCP. |
| `style` | `"bold blue"` | O estilo do módulo. | | `style` | `"bold blue"` | O estilo do módulo. |
| `disabled` | `false` | Desabilita o módulo `gcloud`. | | `disabled` | `false` | Desabilita o módulo `gcloud`. |
### Variáveis ### Variáveis
@ -1323,7 +1325,7 @@ us-central1 = "uc1"
asia-northeast1 = "an1" asia-northeast1 = "an1"
``` ```
#### Display account and aliased project #### Exibir conta e projeto apelidado
```toml ```toml
# ~/.config/starship.toml # ~/.config/starship.toml
@ -1331,7 +1333,7 @@ asia-northeast1 = "an1"
[gcloud] [gcloud]
format = 'on [$symbol$account(@$domain)(\($project\))]($style) ' format = 'on [$symbol$account(@$domain)(\($project\))]($style) '
[gcloud.project_aliases] [gcloud.project_aliases]
very-long-project-name = "vlpn" nome-do-projeto-muito-longo = "npml"
``` ```
## Git Branch ## Git Branch
@ -1340,17 +1342,17 @@ O módulo `git_branch` exibe o branch ativo do repositório no diretório atual.
### Opções ### Opções
| Opções | Padrão | Descrição | | Opções | Padrão | Descrição |
| -------------------- | -------------------------------- | ------------------------------------------------------------------------------------------------- | | -------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------------- |
| `always_show_remote` | `false` | Exibe o nome do braço remoto, mesmo se ele for igual ao nome do braço local. | | `always_show_remote` | `false` | Exibe o nome do braço remoto, mesmo se ele for igual ao nome do braço local. |
| `format` | `"on [$symbol$branch]($style) "` | O formato do módulo. Use `"$branch"` para se referir ao nome do braço atual. | | `format` | `"on [$symbol$branch(:$remote_branch)]($style) "` | O formato do módulo. Use `"$branch"` para se referir ao nome do braço atual. |
| `symbol` | `" "` | Um formato de string que representa o simbolo do git branch. | | `symbol` | `" "` | Um formato de string que representa o simbolo do git branch. |
| `style` | `"bold purple"` | O estilo do módulo. | | `style` | `"bold purple"` | O estilo do módulo. |
| `truncation_length` | `2^63 - 1` | Truncates um braço do git para `N` caracteres. | | `truncation_length` | `2^63 - 1` | Truncates um braço do git para `N` caracteres. |
| `truncation_symbol` | `"…"` | O simbolo usado para indicar que o nome braço foi truncado. Você pode usar `""` para sem simbolo. | | `truncation_symbol` | `"…"` | O simbolo usado para indicar que o nome braço foi truncado. Você pode usar `""` para sem simbolo. |
| `only_attached` | `false` | Apenas exibe o nome do braço quando o estado não for detached `HEAD`. | | `only_attached` | `false` | Apenas exibe o nome do braço quando o estado não for detached `HEAD`. |
| `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for "master" or "main". | | `ignore_branches` | `[]` | Uma lista de nomes para evitar a exibição. Útil para "master" ou "main". |
| `disabled` | `false` | Desabilita o módulo `git_branch`. | | `disabled` | `false` | Desabilita o módulo `git_branch`. |
### Variáveis ### Variáveis
@ -1498,30 +1500,30 @@ O módulo `git_status` exibe o simbolo que representa o estado do repositório n
::: tip ::: tip
The Git Status module is very slow in Windows directories (for example under `/mnt/c/`) when in a WSL environment. You can disable the module or use the `windows_starship` option to use a Windows-native Starship executable to compute `git_status` for those paths. O módulo Git Status é muito lento nos diretórios do Windows (por exemplo, em `/mnt/c/`) quando em um ambiente WSL. Você pode desabilitar o módulo ou usar a opção `windows_starship` para usar um executável Starship nativo do Windows para calcular o `git_status` para esses caminhos.
::: :::
### Opções ### Opções
| Opções | Padrão | Descrição | | Opções | Padrão | Descrição |
| ------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- |
| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | O formato padrão para `git_status` | | `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | O formato padrão para `git_status` |
| `conflicted` | `"="` | Este braço tem conflitos. | | `conflicted` | `"="` | Este braço tem conflitos. |
| `ahead` | `"⇡"` | O formato do `ahead` | | `ahead` | `"⇡"` | O formato do `ahead` |
| `behind` | `"⇣"` | O formato do `behind` | | `behind` | `"⇣"` | O formato do `behind` |
| `diverged` | `"⇕"` | O formato do `diverged` | | `diverged` | `"⇕"` | O formato do `diverged` |
| `up_to_date` | `""` | O formato do `up_to_date` | | `up_to_date` | `""` | O formato do `up_to_date` |
| `untracked` | `"?"` | O formato do `untracked` | | `untracked` | `"?"` | O formato do `untracked` |
| `stashed` | `"$"` | O formato do `stashed` | | `stashed` | `"$"` | O formato do `stashed` |
| `modified` | `"!"` | O formato do `modified` | | `modified` | `"!"` | O formato do `modified` |
| `staged` | `"+"` | O formato do `staged` | | `staged` | `"+"` | O formato do `staged` |
| `renamed` | `"»"` | O formato do `renamed` | | `renamed` | `"»"` | O formato do `renamed` |
| `deleted` | `"✘"` | O formato do `deleted` | | `deleted` | `"✘"` | O formato do `deleted` |
| `style` | `"bold red"` | O estilo do módulo. | | `style` | `"bold red"` | O estilo do módulo. |
| `ignore_submodules` | `false` | Ignora as alterações de submódulos. | | `ignore_submodules` | `false` | Ignora as alterações de submódulos. |
| `disabled` | `false` | Desabilita o módulo `git_status`. | | `disabled` | `false` | Desabilita o módulo `git_status`. |
| `windows_starship` | | Use this (Linux) path to a Windows Starship executable to render `git_status` when on Windows paths in WSL. | | `windows_starship` | | Use este caminho (Linux) para um executável do Windows Starship renderizar o `git_status` quando estiver em caminhos do Windows no WSL. |
### Variáveis ### Variáveis
@ -1585,13 +1587,13 @@ diverged = "⇕⇡${ahead_count}⇣${behind_count}"
behind = "⇣${count}" behind = "⇣${count}"
``` ```
Use Windows Starship executable on Windows paths in WSL Use o executável do Windows Starship em caminhos do Windows em WSL
```toml ```toml
# ~/.config/starship.toml # ~/.config/starship.toml
[git_status] [git_status]
windows_starship = '/mnt/c/Users/username/scoop/apps/starship/current/starship.exe' windows_starship = '/mnt/c/Users/nomedousuario/scoop/apps/starship/current/starship.exe'
``` ```
## Go ## Go
@ -1600,6 +1602,7 @@ O módulo `golang` exibe a versão instalada atual do [Go](https://golang.org/).
- O diretório atual contem um arquivo `go.mod` - O diretório atual contem um arquivo `go.mod`
- O diretório atual contem um arquivo `go.sum` - O diretório atual contem um arquivo `go.sum`
- O diretório atual contem um arquivo `go.work`
- O diretório atual contem um arquivo `glide.yaml` - O diretório atual contem um arquivo `glide.yaml`
- O diretório atual contem um arquivo `Gopkg.yml` - O diretório atual contem um arquivo `Gopkg.yml`
- O diretório atual contém um arquivo `Gopkg.lock` - O diretório atual contém um arquivo `Gopkg.lock`
@ -1609,16 +1612,16 @@ O módulo `golang` exibe a versão instalada atual do [Go](https://golang.org/).
### Opções ### Opções
| Opções | Padrão | Descrição | | Opções | Padrão | Descrição |
| ------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | | ------------------- | ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ |
| `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | | `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. |
| `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🐹 "` | O formato da string que representa o simbolo do Go. | | `symbol` | `"🐹 "` | O formato da string que representa o simbolo do Go. |
| `detect_extensions` | `["go"]` | Quais extensões devem ativar este módulo. | | `detect_extensions` | `["go"]` | Quais extensões devem ativar este módulo. |
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Quais nomes de arquivos devem ativar este módulo. | | `detect_files` | `["go.mod", "go.sum", "go.work", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Quais nomes de arquivos devem ativar este módulo. |
| `detect_folders` | `["Godeps"]` | Quais pastas devem ativar este módulo. | | `detect_folders` | `["Godeps"]` | Quais pastas devem ativar este módulo. |
| `style` | `"bold cyan"` | O estilo do módulo. | | `style` | `"bold cyan"` | O estilo do módulo. |
| `disabled` | `false` | Desabilita o módulo `golang`. | | `disabled` | `false` | Desabilita o módulo `golang`. |
### Variáveis ### Variáveis
@ -1641,34 +1644,34 @@ format = "via [🏎💨 $version](bold cyan) "
## Haskell ## Haskell
The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot. O módulo `haskell` encontra a versão atual do GHC selecionada e/ou o snapshot do Stack selecionado.
Por padrão o módulo vai exibir se uma das condições a seguir for atendida: Por padrão o módulo vai exibir se uma das condições a seguir for atendida:
- O diretório atual contem um arquivo `stack.yaml` - O diretório atual contem um arquivo `stack.yaml`
- The current directory contains any `.hs`, `.cabal`, or `.hs-boot` file - O diretório atual contém qualquer arquivo `.hs`, `.cabal`, ou `.hs-boot`
### Opções ### Opções
| Opções | Padrão | Descrição | | Opções | Padrão | Descrição |
| ------------------- | ------------------------------------ | -------------------------------------------------- | | ------------------- | ------------------------------------ | --------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | | `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. |
| `symbol` | `"λ "` | A format string representing the symbol of Haskell | | `symbol` | `"λ "` | Uma string de formato que representa o símbolo de Haskell |
| `detect_extensions` | `["hs", "cabal", "hs-boot"]` | Quais extensões devem ativar este módulo. | | `detect_extensions` | `["hs", "cabal", "hs-boot"]` | Quais extensões devem ativar este módulo. |
| `detect_files` | `["stack.yaml", "cabal.project"]` | Quais nomes de arquivos devem ativar este módulo. | | `detect_files` | `["stack.yaml", "cabal.project"]` | Quais nomes de arquivos devem ativar este módulo. |
| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | | `detect_folders` | `[]` | Quais pastas devem ativar este módulo. |
| `style` | `"bold purple"` | O estilo do módulo. | | `style` | `"bold purple"` | O estilo do módulo. |
| `disabled` | `false` | Disables the `haskell` module. | | `disabled` | `false` | Desativa o módulo `haskell`. |
### Variáveis ### Variáveis
| Variável | Exemplo | Descrição | | Variável | Exemplo | Descrição |
| -------------- | ----------- | --------------------------------------------------------------------------------------- | | -------------- | ----------- | ------------------------------------------------------------------------------ |
| version | | `ghc_version` or `snapshot` depending on whether the current project is a Stack project | | version | | `ghc_version` ou o `snapshot` dependendo se o projeto atual é um projeto Stack |
| snapshot | `lts-18.12` | Currently selected Stack snapshot | | snapshot | `lts-18.12` | Snapshot do Stack selecionado |
| ghc\_version | `9.2.1` | Currently installed GHC version | | ghc\_version | `9.2.1` | Versão do GHC instalada |
| symbol | | Espelha o valor da opção `symbol` | | symbol | | Espelha o valor da opção `symbol` |
| style\* | | Espelha o valor da opção `style` | | style\* | | Espelha o valor da opção `style` |
*: Esta variável só pode ser usada como parte de uma string de estilo *: Esta variável só pode ser usada como parte de uma string de estilo
@ -1717,20 +1720,22 @@ O módulo `hostname` exibe o nome do hostname.
### Opções ### Opções
| Opções | Padrão | Descrição | | Opções | Padrão | Descrição |
| ---------- | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------ | -------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ssh_only` | `true` | Apenas exibe o hostname quando conectado em uma sessão SSH. | | `ssh_only` | `true` | Apenas exibe o hostname quando conectado em uma sessão SSH. |
| `trim_at` | `"."` | String na qual vai truncar o hostname, após a primeira correspondência. `"."` vai truncar após o primeiro ponto. `""` vai desabilitar qualquer truncação | | `ssh_symbol` | `"🌐 "` | Uma formatação de string que representa o símbolo quando conectado à sessão SSH. |
| `format` | `"[$hostname]($style) in "` | O formato do módulo. | | `trim_at` | `"."` | String na qual vai truncar o hostname, após a primeira correspondência. `"."` vai truncar após o primeiro ponto. `""` vai desabilitar qualquer truncação |
| `style` | `"bold dimmed green"` | O estilo do módulo. | | `format` | `"[$ssh_symbol$hostname]($style) in "` | O formato do módulo. |
| `disabled` | `false` | Desabilita o módulo `hostname`. | | `style` | `"bold dimmed green"` | O estilo do módulo. |
| `disabled` | `false` | Desabilita o módulo `hostname`. |
### Variáveis ### Variáveis
| Variável | Exemplo | Descrição | | Variável | Exemplo | Descrição |
| --------- | ---------- | -------------------------------- | | ---------- | ---------- | -------------------------------------------------------------- |
| hostname | `computer` | O hostname do computador | | hostname | `computer` | O hostname do computador |
| style\* | | Espelha o valor da opção `style` | | style\* | | Espelha o valor da opção `style` |
| ssh_symbol | `"🌏 "` | O símbolo a ser representado quando conectado à uma sessão SSH |
*: Esta variável só pode ser usada como parte de uma string de estilo *: Esta variável só pode ser usada como parte de uma string de estilo
@ -1741,8 +1746,8 @@ O módulo `hostname` exibe o nome do hostname.
[hostname] [hostname]
ssh_only = false ssh_only = false
format = "em [$hostname](bold red) " format = "[$ssh_symbol](bold blue) on [$hostname](bold red) "
trim_at = ".companyname.com" trim_at = ".nomedacompanhia.com"
disabled = false disabled = false
``` ```
@ -1931,7 +1936,7 @@ kotlin_binary = "kotlinc"
## Kubernetes ## Kubernetes
Displays the current [Kubernetes context](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context) name and, if set, the namespace, user and cluster from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via `kubectl config set-context starship-context --namespace astronaut`. Similarly the user and cluster can be set with `kubectl config set-context starship-context --user starship-user` and `kubectl config set-context starship-context --cluster starship-cluster`. Se a env var `$KUBECONFIG` estiver definida o módulo vai usa-la ao invés de usar o `~/.kube/config`. Exibe o nome atual do [Kubernetes context](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context) e, se definido, o namespace, usuário e cluster do arquivo kubeconfig. O namespace precisa ser definido no arquivo kubeconfig, isso pode ser feito via `kubectl config set-context starship-context --namespace astronaut`. Da mesma forma, o usuário e o cluster podem ser definidos com `kubectl config set-context starship-context --user starship-user` e `kubectl config set-context starship-context --cluster starship-cluster`. Se a env var `$KUBECONFIG` estiver definida o módulo vai usa-la ao invés de usar o `~/.kube/config`.
::: tip ::: tip
@ -1953,10 +1958,10 @@ Este módulo é desabilitado por padrão. Para habilitar, defina `disabled` para
| Variável | Exemplo | Descrição | | Variável | Exemplo | Descrição |
| --------- | -------------------- | ------------------------------------------- | | --------- | -------------------- | ------------------------------------------- |
| context | `starship-context` | The current kubernetes context name | | context | `starship-context` | O nome atual do kubernetes context |
| namespace | `starship-namespace` | Se definido o namespace atual do kubernetes | | namespace | `starship-namespace` | Se definido o namespace atual do kubernetes |
| user | `starship-user` | If set, the current kubernetes user | | user | `starship-user` | Se definido, o usuário atual do kubernetes |
| cluster | `starship-cluster` | If set, the current kubernetes cluster | | cluster | `starship-cluster` | Se definido, o cluster atual do kubernetes |
| symbol | | Espelha o valor da opção `symbol` | | symbol | | Espelha o valor da opção `symbol` |
| style\* | | Espelha o valor da opção `style` | | style\* | | Espelha o valor da opção `style` |
@ -2016,25 +2021,25 @@ O módulo `line_break` separa o prompt em duas linhas.
disabled = true disabled = true
``` ```
## Local IP ## IP Local
The `localip` module shows the IPv4 address of the primary network interface. O módulo `localip` mostra o endereço IPv4 da interface primária de rede.
### Opções ### Opções
| Opções | Padrão | Descrição | | Opções | Padrão | Descrição |
| ---------- | ------------------------- | ------------------------------------------------------ | | ---------- | ------------------------- | -------------------------------------------------------------- |
| `ssh_only` | `true` | Only show IP address when connected to an SSH session. | | `ssh_only` | `true` | Apenas mostre o endereço IP quando conectado a uma sessão SSH. |
| `format` | `"[$localipv4]($style) "` | O formato do módulo. | | `format` | `"[$localipv4]($style) "` | O formato do módulo. |
| `style` | `"bold yellow"` | O estilo do módulo. | | `style` | `"bold yellow"` | O estilo do módulo. |
| `disabled` | `true` | Desabilita o módulo `localip`. | | `disabled` | `true` | Desabilita o módulo `localip`. |
### Variáveis ### Variáveis
| Variável | Exemplo | Descrição | | Variável | Exemplo | Descrição |
| --------- | ------------ | --------------------------------- | | --------- | ------------ | -------------------------------- |
| localipv4 | 192.168.1.13 | Contains the primary IPv4 address | | localipv4 | 192.168.1.13 | Contém o endereço IPv4 principal |
| style\* | | Espelha o valor da opção `style` | | style\* | | Espelha o valor da opção `style` |
*: Esta variável só pode ser usada como parte de uma string de estilo *: Esta variável só pode ser usada como parte de uma string de estilo
@ -2262,7 +2267,7 @@ O módulo `nodejs` exibe a versão atual instalada do [Node.js](https://nodejs.o
- O diretório atual tenha um arquivo`.nvmrc` - O diretório atual tenha um arquivo`.nvmrc`
- O diretório atual tenha um diretório `node_modules` - O diretório atual tenha um diretório `node_modules`
- O diretório atual tenha um arquivo com a extensão `.js`, `.mjs` or `.cjs` - O diretório atual tenha um arquivo com a extensão `.js`, `.mjs` or `.cjs`
- The current directory contains a file with the `.ts`, `.mts` or `.cts` extension - O diretório atual contém um arquivo com a extensão `.ts`, `.mts` ou `.cts`
### Opções ### Opções
@ -2381,22 +2386,22 @@ symbol = "☁️ "
## Package Version ## Package Version
O módulo `package` é exibido quando o diretório atual é um repositorio para um pacote e exibe sua versão atual. O módulo atualmente suporta pacotes `npm`, `nimble`, `cargo`, `poetry`, `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. Atualmente o módulo dá suporte aos pacotes `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards` e `dart`.
- [**npm**](https://docs.npmjs.com/cli/commands/npm) – O versionamento de pacotes `npm` é extraído do `package.json` presente no diretório atual - [**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 - [**Cargo**](https://doc.rust-lang.org/cargo/) – O versionamento de pacotes `cargo`é extraído do arquivo `Cargo.toml` presente no diretório atual
- [**Nimble**](https://github.com/nim-lang/nimble) - O versionamento de pacotes `nimble` é extraído do arquivo `*.nimble` presente no diretório atual com o comando`nimble dump` - [**Nimble**](https://github.com/nim-lang/nimble) - O versionamento de pacotes `nimble` é extraído do arquivo `*.nimble` presente no diretório atual com o comando`nimble dump`
- [**Poetry**](https://python-poetry.org/) – O versionamento de pacotes `poetry` é extraído do arquivo `pyproject.toml` presente no diretório atual - [**Poetry**](https://python-poetry.org/) – O versionamento de pacotes `poetry` é extraído do arquivo `pyproject.toml` presente no diretório atual
- [**Python**](https://www.python.org) - O versionamento de pacotes `python` é extraído do arquivo `setup.cfg` presente no diretório atual - [**Python**](https://www.python.org) - O versionamento de pacotes `python` é extraída de um `pyproject.toml` compatível com [PEP 621](https://peps.python.org/pep-0621/) ou um `setup.cfg` presente no diretório atual
- [**Composer**](https://getcomposer.org/) – O versionamento de pacotes `composer` é extraído do arquivo`composer.json` presente no diretório atual - [**Composer**](https://getcomposer.org/) – O versionamento de pacotes `composer` é extraído do arquivo`composer.json` presente no diretório atual
- [**Gradle**](https://gradle.org/) – O versionamento de pacotes `gradle` é extraído do arquivo `build.gradle` presente no diretório atual - [**Gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present in the current directory
- [**Julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - O versionamento de pacotes é extraído do arquivo `Project.toml` presente no diretório atual - [**Julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present in the current directory
- [**Mix**](https://hexdocs.pm/mix/) - O versionamento de pacotes `mix`é extraído do arquivo `mix.exs` presente no diretório atual - [**Mix**](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present in the current directory
- [**Helm**](https://helm.sh/docs/helm/helm_package/) - O versionamento do gráfico `helm` é extraído do arquivo `Chart.yaml` presente no diretório atual - [**Helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present in the current directory
- [**Maven**](https://maven.apache.org/) - O versionamento de pacotes `maven` é extraído do arquivo`pom.xml` presente no diretório atual - [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory
- [**Meson**](https://mesonbuild.com/) - O versionamento de pacotes `meson` é extraído do arquivo`meson.build` presente no diretório atual - [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - O versionamento de pacotes `shards` é extraído do arquivo `shard.yml` presente no diretório atual - [**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) - O versionamento de pacotes `vlang` é extraido do arquivo`v.mod` presente no diretório atual - [**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 - [**SBT**](https://scala-sbt.org) - O versionamento de pacotes `sbt` pé extraído do arquivo `build.sbt` presente no diretório atual
- [**Dart**](https://pub.dev/) - O versionamento de pacotes `dart` pé extraído do arquivo `pubspec.yaml` presente no diretório atual - [**Dart**](https://pub.dev/) - O versionamento de pacotes `dart` pé extraído do arquivo `pubspec.yaml` presente no diretório atual
@ -2514,7 +2519,7 @@ format = "via [🔹 $version](147 bold) "
## Pulumi ## Pulumi
The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. O módulo `pulumi` mostra o nome de usuário atual, a [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/) selcionada e a versão.
::: tip ::: tip
@ -2543,7 +2548,7 @@ Por padrão o módulo vai exibir se uma das condições a seguir for atendida:
| --------- | ---------- | --------------------------------- | | --------- | ---------- | --------------------------------- |
| version | `v0.12.24` | A versão do `pulumi` | | version | `v0.12.24` | A versão do `pulumi` |
| stack | `dev` | A stack Pulumi atual | | stack | `dev` | A stack Pulumi atual |
| username | `alice` | The current Pulumi username | | username | `alice` | O nome de usuário Pulumi atual |
| symbol | | Espelha o valor da opção `symbol` | | symbol | | Espelha o valor da opção `symbol` |
| style\* | | Espelha o valor da opção `style` | | style\* | | Espelha o valor da opção `style` |
@ -2741,7 +2746,7 @@ format = "with [📐 $version](blue bold) "
## Red ## Red
Por padrão o módulo `red` exibe a versão atual instalada do [Red](https://www.red-lang.org/). O módulo será mostrado se alguma das seguintes condições for atendida: Por padrão o módulo `red` exibe a versão atual instalada do [Red](https://www.red-lang.org/). O módulo vai exibir se algumas das condições a seguir for atendida:
- O diretório atual contenha um arquivo com a extensão `.red` or `.reds` - O diretório atual contenha um arquivo com a extensão `.red` or `.reds`
@ -2779,7 +2784,7 @@ symbol = "🔴 "
## Ruby ## Ruby
Por padrão o módulo `ruby` vai exibir a versão atual instalada do [Ruby](https://www.ruby-lang.org/). O módulo será mostrado se alguma das seguintes condições for atendida: Por padrão o módulo `ruby` vai exibir a versão atual instalada do [Ruby](https://www.ruby-lang.org/). O módulo vai exibir se algumas das condições a seguir for atendida:
- O diretório atual tenha um arquivo `Gemfile` - O diretório atual tenha um arquivo `Gemfile`
- O diretório atual contém um arquivo `.ruby-version` - O diretório atual contém um arquivo `.ruby-version`
@ -2823,7 +2828,7 @@ symbol = "🔺 "
## Rust ## Rust
Por padrão o módulo `rust` vai exibir a versão atual instalada do [Rust](https://www.rust-lang.org/). O módulo será mostrado se alguma das seguintes condições for atendida: Por padrão o módulo `rust` vai exibir a versão atual instalada do [Rust](https://www.rust-lang.org/). O módulo vai exibir se algumas das condições a seguir for atendida:
- O diretório atual contem um arquivo `Cargo.toml` - O diretório atual contem um arquivo `Cargo.toml`
- O diretório atual tenha um arquivo com a extensão `.rs` - O diretório atual tenha um arquivo com a extensão `.rs`
@ -2843,11 +2848,13 @@ Por padrão o módulo `rust` vai exibir a versão atual instalada do [Rust](http
### Variáveis ### Variáveis
| Variável | Exemplo | Descrição | | Variável | Exemplo | Descrição |
| --------- | ----------------- | --------------------------------- | | --------- | ----------------- | --------------------------------------- |
| version | `v1.43.0-nightly` | A versão do `rustc` | | version | `v1.43.0-nightly` | A versão do `rustc` |
| symbol | | Espelha o valor da opção `symbol` | | numver | `1.51.0` | O componente numérico da versão `rustc` |
| style\* | | Espelha o valor da opção `style` | | toolchain | `beta` | A versão do toolchain |
| 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 *: Esta variável só pode ser usada como parte de uma string de estilo
@ -2922,7 +2929,7 @@ Este módulo é desabilitado por padrão. Para habilitar, defina `disabled` para
| `elvish_indicator` | `esh` | Uma string usada para representar o elvish. | | `elvish_indicator` | `esh` | Uma string usada para representar o elvish. |
| `tcsh_indicator` | `tsh` | Uma string usada para representar o tcsh. | | `tcsh_indicator` | `tsh` | Uma string usada para representar o tcsh. |
| `xonsh_indicator` | `xsh` | Uma string usada para representar o xonsh. | | `xonsh_indicator` | `xsh` | Uma string usada para representar o xonsh. |
| `cmd_indicator` | `cmd` | A format string used to represent cmd. | | `cmd_indicator` | `cmd` | Uma string usada para representar o cmd. |
| `nu_indicator` | `nu` | Uma string usada para representar o nu. | | `nu_indicator` | `nu` | Uma string usada para representar o nu. |
| `unknown_indicator` | | Valor padrão para exibir quando o shell é desconhecido. | | `unknown_indicator` | | Valor padrão para exibir quando o shell é desconhecido. |
| `format` | `"[$indicator]($style) "` | O formato do módulo. | | `format` | `"[$indicator]($style) "` | O formato do módulo. |
@ -3021,23 +3028,23 @@ format = '[📦 \[$env\]]($style) '
## Spack ## Spack
The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set. O módulo `spack` mostra o ambiente [Spack](https://spack.readthedocs.io/en/latest/) atual, se o `$SPACK_ENV` estiver definido.
### Opções ### Opções
| Opções | Padrão | Descrição | | Opções | Padrão | Descrição |
| ------------------- | -------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------- | -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `truncation_length` | `1` | The number of directories the environment path should be truncated to. `0` quer dizer sem truncação. Também consulte o módulo [`directory`](#directory). | | `truncation_length` | `1` | O número de diretórios para os quais o caminho do ambiente deve ser truncado. `0` quer dizer sem truncação. Também consulte o módulo [`directory`](#directory). |
| `symbol` | `"🅢 "` | O simbolo usado antes do nome do environment. | | `symbol` | `"🅢 "` | O simbolo usado antes do nome do environment. |
| `style` | `"bold blue"` | O estilo do módulo. | | `style` | `"bold blue"` | O estilo do módulo. |
| `format` | `"via [$symbol$environment]($style) "` | O formato do módulo. | | `format` | `"via [$symbol$environment]($style) "` | O formato do módulo. |
| `disabled` | `false` | Disables the `spack` module. | | `disabled` | `false` | Desabilita o módulo `spack`. |
### Variáveis ### Variáveis
| Variável | Exemplo | Descrição | | Variável | Exemplo | Descrição |
| ----------- | ------------ | --------------------------------- | | ----------- | ------------ | --------------------------------- |
| environment | `astronauts` | The current spack environment | | environment | `astronauts` | O ambiente spack atual |
| symbol | | Espelha o valor da opção `symbol` | | symbol | | Espelha o valor da opção `symbol` |
| style\* | | Espelha o valor da opção `style` | | style\* | | Espelha o valor da opção `style` |
@ -3054,7 +3061,7 @@ format = "[$symbol$environment](dimmed blue) "
## Status ## Status
O módulo `status` exibe o código de saída do comando anterior. If $success_symbol is empty (default), the module will be shown only if the exit code is not `0`. The status code will cast to a signed 32-bit integer. O módulo `status` exibe o código de saída do comando anterior. Se o $success_symbol estiver vazio (padrão), o módulo será exibido apenas se o código de saída não for `0.`. O código de status será convertido em um inteiro de 32 bits signed.
::: tip ::: tip
@ -3163,7 +3170,7 @@ disabled = false
## Swift ## Swift
Por padrão o módulo `swift` vai exibir a versão atual instalada do [Swift](https://swift.org/). O módulo será mostrado se alguma das seguintes condições for atendida: Por padrão o módulo `swift` vai exibir a versão atual instalada do [Swift](https://swift.org/). O módulo vai exibir se algumas das condições a seguir for atendida:
- O diretório atual tenha um arquivo `Package.swift` - O diretório atual tenha um arquivo `Package.swift`
- O diretório atual tenha um arquivo com a extensão `.swift` - O diretório atual tenha um arquivo com a extensão `.swift`
@ -3307,9 +3314,9 @@ time_range = "10:00:00-14:00:00"
## Username ## Username
O módulo `username` exibe o username do usuário ativo. O módulo será mostrado se alguma das seguintes condições for atendida: O módulo `username` exibe o username do usuário ativo. O módulo vai exibir se algumas das condições a seguir for atendida:
- The current user is root/admin - O usuário atual é root/admin
- O usuário atual não é o mesmo que está logado - O usuário atual não é o mesmo que está logado
- O usuário atual esta conectado em uma sessão SSH - O usuário atual esta conectado em uma sessão SSH
- A variável `show_always` esta definida como true - A variável `show_always` esta definida como true
@ -3322,13 +3329,13 @@ Conexões SSH são detectadas checando as variáveis de ambiente `SSH_CONNECTION
### Opções ### Opções
| Opções | Padrão | Descrição | | Opções | Padrão | Descrição |
| ------------- | ----------------------- | ------------------------------------------- | | ------------- | ----------------------- | --------------------------------------------- |
| `style_root` | `"bold red"` | The style used when the user is root/admin. | | `style_root` | `"bold red"` | O estilo usado quando o usuário é root/admin. |
| `style_user` | `"bold yellow"` | O estilo usado para usuários não root. | | `style_user` | `"bold yellow"` | O estilo usado para usuários não root. |
| `format` | `"[$user]($style) in "` | O formato do módulo. | | `format` | `"[$user]($style) in "` | O formato do módulo. |
| `show_always` | `false` | Sempre exibe o módulo `username`. | | `show_always` | `false` | Sempre exibe o módulo `username`. |
| `disabled` | `false` | Desabilita o módulo `username`. | | `disabled` | `false` | Desabilita o módulo `username`. |
### Variáveis ### Variáveis
@ -3458,7 +3465,7 @@ format = "[🆅 $repo](bold blue) "
## Zig ## Zig
Por padrão o módulo `zig` exibe a versão atual instalada do [Zig](https://ziglang.org/). O módulo será mostrado se alguma das seguintes condições for atendida: 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:
- O diretório atual contém arquivo com a extensão `.zig` - O diretório atual contém arquivo com a extensão `.zig`
@ -3500,9 +3507,9 @@ O módulo `custom` exibe a saída de alguns comandos arbitrários.
Este módulo vai ser exibir se algumas das condições a seguir for atendida: Este módulo vai ser exibir se algumas das condições a seguir for atendida:
- The current directory contains a file whose name is in `detect_files` - O diretório atual contém um arquivo cujo nome está em `detect_files`
- The current directory contains a directory whose name is in `detect_folders` - O diretório atual contém um diretório cujo nome está em `detect_folders`
- The current directory contains a file whose extension is in `detect_extensions` - O diretório atual contém um arquivo cuja extensão está em `detect_extensions`
- O comando `when` retorna 0 - O comando `when` retorna 0
- O sistema operacional (std::env::consts::OS) corresponde com o `os` se definido. - O sistema operacional (std::env::consts::OS) corresponde com o `os` se definido.
@ -3534,22 +3541,22 @@ Strings de formatação também podem conter sequencias de prompt especificas de
### Opções ### Opções
| Opções | Padrão | Descrição | | Opções | Padrão | Descrição |
| ------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------- | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `command` | `""` | O comando cuja a saída deve ser exibida. O comando será passado no stdin para o shell. | | `command` | `""` | O comando cuja a saída deve ser exibida. O comando será passado no stdin para o shell. |
| `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. | | `when` | `false` | Ou um valor booleano (`true` ou `false`, sem aspas) ou um comando shell de string usado como condição para mostrar o módulo. No caso de uma string, o módulo será mostrado se o comando retornar um código de status `0`. |
| `shell` | | [Veja abaixo](#custom-command-shell) | | `shell` | | [Veja abaixo](#custom-command-shell) |
| `description` | `"<custom module>"` | A descrição do módulo, isto será exibido quando executar `starship explain`. | | `description` | `"<custom module>"` | A descrição do módulo, isto será exibido quando executar `starship explain`. |
| `detect_files` | `[]` | Os arquivos que serão buscados por correspondência no diretório atual. | | `detect_files` | `[]` | Os arquivos que serão buscados por correspondência no diretório atual. |
| `detect_folders` | `[]` | Os diretórios que serão buscados por correspondência no diretório atual. | | `detect_folders` | `[]` | Os diretórios que serão buscados por correspondência no diretório atual. |
| `detect_extensions` | `[]` | As extensões que serão buscadas por correspondência no diretório atual. | | `detect_extensions` | `[]` | As extensões que serão buscadas por correspondência no diretório atual. |
| `symbol` | `""` | O simbolo usado antes de exibir a saída do comando. | | `symbol` | `""` | O simbolo usado antes de exibir a saída do comando. |
| `style` | `"bold green"` | O estilo do módulo. | | `style` | `"bold green"` | O estilo do módulo. |
| `format` | `"[$symbol($output )]($style)"` | O formato do módulo. | | `format` | `"[$symbol($output )]($style)"` | O formato do módulo. |
| `disabled` | `false` | Desabilita este módulo `custom`. | | `disabled` | `false` | Desabilita este módulo `custom`. |
| `os` | | Nome do sistema operacional onde módulo sera exibido (unix, linux, macos, windows, ... ) [Veja os possíveis valores](https://doc.rust-lang.org/std/env/consts/constant.OS.html). | | `os` | | Nome do sistema operacional onde módulo sera exibido (unix, linux, macos, windows, ... ) [Veja os possíveis valores](https://doc.rust-lang.org/std/env/consts/constant.OS.html). |
| `use_stdin` | | An optional boolean value that overrides whether commands should be forwarded to the shell via the standard input or as an argument. If unset standard input is used by default, unless the shell does not support it (cmd, nushell). Setting this disables shell-specific argument handling. | | `use_stdin` | | Um valor booleano opcional que substitui se os comandos devem ser encaminhados para o shell por meio da entrada padrão ou como um argumento. Se a entrada padrão não definida for usada por padrão, a menos que o shell não a suporte (cmd, nushell). Configurar isso desativa a manipulação de argumentos específicos do shell. |
| `ignore_timeout` | `false` | Ignore global `command_timeout` setting and keep running external commands, no matter how long they take. | | `ignore_timeout` | `false` | Ignora a configuração global do `command_timeout` e continua executando comandos externos, não importa quanto tempo eles demorem. |
### Variáveis ### Variáveis
@ -3572,7 +3579,7 @@ Se não definido, ele retornará para o STARSHIP_SHELl e então para o "sh" no L
O `command` será passado no stdin. O `command` será passado no stdin.
Se o `shell` não for dado ou apenas conter um elemento e o Starship detectar PowerShell ele será usado, os seguintes argumentos serão automaticamente adicionados: `-NoProfile -Command -`. If `shell` is not given or only contains one element and Starship detects Cmd will be used, the following argument will automatically be added: `/C` and `stdin` will be set to `false`. If `shell` is not given or only contains one element and Starship detects Nushell will be used, the following arguments will automatically be added: `-c` and `stdin` will be set to `false`. This behavior can be avoided by explicitly passing arguments to the shell, e.g. Se o `shell` não for dado ou apenas conter um elemento e o Starship detectar PowerShell ele será usado, os seguintes argumentos serão automaticamente adicionados: `-NoProfile -Command -`. Se `shell` não for fornecido ou contiver apenas um elemento e o Starship detectar que o Cmd será usado, o seguinte argumento será adicionado automaticamente: `/C` e `stdin` serão definidos como `false`. Se `shell` não for fornecido ou contiver apenas um elemento e o Starship detectar que o Nushell será usado, os seguintes argumentos serão adicionados automaticamente: `-c` e `stdin` serão definidos como `false`. Este comportamento pode ser evitado passando explicitamente argumento para o shell, ex.
```toml ```toml
shell = ["pwsh", "-Command", "-"] shell = ["pwsh", "-Command", "-"]

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

@ -326,21 +326,20 @@ eval $(starship init ion)
<details> <details>
<summary>Nushell</summary> <summary>Nushell</summary>
Run the following: Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu starship init nu | save ~/.cache/starship/init.nu
``` ```
And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`): E adicione o seguinte ao final da sua configuração do Nushell (encontre-o executando `$nu.config-path`):
```sh ```sh
starship init nu | save ~/.cache/starship/init.nu
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```
Note: Only Nushell v0.60+ is supported Nota: Somente o Nushell v0.61+ é suportado
</details> </details>

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

@ -63,7 +63,7 @@ Ative o modulo `programs.starship` em seu arquivo `home.nix`, e adicione suas co
{ {
programs.starship = { programs.starship = {
enable = true; enable = true;
# Configuration written to ~/.config/starship.toml # Configuração gravada em ~/.config/starship.toml
settings = { settings = {
# add_newline = false; # add_newline = false;

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

@ -120,7 +120,11 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
#### Elvish #### Elvish
::: warning Only elvish v0.18 or higher is supported. ::: ::: warning
Only elvish v0.18 or higher is supported.
:::
Add the following to the end of `~/.elvish/rc.elv`: Add the following to the end of `~/.elvish/rc.elv`:
@ -144,7 +148,13 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
#### Nushell #### Nushell
::: warning This will change in the future. Only Nushell v0.60+ is supported. ::: Run the following: ::: warning
This will change in the future. Only Nushell v0.61+ is supported.
:::
Add the following to to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu starship init nu | save ~/.cache/starship/init.nu
@ -153,8 +163,6 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`): And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):
```sh ```sh
mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```

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

@ -280,16 +280,16 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | | ------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | The format for the module. | | `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)'` | The format for the module. |
| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. | | `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
| `region_aliases` | | Table of region aliases to display in addition to the AWS name. | | `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | | `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. |
| `style` | `"bold yellow"` | The style for the module. | | `style` | `"bold yellow"` | The style for the module. |
| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. | | `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. |
| `disabled` | `false` | Disables the `AWS` module. | | `disabled` | `false` | Disables the `AWS` module. |
| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. | | `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. |
### Variables ### Variables
@ -1140,7 +1140,9 @@ The `env_var` module displays the current value of a selected environment variab
- The `variable` configuration option matches an existing environment variable - The `variable` configuration option matches an existing environment variable
- The `variable` configuration option is not defined, but the `default` configuration option is - The `variable` configuration option is not defined, but the `default` configuration option is
::: tip Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. ::: tip
Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character.
Example: following configuration will display value of USER environment variable Example: following configuration will display value of USER environment variable
@ -1342,17 +1344,17 @@ The `git_branch` module shows the active branch of the repo in your current dire
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| -------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | | -------------------- | ------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | | `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. |
| `format` | `"on [$symbol$branch]($style) "` | The format for the module. Use `"$branch"` to refer to the current branch name. | | `format` | `"on [$symbol$branch(:$remote_branch)]($style) "` | The format for the module. Use `"$branch"` to refer to the current branch name. |
| `symbol` | `" "` | A format string representing the symbol of git branch. | | `symbol` | `" "` | A format string representing the symbol of git branch. |
| `style` | `"bold purple"` | The style for the module. | | `style` | `"bold purple"` | The style for the module. |
| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | | `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. |
| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. | | `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. |
| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | | `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". | | `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for "master" or "main". |
| `disabled` | `false` | Disables the `git_branch` module. | | `disabled` | `false` | Disables the `git_branch` module. |
### Variables ### Variables
@ -1602,6 +1604,7 @@ The `golang` module shows the currently installed version of [Go](https://golang
- The current directory contains a `go.mod` file - The current directory contains a `go.mod` file
- The current directory contains a `go.sum` file - The current directory contains a `go.sum` file
- The current directory contains a `go.work` file
- The current directory contains a `glide.yaml` file - The current directory contains a `glide.yaml` file
- The current directory contains a `Gopkg.yml` file - The current directory contains a `Gopkg.yml` file
- The current directory contains a `Gopkg.lock` file - The current directory contains a `Gopkg.lock` file
@ -1611,16 +1614,16 @@ The `golang` module shows the currently installed version of [Go](https://golang
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. | | `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
| `detect_extensions` | `["go"]` | Which extensions should trigger this module. | | `detect_extensions` | `["go"]` | Which extensions should trigger this module. |
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. | | `detect_files` | `["go.mod", "go.sum", "go.work", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `["Godeps"]` | Which folders should trigger this module. | | `detect_folders` | `["Godeps"]` | Which folders should trigger this module. |
| `style` | `"bold cyan"` | The style for the module. | | `style` | `"bold cyan"` | The style for the module. |
| `disabled` | `false` | Disables the `golang` module. | | `disabled` | `false` | Disables the `golang` module. |
### Variables ### Variables
@ -1719,20 +1722,22 @@ The `hostname` module shows the system hostname.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | | ------------ | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `ssh_only` | `true` | Only show hostname when connected to an SSH session. | | `ssh_only` | `true` | Only show hostname when connected to an SSH session. |
| `trim_at` | `"."` | String that the hostname is cut off at, after the first match. `"."` will stop after the first dot. `""` will disable any truncation | | `ssh_symbol` | `"🌐 "` | A format string representing the symbol when connected to SSH session. |
| `format` | `"[$hostname]($style) in "` | The format for the module. | | `trim_at` | `"."` | String that the hostname is cut off at, after the first match. `"."` will stop after the first dot. `""` will disable any truncation |
| `style` | `"bold dimmed green"` | The style for the module. | | `format` | `"[$ssh_symbol$hostname]($style) in "` | The format for the module. |
| `disabled` | `false` | Disables the `hostname` module. | | `style` | `"bold dimmed green"` | The style for the module. |
| `disabled` | `false` | Disables the `hostname` module. |
### Variables ### Variables
| Variable | Example | Description | | Variable | Example | Description |
| --------- | ---------- | ----------------------------------- | | ---------- | ---------- | ----------------------------------------------------- |
| hostname | `computer` | The hostname of the computer | | hostname | `computer` | The hostname of the computer |
| style\* | | Mirrors the value of option `style` | | style\* | | Mirrors the value of option `style` |
| ssh_symbol | `"🌏 "` | The symbol to represent when connected to SSH session |
*: This variable can only be used as a part of a style string *: This variable can only be used as a part of a style string
@ -1743,7 +1748,7 @@ The `hostname` module shows the system hostname.
[hostname] [hostname]
ssh_only = false ssh_only = false
format = "on [$hostname](bold red) " format = "[$ssh_symbol](bold blue) on [$hostname](bold red) "
trim_at = ".companyname.com" trim_at = ".companyname.com"
disabled = false disabled = false
``` ```
@ -2383,22 +2388,22 @@ symbol = "☁️ "
## Package Version ## Package Version
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `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` 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 - [**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 - [**Cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
- [**Nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command - [**Nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command
- [**Poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory - [**Poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
- [**Python**](https://www.python.org) - The `python` package version is extracted from the `setup.cfg` present in the current directory - [**Python**](https://www.python.org) - The `python` package version is extracted from a [PEP 621](https://peps.python.org/pep-0621/) compliant `pyproject.toml` or a `setup.cfg` present in the current directory
- [**Composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory - [**Composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory
- [**Gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present - [**Gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present in the current directory
- [**Julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present - [**Julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present in the current directory
- [**Mix**](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present - [**Mix**](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present in the current directory
- [**Helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present - [**Helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present in the current directory
- [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present - [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory
- [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present - [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present - [**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 - [**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 - [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory
- [**Dart**](https://pub.dev/) - The `dart` package version is extracted from the `pubspec.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
@ -2845,11 +2850,13 @@ By default the `rust` module shows the currently installed version of [Rust](htt
### Variables ### Variables
| Variable | Example | Description | | Variable | Example | Description |
| --------- | ----------------- | ------------------------------------ | | --------- | ----------------- | -------------------------------------------- |
| version | `v1.43.0-nightly` | The version of `rustc` | | version | `v1.43.0-nightly` | The version of `rustc` |
| symbol | | Mirrors the value of option `symbol` | | numver | `1.51.0` | The numeric component of the `rustc` version |
| style\* | | Mirrors the value of option `style` | | toolchain | `beta` | The toolchain version |
| 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 *: This variable can only be used as a part of a style string

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

@ -326,7 +326,7 @@ eval $(starship init ion)
<details> <details>
<summary>Nushell</summary> <summary>Nushell</summary>
Run the following: Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
@ -336,11 +336,10 @@ 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`): And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):
```sh ```sh
starship init nu | save ~/.cache/starship/init.nu
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```
Note: Only Nushell v0.60+ is supported Note: Only Nushell v0.61+ is supported
</details> </details>

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

@ -120,7 +120,11 @@ description: Starship - минимальная, быстрая и бесконе
#### Elvish #### Elvish
::: warning Поддерживается только elvish v0.18 или выше. ::: ::: warning
Only elvish v0.18 or higher is supported.
:::
Добавьте следующую строку в конец `~/.elvish/rc.elv`: Добавьте следующую строку в конец `~/.elvish/rc.elv`:
@ -144,7 +148,13 @@ description: Starship - минимальная, быстрая и бесконе
#### Nushell #### Nushell
::: warning Это будет изменено. Only Nushell v0.60+ is supported. ::: Run the following: ::: warning
This will change in the future. Only Nushell v0.61+ is supported.
:::
Add the following to to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu starship init nu | save ~/.cache/starship/init.nu
@ -153,8 +163,6 @@ description: Starship - минимальная, быстрая и бесконе
And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`): And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):
```sh ```sh
mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```

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

@ -280,16 +280,16 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL
### Опции ### Опции
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | | ------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | Формат модуля. | | `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)'` | Формат модуля. |
| `symbol` | `"☁️ "` | Символ перед отображением текущего профиля AWS. | | `symbol` | `"☁️ "` | Символ перед отображением текущего профиля AWS. |
| `region_aliases` | | Таблица региона псевдонимов, отображаемая вместе с именем AWS. | | `region_aliases` | | Таблица региона псевдонимов, отображаемая вместе с именем AWS. |
| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | | `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. |
| `style` | `"bold yellow"` | Стиль модуля. | | `style` | `"bold yellow"` | Стиль модуля. |
| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. | | `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. |
| `disabled` | `false` | Отключение модуля `AWS`. | | `disabled` | `false` | Отключение модуля `AWS`. |
| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. | | `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. |
### Переменные ### Переменные
@ -1140,7 +1140,9 @@ The `env_var` module displays the current value of a selected environment variab
- Опция `variable` соответствует существующей переменной среды - Опция `variable` соответствует существующей переменной среды
- Опция `variable` не определена, но определена опция `default` - Опция `variable` не определена, но определена опция `default`
::: tip Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. ::: tip Подсказка
Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character.
Example: following configuration will display value of USER environment variable Example: following configuration will display value of USER environment variable
@ -1342,17 +1344,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. | | `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. |
| `format` | `"on [$symbol$branch]($style) "` | Формат модуля. Use `"$branch"` to refer to the current branch name. | | `format` | `"on [$symbol$branch(:$remote_branch)]($style) "` | Формат модуля. Use `"$branch"` to refer to the current branch name. |
| `symbol` | `" "` | A format string representing the symbol of git branch. | | `symbol` | `" "` | A format string representing the symbol of git branch. |
| `style` | `"bold purple"` | Стиль модуля. | | `style` | `"bold purple"` | Стиль модуля. |
| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | | `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. |
| `truncation_symbol` | `"…"` | Символ, используемый для обозначения усечения названия ветки. You can use `""` for no symbol. | | `truncation_symbol` | `"…"` | Символ, используемый для обозначения усечения названия ветки. You can use `""` for no symbol. |
| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | | `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". | | `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for "master" or "main". |
| `disabled` | `false` | Отключает модуль `git_branch`. | | `disabled` | `false` | Отключает модуль `git_branch`. |
### Переменные ### Переменные
@ -1602,6 +1604,7 @@ The `golang` module shows the currently installed version of [Go](https://golang
- Текущий каталог содержит файл `go.mod` - Текущий каталог содержит файл `go.mod`
- Текущий каталог содержит файл `go.sum` - Текущий каталог содержит файл `go.sum`
- Текущий каталог содержит файл `go.work`
- Текущий каталог содержит файл `glide.yaml` - Текущий каталог содержит файл `glide.yaml`
- Текущий каталог содержит файл `Gopkg.yml` - Текущий каталог содержит файл `Gopkg.yml`
- Текущий каталог содержит файл `Gopkg.lock` - Текущий каталог содержит файл `Gopkg.lock`
@ -1611,16 +1614,16 @@ The `golang` module shows the currently installed version of [Go](https://golang
### Опции ### Опции
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| ------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | | `format` | `"via [$symbol($version )]($style)"` | Формат модуля. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. | | `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
| `detect_extensions` | `["go"]` | Which extensions should trigger this module. | | `detect_extensions` | `["go"]` | Which extensions should trigger this module. |
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. | | `detect_files` | `["go.mod", "go.sum", "go.work", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `["Godeps"]` | Which folders should trigger this module. | | `detect_folders` | `["Godeps"]` | Which folders should trigger this module. |
| `style` | `"bold cyan"` | Стиль модуля. | | `style` | `"bold cyan"` | Стиль модуля. |
| `disabled` | `false` | Отключает модуль `golang`. | | `disabled` | `false` | Отключает модуль `golang`. |
### Переменные ### Переменные
@ -1719,20 +1722,22 @@ format = "via [⎈ $version](bold white) "
### Опции ### Опции
| Параметр | По умолчанию | Описание | | Параметр | По умолчанию | Описание |
| ---------- | --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | ------------ | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- |
| `ssh_only` | `true` | Показывать имя хоста только при подключении к SSH-сессии. | | `ssh_only` | `true` | Показывать имя хоста только при подключении к SSH-сессии. |
| `trim_at` | `"."` | Строка, по которую имя хоста будет сокращено после первого совпадения. `"."` остановится после первой точки. `"` отключит любое усечение | | `ssh_symbol` | `"🌐 "` | A format string representing the symbol when connected to SSH session. |
| `format` | `"[$hostname]($style) in "` | Формат модуля. | | `trim_at` | `"."` | Строка, по которую имя хоста будет сокращено после первого совпадения. `"."` остановится после первой точки. `"` отключит любое усечение |
| `style` | `"bold dimmed green"` | Стиль модуля. | | `format` | `"[$ssh_symbol$hostname]($style) in "` | Формат модуля. |
| `disabled` | `false` | Отключает модуль `hostname`. | | `style` | `"bold dimmed green"` | Стиль модуля. |
| `disabled` | `false` | Отключает модуль `hostname`. |
### Переменные ### Переменные
| Переменная | Пример | Описание | | Переменная | Пример | Описание |
| ---------- | ---------- | ----------------------------------- | | ---------- | ---------- | ----------------------------------------------------- |
| имя хоста | `computer` | The hostname of the computer | | имя хоста | `computer` | The hostname of the computer |
| style\* | | Отражает значение параметра `style` | | style\* | | Отражает значение параметра `style` |
| ssh_symbol | `"🌏 "` | The symbol to represent when connected to SSH session |
*: Эта переменная может использоваться только в качестве части строки style *: Эта переменная может использоваться только в качестве части строки style
@ -1743,7 +1748,7 @@ format = "via [⎈ $version](bold white) "
[hostname] [hostname]
ssh_only = false ssh_only = false
format = "on [$hostname](bold red) " format = "[$ssh_symbol](bold blue) on [$hostname](bold red) "
trim_at = ".companyname.com" trim_at = ".companyname.com"
disabled = false disabled = false
``` ```
@ -2383,22 +2388,22 @@ symbol = "☁️ "
## Версия пакета ## Версия пакета
Модуль `package` отображается, когда текущий каталог является репозиторием для пакета и показывает его текущую версию. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `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` 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 - [**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 - [**Cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
- [**Nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command - [**Nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command
- [**Poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory - [**Poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
- [**Python**](https://www.python.org) - The `python` package version is extracted from the `setup.cfg` present in the current directory - [**Python**](https://www.python.org) - The `python` package version is extracted from a [PEP 621](https://peps.python.org/pep-0621/) compliant `pyproject.toml` or a `setup.cfg` present in the current directory
- [**Composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory - [**Composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory
- [**Gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present - [**Gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present in the current directory
- [**Julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present - [**Julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present in the current directory
- [**Mix**](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present - [**Mix**](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present in the current directory
- [**Helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present - [**Helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present in the current directory
- [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present - [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory
- [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present - [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present - [**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 - [**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 - [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory
- [**Dart**](https://pub.dev/) - The `dart` package version is extracted from the `pubspec.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
@ -2845,11 +2850,13 @@ By default the `rust` module shows the currently installed version of [Rust](htt
### Переменные ### Переменные
| Переменная | Пример | Описание | | Переменная | Пример | Описание |
| ---------- | ----------------- | ------------------------------------ | | ---------- | ----------------- | -------------------------------------------- |
| version | `v1.43.0-nightly` | The version of `rustc` | | version | `v1.43.0-nightly` | The version of `rustc` |
| symbol | | Отражает значение параметра `symbol` | | numver | `1.51.0` | The numeric component of the `rustc` version |
| style\* | | Отражает значение параметра `style` | | toolchain | `beta` | The toolchain version |
| symbol | | Отражает значение параметра `symbol` |
| style\* | | Отражает значение параметра `style` |
*: Эта переменная может использоваться только в качестве части строки style *: Эта переменная может использоваться только в качестве части строки style

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

@ -326,7 +326,7 @@ eval $(starship init ion)
<details> <details>
<summary>Nushell</summary> <summary>Nushell</summary>
Run the following: Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
@ -336,11 +336,10 @@ 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`): And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):
```sh ```sh
starship init nu | save ~/.cache/starship/init.nu
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```
Note: Only Nushell v0.60+ is supported Note: Only Nushell v0.61+ is supported
</details> </details>

36
docs/tr-TR/README.md
View File

@ -2,7 +2,7 @@
home: true home: true
heroImage: /logo.svg heroImage: /logo.svg
heroText: heroText:
tagline: The minimal, blazing-fast, and infinitely customizable prompt for any shell! tagline: Sade, hızlı, dilediğiniz gibi özelleştirilebilen ve istenilen shell'de kullanılabilen prompt!
actionText: Get Started → actionText: Get Started →
actionLink: ./guide/ actionLink: ./guide/
features: features:
@ -67,7 +67,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
#### Bash #### Bash
Add the following to the end of `~/.bashrc`: `~/.bashrc` dosyasının sonuna ekleyin:
```sh ```sh
# ~/.bashrc # ~/.bashrc
@ -78,7 +78,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
#### Fish #### Fish
Add the following to the end of `~/.config/fish/config.fish`: `~/.config/fish/config.fish` dosyasının sonuna ekleyin:
```sh ```sh
# ~/.config/fish/config.fish # ~/.config/fish/config.fish
@ -89,7 +89,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
#### Zsh #### Zsh
Add the following to the end of `~/.zshrc`: `~/.zshrc` dosyasının sonuna ekleyin:
```sh ```sh
# ~/.zshrc # ~/.zshrc
@ -109,7 +109,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
#### Ion #### Ion
Add the following to the end of `~/.config/ion/initrc`: `~/.config/ion/initrc` dosyasının sonuna ekleyin:
```sh ```sh
# ~/.config/ion/initrc # ~/.config/ion/initrc
@ -120,9 +120,13 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
#### Elvish #### Elvish
::: warning Only elvish v0.18 or higher is supported. ::: ::: uyarı
Add the following to the end of `~/.elvish/rc.elv`: Only elvish v0.18 or higher is supported.
:::
`~/.elvish/rc.elv` dosyasının sonuna ekleyin:
```sh ```sh
# ~/.elvish/rc.elv # ~/.elvish/rc.elv
@ -133,7 +137,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
#### Tcsh #### Tcsh
Add the following to the end of `~/.tcshrc`: `~/.tcshrc` dosyasının sonuna ekleyın:
```sh ```sh
# ~/.tcshrc # ~/.tcshrc
@ -144,23 +148,27 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
#### Nushell #### Nushell
::: warning This will change in the future. Only Nushell v0.60+ is supported. ::: Run the following: ::: uyarı
This will change in the future. Only Nushell v0.61+ is supported.
:::
Add the following to to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu starship init nu | save ~/.cache/starship/init.nu
``` ```
And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`): Aşağıdaki kodu Nushell ayarlarınızın (`$nu.config-path` komutu ile ulaşabilirsiniz) sonuna ekleyin:
```sh ```sh
mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```
#### Xonsh #### Xonsh
Add the following to the end of `~/.xonshrc`: `~/.xonshrc` dosyasının sonuna ekleyin:
```sh ```sh
# ~/.xonshrc # ~/.xonshrc
@ -171,7 +179,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
#### Cmd #### Cmd
You need to use [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) with Cmd. Add the following to a file `starship.lua` and place this file in Clink scripts directory: Cmd ıle beraber [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) kullanmalısınız. Add the following to a file `starship.lua` and place this file in Clink scripts directory:
```lua ```lua
-- starship.lua -- starship.lua

263
docs/tr-TR/config/README.md
View File

@ -280,16 +280,16 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | | ------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | The format for the module. | | `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)'` | The format for the module. |
| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. | | `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. |
| `region_aliases` | | Table of region aliases to display in addition to the AWS name. | | `region_aliases` | | Table of region aliases to display in addition to the AWS name. |
| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | | `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. |
| `style` | `"bold yellow"` | The style for the module. | | `stil` | `"bold yellow"` | The style for the module. |
| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. | | `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. |
| `disabled` | `false` | Disables the `AWS` module. | | `disabled` | `false` | Disables the `AWS` module. |
| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. | | `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. |
### Variables ### Variables
@ -358,7 +358,7 @@ The `azure` module shows the current Azure Subscription. This is based on showin
| ---------- | ---------------------------------------- | ------------------------------------------ | | ---------- | ---------------------------------------- | ------------------------------------------ |
| `format` | `"on [$symbol($subscription)]($style) "` | The format for the Azure module to render. | | `format` | `"on [$symbol($subscription)]($style) "` | The format for the Azure module to render. |
| `symbol` | `"ﴃ "` | The symbol used in the format. | | `symbol` | `"ﴃ "` | The symbol used in the format. |
| `style` | `"blue bold"` | The style used in the format. | | `stil` | `"blue bold"` | The style used in the format. |
| `disabled` | `true` | Disables the `azure` module. | | `disabled` | `true` | Disables the `azure` module. |
### Example ### Example
@ -420,7 +420,7 @@ The `display` option is an array of the following table.
| Option | Default | Description | | Option | Default | Description |
| -------------------- | ---------- | --------------------------------------------------------------------------------------------------------- | | -------------------- | ---------- | --------------------------------------------------------------------------------------------------------- |
| `threshold` | `10` | The upper bound for the display option. | | `threshold` | `10` | The upper bound for the display option. |
| `style` | `bold red` | The style used if the display option is in use. | | `stil` | `bold red` | The style used if the display option is in use. |
| `charging_symbol` | `-` | Optional symbol displayed if display option is in use, defaults to battery's `charging_symbol` option. | | `charging_symbol` | `-` | Optional symbol displayed if display option is in use, defaults to battery's `charging_symbol` option. |
| `discharging_symbol` | `-` | Optional symbol displayed if display option is in use, defaults to battery's `discharging_symbol` option. | | `discharging_symbol` | `-` | Optional symbol displayed if display option is in use, defaults to battery's `discharging_symbol` option. |
@ -456,7 +456,7 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil
| `detect_extensions` | `[]` | Which extensions should trigger this module. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `detect_files` | `["buf.yaml", "buf.gen.yaml", "buf.work.yaml"]` | Which filenames should trigger this module. | | `detect_files` | `["buf.yaml", "buf.gen.yaml", "buf.work.yaml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `style` | `"bold blue"` | The style for the module. | | `stil` | `"bold blue"` | The style for the module. |
| `disabled` | `false` | Disables the `elixir` module. | | `disabled` | `false` | Disables the `elixir` module. |
### Variables ### Variables
@ -493,7 +493,7 @@ The `c` module shows some information about your C compiler. By default the modu
| `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. |
| `commands` | [ [ "cc", "--version" ], [ "gcc", "--version" ], [ "clang", "--version" ] ] | How to detect what the compiler is | | `commands` | [ [ "cc", "--version" ], [ "gcc", "--version" ], [ "clang", "--version" ] ] | How to detect what the compiler is |
| `style` | `"bold 149"` | The style for the module. | | `stil` | `"bold 149"` | The style for the module. |
| `disabled` | `false` | Disables the `c` module. | | `disabled` | `false` | Disables the `c` module. |
### Variables ### Variables
@ -503,7 +503,7 @@ The `c` module shows some information about your C compiler. By default the modu
| name | clang | The name of the compiler | | name | clang | The name of the compiler |
| version | 13.0.0 | The version of the compiler | | version | 13.0.0 | The version of the compiler |
| symbol | | Mirrors the value of option `symbol` | | symbol | | Mirrors the value of option `symbol` |
| style | | Mirrors the value of option `style` | | stil | | Mirrors the value of option `style` |
NB that `version` is not in the default format. NB that `version` is not in the default format.
@ -605,7 +605,7 @@ The `cmake` module shows the currently installed version of [CMake](https://cmak
| `detect_extensions` | `[]` | Which extensions should trigger this module | | `detect_extensions` | `[]` | Which extensions should trigger this module |
| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | | `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module |
| `detect_folders` | `[]` | Which folders should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module |
| `style` | `"bold blue"` | The style for the module. | | `stil` | `"bold blue"` | The style for the module. |
| `disabled` | `false` | Disables the `cmake` module. | | `disabled` | `false` | Disables the `cmake` module. |
### Variables ### Variables
@ -632,7 +632,7 @@ The `cobol` module shows the currently installed version of COBOL. By default, t
| `symbol` | `"⚙️ "` | The symbol used before displaying the version of COBOL. | | `symbol` | `"⚙️ "` | The symbol used before displaying the version of COBOL. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `style` | `"bold blue"` | The style for the module. | | `stil` | `"bold blue"` | The style for the module. |
| `detect_extensions` | `["cbl", "cob", "CBL", "COB"]` | Which extensions should trigger this module. | | `detect_extensions` | `["cbl", "cob", "CBL", "COB"]` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. |
@ -667,7 +667,7 @@ Bash users who need preexec-like functionality can use [rcaloras's bash_preexec
| `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). | | `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). |
| `show_milliseconds` | `false` | Show milliseconds in addition to seconds for the duration. | | `show_milliseconds` | `false` | Show milliseconds in addition to seconds for the duration. |
| `format` | `"took [$duration]($style) "` | The format for the module. | | `format` | `"took [$duration]($style) "` | The format for the module. |
| `style` | `"bold yellow"` | The style for the module. | | `stil` | `"bold yellow"` | The style for the module. |
| `disabled` | `false` | Disables the `cmd_duration` module. | | `disabled` | `false` | Disables the `cmd_duration` module. |
| `show_notifications` | `false` | Show desktop notifications when command completes. | | `show_notifications` | `false` | Show desktop notifications when command completes. |
| `min_time_to_notify` | `45_000` | Shortest duration for notification (in milliseconds). | | `min_time_to_notify` | `45_000` | Shortest duration for notification (in milliseconds). |
@ -708,7 +708,7 @@ This does not suppress conda's own prompt modifier, you may want to run `conda c
| ------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `truncation_length` | `1` | The number of directories the environment path should be truncated to, if the environment was created via `conda create -p [path]`. `0` means no truncation. Also see the [`directory`](#directory) module. | | `truncation_length` | `1` | The number of directories the environment path should be truncated to, if the environment was created via `conda create -p [path]`. `0` means no truncation. Also see the [`directory`](#directory) module. |
| `symbol` | `"🅒 "` | The symbol used before the environment name. | | `symbol` | `"🅒 "` | The symbol used before the environment name. |
| `style` | `"bold green"` | The style for the module. | | `stil` | `"bold green"` | The style for the module. |
| `format` | `"via [$symbol$environment]($style) "` | The format for the module. | | `format` | `"via [$symbol$environment]($style) "` | The format for the module. |
| `ignore_base` | `true` | Ignores `base` environment when activated. | | `ignore_base` | `true` | Ignores `base` environment when activated. |
| `disabled` | `false` | Disables the `conda` module. | | `disabled` | `false` | Disables the `conda` module. |
@ -741,7 +741,7 @@ The `container` module displays a symbol and container name, if inside a contain
| Option | Default | Description | | Option | Default | Description |
| ---------- | -------------------------------------- | ----------------------------------------- | | ---------- | -------------------------------------- | ----------------------------------------- |
| `symbol` | `"⬢"` | The symbol shown, when inside a container | | `symbol` | `"⬢"` | The symbol shown, when inside a container |
| `style` | `"bold red dimmed"` | The style for the module. | | `stil` | `"bold red dimmed"` | The style for the module. |
| `format` | `"[$symbol \\[$name\\]]($style) "` | The format for the module. | | `format` | `"[$symbol \\[$name\\]]($style) "` | The format for the module. |
| `disabled` | `false` | Disables the `container` module. | | `disabled` | `false` | Disables the `container` module. |
@ -778,7 +778,7 @@ The `crystal` module shows the currently installed version of [Crystal](https://
| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | | `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `style` | `"bold red"` | The style for the module. | | `stil` | `"bold red"` | The style for the module. |
| `detect_extensions` | `["cr"]` | Which extensions should trigger this module. | | `detect_extensions` | `["cr"]` | Which extensions should trigger this module. |
| `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. | | `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. |
@ -821,7 +821,7 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d
| `detect_extensions` | `["dart"]` | Which extensions should trigger this module. | | `detect_extensions` | `["dart"]` | Which extensions should trigger this module. |
| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. | | `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Which filenames should trigger this module. |
| `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. | | `detect_folders` | `[".dart_tool"]` | Which folders should trigger this module. |
| `style` | `"bold blue"` | The style for the module. | | `stil` | `"bold blue"` | The style for the module. |
| `disabled` | `false` | Disables the `dart` module. | | `disabled` | `false` | Disables the `dart` module. |
### Variables ### Variables
@ -859,7 +859,7 @@ The `deno` module shows you your currently installed version of [Deno](https://d
| `detect_extensions` | `[]` | Which extensions should trigger this module. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `detect_files` | `["deno.json", "deno.jsonc", "mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. | | `detect_files` | `["deno.json", "deno.jsonc", "mod.ts", "mod.js", "deps.ts", "deps.js"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"green bold"` | The style for the module. | | `stil` | `"green bold"` | The style for the module. |
| `disabled` | `false` | Disables the `deno` module. | | `disabled` | `false` | Disables the `deno` module. |
### Variables ### Variables
@ -894,7 +894,7 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an
| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. | | `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. |
| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. | | `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. |
| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | The format for the module. | | `format` | `"[$path]($style)[$read_only]($read_only_style) "` | The format for the module. |
| `style` | `"bold cyan"` | The style for the module. | | `stil` | `"bold cyan"` | The style for the module. |
| `disabled` | `false` | Disables the `directory` module. | | `disabled` | `false` | Disables the `directory` module. |
| `read_only` | `"🔒"` | The symbol indicating current directory is read only. | | `read_only` | `"🔒"` | The symbol indicating current directory is read only. |
| `read_only_style` | `"red"` | The style for the read only symbol. | | `read_only_style` | `"red"` | The style for the read only symbol. |
@ -944,7 +944,7 @@ Let us consider the path `/path/to/home/git_repo/src/lib`
| before_root_path | `"/path/to/home/"` | The path before git root directory path | | before_root_path | `"/path/to/home/"` | The path before git root directory path |
| repo_root | `"git_repo"` | The git root directory name | | repo_root | `"git_repo"` | The git root directory name |
| path | `"/src/lib"` | The remaining path | | path | `"/src/lib"` | The remaining path |
| style | `"black bold dimmed"` | Mirrors the value of option `style` | | stil | `"black bold dimmed"` | Mirrors the value of option `style` |
| repo_root_style | `"underline white"` | Style for git root directory name | | repo_root_style | `"underline white"` | Style for git root directory name |
</details> </details>
@ -973,7 +973,7 @@ The `docker_context` module shows the currently active [Docker context](https://
| `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). | | `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). |
| `detect_files` | `["docker-compose.yml", "docker-compose.yaml", "Dockerfile"]` | Which filenames should trigger this module (needs `only_with_files` to be true). | | `detect_files` | `["docker-compose.yml", "docker-compose.yaml", "Dockerfile"]` | Which filenames should trigger this module (needs `only_with_files` to be true). |
| `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). | | `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). |
| `style` | `"blue bold"` | The style for the module. | | `stil` | `"blue bold"` | The style for the module. |
| `disabled` | `false` | Disables the `docker_context` module. | | `disabled` | `false` | Disables the `docker_context` module. |
### Variables ### Variables
@ -1027,7 +1027,7 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
| `detect_extensions` | `["csproj", "fsproj", "xproj"]` | Which extensions should trigger this module. | | `detect_extensions` | `["csproj", "fsproj", "xproj"]` | Which extensions should trigger this module. |
| `detect_files` | `["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]` | Which filenames should trigger this module. | | `detect_files` | `["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `style` | `"bold blue"` | The style for the module. | | `stil` | `"bold blue"` | The style for the module. |
| `disabled` | `false` | Disables the `dotnet` module. | | `disabled` | `false` | Disables the `dotnet` module. |
### Variables ### Variables
@ -1068,7 +1068,7 @@ The `elixir` module shows the currently installed version of [Elixir](https://el
| `detect_extensions` | `[]` | Which extensions should trigger this module. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `detect_files` | `["mix.exs"]` | Which filenames should trigger this module. | | `detect_files` | `["mix.exs"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `style` | `"bold purple"` | The style for the module. | | `stil` | `"bold purple"` | The style for the module. |
| `disabled` | `false` | Disables the `elixir` module. | | `disabled` | `false` | Disables the `elixir` module. |
### Variables ### Variables
@ -1111,7 +1111,7 @@ The `elm` module shows the currently installed version of [Elm](https://elm-lang
| `detect_extensions` | `["elm"]` | Which extensions should trigger this module. | | `detect_extensions` | `["elm"]` | Which extensions should trigger this module. |
| `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Which filenames should trigger this module. | | `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `["elm-stuff"]` | Which folders should trigger this modules. | | `detect_folders` | `["elm-stuff"]` | Which folders should trigger this modules. |
| `style` | `"cyan bold"` | The style for the module. | | `stil` | `"cyan bold"` | The style for the module. |
| `disabled` | `false` | Disables the `elm` module. | | `disabled` | `false` | Disables the `elm` module. |
### Variables ### Variables
@ -1140,7 +1140,9 @@ The `env_var` module displays the current value of a selected environment variab
- The `variable` configuration option matches an existing environment variable - The `variable` configuration option matches an existing environment variable
- The `variable` configuration option is not defined, but the `default` configuration option is - The `variable` configuration option is not defined, but the `default` configuration option is
::: tip Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. ::: tip
Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character.
Example: following configuration will display value of USER environment variable Example: following configuration will display value of USER environment variable
@ -1209,7 +1211,7 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https:
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `" "` | The symbol used before displaying the version of erlang. | | `symbol` | `" "` | The symbol used before displaying the version of erlang. |
| `style` | `"bold red"` | The style for the module. | | `stil` | `"bold red"` | The style for the module. |
| `detect_extensions` | `[]` | Which extensions should trigger this module. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `detect_files` | `["rebar.config", "elang.mk"]` | Which filenames should trigger this module. | | `detect_files` | `["rebar.config", "elang.mk"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
@ -1243,7 +1245,7 @@ The `fill` module fills any extra space on the line with a symbol. If multiple `
| Option | Default | Description | | Option | Default | Description |
| ---------- | -------------- | --------------------------------- | | ---------- | -------------- | --------------------------------- |
| `symbol` | `"."` | The symbol used to fill the line. | | `symbol` | `"."` | The symbol used to fill the line. |
| `style` | `"bold black"` | The style for the module. | | `stil` | `"bold black"` | The style for the module. |
| `disabled` | `false` | Disables the `fill` module | | `disabled` | `false` | Disables the `fill` module |
### Example ### Example
@ -1275,7 +1277,7 @@ The `gcloud` module shows the current configuration for [`gcloud`](https://cloud
| `symbol` | `"☁️ "` | The symbol used before displaying the current GCP profile. | | `symbol` | `"☁️ "` | The symbol used before displaying the current GCP profile. |
| `region_aliases` | | Table of region aliases to display in addition to the GCP name. | | `region_aliases` | | Table of region aliases to display in addition to the GCP name. |
| `project_aliases` | | Table of project aliases to display in addition to the GCP name. | | `project_aliases` | | Table of project aliases to display in addition to the GCP name. |
| `style` | `"bold blue"` | The style for the module. | | `stil` | `"bold blue"` | The style for the module. |
| `disabled` | `false` | Disables the `gcloud` module. | | `disabled` | `false` | Disables the `gcloud` module. |
### Variables ### Variables
@ -1342,17 +1344,17 @@ The `git_branch` module shows the active branch of the repo in your current dire
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| -------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | | -------------------- | ------------------------------------------------- | ---------------------------------------------------------------------------------------- |
| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | | `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. |
| `format` | `"on [$symbol$branch]($style) "` | The format for the module. Use `"$branch"` to refer to the current branch name. | | `format` | `"on [$symbol$branch(:$remote_branch)]($style) "` | The format for the module. Use `"$branch"` to refer to the current branch name. |
| `symbol` | `" "` | A format string representing the symbol of git branch. | | `symbol` | `" "` | A format string representing the symbol of git branch. |
| `style` | `"bold purple"` | The style for the module. | | `stil` | `"bold purple"` | The style for the module. |
| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | | `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. |
| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. | | `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. |
| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | | `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". | | `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for "master" or "main". |
| `disabled` | `false` | Disables the `git_branch` module. | | `disabled` | `false` | Disables the `git_branch` module. |
### Variables ### Variables
@ -1388,7 +1390,7 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
| -------------------- | ---------------------------------- | ------------------------------------------------------- | | -------------------- | ---------------------------------- | ------------------------------------------------------- |
| `commit_hash_length` | `7` | The length of the displayed git commit hash. | | `commit_hash_length` | `7` | The length of the displayed git commit hash. |
| `format` | `"[\\($hash$tag\\)]($style) "` | The format for the module. | | `format` | `"[\\($hash$tag\\)]($style) "` | The format for the module. |
| `style` | `"bold green"` | The style for the module. | | `stil` | `"bold green"` | The style for the module. |
| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state | | `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state |
| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. | | `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. |
| `tag_symbol` | `" 🏷 "` | Tag symbol prefixing the info shown | | `tag_symbol` | `" 🏷 "` | Tag symbol prefixing the info shown |
@ -1428,7 +1430,7 @@ The `git_state` module will show in directories which are part of a git reposito
| `bisect` | `"BISECTING"` | A format string displayed when a `bisect` is in progress. | | `bisect` | `"BISECTING"` | A format string displayed when a `bisect` is in progress. |
| `am` | `"AM"` | A format string displayed when an `apply-mailbox` (`git am`) is in progress. | | `am` | `"AM"` | A format string displayed when an `apply-mailbox` (`git am`) is in progress. |
| `am_or_rebase` | `"AM/REBASE"` | A format string displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. | | `am_or_rebase` | `"AM/REBASE"` | A format string displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. |
| `style` | `"bold yellow"` | The style for the module. | | `stil` | `"bold yellow"` | The style for the module. |
| `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | The format for the module. | | `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | The format for the module. |
| `disabled` | `false` | Disables the `git_state` module. | | `disabled` | `false` | Disables the `git_state` module. |
@ -1520,7 +1522,7 @@ The Git Status module is very slow in Windows directories (for example under `/m
| `staged` | `"+"` | The format of `staged` | | `staged` | `"+"` | The format of `staged` |
| `renamed` | `"»"` | The format of `renamed` | | `renamed` | `"»"` | The format of `renamed` |
| `deleted` | `"✘"` | The format of `deleted` | | `deleted` | `"✘"` | The format of `deleted` |
| `style` | `"bold red"` | The style for the module. | | `stil` | `"bold red"` | The style for the module. |
| `ignore_submodules` | `false` | Ignore changes to submodules. | | `ignore_submodules` | `false` | Ignore changes to submodules. |
| `disabled` | `false` | Disables the `git_status` module. | | `disabled` | `false` | Disables the `git_status` module. |
| `windows_starship` | | Use this (Linux) path to a Windows Starship executable to render `git_status` when on Windows paths in WSL. | | `windows_starship` | | Use this (Linux) path to a Windows Starship executable to render `git_status` when on Windows paths in WSL. |
@ -1602,6 +1604,7 @@ The `golang` module shows the currently installed version of [Go](https://golang
- The current directory contains a `go.mod` file - The current directory contains a `go.mod` file
- The current directory contains a `go.sum` file - The current directory contains a `go.sum` file
- The current directory contains a `go.work` file
- The current directory contains a `glide.yaml` file - The current directory contains a `glide.yaml` file
- The current directory contains a `Gopkg.yml` file - The current directory contains a `Gopkg.yml` file
- The current directory contains a `Gopkg.lock` file - The current directory contains a `Gopkg.lock` file
@ -1611,16 +1614,16 @@ The `golang` module shows the currently installed version of [Go](https://golang
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. | | `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
| `detect_extensions` | `["go"]` | Which extensions should trigger this module. | | `detect_extensions` | `["go"]` | Which extensions should trigger this module. |
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. | | `detect_files` | `["go.mod", "go.sum", "go.work", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `["Godeps"]` | Which folders should trigger this module. | | `detect_folders` | `["Godeps"]` | Which folders should trigger this module. |
| `style` | `"bold cyan"` | The style for the module. | | `stil` | `"bold cyan"` | The style for the module. |
| `disabled` | `false` | Disables the `golang` module. | | `disabled` | `false` | Disables the `golang` module. |
### Variables ### Variables
@ -1659,7 +1662,7 @@ By default the module will be shown if any of the following conditions are met:
| `detect_extensions` | `["hs", "cabal", "hs-boot"]` | Which extensions should trigger this module. | | `detect_extensions` | `["hs", "cabal", "hs-boot"]` | Which extensions should trigger this module. |
| `detect_files` | `["stack.yaml", "cabal.project"]` | Which filenames should trigger this module. | | `detect_files` | `["stack.yaml", "cabal.project"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold purple"` | The style for the module. | | `stil` | `"bold purple"` | The style for the module. |
| `disabled` | `false` | Disables the `haskell` module. | | `disabled` | `false` | Disables the `haskell` module. |
### Variables ### Variables
@ -1691,7 +1694,7 @@ The `helm` module shows the currently installed version of [Helm](https://helm.s
| `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | Which filenames should trigger this module. | | `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"⎈ "` | A format string representing the symbol of Helm. | | `symbol` | `"⎈ "` | A format string representing the symbol of Helm. |
| `style` | `"bold white"` | The style for the module. | | `stil` | `"bold white"` | The style for the module. |
| `disabled` | `false` | Disables the `helm` module. | | `disabled` | `false` | Disables the `helm` module. |
### Variables ### Variables
@ -1719,20 +1722,22 @@ The `hostname` module shows the system hostname.
### Options ### Options
| Option | Default | Description | | Option | Default | Description |
| ---------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | | ------------ | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ |
| `ssh_only` | `true` | Only show hostname when connected to an SSH session. | | `ssh_only` | `true` | Only show hostname when connected to an SSH session. |
| `trim_at` | `"."` | String that the hostname is cut off at, after the first match. `"."` will stop after the first dot. `""` will disable any truncation | | `ssh_symbol` | `"🌐 "` | A format string representing the symbol when connected to SSH session. |
| `format` | `"[$hostname]($style) in "` | The format for the module. | | `trim_at` | `"."` | String that the hostname is cut off at, after the first match. `"."` will stop after the first dot. `""` will disable any truncation |
| `style` | `"bold dimmed green"` | The style for the module. | | `format` | `"[$ssh_symbol$hostname]($style) in "` | The format for the module. |
| `disabled` | `false` | Disables the `hostname` module. | | `stil` | `"bold dimmed green"` | The style for the module. |
| `disabled` | `false` | Disables the `hostname` module. |
### Variables ### Variables
| Variable | Example | Description | | Variable | Example | Description |
| --------- | ---------- | ----------------------------------- | | ---------- | ---------- | ----------------------------------------------------- |
| hostname | `computer` | The hostname of the computer | | hostname | `computer` | The hostname of the computer |
| style\* | | Mirrors the value of option `style` | | style\* | | Mirrors the value of option `style` |
| ssh_symbol | `"🌏 "` | The symbol to represent when connected to SSH session |
*: This variable can only be used as a part of a style string *: This variable can only be used as a part of a style string
@ -1743,7 +1748,7 @@ The `hostname` module shows the system hostname.
[hostname] [hostname]
ssh_only = false ssh_only = false
format = "on [$hostname](bold red) " format = "[$ssh_symbol](bold blue) on [$hostname](bold red) "
trim_at = ".companyname.com" trim_at = ".companyname.com"
disabled = false disabled = false
``` ```
@ -1765,7 +1770,7 @@ The `java` module shows the currently installed version of [Java](https://www.or
| `detect_files` | `["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"]` | Which filenames should trigger this module. | | `detect_files` | `["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"☕ "` | A format string representing the symbol of Java | | `symbol` | `"☕ "` | A format string representing the symbol of Java |
| `style` | `"red dimmed"` | The style for the module. | | `stil` | `"red dimmed"` | The style for the module. |
| `disabled` | `false` | Disables the `java` module. | | `disabled` | `false` | Disables the `java` module. |
### Variables ### Variables
@ -1818,7 +1823,7 @@ The `threshold` option is deprecated, but if you want to use it, the module will
| `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. | | `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. |
| `format` | `"[$symbol$number]($style) "` | The format for the module. | | `format` | `"[$symbol$number]($style) "` | The format for the module. |
| `symbol` | `"✦"` | The string used to represent the `symbol` variable. | | `symbol` | `"✦"` | The string used to represent the `symbol` variable. |
| `style` | `"bold blue"` | The style for the module. | | `stil` | `"bold blue"` | The style for the module. |
| `disabled` | `false` | Disables the `jobs` module. | | `disabled` | `false` | Disables the `jobs` module. |
*: This option is deprecated, please use the `number_threshold` and `symbol_threshold` options instead. *: This option is deprecated, please use the `number_threshold` and `symbol_threshold` options instead.
@ -1862,7 +1867,7 @@ The `julia` module shows the currently installed version of [Julia](https://juli
| `detect_files` | `["Project.toml", "Manifest.toml"]` | Which filenames should trigger this module. | | `detect_files` | `["Project.toml", "Manifest.toml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"ஃ "` | A format string representing the symbol of Julia. | | `symbol` | `"ஃ "` | A format string representing the symbol of Julia. |
| `style` | `"bold purple"` | The style for the module. | | `stil` | `"bold purple"` | The style for the module. |
| `disabled` | `false` | Disables the `julia` module. | | `disabled` | `false` | Disables the `julia` module. |
### Variables ### Variables
@ -1900,7 +1905,7 @@ The `kotlin` module shows the currently installed version of [Kotlin](https://ko
| `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this modules. | | `detect_folders` | `[]` | Which folders should trigger this modules. |
| `symbol` | `"🅺 "` | A format string representing the symbol of Kotlin. | | `symbol` | `"🅺 "` | A format string representing the symbol of Kotlin. |
| `style` | `"bold blue"` | The style for the module. | | `stil` | `"bold blue"` | The style for the module. |
| `kotlin_binary` | `"kotlin"` | Configures the kotlin binary that Starship executes when getting the version. | | `kotlin_binary` | `"kotlin"` | Configures the kotlin binary that Starship executes when getting the version. |
| `disabled` | `false` | Disables the `kotlin` module. | | `disabled` | `false` | Disables the `kotlin` module. |
@ -1947,7 +1952,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| ----------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | | ----------------- | ---------------------------------------------------- | --------------------------------------------------------------------- |
| `symbol` | `"☸ "` | A format string representing the symbol displayed before the Cluster. | | `symbol` | `"☸ "` | A format string representing the symbol displayed before the Cluster. |
| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | The format for the module. | | `format` | `'[$symbol$context( \($namespace\))]($style) in '` | The format for the module. |
| `style` | `"cyan bold"` | The style for the module. | | `stil` | `"cyan bold"` | The style for the module. |
| `context_aliases` | | Table of context aliases to display. | | `context_aliases` | | Table of context aliases to display. |
| `disabled` | `true` | Disables the `kubernetes` module. | | `disabled` | `true` | Disables the `kubernetes` module. |
@ -2028,7 +2033,7 @@ The `localip` module shows the IPv4 address of the primary network interface.
| ---------- | ------------------------- | ------------------------------------------------------ | | ---------- | ------------------------- | ------------------------------------------------------ |
| `ssh_only` | `true` | Only show IP address when connected to an SSH session. | | `ssh_only` | `true` | Only show IP address when connected to an SSH session. |
| `format` | `"[$localipv4]($style) "` | The format for the module. | | `format` | `"[$localipv4]($style) "` | The format for the module. |
| `style` | `"bold yellow"` | The style for the module. | | `stil` | `"bold yellow"` | The style for the module. |
| `disabled` | `true` | Disables the `localip` module. | | `disabled` | `true` | Disables the `localip` module. |
### Variables ### Variables
@ -2069,7 +2074,7 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o
| `detect_extensions` | `["lua"]` | Which extensions should trigger this module. | | `detect_extensions` | `["lua"]` | Which extensions should trigger this module. |
| `detect_files` | `[".lua-version"]` | Which filenames should trigger this module. | | `detect_files` | `[".lua-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `["lua"]` | Which folders should trigger this module. | | `detect_folders` | `["lua"]` | Which folders should trigger this module. |
| `style` | `"bold blue"` | The style for the module. | | `stil` | `"bold blue"` | The style for the module. |
| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. | | `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. |
| `disabled` | `false` | Disables the `lua` module. | | `disabled` | `false` | Disables the `lua` module. |
@ -2111,7 +2116,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. | | `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. |
| `format` | `"via $symbol [${ram}( \| ${swap})]($style) "` | The format for the module. | | `format` | `"via $symbol [${ram}( \| ${swap})]($style) "` | The format for the module. |
| `symbol` | `"🐏"` | The symbol used before displaying the memory usage. | | `symbol` | `"🐏"` | The symbol used before displaying the memory usage. |
| `style` | `"bold dimmed white"` | The style for the module. | | `stil` | `"bold dimmed white"` | The style for the module. |
| `disabled` | `true` | Disables the `memory_usage` module. | | `disabled` | `true` | Disables the `memory_usage` module. |
### Variables ### Variables
@ -2148,7 +2153,7 @@ The `hg_branch` module shows the active branch of the repo in your current direc
| Option | Default | Description | | Option | Default | Description |
| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------- | | ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------- |
| `symbol` | `" "` | The symbol used before the hg bookmark or branch name of the repo in your current directory. | | `symbol` | `" "` | The symbol used before the hg bookmark or branch name of the repo in your current directory. |
| `style` | `"bold purple"` | The style for the module. | | `stil` | `"bold purple"` | The style for the module. |
| `format` | `"on [$symbol$branch]($style) "` | The format for the module. | | `format` | `"on [$symbol$branch]($style) "` | The format for the module. |
| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to `N` graphemes | | `truncation_length` | `2^63 - 1` | Truncates the hg branch name to `N` graphemes |
| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. | | `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. |
@ -2194,7 +2199,7 @@ The `nim` module shows the currently installed version of [Nim](https://nim-lang
| `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this module. | | `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this module. |
| `detect_files` | `["nim.cfg"]` | Which filenames should trigger this module. | | `detect_files` | `["nim.cfg"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold yellow"` | The style for the module. | | `stil` | `"bold yellow"` | The style for the module. |
| `disabled` | `false` | Disables the `nim` module. | | `disabled` | `false` | Disables the `nim` module. |
### Variables ### Variables
@ -2227,7 +2232,7 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/
| ------------ | ---------------------------------------------- | ----------------------------------------------------- | | ------------ | ---------------------------------------------- | ----------------------------------------------------- |
| `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. | | `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. |
| `symbol` | `"❄️ "` | A format string representing the symbol of nix-shell. | | `symbol` | `"❄️ "` | A format string representing the symbol of nix-shell. |
| `style` | `"bold blue"` | The style for the module. | | `stil` | `"bold blue"` | The style for the module. |
| `impure_msg` | `"impure"` | A format string shown when the shell is impure. | | `impure_msg` | `"impure"` | A format string shown when the shell is impure. |
| `pure_msg` | `"pure"` | A format string shown when the shell is pure. | | `pure_msg` | `"pure"` | A format string shown when the shell is pure. |
| `disabled` | `false` | Disables the `nix_shell` module. | | `disabled` | `false` | Disables the `nix_shell` module. |
@ -2276,7 +2281,7 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n
| `detect_extensions` | `["js", "mjs", "cjs", "ts", "mts", "cts"]` | Which extensions should trigger this module. | | `detect_extensions` | `["js", "mjs", "cjs", "ts", "mts", "cts"]` | Which extensions should trigger this module. |
| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. | | `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. | | `detect_folders` | `["node_modules"]` | Which folders should trigger this module. |
| `style` | `"bold green"` | The style for the module. | | `stil` | `"bold green"` | The style for the module. |
| `disabled` | `false` | Disables the `nodejs` module. | | `disabled` | `false` | Disables the `nodejs` module. |
| `not_capable_style` | `bold red` | The style for the module when an engines property in package.json does not match the Node.js version. | | `not_capable_style` | `bold red` | The style for the module when an engines property in package.json does not match the Node.js version. |
@ -2322,7 +2327,7 @@ The `ocaml` module shows the currently installed version of [OCaml](https://ocam
| `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | Which extensions should trigger this module. | | `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | Which extensions should trigger this module. |
| `detect_files` | `["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]` | Which filenames should trigger this module. | | `detect_files` | `["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]` | Which filenames should trigger this module. |
| `detect_folders` | `["_opam", "esy.lock"]` | Which folders should trigger this module. | | `detect_folders` | `["_opam", "esy.lock"]` | Which folders should trigger this module. |
| `style` | `"bold yellow"` | The style for the module. | | `stil` | `"bold yellow"` | The style for the module. |
| `disabled` | `false` | Disables the `ocaml` module. | | `disabled` | `false` | Disables the `ocaml` module. |
### Variables ### Variables
@ -2356,7 +2361,7 @@ The `openstack` module shows the current OpenStack cloud and project. The module
| ---------- | --------------------------------------------------- | -------------------------------------------------------------- | | ---------- | --------------------------------------------------- | -------------------------------------------------------------- |
| `format` | `"on [$symbol$cloud(\\($project\\))]($style) "` | The format for the module. | | `format` | `"on [$symbol$cloud(\\($project\\))]($style) "` | The format for the module. |
| `symbol` | `"☁️ "` | The symbol used before displaying the current OpenStack cloud. | | `symbol` | `"☁️ "` | The symbol used before displaying the current OpenStack cloud. |
| `style` | `"bold yellow"` | The style for the module. | | `stil` | `"bold yellow"` | The style for the module. |
| `disabled` | `false` | Disables the `openstack` module. | | `disabled` | `false` | Disables the `openstack` module. |
### Variables ### Variables
@ -2383,22 +2388,22 @@ symbol = "☁️ "
## Package Version ## Package Version
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `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` 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 - [**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 - [**Cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
- [**Nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command - [**Nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command
- [**Poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory - [**Poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
- [**Python**](https://www.python.org) - The `python` package version is extracted from the `setup.cfg` present in the current directory - [**Python**](https://www.python.org) - The `python` package version is extracted from a [PEP 621](https://peps.python.org/pep-0621/) compliant `pyproject.toml` or a `setup.cfg` present in the current directory
- [**Composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory - [**Composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory
- [**Gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present - [**Gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present in the current directory
- [**Julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present - [**Julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present in the current directory
- [**Mix**](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present - [**Mix**](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present in the current directory
- [**Helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present - [**Helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present in the current directory
- [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present - [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory
- [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present - [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present - [**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 - [**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 - [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory
- [**Dart**](https://pub.dev/) - The `dart` package version is extracted from the `pubspec.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
@ -2411,7 +2416,7 @@ The `package` module is shown when the current directory is the repository for a
| `format` | `"is [$symbol$version]($style) "` | The format for the module. | | `format` | `"is [$symbol$version]($style) "` | The format for the module. |
| `symbol` | `"📦 "` | The symbol used before displaying the version the package. | | `symbol` | `"📦 "` | The symbol used before displaying the version the package. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `style` | `"bold 208"` | The style for the module. | | `stil` | `"bold 208"` | The style for the module. |
| `display_private` | `false` | Enable displaying version for packages marked as private. | | `display_private` | `false` | Enable displaying version for packages marked as private. |
| `disabled` | `false` | Disables the `package` module. | | `disabled` | `false` | Disables the `package` module. |
@ -2454,7 +2459,7 @@ The `perl` module shows the currently installed version of [Perl](https://www.pe
| `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. | | `detect_extensions` | `["pl", "pm", "pod"]` | Which extensions should trigger this module. |
| `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. | | `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold 149"` | The style for the module. | | `stil` | `"bold 149"` | The style for the module. |
| `disabled` | `false` | Disables the `perl` module. | | `disabled` | `false` | Disables the `perl` module. |
### Variables ### Variables
@ -2492,7 +2497,7 @@ The `php` module shows the currently installed version of [PHP](https://www.php.
| `detect_extensions` | `["php"]` | Which extensions should trigger this module. | | `detect_extensions` | `["php"]` | Which extensions should trigger this module. |
| `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. | | `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"147 bold"` | The style for the module. | | `stil` | `"147 bold"` | The style for the module. |
| `disabled` | `false` | Disables the `php` module. | | `disabled` | `false` | Disables the `php` module. |
### Variables ### Variables
@ -2536,7 +2541,7 @@ By default the module will be shown if any of the following conditions are met:
| `format` | `"via [$symbol($username@)$stack]($style) "` | The format string for the module. | | `format` | `"via [$symbol($username@)$stack]($style) "` | The format string for the module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `" "` | A format string shown before the Pulumi stack. | | `symbol` | `" "` | A format string shown before the Pulumi stack. |
| `style` | `"bold 5"` | The style for the module. | | `stil` | `"bold 5"` | The style for the module. |
| `disabled` | `false` | Disables the `pulumi` module. | | `disabled` | `false` | Disables the `pulumi` module. |
### Variables ### Variables
@ -2588,7 +2593,7 @@ The `purescript` module shows the currently installed version of [PureScript](ht
| `detect_extensions` | `["purs"]` | Which extensions should trigger this module. | | `detect_extensions` | `["purs"]` | Which extensions should trigger this module. |
| `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. | | `detect_files` | `["spago.dhall"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold white"` | The style for the module. | | `stil` | `"bold white"` | The style for the module. |
| `disabled` | `false` | Disables the `purescript` module. | | `disabled` | `false` | Disables the `purescript` module. |
### Variables ### Variables
@ -2635,7 +2640,7 @@ By default the module will be shown if any of the following conditions are met:
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | The format for the module. | | `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | The format for the module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🐍 "` | A format string representing the symbol of Python | | `symbol` | `"🐍 "` | A format string representing the symbol of Python |
| `style` | `"yellow bold"` | The style for the module. | | `stil` | `"yellow bold"` | The style for the module. |
| `pyenv_version_name` | `false` | Use pyenv to get Python version | | `pyenv_version_name` | `false` | Use pyenv to get Python version |
| `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used |
| `python_binary` | `["python", "python3", "python2"]` | Configures the python binaries that Starship should executes when getting the version. | | `python_binary` | `["python", "python3", "python2"]` | Configures the python binaries that Starship should executes when getting the version. |
@ -2658,7 +2663,7 @@ The default values and order for `python_binary` was chosen to first identify th
| ------------ | --------------- | ------------------------------------------ | | ------------ | --------------- | ------------------------------------------ |
| version | `"v3.8.1"` | The version of `python` | | version | `"v3.8.1"` | The version of `python` |
| symbol | `"🐍 "` | Mirrors the value of option `symbol` | | symbol | `"🐍 "` | Mirrors the value of option `symbol` |
| style | `"yellow bold"` | Mirrors the value of option `style` | | stil | `"yellow bold"` | Mirrors the value of option `style` |
| pyenv_prefix | `"pyenv "` | Mirrors the value of option `pyenv_prefix` | | pyenv_prefix | `"pyenv "` | Mirrors the value of option `pyenv_prefix` |
| virtualenv | `"venv"` | The current `virtualenv` name | | virtualenv | `"venv"` | The current `virtualenv` name |
@ -2718,7 +2723,7 @@ The `rlang` module shows the currently installed version of [R](https://www.r-pr
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"📐"` | A format string representing the symbol of R. | | `symbol` | `"📐"` | A format string representing the symbol of R. |
| `style` | `"blue bold"` | The style for the module. | | `stil` | `"blue bold"` | The style for the module. |
| `detect_extensions` | `["R", "Rd", "Rmd", "Rproj", "Rsx"]` | Which extensions should trigger this module | | `detect_extensions` | `["R", "Rd", "Rmd", "Rproj", "Rsx"]` | Which extensions should trigger this module |
| `detect_files` | `[".Rprofile"]` | Which filenames should trigger this module | | `detect_files` | `[".Rprofile"]` | Which filenames should trigger this module |
| `detect_folders` | `[".Rproj.user"]` | Which folders should trigger this module | | `detect_folders` | `[".Rproj.user"]` | Which folders should trigger this module |
@ -2730,7 +2735,7 @@ The `rlang` module shows the currently installed version of [R](https://www.r-pr
| -------- | ------------- | ------------------------------------ | | -------- | ------------- | ------------------------------------ |
| version | `v4.0.5` | The version of `R` | | version | `v4.0.5` | The version of `R` |
| symbol | | Mirrors the value of option `symbol` | | symbol | | Mirrors the value of option `symbol` |
| style | `"blue bold"` | Mirrors the value of option `style` | | stil | `"blue bold"` | Mirrors the value of option `style` |
### Example ### Example
@ -2757,7 +2762,7 @@ By default the `red` module shows the currently installed version of [Red](https
| `detect_extensions` | `["red"]` | Which extensions should trigger this module. | | `detect_extensions` | `["red"]` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"red bold"` | The style for the module. | | `stil` | `"red bold"` | The style for the module. |
| `disabled` | `false` | Disables the `red` module. | | `disabled` | `false` | Disables the `red` module. |
### Variables ### Variables
@ -2801,7 +2806,7 @@ Starship gets the current Ruby version by running `ruby -v`.
| `detect_files` | `["Gemfile", ".ruby-version"]` | Which filenames should trigger this module. | | `detect_files` | `["Gemfile", ".ruby-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. |
| `detect_variables` | `["RUBY_VERSION", "RBENV_VERSION"]` | Which environment variables should trigger this module. | | `detect_variables` | `["RUBY_VERSION", "RBENV_VERSION"]` | Which environment variables should trigger this module. |
| `style` | `"bold red"` | The style for the module. | | `stil` | `"bold red"` | The style for the module. |
| `disabled` | `false` | Disables the `ruby` module. | | `disabled` | `false` | Disables the `ruby` module. |
### Variables ### Variables
@ -2840,16 +2845,18 @@ By default the `rust` module shows the currently installed version of [Rust](htt
| `detect_extensions` | `["rs"]` | Which extensions should trigger this module. | | `detect_extensions` | `["rs"]` | Which extensions should trigger this module. |
| `detect_files` | `["Cargo.toml"]` | Which filenames should trigger this module. | | `detect_files` | `["Cargo.toml"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold red"` | The style for the module. | | `stil` | `"bold red"` | The style for the module. |
| `disabled` | `false` | Disables the `rust` module. | | `disabled` | `false` | Disables the `rust` module. |
### Variables ### Variables
| Variable | Example | Description | | Variable | Example | Description |
| --------- | ----------------- | ------------------------------------ | | --------- | ----------------- | -------------------------------------------- |
| version | `v1.43.0-nightly` | The version of `rustc` | | version | `v1.43.0-nightly` | The version of `rustc` |
| symbol | | Mirrors the value of option `symbol` | | numver | `1.51.0` | The numeric component of the `rustc` version |
| style\* | | Mirrors the value of option `style` | | toolchain | `beta` | The toolchain version |
| 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 *: This variable can only be used as a part of a style string
@ -2880,7 +2887,7 @@ The `scala` module shows the currently installed version of [Scala](https://www.
| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Which filenames should trigger this module. | | `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Which filenames should trigger this module. |
| `detect_folders` | `[".metals"]` | Which folders should trigger this modules. | | `detect_folders` | `[".metals"]` | Which folders should trigger this modules. |
| `symbol` | `"🆂 "` | A format string representing the symbol of Scala. | | `symbol` | `"🆂 "` | A format string representing the symbol of Scala. |
| `style` | `"red dimmed"` | The style for the module. | | `stil` | `"red dimmed"` | The style for the module. |
| `disabled` | `false` | Disables the `scala` module. | | `disabled` | `false` | Disables the `scala` module. |
### Variables ### Variables
@ -2928,7 +2935,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| `nu_indicator` | `nu` | A format string used to represent nu. | | `nu_indicator` | `nu` | A format string used to represent nu. |
| `unknown_indicator` | | The default value to be displayed when the shell is unknown. | | `unknown_indicator` | | The default value to be displayed when the shell is unknown. |
| `format` | `"[$indicator]($style) "` | The format for the module. | | `format` | `"[$indicator]($style) "` | The format for the module. |
| `style` | `"white bold"` | The style for the module. | | `stil` | `"white bold"` | The style for the module. |
| `disabled` | `true` | Disables the `shell` module. | | `disabled` | `true` | Disables the `shell` module. |
### Variables ### Variables
@ -2965,7 +2972,7 @@ The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/int
| `format` | `"[$symbol$shlvl]($style) "` | The format for the module. | | `format` | `"[$symbol$shlvl]($style) "` | The format for the module. |
| `symbol` | `"↕️ "` | The symbol used to represent the `SHLVL`. | | `symbol` | `"↕️ "` | The symbol used to represent the `SHLVL`. |
| `repeat` | `false` | Causes `symbol` to be repeated by the current `SHLVL` amount. | | `repeat` | `false` | Causes `symbol` to be repeated by the current `SHLVL` amount. |
| `style` | `"bold yellow"` | The style for the module. | | `stil` | `"bold yellow"` | The style for the module. |
| `disabled` | `true` | Disables the `shlvl` module. | | `disabled` | `true` | Disables the `shlvl` module. |
### Variables ### Variables
@ -2999,7 +3006,7 @@ The `singularity` module shows the current [Singularity](https://sylabs.io/singu
| ---------- | -------------------------------- | ------------------------------------------------ | | ---------- | -------------------------------- | ------------------------------------------------ |
| `format` | `'[$symbol\[$env\]]($style) '` | The format for the module. | | `format` | `'[$symbol\[$env\]]($style) '` | The format for the module. |
| `symbol` | `""` | A format string displayed before the image name. | | `symbol` | `""` | A format string displayed before the image name. |
| `style` | `"bold dimmed blue"` | The style for the module. | | `stil` | `"bold dimmed blue"` | The style for the module. |
| `disabled` | `false` | Disables the `singularity` module. | | `disabled` | `false` | Disables the `singularity` module. |
### Variables ### Variables
@ -3031,7 +3038,7 @@ The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/lat
| ------------------- | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------- | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| `truncation_length` | `1` | The number of directories the environment path should be truncated to. `0` means no truncation. Also see the [`directory`](#directory) module. | | `truncation_length` | `1` | The number of directories the environment path should be truncated to. `0` means no truncation. Also see the [`directory`](#directory) module. |
| `symbol` | `"🅢 "` | The symbol used before the environment name. | | `symbol` | `"🅢 "` | The symbol used before the environment name. |
| `style` | `"bold blue"` | The style for the module. | | `stil` | `"bold blue"` | The style for the module. |
| `format` | `"via [$symbol$environment]($style) "` | The format for the module. | | `format` | `"via [$symbol$environment]($style) "` | The format for the module. |
| `disabled` | `false` | Disables the `spack` module. | | `disabled` | `false` | Disables the `spack` module. |
@ -3075,7 +3082,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| `not_found_symbol` | `"🔍"` | The symbol displayed when the command can't be found | | `not_found_symbol` | `"🔍"` | The symbol displayed when the command can't be found |
| `sigint_symbol` | `"🧱"` | The symbol displayed on SIGINT (Ctrl + c) | | `sigint_symbol` | `"🧱"` | The symbol displayed on SIGINT (Ctrl + c) |
| `signal_symbol` | `"⚡"` | The symbol displayed on any signal | | `signal_symbol` | `"⚡"` | The symbol displayed on any signal |
| `style` | `"bold red"` | The style for the module. | | `stil` | `"bold red"` | The style for the module. |
| `recognize_signal_code` | `true` | Enable signal mapping from exit code | | `recognize_signal_code` | `true` | Enable signal mapping from exit code |
| `map_symbol` | `false` | Enable symbols mapping from exit code | | `map_symbol` | `false` | Enable symbols mapping from exit code |
| `pipestatus` | `false` | Enable pipestatus reporting | | `pipestatus` | `false` | Enable pipestatus reporting |
@ -3130,7 +3137,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| --------------- | ----------------------- | ------------------------------------------------------- | | --------------- | ----------------------- | ------------------------------------------------------- |
| `format` | `[as $symbol]($style)"` | The format of the module | | `format` | `[as $symbol]($style)"` | The format of the module |
| `symbol` | `"🧙 "` | The symbol displayed when credentials are cached | | `symbol` | `"🧙 "` | The symbol displayed when credentials are cached |
| `style` | `"bold blue"` | The style for the module. | | `stil` | `"bold blue"` | The style for the module. |
| `allow_windows` | `false` | Since windows has no default sudo, default is disabled. | | `allow_windows` | `false` | Since windows has no default sudo, default is disabled. |
| `disabled` | `true` | Disables the `sudo` module. | | `disabled` | `true` | Disables the `sudo` module. |
@ -3180,7 +3187,7 @@ By default the `swift` module shows the currently installed version of [Swift](h
| `detect_extensions` | `["swift"]` | Which extensions should trigger this module. | | `detect_extensions` | `["swift"]` | Which extensions should trigger this module. |
| `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. | | `detect_files` | `["Package.swift"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"bold 202"` | The style for the module. | | `stil` | `"bold 202"` | The style for the module. |
| `disabled` | `false` | Disables the `swift` module. | | `disabled` | `false` | Disables the `swift` module. |
### Variables ### Variables
@ -3227,7 +3234,7 @@ By default the module will be shown if any of the following conditions are met:
| `detect_extensions` | `["tf", "tfplan", "tfstate"]` | Which extensions should trigger this module. | | `detect_extensions` | `["tf", "tfplan", "tfstate"]` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
| `detect_folders` | `[".terraform"]` | Which folders should trigger this module. | | `detect_folders` | `[".terraform"]` | Which folders should trigger this module. |
| `style` | `"bold 105"` | The style for the module. | | `stil` | `"bold 105"` | The style for the module. |
| `disabled` | `false` | Disables the `terraform` module. | | `disabled` | `false` | Disables the `terraform` module. |
### Variables ### Variables
@ -3278,7 +3285,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y
| `format` | `"at [$time]($style) "` | The format string for the module. | | `format` | `"at [$time]($style) "` | The format string for the module. |
| `use_12hr` | `false` | Enables 12 hour formatting | | `use_12hr` | `false` | Enables 12 hour formatting |
| `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. | | `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. |
| `style` | `"bold yellow"` | The style for the module time | | `stil` | `"bold yellow"` | The style for the module time |
| `utc_time_offset` | `"local"` | Sets the UTC offset to use. Range from -24 &lt; x &lt; 24. Allows floats to accommodate 30/45 minute timezone offsets. | | `utc_time_offset` | `"local"` | Sets the UTC offset to use. Range from -24 &lt; x &lt; 24. Allows floats to accommodate 30/45 minute timezone offsets. |
| `disabled` | `true` | Disables the `time` module. | | `disabled` | `true` | Disables the `time` module. |
| `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | | `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format |
@ -3336,7 +3343,7 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, `
| Variable | Example | Description | | Variable | Example | Description |
| -------- | ------------ | ------------------------------------------------------------------------------------------- | | -------- | ------------ | ------------------------------------------------------------------------------------------- |
| `style` | `"red bold"` | Mirrors the value of option `style_root` when root is logged in and `style_user` otherwise. | | `stil` | `"red bold"` | Mirrors the value of option `style_root` when root is logged in and `style_user` otherwise. |
| `user` | `"matchai"` | The currently logged-in user ID. | | `user` | `"matchai"` | The currently logged-in user ID. |
### Example ### Example
@ -3368,7 +3375,7 @@ The `vagrant` module shows the currently installed version of [Vagrant](https://
| `detect_extensions` | `[]` | Which extensions should trigger this module. | | `detect_extensions` | `[]` | Which extensions should trigger this module. |
| `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. | | `detect_files` | `["Vagrantfile"]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"cyan bold"` | The style for the module. | | `stil` | `"cyan bold"` | The style for the module. |
| `disabled` | `false` | Disables the `vagrant` module. | | `disabled` | `false` | Disables the `vagrant` module. |
### Variables ### Variables
@ -3407,7 +3414,7 @@ The `vlang` module shows you your currently installed version of [V](https://vla
| `detect_extensions` | `["v"]` | Which extensions should trigger this module. | | `detect_extensions` | `["v"]` | Which extensions should trigger this module. |
| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Which filenames should trigger this module. | | `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Which filenames should trigger this module. |
| `detect_folders` | `[]` | Which folders should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. |
| `style` | `"blue bold"` | The style for the module. | | `stil` | `"blue bold"` | The style for the module. |
| `disabled` | `false` | Disables the `vlang` module. | | `disabled` | `false` | Disables the `vlang` module. |
### Variables ### Variables
@ -3435,7 +3442,7 @@ The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/v
| Option | Default | Description | | Option | Default | Description |
| ---------- | -------------------------------- | ------------------------------------------------------ | | ---------- | -------------------------------- | ------------------------------------------------------ |
| `symbol` | | The symbol used before displaying the repository name. | | `symbol` | | The symbol used before displaying the repository name. |
| `style` | `"bold yellow"` | The style for the module. | | `stil` | `"bold yellow"` | The style for the module. |
| `format` | `"vcsh [$symbol$repo]($style) "` | The format for the module. | | `format` | `"vcsh [$symbol$repo]($style) "` | The format for the module. |
| `disabled` | `false` | Disables the `vcsh` module. | | `disabled` | `false` | Disables the `vcsh` module. |
@ -3471,7 +3478,7 @@ By default the the `zig` module shows the currently installed version of [Zig](h
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | | `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. |
| `style` | `"bold yellow"` | The style for the module. | | `stil` | `"bold yellow"` | The style for the module. |
| `disabled` | `false` | Disables the `zig` module. | | `disabled` | `false` | Disables the `zig` module. |
| `detect_extensions` | `["zig"]` | Which extensions should trigger this module. | | `detect_extensions` | `["zig"]` | Which extensions should trigger this module. |
| `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_files` | `[]` | Which filenames should trigger this module. |
@ -3546,7 +3553,7 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt
| `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. | | `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. |
| `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. | | `detect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. |
| `symbol` | `""` | The symbol used before displaying the command output. | | `symbol` | `""` | The symbol used before displaying the command output. |
| `style` | `"bold green"` | The style for the module. | | `stil` | `"bold green"` | The style for the module. |
| `format` | `"[$symbol($output )]($style)"` | The format for the module. | | `format` | `"[$symbol($output )]($style)"` | The format for the module. |
| `disabled` | `false` | Disables this `custom` module. | | `disabled` | `false` | Disables this `custom` module. |
| `os` | | Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) [See possible values](https://doc.rust-lang.org/std/env/consts/constant.OS.html). | | `os` | | Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) [See possible values](https://doc.rust-lang.org/std/env/consts/constant.OS.html). |

97
docs/tr-TR/guide/README.md
View File

@ -37,9 +37,9 @@
<p align="center"> <p align="center">
<a href="https://starship.rs">Website</a> <a href="https://starship.rs">Website</a>
· ·
<a href="#🚀-installation">Installation</a> <a href="#🚀-installation">Kurulum</a>
· ·
<a href="https://starship.rs/config/">Configuration</a> <a href="https://starship.rs/config/">Yapılandırma</a>
</p> </p>
<p align="center"> <p align="center">
@ -150,35 +150,35 @@
align="right" align="right"
/> />
**The minimal, blazing-fast, and infinitely customizable prompt for any shell!** **Sade, hızlı, dilediğiniz gibi özelleştirilebilen ve istenilen shell'de kullanılabilen prompt!**
- **Fast:** it's fast – _really really_ fast! 🚀 - **Hızlı:** _gerçekten_ hızlı! 🚀
- **Customizable:** configure every aspect of your prompt. - **Özelleştirilebilir:** promptunuzu en ince ayrıntısına kadar özelleştirin.
- **Universal:** works on any shell, on any operating system. - **Evrensel:** herhangi bir shell ve işletim sisteminde çalışır.
- **Intelligent:** shows relevant information at a glance. - **Akıllı:** bir bakışta ilgili bilgilere ulaş.
- **Feature rich:** support for all your favorite tools. - **Zengin içerik:** bütün sevdiğiniz araçları destekler.
- **Easy:** quick to install – start using it in minutes. - **Kolay:** hızlı kurulum -  dakikalar içinde kullanmaya başla.
<p align="center"> <p align="center">
<a href="https://starship.rs/config/"><strong>Explore the Starship docs&nbsp;&nbsp;▶</strong></a> <a href="https://starship.rs/config/"><strong>Starship dokümantasyonunu incele &nbsp;&nbsp;▶</strong></a>
</p> </p>
<a name="🚀-installation"></a> <a name="🚀-installation"></a>
## 🚀 Installation ## 🚀 Kurulum
### Ön koşullar ### Ön koşullar
- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (for example, try the [Fira Code Nerd Font](https://www.nerdfonts.com/font-downloads)). - [Nerd Font](https://www.nerdfonts.com/) kurulu ve terminalinizde kullanılıyor olmalı (başlarken [Fira Code Nerd Font](https://www.nerdfonts.com/font-downloads)'u deneyebilirsiniz).
### Step 1. Install Starship ### 1. Adım Starship'i Kur
Select your operating system from the list below to view installation instructions: Kurulum talimatlarını görmek için aşağıdaki listeden işletim sisteminizi seçiniz:
<details> <details>
<summary>Android</summary> <summary>Android</summary>
Install Starship using any of the following package managers: Starship'i herhangi bir paket yöneticisi ile yükleyin:
| Repository | Instructions | | Repository | Instructions |
| --------------------------------------------------------------------------------- | ---------------------- | | --------------------------------------------------------------------------------- | ---------------------- |
@ -189,7 +189,7 @@ Install Starship using any of the following package managers:
<details> <details>
<summary>BSD</summary> <summary>BSD</summary>
Install Starship using any of the following package managers: Starship'i herhangi bir paket yöneticisi ile yükleyin:
| Distribution | Repository | Instructions | | Distribution | Repository | Instructions |
| ------------ | -------------------------------------------------------- | --------------------------------- | | ------------ | -------------------------------------------------------- | --------------------------------- |
@ -202,13 +202,13 @@ Install Starship using any of the following package managers:
<details> <details>
<summary>Linux</summary> <summary>Linux</summary>
Install the latest version for your system: Sisteminiz için son sürümü yükleyin:
```sh ```sh
curl -sS https://starship.rs/install.sh | sh curl -sS https://starship.rs/install.sh | sh
``` ```
Alternatively, install Starship using any of the following package managers: Alternatif olarak aşağıdaki paket yöneticileri ile de Starship'i yükleyebilirsiniz:
| Distribution | Repository | Instructions | | Distribution | Repository | Instructions |
| ------------------ | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | | ------------------ | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ |
@ -231,13 +231,13 @@ Alternatively, install Starship using any of the following package managers:
<details> <details>
<summary>macOS</summary> <summary>macOS</summary>
Install the latest version for your system: Sisteminiz için son sürümü yükleyin:
```sh ```sh
curl -sS https://starship.rs/install.sh | sh curl -sS https://starship.rs/install.sh | sh
``` ```
Alternatively, install Starship using any of the following package managers: Alternatif olarak aşağıdaki paket yöneticileri ile de Starship'i yükleyebilirsiniz:
| Repository | Instructions | | Repository | Instructions |
| -------------------------------------------------------- | --------------------------------------- | | -------------------------------------------------------- | --------------------------------------- |
@ -251,7 +251,7 @@ Alternatively, install Starship using any of the following package managers:
<details> <details>
<summary>Windows</summary> <summary>Windows</summary>
Install Starship using any of the following package managers: Starship'i herhangi bir paket yöneticisi ile yükleyin:
| Repository | Instructions | | Repository | Instructions |
| -------------------------------------------------------------------------------- | --------------------------------------- | | -------------------------------------------------------------------------------- | --------------------------------------- |
@ -262,14 +262,14 @@ Install Starship using any of the following package managers:
</details> </details>
### Step 2. Setup your shell to use Starship ### 2. Adım Shell'inizi Starship kullanmaya hazır hale getirin
Configure your shell to initialize starship. Select yours from the list below: Shell'ı starshiple çalışması için ayarla. Aşağıdaki listeden shell'inizi seçin:
<details> <details>
<summary>Bash</summary> <summary>Bash</summary>
Add the following to the end of `~/.bashrc`: `~/.bashrc` dosyasının sonuna ekleyin:
```sh ```sh
eval "$(starship init bash)" eval "$(starship init bash)"
@ -280,7 +280,7 @@ eval "$(starship init bash)"
<details> <details>
<summary>Cmd</summary> <summary>Cmd</summary>
You need to use [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) with Cmd. Create a file at this path `%LocalAppData%\clink\starship.lua` with the following contents: Cmd ıle beraber [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) kullanmalısınız. `%LocalAppData%\clink\starship.lua` dosyasını belirtilen dizinde aşağıdaki kod içeriği olacak şekilde oluşturun:
```lua ```lua
load(io.popen('starship init cmd'):read("*a"))() load(io.popen('starship init cmd'):read("*a"))()
@ -291,20 +291,20 @@ load(io.popen('starship init cmd'):read("*a"))()
<details> <details>
<summary>Elvish</summary> <summary>Elvish</summary>
Add the following to the end of `~/.elvish/rc.elv`: `~/.elvish/rc.elv` dosyasının sonuna ekleyin:
```sh ```sh
eval (starship init elvish) eval (starship init elvish)
``` ```
Note: Only Elvish v0.18+ is supported Not: Elvish v0.18'den sonraki sürümler desteklenmektedir
</details> </details>
<details> <details>
<summary>Fish</summary> <summary>Fish</summary>
Add the following to the end of `~/.config/fish/config.fish`: `~/.config/fish/config.fish` dosyasının sonuna ekleyin:
```fish ```fish
starship init fish | source starship init fish | source
@ -315,7 +315,7 @@ starship init fish | source
<details> <details>
<summary>Ion</summary> <summary>Ion</summary>
Add the following to the end of `~/.config/ion/initrc`: `~/.config/ion/initrc` dosyasının sonuna ekleyin:
```sh ```sh
eval $(starship init ion) eval $(starship init ion)
@ -326,28 +326,27 @@ eval $(starship init ion)
<details> <details>
<summary>Nushell</summary> <summary>Nushell</summary>
Run the following: Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu starship init nu | save ~/.cache/starship/init.nu
``` ```
And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`): Aşağıdaki kodu Nushell ayarlarınızın (`$nu.config-path` komutu ile ulaşabilirsiniz) sonuna ekleyin:
```sh ```sh
starship init nu | save ~/.cache/starship/init.nu
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```
Note: Only Nushell v0.60+ is supported Not: Nushell v0.61'tan sonraki sürümler desteklenmektedir
</details> </details>
<details> <details>
<summary>PowerShell</summary> <summary>PowerShell</summary>
Add the following to the end of your PowerShell configuration (find it by running `$PROFILE`): Aşağıdaki kodu PowerShell ayarlarınızın (`$PROFILE` komutu ile ulaşabilirsiniz) sonuna ekleyin:
```powershell ```powershell
Invoke-Expression (&starship init powershell) Invoke-Expression (&starship init powershell)
@ -358,7 +357,7 @@ Invoke-Expression (&starship init powershell)
<details> <details>
<summary>Tcsh</summary> <summary>Tcsh</summary>
Add the following to the end of `~/.tcshrc`: `~/.tcshrc` dosyasının sonuna ekleyın:
```sh ```sh
eval `starship init tcsh` eval `starship init tcsh`
@ -369,7 +368,7 @@ eval `starship init tcsh`
<details> <details>
<summary>Xonsh</summary> <summary>Xonsh</summary>
Add the following to the end of `~/.xonshrc`: `~/.xonshrc` dosyasının sonuna ekleyin:
```python ```python
execx($(starship init xonsh)) execx($(starship init xonsh))
@ -380,7 +379,7 @@ execx($(starship init xonsh))
<details> <details>
<summary>Zsh</summary> <summary>Zsh</summary>
Add the following to the end of `~/.zshrc`: `~/.zshrc` dosyasının sonuna ekleyin:
```sh ```sh
eval "$(starship init zsh)" eval "$(starship init zsh)"
@ -388,27 +387,27 @@ eval "$(starship init zsh)"
</details> </details>
### Step 3. Configure Starship ### 3. Adım Starship'i Yapılandır
Start a new shell instance, and you should see your beautiful new shell prompt. If you're happy with the defaults, enjoy! Shellinizi yeniden başlatın, işte yeni shell promptunuzun güzelliği ile karşı karşıyasınız. Eğer varsayılan görünümden memnunsanız, keyfini çıkartın!
If you're looking to further customize Starship: Daha fazla özelleştirme seçeneği için:
- **[Configuration](https://starship.rs/config/)** – learn how to configure Starship to tweak your prompt to your liking - **[Configuration](https://starship.rs/config/)** – Starship'i yapılandırmayı ve dilediğiniz gibi düzenlenemeyi öğrenin
- **[Presets](https://starship.rs/presets/)** – get inspired by the pre-built configuration of others - **[Presets](https://starship.rs/presets/)** – başkalaranın oluşturduğu düzenlemelerden ilham alın
## 🤝 Contributing ## 🤝 Katkıda Bulunmak
We are always looking for contributors of **all skill levels**! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). Katılımcılara **yetenek düzeyleri fark etmeksizin**, her zaman açığız! Eğer katkıda bulunmaya kolay bir şekilde başlamak istiyorsanız [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue)'lardan bir tanesini deneyin.
If you are fluent in a non-English language, we greatly appreciate any help keeping our docs translated and up-to-date in other languages. If you would like to help, translations can be contributed on the [Starship Crowdin](https://translate.starship.rs/). Eğer ingilizce harici bir dili akıcı seviyede kullanabiliyorsanız, dosyaların diğer diller ile güncel bir şekilde çevirilebilmesi için yardımlarınızı bekliyoruz. Çeviriye [Starship Crowdin](https://translate.starship.rs/)'den destekte bulunabilirsiniz.
If you are interested in helping contribute to starship, please take a look at our [Contributing Guide](https://github.com/starship/starship/blob/master/CONTRIBUTING.md). Also, feel free to drop into our [Discord server](https://discord.gg/8Jzqu3T) and say hi. 👋 Eğer starship'e katkıda bulunmak istiyorsanız lütfen [Katkı Kılavuzu](https://github.com/starship/starship/blob/master/CONTRIBUTING.md)'na göz atınız. Ayrıca, istediğiniz zaman [Discord server](https://discord.gg/8Jzqu3T)'ımıza gelip merhaba diyebilir, iletişime geçebilirsiniz. 👋
## 💭 Inspired By ## 💭 İlham Kaynakları
Please check out these previous works that helped inspire the creation of starship. 🙏 Lütfen starship'in oluşmasında ilham kaynağı olan çalışmalara da göz atın. 🙏
- **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** – A ZSH prompt for astronauts. - **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** – A ZSH prompt for astronauts.
@ -421,6 +420,6 @@ Please check out these previous works that helped inspire the creation of starsh
<img width="100" src="https://raw.githubusercontent.com/starship/starship/master/media/icon.png" alt="Starship rocket icon"> <img width="100" src="https://raw.githubusercontent.com/starship/starship/master/media/icon.png" alt="Starship rocket icon">
</p> </p>
## 📝 License ## 📝 Lisans
Copyright © 2019-present, [Starship Contributors](https://github.com/starship/starship/graphs/contributors).<br /> This project is [ISC](https://github.com/starship/starship/blob/master/LICENSE) licensed. 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.

16
docs/vi-VN/README.md
View File

@ -120,7 +120,11 @@ description: Starship là prompt nhỏ, cực nhanh, và khả năng tuỳ biế
#### Elvish #### Elvish
::: warning Chỉ elvish v0.18 hoặc cao hơn được hỗ trợ. ::: ::: cảnh báo
Only elvish v0.18 or higher is supported.
:::
Thêm đoạn sau vào cuối tệp tin `~/.elvish/rc.elv`: Thêm đoạn sau vào cuối tệp tin `~/.elvish/rc.elv`:
@ -144,7 +148,13 @@ description: Starship là prompt nhỏ, cực nhanh, và khả năng tuỳ biế
#### Nushell #### Nushell
::: warning This will change in the future. Only Nushell v0.60+ is supported. ::: Run the following: ::: cảnh báo
This will change in the future. Only Nushell v0.61+ is supported.
:::
Add the following to to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu starship init nu | save ~/.cache/starship/init.nu
@ -153,8 +163,6 @@ description: Starship là prompt nhỏ, cực nhanh, và khả năng tuỳ biế
And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`): And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):
```sh ```sh
mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```

125
docs/vi-VN/config/README.md
View File

@ -280,16 +280,16 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL
### Các tuỳ chọn ### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả | | Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | | ------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | Định dạng cho module. | | `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)'` | Định dạng cho module. |
| `symbol` | `"☁️ "` | Kí hiệu sử dụng hiển thị trước profile AWS hiện tại. | | `symbol` | `"☁️ "` | Kí hiệu sử dụng hiển thị trước profile AWS hiện tại. |
| `region_aliases` | | Bảng của các region alias để hiển thị ngoài tên AWS. | | `region_aliases` | | Bảng của các region alias để hiển thị ngoài tên AWS. |
| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | | `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. |
| `style` | `"bold yellow"` | Kiểu cho module. | | `style` | `"bold yellow"` | Kiểu cho module. |
| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. | | `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. |
| `disabled` | `false` | Vô hiệu `AWS` module. | | `disabled` | `false` | Vô hiệu `AWS` module. |
| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. | | `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. |
### Các biến ### Các biến
@ -1140,7 +1140,9 @@ The `env_var` module displays the current value of a selected environment variab
- Tùy chọn `variable` khớp với mootjj biến môi trường tồn tại - Tùy chọn `variable` khớp với mootjj biến môi trường tồn tại
- Tùy chọn `variable` không được định nghĩa, nhưng tùy chọn `default` là - Tùy chọn `variable` không được định nghĩa, nhưng tùy chọn `default` là
::: tip Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. ::: tip
Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character.
Example: following configuration will display value of USER environment variable Example: following configuration will display value of USER environment variable
@ -1342,17 +1344,17 @@ Mô đun `git_branch` hiển thị nhánh hiệu lực của repo trong thư m
### Các tuỳ chọn ### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả | | Tuỳ chọn | Mặc định | Mô tả |
| -------------------- | -------------------------------- | ----------------------------------------------------------------------------------------------------- | | -------------------- | ------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |
| `always_show_remote` | `false` | Hiển thị tên nhánh remote tracking, thậm chí nếu nó bằng với tên nhánh local. | | `always_show_remote` | `false` | Hiển thị tên nhánh remote tracking, thậm chí nếu nó bằng với tên nhánh local. |
| `format` | `"on [$symbol$branch]($style) "` | Định dạng cho module. Sử dụng `"$branch"` để tham chiếu tới tên nhánh hiện tại. | | `format` | `"on [$symbol$branch(:$remote_branch)]($style) "` | Định dạng cho module. Sử dụng `"$branch"` để tham chiếu tới tên nhánh hiện tại. |
| `symbol` | `" "` | Một chuỗi định dạng hiển thị biểu tượng của nhánh git. | | `symbol` | `" "` | Một chuỗi định dạng hiển thị biểu tượng của nhánh git. |
| `style` | `"bold purple"` | Kiểu cho module. | | `style` | `"bold purple"` | Kiểu cho module. |
| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | | `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. |
| `truncation_symbol` | `"…"` | Biểu tượng sử dụng để nhận biết một tên nhánh được rút gọn. Bạn có thể sử dụng `""` để ẩn biểu tượng. | | `truncation_symbol` | `"…"` | Biểu tượng sử dụng để nhận biết một tên nhánh được rút gọn. Bạn có thể sử dụng `""` để ẩn biểu tượng. |
| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | | `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". | | `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for "master" or "main". |
| `disabled` | `false` | Vô hiệu mô đun `git_branch`. | | `disabled` | `false` | Vô hiệu mô đun `git_branch`. |
### Các biến ### Các biến
@ -1602,6 +1604,7 @@ The `golang` module shows the currently installed version of [Go](https://golang
- Thư mục hiện tại chứa một tập tin `go.mod` - Thư mục hiện tại chứa một tập tin `go.mod`
- Đường dẫn hiện tại chứa một tập tin `go.sum` - Đường dẫn hiện tại chứa một tập tin `go.sum`
- Đường dẫn hiện tại chứa một tập tin `go.work`
- Thư mục hiện tại chứa một tập tin `glide.yaml` - Thư mục hiện tại chứa một tập tin `glide.yaml`
- Thư mục hiện tại chứa một tập tin `Gopkg.yml` - Thư mục hiện tại chứa một tập tin `Gopkg.yml`
- Đường dẫn hiện tại chứa một tập tin `Gopkg.lock` - Đường dẫn hiện tại chứa một tập tin `Gopkg.lock`
@ -1611,16 +1614,16 @@ The `golang` module shows the currently installed version of [Go](https://golang
### Các tuỳ chọn ### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả | | Tuỳ chọn | Mặc định | Mô tả |
| ------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | | `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🐹 "` | Một format string đại diện cho biểu tượng của Go. | | `symbol` | `"🐹 "` | Một format string đại diện cho biểu tượng của Go. |
| `detect_extensions` | `["go"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | | `detect_extensions` | `["go"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. |
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Những tên tệp nào sẽ kích hoạt mô-đun này. | | `detect_files` | `["go.mod", "go.sum", "go.work", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Những tên tệp nào sẽ kích hoạt mô-đun này. |
| `detect_folders` | `["Godeps"]` | Những thư mục nào sẽ kích hoạt mô-đun này. | | `detect_folders` | `["Godeps"]` | Những thư mục nào sẽ kích hoạt mô-đun này. |
| `style` | `"bold cyan"` | Kiểu cho module. | | `style` | `"bold cyan"` | Kiểu cho module. |
| `disabled` | `false` | Vô hiệu `golang` module. | | `disabled` | `false` | Vô hiệu `golang` module. |
### Các biến ### Các biến
@ -1719,20 +1722,22 @@ Mô đun `hostname` hiển thị hostnam hệ thống.
### Các tuỳ chọn ### Các tuỳ chọn
| Tuỳ chọn | Mặc định | Mô tả | | Tuỳ chọn | Mặc định | Mô tả |
| ---------- | --------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | | ------------ | -------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------- |
| `ssh_only` | `true` | Chỉ hiển thị hostname khi được kết nối tới một phiên SSH. | | `ssh_only` | `true` | Chỉ hiển thị hostname khi được kết nối tới một phiên SSH. |
| `trim_at` | `"."` | Chuỗi mà hostname được cắt ngắn, sau khi khớp lần đầu tiên. `"."` sẽ dừng sau dấu chấm đầu tiên. `""` sẽ vô hiệu mọi sự cắt ngắn | | `ssh_symbol` | `"🌐 "` | A format string representing the symbol when connected to SSH session. |
| `format` | `"[$hostname]($style) in "` | Định dạng cho module. | | `trim_at` | `"."` | Chuỗi mà hostname được cắt ngắn, sau khi khớp lần đầu tiên. `"."` sẽ dừng sau dấu chấm đầu tiên. `""` sẽ vô hiệu mọi sự cắt ngắn |
| `style` | `"bold dimmed green"` | Kiểu cho module. | | `format` | `"[$ssh_symbol$hostname]($style) in "` | Định dạng cho module. |
| `disabled` | `false` | Vô hiệu `hastname` module. | | `style` | `"bold dimmed green"` | Kiểu cho module. |
| `disabled` | `false` | Vô hiệu `hastname` module. |
### Các biến ### Các biến
| Biến | Ví dụ | Mô tả | | Biến | Ví dụ | Mô tả |
| --------- | ---------- | ---------------------------- | | ---------- | ---------- | ----------------------------------------------------- |
| hostname | `computer` | The hostname of the computer | | hostname | `computer` | The hostname of the computer |
| style\* | | Giá trị ghi đè của `style` | | style\* | | Giá trị ghi đè của `style` |
| ssh_symbol | `"🌏 "` | The symbol to represent when connected to SSH session |
*: Biến này có thể chỉ được sử dụng như một phần của style string *: Biến này có thể chỉ được sử dụng như một phần của style string
@ -1743,7 +1748,7 @@ Mô đun `hostname` hiển thị hostnam hệ thống.
[hostname] [hostname]
ssh_only = false ssh_only = false
format = "on [$hostname](bold red) " format = "[$ssh_symbol](bold blue) on [$hostname](bold red) "
trim_at = ".companyname.com" trim_at = ".companyname.com"
disabled = false disabled = false
``` ```
@ -2383,22 +2388,22 @@ symbol = "☁️ "
## Package Version ## Package Version
The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `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` 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 - [**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 - [**Cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
- [**Nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command - [**Nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command
- [**Poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory - [**Poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
- [**Python**](https://www.python.org) - The `python` package version is extracted from the `setup.cfg` present in the current directory - [**Python**](https://www.python.org) - The `python` package version is extracted from a [PEP 621](https://peps.python.org/pep-0621/) compliant `pyproject.toml` or a `setup.cfg` present in the current directory
- [**Composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory - [**Composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory
- [**Gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present - [**Gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present in the current directory
- [**Julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present - [**Julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present in the current directory
- [**Mix**](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present - [**Mix**](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present in the current directory
- [**Helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present - [**Helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present in the current directory
- [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present - [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory
- [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present - [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present - [**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 - [**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 - [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory
- [**Dart**](https://pub.dev/) - The `dart` package version is extracted from the `pubspec.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
@ -2845,11 +2850,13 @@ By default the `rust` module shows the currently installed version of [Rust](htt
### Các biến ### Các biến
| Biến | Ví dụ | Mô tả | | Biến | Ví dụ | Mô tả |
| --------- | ----------------- | -------------------------------- | | --------- | ----------------- | -------------------------------------------- |
| version | `v1.43.0-nightly` | The version of `rustc` | | version | `v1.43.0-nightly` | The version of `rustc` |
| symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | numver | `1.51.0` | The numeric component of the `rustc` version |
| style\* | | Giá trị ghi đè của `style` | | toolchain | `beta` | The toolchain version |
| 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 *: Biến này có thể chỉ được sử dụng như một phần của style string

5
docs/vi-VN/guide/README.md
View File

@ -326,7 +326,7 @@ eval $(starship init ion)
<details> <details>
<summary>Nushell</summary> <summary>Nushell</summary>
Run the following: Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
@ -336,11 +336,10 @@ 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`): And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):
```sh ```sh
starship init nu | save ~/.cache/starship/init.nu
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```
Note: Only Nushell v0.60+ is supported Note: Only Nushell v0.61+ is supported
</details> </details>

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

@ -18,7 +18,7 @@ features:
footer: ISC Licensed | Copyright © 2019-present Starship Contributors footer: ISC Licensed | Copyright © 2019-present Starship Contributors
#Used for the description meta tag, for SEO #Used for the description meta tag, for SEO
metaTitle: "Starship：可用于各种 Shell 的提示符" metaTitle: "Starship：可用于各种 Shell 的提示符"
description: Starship is the minimal, blazing fast, and extremely customizable prompt for any shell! Shows the information you need, while staying sleek and minimal. Quick installation available for Bash, Fish, ZSH, Ion, Tcsh, Elvish, Nu, Xonsh, Cmd, and PowerShell. description: Starship是一款轻量级、反应迅速、可自定义的高颜值终端！ Shows the information you need, while staying sleek and minimal. 可以为Bash、Fish、ZSH、Ion、Tcsh、Elvish、Nu、Xonsh、Cmd和PowerShell执行快速安装。
--- ---
<div class="center"> <div class="center">
@ -30,7 +30,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
### 前置要求 ### 前置要求
- 安装并在你的终端启用一种 [Nerd Font](https://www.nerdfonts.com/) 。 - 安装并在你的终端启用 [Nerd Font](https://www.nerdfonts.com/) 。
### 快速安装 ### 快速安装
@ -120,7 +120,11 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
#### Elvish #### Elvish
::: warning 警告 只支持 elvish v0.18 及以上。 ::: ::: warning
Only elvish v0.18 or higher is supported.
:::
在 `~/.config/fish/rc.elv` 的最后，添加以下内容： 在 `~/.config/fish/rc.elv` 的最后，添加以下内容：
@ -144,7 +148,13 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
#### Nushell #### Nushell
::: warning 警告 将来可能会改变。 Only Nushell v0.60+ is supported. ::: Run the following: ::: warning
This will change in the future. Only Nushell v0.61+ is supported.
:::
Add the following to to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu starship init nu | save ~/.cache/starship/init.nu
@ -153,8 +163,6 @@ description: Starship is the minimal, blazing fast, and extremely customizable p
And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`): And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):
```sh ```sh
mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```

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

@ -70,29 +70,29 @@ os.setenv('STARSHIP_CACHE', 'C:\\Users\\user\\AppData\\Local\\Temp')
By convention, most modules have a prefix of default terminal color (e.g. `via` in "nodejs") and an empty space as a suffix. By convention, most modules have a prefix of default terminal color (e.g. `via` in "nodejs") and an empty space as a suffix.
### Format Strings ### 格式字符串
Format strings are the format that a module prints all its variables with. Most modules have an entry called `format` that configures the display format of the module. You can use texts, variables and text groups in a format string. 模块通过格式字符串定义的格式输出它所有的变量。 大多数模块拥有一个名为 `format` 的入口来配置它的显示格式。 你可以在其中使用文本，变量或者文本组。
#### 字段 #### 字段
A variable contains a `$` symbol followed by the name of the variable. The name of a variable can only contain letters, numbers and `_`. A variable contains a `$` symbol followed by the name of the variable. The name of a variable can only contain letters, numbers and `_`.
For example: 例如：
- `$version` is a format string with a variable named `version`. - `$version` is a format string with a variable named `version`.
- `$git_branch$git_commit` is a format string with two variables named `git_branch` and `git_commit`. - `$git_branch$git_commit` is a format string with two variables named `git_branch` and `git_commit`.
- `$git_branch $git_commit` has the two variables separated with a space. - `$git_branch $git_commit` has the two variables separated with a space.
#### Text Group #### 文本组
A text group is made up of two different parts. 文本由以下两种括号来进行分组：
The first part, which is enclosed in a `[]`, is a [format string](#format-strings). You can add texts, variables, or even nested text groups in it. 第一种`[]`括号中的内容是[格式字符串](#format-strings)， 你可以在当中添加文本，变量甚至嵌套其他括号。
In the second part, which is enclosed in a `()`, is a [style string](#style-strings). This can be used to style the first part. 第二种`()`括号中的内容是[样式字符串](#style-strings)， 可用于指定第一种括号中内容的样式。
For example: 例如：
- `[on](red bold)` will print a string `on` with bold text colored red. - `[on](red bold)` will print a string `on` with bold text colored red.
- `[⌘ $version](bold green)` will print a symbol `⌘` followed by the content of variable `version`, with bold text colored green. - `[⌘ $version](bold green)` will print a symbol `⌘` followed by the content of variable `version`, with bold text colored green.
@ -115,15 +115,15 @@ Starship 中的大多数组件允许您为其设置显示样式。 显示样式
A conditional format string wrapped in `(` and `)` will not render if all variables inside are empty. A conditional format string wrapped in `(` and `)` will not render if all variables inside are empty.
For example: 例如：
- `(@$region)` will show nothing if the variable `region` is `None` or empty string, otherwise `@` followed by the value of region. - 如果变量 `region` 是 `None` 或者为空，`(@$region)` 将不会显示，否则 `@` 之后会显示 region 的值。
- `(some text)` will always show nothing since there are no variables wrapped in the braces. - `(some text)` 将永远不会显示因为在括号里并没有变量。
- When `$all` is a shortcut for `\[$a$b\]`, `($all)` will show nothing only if `$a` and `$b` are both `None`. This works the same as `(\[$a$b\] )`. - When `$all` is a shortcut for `\[$a$b\]`, `($all)` will show nothing only if `$a` and `$b` are both `None`. This works the same as `(\[$a$b\] )`.
#### Special characters #### 特殊字符
The following symbols have special usage in a format string and must be escaped: `$ \ [ ] ( )`. 以下符号在格式字符串中具有特殊用途，必须转义： `$ [ ] ( )`。
Note that TOML has [both basic strings and literal strings](https://toml.io/en/v1.0.0#string). It is recommended to use a literal string (surrounded by single quotes) in your config. If you want to use a basic string (surrounded by double quotes), you must escape the backslash itself (i.e. use `\\`). Note that TOML has [both basic strings and literal strings](https://toml.io/en/v1.0.0#string). It is recommended to use a literal string (surrounded by single quotes) in your config. If you want to use a basic string (surrounded by double quotes), you must escape the backslash itself (i.e. use `\\`).
@ -150,7 +150,7 @@ format = '''
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ----------------- | ----------------------------- | ---------------------------------------------------------------- | | ----------------- | ----------------------------- | ---------------------------------------------------------------- |
| `format` | [见下文](#default-prompt-format) | 配置提示符的格式。 | | `format` | [见下文](#default-prompt-format) | 配置提示符的格式。 |
| `right_format` | `""` | See [Enable Right Prompt](/advanced-config/#enable-right-prompt) | | `right_format` | `""` | See [Enable Right Prompt](/advanced-config/#enable-right-prompt) |
@ -178,7 +178,7 @@ add_newline = false
### 默认提示符格式 ### 默认提示符格式
The default `format` is used to define the format of the prompt, if empty or no `format` is provided. 默认设置如下： 如果没有提供`format`字段或者它的值是空的，将会使用默认的`format`配置来指定提示符的格式。 默认配置如下：
```toml ```toml
format = "$all" format = "$all"
@ -259,10 +259,10 @@ $shell\
$character""" $character"""
``` ```
If you just want to extend the default format, you can use `$all`; modules you explicitly add to the format will not be duplicated. Eg. 如果你只是想扩展默认的格式，你可以使用 `$all`; 你另外添加到格式中的modules不会重复出现。 例如：
```toml ```toml
# Move the directory to the second line # 将目录信息移到第二行
format = "$all$directory$character" format = "$all$directory$character"
``` ```
@ -280,16 +280,16 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | | ------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | 组件格式化模板。 | | `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)'` | 组件格式化模板。 |
| `symbol` | `"☁️ "` | 这个字段的内容会显示在当前 AWS 配置信息之前。 | | `symbol` | `"☁️ "` | 这个字段的内容会显示在当前 AWS 配置信息之前。 |
| `region_aliases` | | 地区缩写列表，用来显示在 AWS 主机名之后。 | | `region_aliases` | | 地区缩写列表，用来显示在 AWS 主机名之后。 |
| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | | `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. |
| `style` | `"bold yellow"` | 此组件的样式。 | | `style` | `"bold yellow"` | 此组件的样式。 |
| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. | | `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. |
| `disabled` | `false` | 禁用 `AWS` 组件。 | | `disabled` | `false` | 禁用 `AWS` 组件。 |
| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. | | `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. |
### Variables ### Variables
@ -379,7 +379,7 @@ style = "blue bold"
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| -------------------- | --------------------------------- | ---------------- | | -------------------- | --------------------------------- | ---------------- |
| `full_symbol` | `" "` | 显示于电池充满时。 | | `full_symbol` | `" "` | 显示于电池充满时。 |
| `charging_symbol` | `" "` | 显示于正在充电时。 | | `charging_symbol` | `" "` | 显示于正在充电时。 |
@ -417,7 +417,7 @@ The default value for the `charging_symbol` and `discharging_symbol` option is r
`display` 字段的子字段如下： `display` 字段的子字段如下：
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| -------------------- | ---------- | --------------------------------------------------------------------------------------------------------- | | -------------------- | ---------- | --------------------------------------------------------------------------------------------------------- |
| `threshold` | `10` | 当前显示设置的电量上限（见示例） | | `threshold` | `10` | 当前显示设置的电量上限（见示例） |
| `style` | `bold red` | 若组件被显示，则使用此样式 | | `style` | `bold red` | 若组件被显示，则使用此样式 |
@ -448,7 +448,7 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ------------------- | ------------------------------------------------------------ | ----------------------------------------------------- | | ------------------- | ------------------------------------------------------------ | ----------------------------------------------------- |
| `format` | `'with [$symbol($version \(Buf $buf_version\) )]($style)'` | The format for the `buf` module. | | `format` | `'with [$symbol($version \(Buf $buf_version\) )]($style)'` | The format for the `buf` module. |
| `version_format` | `"v${raw}"` | The version format. | | `version_format` | `"v${raw}"` | The version format. |
@ -484,7 +484,7 @@ The `c` module shows some information about your C compiler. By default the modu
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------- | | ------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version(-$name) )]($style)"` | The format string for the module. | | `format` | `"via [$symbol($version(-$name) )]($style)"` | The format string for the module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
@ -543,7 +543,7 @@ By default it only changes color. If you also want to change its shape take a lo
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ---------------- | ------------------- | -------------------------------------------------------------------------------- | | ---------------- | ------------------- | -------------------------------------------------------------------------------- |
| `format` | `"$symbol "` | The format string used before the text input. | | `format` | `"$symbol "` | The format string used before the text input. |
| `success_symbol` | `"[❯](bold green)"` | The format string used before the text input if the previous command succeeded. | | `success_symbol` | `"[❯](bold green)"` | The format string used before the text input if the previous command succeeded. |
@ -597,7 +597,7 @@ The `cmake` module shows the currently installed version of [CMake](https://cmak
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ------------------- | -------------------------------------- | ------------------------------------------------------------------------- | | ------------------- | -------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | | `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
@ -627,7 +627,7 @@ The `cobol` module shows the currently installed version of COBOL. By default, t
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `symbol` | `"⚙️ "` | The symbol used before displaying the version of COBOL. | | `symbol` | `"⚙️ "` | The symbol used before displaying the version of COBOL. |
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | | `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
@ -662,7 +662,7 @@ The `cobol` module shows the currently installed version of COBOL. By default, t
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ---------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ---------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `min_time` | `2_000` | 显示此组件所需的最短执行时长（单位：毫秒）。 | | `min_time` | `2_000` | 显示此组件所需的最短执行时长（单位：毫秒）。 |
| `show_milliseconds` | `false` | 除了秒数外在执行时长中额外显示毫秒。 | | `show_milliseconds` | `false` | 除了秒数外在执行时长中额外显示毫秒。 |
@ -704,7 +704,7 @@ The `conda` module shows the current [Conda](https://docs.conda.io/en/latest/) e
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ------------------- | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | | ------------------- | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| `truncation_length` | `1` | 如果这个 conda 环境是通过 `conda create -p [path]` 创建的，环境路径的目录深度应该被截断到此数量。 `0` 表示不用截断。 另请参阅 [`directory`](#directory) 组件。 | | `truncation_length` | `1` | 如果这个 conda 环境是通过 `conda create -p [path]` 创建的，环境路径的目录深度应该被截断到此数量。 `0` 表示不用截断。 另请参阅 [`directory`](#directory) 组件。 |
| `symbol` | `"🅒 "` | 在环境名之前显示的符号。 | | `symbol` | `"🅒 "` | 在环境名之前显示的符号。 |
@ -738,7 +738,7 @@ The `container` module displays a symbol and container name, if inside a contain
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ---------- | -------------------------------------- | ----------------------------------------- | | ---------- | -------------------------------------- | ----------------------------------------- |
| `symbol` | `"⬢"` | The symbol shown, when inside a container | | `symbol` | `"⬢"` | The symbol shown, when inside a container |
| `style` | `"bold red dimmed"` | 此组件的样式。 | | `style` | `"bold red dimmed"` | 此组件的样式。 |
@ -773,7 +773,7 @@ The `crystal` module shows the currently installed version of [Crystal](https://
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | | `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. |
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | | `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
@ -813,7 +813,7 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------- | | ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | | `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
@ -851,7 +851,7 @@ The `deno` module shows you your currently installed version of [Deno](https://d
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ------------------- | ----------------------------------------------------------------------- | ------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | | `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
@ -889,7 +889,7 @@ format = "via [🦕 $version](green bold) "
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ------------------- | ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| `truncation_length` | `3` | 当前目录路径被截断后最多保留的父目录数量。 | | `truncation_length` | `3` | 当前目录路径被截断后最多保留的父目录数量。 |
| `truncate_to_repo` | `true` | 是否只截断到您当前处于的 git 仓库根目录下。 | | `truncate_to_repo` | `true` | 是否只截断到您当前处于的 git 仓库根目录下。 |
@ -965,7 +965,7 @@ The `docker_context` module shows the currently active [Docker context](https://
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- | | ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `format` | `"via [$symbol$context]($style) "` | 组件格式化模板。 | | `format` | `"via [$symbol$context]($style) "` | 组件格式化模板。 |
| `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. | | `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. |
@ -1018,7 +1018,7 @@ The module will also show the Target Framework Moniker (<https://docs.microsoft.
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | | ------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )(🎯 $tfm )]($style)"` | 组件格式化模板。 | | `format` | `"via [$symbol($version )(🎯 $tfm )]($style)"` | 组件格式化模板。 |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
@ -1060,7 +1060,7 @@ The `elixir` module shows the currently installed version of [Elixir](https://el
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. | | `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
@ -1103,7 +1103,7 @@ The `elm` module shows the currently installed version of [Elm](https://elm-lang
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ------------------- | -------------------------------------------------- | ------------------------------------------------------------------------- | | ------------------- | -------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | | `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
@ -1140,7 +1140,9 @@ The `env_var` module displays the current value of a selected environment variab
- 设置的 `variable` 是一个已存在的环境变量 - 设置的 `variable` 是一个已存在的环境变量
- 未定义 `variable`，但定义了 `default` - 未定义 `variable`，但定义了 `default`
::: tip Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. ::: tip
Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character.
Example: following configuration will display value of USER environment variable Example: following configuration will display value of USER environment variable
@ -1155,7 +1157,7 @@ default = "unknown user"
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ---------- | ------------------------------ | ------------------- | | ---------- | ------------------------------ | ------------------- |
| `symbol` | `""` | 这个字段的内容会显示在环境变量值之前。 | | `symbol` | `""` | 这个字段的内容会显示在环境变量值之前。 |
| `variable` | | 要显示的环境变量。 | | `variable` | | 要显示的环境变量。 |
@ -1204,7 +1206,7 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https:
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | | `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
@ -1240,7 +1242,7 @@ The `fill` module fills any extra space on the line with a symbol. If multiple `
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ---------- | -------------- | --------------------------------- | | ---------- | -------------- | --------------------------------- |
| `symbol` | `"."` | The symbol used to fill the line. | | `symbol` | `"."` | The symbol used to fill the line. |
| `style` | `"bold black"` | 此组件的样式。 | | `style` | `"bold black"` | 此组件的样式。 |
@ -1269,7 +1271,7 @@ The `gcloud` module shows the current configuration for [`gcloud`](https://cloud
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ----------------- | ---------------------------------------------------------- | ---------------------------------------------------------------- | | ----------------- | ---------------------------------------------------------- | ---------------------------------------------------------------- |
| `format` | `'on [$symbol$account(@$domain)(\($region\))]($style) '` | 组件格式化模板。 | | `format` | `'on [$symbol$account(@$domain)(\($region\))]($style) '` | 组件格式化模板。 |
| `symbol` | `"☁️ "` | The symbol used before displaying the current GCP profile. | | `symbol` | `"☁️ "` | The symbol used before displaying the current GCP profile. |
@ -1342,17 +1344,17 @@ very-long-project-name = "vlpn"
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| -------------------- | -------------------------------- | ------------------------------------------------------------------------------------ | | -------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------ |
| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | | `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. |
| `format` | `"on [$symbol$branch]($style) "` | 组件格式化模板。 Use `"$branch"` to refer to the current branch name. | | `format` | `"on [$symbol$branch(:$remote_branch)]($style) "` | 组件格式化模板。 Use `"$branch"` to refer to the current branch name. |
| `symbol` | `" "` | A format string representing the symbol of git branch. | | `symbol` | `" "` | A format string representing the symbol of git branch. |
| `style` | `"bold purple"` | 此组件的样式。 | | `style` | `"bold purple"` | 此组件的样式。 |
| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | | `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. |
| `truncation_symbol` | `"…"` | 此字段的内容用来表示分支名称被截断。 You can use `""` for no symbol. | | `truncation_symbol` | `"…"` | 此字段的内容用来表示分支名称被截断。 You can use `""` for no symbol. |
| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | | `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". | | `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for "master" or "main". |
| `disabled` | `false` | 禁用 `git_branch` 组件。 | | `disabled` | `false` | 禁用 `git_branch` 组件。 |
### Variables ### Variables
@ -1384,7 +1386,7 @@ The `git_commit` module shows the current commit hash and also the tag (if any)
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| -------------------- | ---------------------------------- | ------------------------------------------------------- | | -------------------- | ---------------------------------- | ------------------------------------------------------- |
| `commit_hash_length` | `7` | 显示的 git 提交哈希值的长度。 | | `commit_hash_length` | `7` | 显示的 git 提交哈希值的长度。 |
| `format` | `"[\\($hash$tag\\)]($style) "` | 组件格式化模板。 | | `format` | `"[\\($hash$tag\\)]($style) "` | 组件格式化模板。 |
@ -1419,7 +1421,7 @@ tag_symbol = "🔖 "
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| -------------- | --------------------------------------------------------------- | --------------------------------------------------------------------------------------- | | -------------- | --------------------------------------------------------------- | --------------------------------------------------------------------------------------- |
| `rebase` | `"REBASING"` | A format string displayed when a `rebase` is in progress. | | `rebase` | `"REBASING"` | A format string displayed when a `rebase` is in progress. |
| `merge` | `"MERGING"` | A format string displayed when a `merge` is in progress. | | `merge` | `"MERGING"` | A format string displayed when a `merge` is in progress. |
@ -1465,7 +1467,7 @@ The `git_metrics` module will show the number of added and deleted lines in the
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| -------------------- | ------------------------------------------------------------ | ------------------------------------- | | -------------------- | ------------------------------------------------------------ | ------------------------------------- |
| `added_style` | `"bold green"` | The style for the added count. | | `added_style` | `"bold green"` | The style for the added count. |
| `deleted_style` | `"bold red"` | The style for the deleted count. | | `deleted_style` | `"bold red"` | The style for the deleted count. |
@ -1506,7 +1508,7 @@ The Git Status module is very slow in Windows directories (for example under `/m
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | The default format for `git_status` | | `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | The default format for `git_status` |
| `conflicted` | `"="` | 这个分支有合并冲突。 | | `conflicted` | `"="` | 这个分支有合并冲突。 |
@ -1602,6 +1604,7 @@ The `golang` module shows the currently installed version of [Go](https://golang
- 当前目录包含 `go.mod` 文件 - 当前目录包含 `go.mod` 文件
- 当前目录包含 `go.sum` 文件 - 当前目录包含 `go.sum` 文件
- 当前目录包含 `go.work` 文件
- 当前目录包含 `glide.yaml` 文件 - 当前目录包含 `glide.yaml` 文件
- 当前目录包含 `Gopkg.yml` 文件 - 当前目录包含 `Gopkg.yml` 文件
- 当前目录包含 `Gopkg.lock` 文件 - 当前目录包含 `Gopkg.lock` 文件
@ -1611,16 +1614,16 @@ The `golang` module shows the currently installed version of [Go](https://golang
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | | `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. | | `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
| `detect_extensions` | `["go"]` | Which extensions should trigger this module. | | `detect_extensions` | `["go"]` | Which extensions should trigger this module. |
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. | | `detect_files` | `["go.mod", "go.sum", "go.work", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `["Godeps"]` | Which folders should trigger this module. | | `detect_folders` | `["Godeps"]` | Which folders should trigger this module. |
| `style` | `"bold cyan"` | 此组件的样式。 | | `style` | `"bold cyan"` | 此组件的样式。 |
| `disabled` | `false` | 禁用 `golang` 组件。 | | `disabled` | `false` | 禁用 `golang` 组件。 |
### Variables ### Variables
@ -1652,7 +1655,7 @@ By default the module will be shown if any of the following conditions are met:
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ------------------- | ------------------------------------ | -------------------------------------------------- | | ------------------- | ------------------------------------ | -------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | | `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
| `symbol` | `"λ "` | A format string representing the symbol of Haskell | | `symbol` | `"λ "` | A format string representing the symbol of Haskell |
@ -1683,7 +1686,7 @@ The `helm` module shows the currently installed version of [Helm](https://helm.s
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | | `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
@ -1719,20 +1722,22 @@ format = "via [⎈ $version](bold white) "
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ---------- | --------------------------- | ------------------------------------------------------------------ | | ------------ | -------------------------------------- | ---------------------------------------------------------------------- |
| `ssh_only` | `true` | 仅在连接到 SSH 会话时显示主机名。 | | `ssh_only` | `true` | 仅在连接到 SSH 会话时显示主机名。 |
| `trim_at` | `"."` | 当主机名过长被截断时，会截断成第一次匹配该字符串之前的主机名。 `"."` 会让主机名截断到第一个点处。 `""` 会禁用任何截断。 | | `ssh_symbol` | `"🌐 "` | A format string representing the symbol when connected to SSH session. |
| `format` | `"[$hostname]($style) in "` | 组件格式化模板。 | | `trim_at` | `"."` | 当主机名过长被截断时，会截断成第一次匹配该字符串之前的主机名。 `"."` 会让主机名截断到第一个点处。 `""` 会禁用任何截断。 |
| `style` | `"bold dimmed green"` | 此组件的样式。 | | `format` | `"[$ssh_symbol$hostname]($style) in "` | 组件格式化模板。 |
| `disabled` | `false` | 禁用 `hostname` 组件。 | | `style` | `"bold dimmed green"` | 此组件的样式。 |
| `disabled` | `false` | 禁用 `hostname` 组件。 |
### Variables ### Variables
| 字段 | 示例 | 描述 | | 字段 | 示例 | 描述 |
| --------- | ---------- | ---------------------------- | | ---------- | ---------- | ----------------------------------------------------- |
| hostname | `computer` | The hostname of the computer | | hostname | `computer` | The hostname of the computer |
| style\* | | `style`对应值 | | style\* | | `style`对应值 |
| ssh_symbol | `"🌏 "` | The symbol to represent when connected to SSH session |
*: This variable can only be used as a part of a style string *: This variable can only be used as a part of a style string
@ -1743,7 +1748,7 @@ format = "via [⎈ $version](bold white) "
[hostname] [hostname]
ssh_only = false ssh_only = false
format = "on [$hostname](bold red) " format = "[$ssh_symbol](bold blue) on [$hostname](bold red) "
trim_at = ".companyname.com" trim_at = ".companyname.com"
disabled = false disabled = false
``` ```
@ -1757,7 +1762,7 @@ The `java` module shows the currently installed version of [Java](https://www.or
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ------------------- | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | | ------------------- | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `"via [${symbol}(${version} )]($style)"` | 组件格式化模板。 | | `format` | `"via [${symbol}(${version} )]($style)"` | 组件格式化模板。 |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
@ -1811,7 +1816,7 @@ The `threshold` option is deprecated, but if you want to use it, the module will
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ------------------ | ----------------------------- | ------------------------------------------------------------------------ | | ------------------ | ----------------------------- | ------------------------------------------------------------------------ |
| `threshold`* | `1` | 如果超过此字段的值，显示任务数量。 | | `threshold`* | `1` | 如果超过此字段的值，显示任务数量。 |
| `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. | | `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. |
@ -1854,7 +1859,7 @@ The `julia` module shows the currently installed version of [Julia](https://juli
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | | `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
@ -1892,7 +1897,7 @@ The `kotlin` module shows the currently installed version of [Kotlin](https://ko
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | | `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
@ -1943,7 +1948,7 @@ Displays the current [Kubernetes context](https://kubernetes.io/docs/concepts/co
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ----------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | | ----------------- | ---------------------------------------------------- | --------------------------------------------------------------------- |
| `symbol` | `"☸ "` | A format string representing the symbol displayed before the Cluster. | | `symbol` | `"☸ "` | A format string representing the symbol displayed before the Cluster. |
| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | 组件格式化模板。 | | `format` | `'[$symbol$context( \($namespace\))]($style) in '` | 组件格式化模板。 |
@ -2005,7 +2010,7 @@ Long and automatically generated cluster names can be identified and shortened u
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ---------- | ------- | --------------------------- | | ---------- | ------- | --------------------------- |
| `disabled` | `false` | 禁用 `line_break` 组件，使提示成为单行。 | | `disabled` | `false` | 禁用 `line_break` 组件，使提示成为单行。 |
@ -2024,7 +2029,7 @@ The `localip` module shows the IPv4 address of the primary network interface.
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ---------- | ------------------------- | ------------------------------------------------------ | | ---------- | ------------------------- | ------------------------------------------------------ |
| `ssh_only` | `true` | Only show IP address when connected to an SSH session. | | `ssh_only` | `true` | Only show IP address when connected to an SSH session. |
| `format` | `"[$localipv4]($style) "` | 组件格式化模板。 | | `format` | `"[$localipv4]($style) "` | 组件格式化模板。 |
@ -2061,7 +2066,7 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ------------------- | ------------------------------------ | -------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | -------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | | `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
@ -2106,7 +2111,7 @@ format = "via [🌕 $version](bold blue) "
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ----------- | ----------------------------------------------- | ---------------------- | | ----------- | ----------------------------------------------- | ---------------------- |
| `threshold` | `75` | 隐藏内存使用情况，除非它超过这个百分比。 | | `threshold` | `75` | 隐藏内存使用情况，除非它超过这个百分比。 |
| `format` | `"via $symbol [${ram}( \| ${swap})]($style) "` | 组件格式化模板。 | | `format` | `"via $symbol [${ram}( \| ${swap})]($style) "` | 组件格式化模板。 |
@ -2145,7 +2150,7 @@ style = "bold dimmed green"
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ------------------- | -------------------------------- | --------------------------------------------- | | ------------------- | -------------------------------- | --------------------------------------------- |
| `symbol` | `" "` | 该字段的内容显示于当前仓库的 hg 书签或活动分支名之前。 | | `symbol` | `" "` | 该字段的内容显示于当前仓库的 hg 书签或活动分支名之前。 |
| `style` | `"bold purple"` | 此组件的样式。 | | `style` | `"bold purple"` | 此组件的样式。 |
@ -2186,7 +2191,7 @@ The `nim` module shows the currently installed version of [Nim](https://nim-lang
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module | | `format` | `"via [$symbol($version )]($style)"` | The format for the module |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
@ -2223,7 +2228,7 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ------------ | ---------------------------------------------- | ----------------------------------------------------- | | ------------ | ---------------------------------------------- | ----------------------------------------------------- |
| `format` | `'via [$symbol$state( \($name\))]($style) '` | 组件格式化模板。 | | `format` | `'via [$symbol$state( \($name\))]($style) '` | 组件格式化模板。 |
| `symbol` | `"❄️ "` | A format string representing the symbol of nix-shell. | | `symbol` | `"❄️ "` | A format string representing the symbol of nix-shell. |
@ -2268,7 +2273,7 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ------------------- | ------------------------------------------ | ----------------------------------------------------------------------------------------------------- | | ------------------- | ------------------------------------------ | ----------------------------------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | | `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
@ -2312,7 +2317,7 @@ The `ocaml` module shows the currently installed version of [OCaml](https://ocam
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------- | | ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | The format string for the module. | | `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | The format string for the module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
@ -2352,7 +2357,7 @@ The `openstack` module shows the current OpenStack cloud and project. The module
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ---------- | --------------------------------------------------- | -------------------------------------------------------------- | | ---------- | --------------------------------------------------- | -------------------------------------------------------------- |
| `format` | `"on [$symbol$cloud(\\($project\\))]($style) "` | 组件格式化模板。 | | `format` | `"on [$symbol$cloud(\\($project\\))]($style) "` | 组件格式化模板。 |
| `symbol` | `"☁️ "` | The symbol used before displaying the current OpenStack cloud. | | `symbol` | `"☁️ "` | The symbol used before displaying the current OpenStack cloud. |
@ -2383,22 +2388,22 @@ symbol = "☁️ "
## Package Version ## Package Version
当前目录是软件包的代码仓库时，将显示 `package` 组件，并显示软件包当前版本。 The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `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` 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 - [**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 - [**Cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
- [**Nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command - [**Nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command
- [**Poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory - [**Poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
- [**Python**](https://www.python.org) - The `python` package version is extracted from the `setup.cfg` present in the current directory - [**Python**](https://www.python.org) - The `python` package version is extracted from a [PEP 621](https://peps.python.org/pep-0621/) compliant `pyproject.toml` or a `setup.cfg` present in the current directory
- [**Composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory - [**Composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory
- [**Gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present - [**Gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present in the current directory
- [**Julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present - [**Julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present in the current directory
- [**Mix**](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present - [**Mix**](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present in the current directory
- [**Helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present - [**Helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present in the current directory
- [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present - [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory
- [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present - [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present - [**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 - [**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 - [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory
- [**Dart**](https://pub.dev/) - The `dart` package version is extracted from the `pubspec.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
@ -2406,7 +2411,7 @@ symbol = "☁️ "
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ----------------- | --------------------------------- | ------------------------------------------------------------------------- | | ----------------- | --------------------------------- | ------------------------------------------------------------------------- |
| `format` | `"is [$symbol$version]($style) "` | 组件格式化模板。 | | `format` | `"is [$symbol$version]($style) "` | 组件格式化模板。 |
| `symbol` | `"📦 "` | 这个字段的内容会显示在当前软件包版本之前。 | | `symbol` | `"📦 "` | 这个字段的内容会显示在当前软件包版本之前。 |
@ -2446,7 +2451,7 @@ The `perl` module shows the currently installed version of [Perl](https://www.pe
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | | ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format string for the module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
@ -2484,7 +2489,7 @@ The `php` module shows the currently installed version of [PHP](https://www.php.
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | | `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
@ -2531,7 +2536,7 @@ By default the module will be shown if any of the following conditions are met:
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ---------------- | -------------------------------------------- | ------------------------------------------------------------------------- | | ---------------- | -------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($username@)$stack]($style) "` | The format string for the module. | | `format` | `"via [$symbol($username@)$stack]($style) "` | The format string for the module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
@ -2580,7 +2585,7 @@ The `purescript` module shows the currently installed version of [PureScript](ht
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | | `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
@ -2630,7 +2635,7 @@ By default the module will be shown if any of the following conditions are met:
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- | | -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- |
| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | 组件格式化模板。 | | `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | 组件格式化模板。 |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
@ -2713,7 +2718,7 @@ The `rlang` module shows the currently installed version of [R](https://www.r-pr
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | | `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
@ -2749,7 +2754,7 @@ By default the `red` module shows the currently installed version of [Red](https
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | | `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
@ -2792,7 +2797,7 @@ Starship gets the current Ruby version by running `ruby -v`.
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | | `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
@ -2832,7 +2837,7 @@ By default the `rust` module shows the currently installed version of [Rust](htt
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | | `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
@ -2845,11 +2850,13 @@ By default the `rust` module shows the currently installed version of [Rust](htt
### Variables ### Variables
| 字段 | 示例 | 描述 | | 字段 | 示例 | 描述 |
| --------- | ----------------- | ---------------------- | | --------- | ----------------- | -------------------------------------------- |
| version | `v1.43.0-nightly` | The version of `rustc` | | version | `v1.43.0-nightly` | The version of `rustc` |
| symbol | | `symbol`对应值 | | numver | `1.51.0` | The numeric component of the `rustc` version |
| style\* | | `style`对应值 | | toolchain | `beta` | The toolchain version |
| symbol | | `symbol`对应值 |
| style\* | | `style`对应值 |
*: This variable can only be used as a part of a style string *: This variable can only be used as a part of a style string
@ -2872,7 +2879,7 @@ The `scala` module shows the currently installed version of [Scala](https://www.
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ------------------- | ---------------------------------------- | ------------------------------------------------------------------------- | | ------------------- | ---------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `"via [${symbol}(${version} )]($style)"` | 组件格式化模板。 | | `format` | `"via [${symbol}(${version} )]($style)"` | 组件格式化模板。 |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
@ -2914,7 +2921,7 @@ The `shell` module shows an indicator for currently used shell.
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ---------------------- | ------------------------- | ------------------------------------------------------------ | | ---------------------- | ------------------------- | ------------------------------------------------------------ |
| `bash_indicator` | `bsh` | A format string used to represent bash. | | `bash_indicator` | `bsh` | A format string used to represent bash. |
| `fish_indicator` | `fsh` | A format string used to represent fish. | | `fish_indicator` | `fsh` | A format string used to represent fish. |
@ -2959,7 +2966,7 @@ The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/int
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ----------- | ---------------------------- | ------------------------------------------------------------- | | ----------- | ---------------------------- | ------------------------------------------------------------- |
| `threshold` | `2` | Display threshold. | | `threshold` | `2` | Display threshold. |
| `format` | `"[$symbol$shlvl]($style) "` | 组件格式化模板。 | | `format` | `"[$symbol$shlvl]($style) "` | 组件格式化模板。 |
@ -2995,7 +3002,7 @@ The `singularity` module shows the current [Singularity](https://sylabs.io/singu
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ---------- | -------------------------------- | ------------------------------------------------ | | ---------- | -------------------------------- | ------------------------------------------------ |
| `format` | `'[$symbol\[$env\]]($style) '` | 组件格式化模板。 | | `format` | `'[$symbol\[$env\]]($style) '` | 组件格式化模板。 |
| `symbol` | `""` | A format string displayed before the image name. | | `symbol` | `""` | A format string displayed before the image name. |
@ -3027,7 +3034,7 @@ The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/lat
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ------------------- | -------------------------------------- | --------------------------------------------------------------------------------------------------------------------- | | ------------------- | -------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
| `truncation_length` | `1` | The number of directories the environment path should be truncated to. `0` 表示不用截断。 另请参阅 [`directory`](#directory) 组件。 | | `truncation_length` | `1` | The number of directories the environment path should be truncated to. `0` 表示不用截断。 另请参阅 [`directory`](#directory) 组件。 |
| `symbol` | `"🅢 "` | 在环境名之前显示的符号。 | | `symbol` | `"🅢 "` | 在环境名之前显示的符号。 |
@ -3066,7 +3073,7 @@ The `status` module displays the exit code of the previous command. If $success_
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ----------------------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------- | | ----------------------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------- |
| `format` | `"[$symbol$status]($style) "` | The format of the module | | `format` | `"[$symbol$status]($style) "` | The format of the module |
| `symbol` | `"✖"` | The symbol displayed on program error | | `symbol` | `"✖"` | The symbol displayed on program error |
@ -3126,7 +3133,7 @@ The `sudo` module displays if sudo credentials are currently cached. The module
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| --------------- | ----------------------- | ------------------------------------------------------- | | --------------- | ----------------------- | ------------------------------------------------------- |
| `format` | `[as $symbol]($style)"` | The format of the module | | `format` | `[as $symbol]($style)"` | The format of the module |
| `symbol` | `"🧙 "` | The symbol displayed when credentials are cached | | `symbol` | `"🧙 "` | The symbol displayed when credentials are cached |
@ -3172,7 +3179,7 @@ By default the `swift` module shows the currently installed version of [Swift](h
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | | `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
@ -3219,7 +3226,7 @@ By default the module will be shown if any of the following conditions are met:
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | | `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
@ -3273,7 +3280,7 @@ format = "[🏎💨 $workspace]($style) "
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ----------------- | ----------------------- | ----------------------------------------------------------------------------------------------------- | | ----------------- | ----------------------- | ----------------------------------------------------------------------------------------------------- |
| `format` | `"at [$time]($style) "` | The format string for the module. | | `format` | `"at [$time]($style) "` | The format string for the module. |
| `use_12hr` | `false` | 启用 12 小时格式 | | `use_12hr` | `false` | 启用 12 小时格式 |
@ -3324,7 +3331,7 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, `
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ------------- | ----------------------- | ------------------------------------------- | | ------------- | ----------------------- | ------------------------------------------- |
| `style_root` | `"bold red"` | The style used when the user is root/admin. | | `style_root` | `"bold red"` | The style used when the user is root/admin. |
| `style_user` | `"bold yellow"` | 非 root 用户使用的样式。 | | `style_user` | `"bold yellow"` | 非 root 用户使用的样式。 |
@ -3360,7 +3367,7 @@ The `vagrant` module shows the currently installed version of [Vagrant](https://
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | | `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
@ -3399,7 +3406,7 @@ The `vlang` module shows you your currently installed version of [V](https://vla
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- | | ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | | `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
@ -3432,7 +3439,7 @@ The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/v
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ---------- | -------------------------------- | ------------------------------------------------------ | | ---------- | -------------------------------- | ------------------------------------------------------ |
| `symbol` | | The symbol used before displaying the repository name. | | `symbol` | | The symbol used before displaying the repository name. |
| `style` | `"bold yellow"` | 此组件的样式。 | | `style` | `"bold yellow"` | 此组件的样式。 |
@ -3466,7 +3473,7 @@ By default the the `zig` module shows the currently installed version of [Zig](h
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | | `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
@ -3536,7 +3543,7 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt
### 配置项 ### 配置项
| Option | 默认值 | 描述 | | 选项 | 默认值 | 描述 |
| ------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `command` | `""` | The command whose output should be printed. The command will be passed on stdin to the shell. | | `command` | `""` | The command whose output should be printed. The command will be passed on stdin to the shell. |
| `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. | | `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. |

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

@ -326,7 +326,7 @@ eval $(starship init ion)
<details> <details>
<summary>Nushell</summary> <summary>Nushell</summary>
Run the following: Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
@ -336,11 +336,10 @@ 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`): And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):
```sh ```sh
starship init nu | save ~/.cache/starship/init.nu
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```
Note: Only Nushell v0.60+ is supported Note: Only Nushell v0.61+ is supported
</details> </details>
@ -390,7 +389,7 @@ eval "$(starship init zsh)"
### 步骤 3. 配置 Starship ### 步骤 3. 配置 Starship
打开一个新的 Shell 实例，你应该就能看到漂亮的 Shell 新提示符了。 如果你对默认配置感到满意，就可以开始享用了！ 打开一个新的 Shell 实例，你应该就能看到漂亮的 Shell 新提示符了。 如果你对默认配置感到满意，那么开始使用吧！
如果你想进一步配置 Starship，查阅下列内容： 如果你想进一步配置 Starship，查阅下列内容：

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

@ -120,7 +120,11 @@ description: Starship 是適合任何 shell 的最小、極速、高度客製化
#### Elvish #### Elvish
::: warning 只有 elvish v0.18 或以上版本才有支援 ::: ::: warning
Only elvish v0.18 or higher is supported.
:::
將以下內容放到 `~/.elvish/rc.elv` 的結尾： 將以下內容放到 `~/.elvish/rc.elv` 的結尾：
@ -144,7 +148,13 @@ description: Starship 是適合任何 shell 的最小、極速、高度客製化
#### Nushell #### Nushell
::: warning 這項設定可能在未來改變 Only Nushell v0.60+ is supported. ::: Run the following: ::: warning
This will change in the future. Only Nushell v0.61+ is supported.
:::
Add the following to to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu starship init nu | save ~/.cache/starship/init.nu
@ -153,8 +163,6 @@ description: Starship 是適合任何 shell 的最小、極速、高度客製化
And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`): And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):
```sh ```sh
mkdir ~/.cache/starship
starship init nu | save ~/.cache/starship/init.nu
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```

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

@ -280,16 +280,16 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL
### 選項 ### 選項
| Option | 預設 | 說明 | | Option | 預設 | 說明 |
| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | | ------------------- | --------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- |
| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | The format for the module. | | `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\] )]($style)'` | The format for the module. |
| `symbol` | `"☁️ "` | 顯示在目前 AWS 配置之前的符號。 | | `symbol` | `"☁️ "` | 顯示在目前 AWS 配置之前的符號。 |
| `region_aliases` | | 除了AWS名稱外，顯示區域別名表 | | `region_aliases` | | 除了AWS名稱外，顯示區域別名表 |
| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | | `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. |
| `style` | `"bold yellow"` | 這個模組的風格。 | | `style` | `"bold yellow"` | 這個模組的風格。 |
| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. | | `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. |
| `disabled` | `false` | 停用 `AWS` 模組。 | | `disabled` | `false` | 停用 `AWS` 模組。 |
| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. | | `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. |
### Variables ### Variables
@ -1140,7 +1140,9 @@ The `env_var` module displays the current value of a selected environment variab
- `variable` 設定選項符合一個存在的環境變數。 - `variable` 設定選項符合一個存在的環境變數。
- 沒有設定 `variable` 選項，但是有設定 `default` 選項。 - 沒有設定 `variable` 選項，但是有設定 `default` 選項。
::: tip Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. ::: tip
Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character.
Example: following configuration will display value of USER environment variable Example: following configuration will display value of USER environment variable
@ -1342,17 +1344,17 @@ very-long-project-name = "vlpn"
### 選項 ### 選項
| Option | 預設 | 說明 | | Option | 預設 | 說明 |
| -------------------- | -------------------------------- | ------------------------------------------------------------------------------------ | | -------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------ |
| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | | `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. |
| `format` | `"on [$symbol$branch]($style) "` | The format for the module. Use `"$branch"` to refer to the current branch name. | | `format` | `"on [$symbol$branch(:$remote_branch)]($style) "` | The format for the module. Use `"$branch"` to refer to the current branch name. |
| `symbol` | `" "` | A format string representing the symbol of git branch. | | `symbol` | `" "` | A format string representing the symbol of git branch. |
| `style` | `"bold purple"` | 這個模組的風格。 | | `style` | `"bold purple"` | 這個模組的風格。 |
| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | | `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. |
| `truncation_symbol` | `"…"` | 用來指示分支名稱被縮減的符號。 You can use `""` for no symbol. | | `truncation_symbol` | `"…"` | 用來指示分支名稱被縮減的符號。 You can use `""` for no symbol. |
| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | | `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". | | `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for "master" or "main". |
| `disabled` | `false` | 停用 `git_branch` 模組。 | | `disabled` | `false` | 停用 `git_branch` 模組。 |
### Variables ### Variables
@ -1602,6 +1604,7 @@ The `golang` module shows the currently installed version of [Go](https://golang
- 現在資料夾中含有一個 `go.mod` 檔案 - 現在資料夾中含有一個 `go.mod` 檔案
- 現在資料夾中含有一個 `go.sum` 檔案 - 現在資料夾中含有一個 `go.sum` 檔案
- 現在資料夾中含有一個 `go.work` 檔案
- 現在資料夾中含有一個 `glide.yaml` 檔案 - 現在資料夾中含有一個 `glide.yaml` 檔案
- 現在資料夾中含有一個 `Gopkg.yml` 檔案 - 現在資料夾中含有一個 `Gopkg.yml` 檔案
- 現在資料夾中含有一個 `Gopkg.lock` 檔案 - 現在資料夾中含有一個 `Gopkg.lock` 檔案
@ -1611,16 +1614,16 @@ The `golang` module shows the currently installed version of [Go](https://golang
### 選項 ### 選項
| Option | 預設 | 說明 | | Option | 預設 | 說明 |
| ------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------------------------- | | ------------------- | ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |
| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | | `format` | `"via [$symbol($version )]($style)"` | The format for the module. |
| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` |
| `symbol` | `"🐹 "` | A format string representing the symbol of Go. | | `symbol` | `"🐹 "` | A format string representing the symbol of Go. |
| `detect_extensions` | `["go"]` | Which extensions should trigger this module. | | `detect_extensions` | `["go"]` | Which extensions should trigger this module. |
| `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. | | `detect_files` | `["go.mod", "go.sum", "go.work", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Which filenames should trigger this module. |
| `detect_folders` | `["Godeps"]` | Which folders should trigger this module. | | `detect_folders` | `["Godeps"]` | Which folders should trigger this module. |
| `style` | `"bold cyan"` | 這個模組的風格。 | | `style` | `"bold cyan"` | 這個模組的風格。 |
| `disabled` | `false` | 停用 `golang` 模組。 | | `disabled` | `false` | 停用 `golang` 模組。 |
### Variables ### Variables
@ -1719,20 +1722,22 @@ format = "via [⎈ $version](bold white) "
### 選項 ### 選項
| Option | 預設 | 說明 | | Option | 預設 | 說明 |
| ---------- | --------------------------- | ---------------------------------------------------------- | | ------------ | -------------------------------------- | ---------------------------------------------------------------------- |
| `ssh_only` | `true` | 只在連接到一個 SSH session 時顯示主機名稱。 | | `ssh_only` | `true` | 只在連接到一個 SSH session 時顯示主機名稱。 |
| `trim_at` | `"."` | 擷取出主機名稱的斷點，以第一個符合的為準。 `"."` 會讓它停在第一個點的符號。 `""` 會停用任何的截斷功能。 | | `ssh_symbol` | `"🌐 "` | A format string representing the symbol when connected to SSH session. |
| `format` | `"[$hostname]($style) in "` | The format for the module. | | `trim_at` | `"."` | 擷取出主機名稱的斷點，以第一個符合的為準。 `"."` 會讓它停在第一個點的符號。 `""` 會停用任何的截斷功能。 |
| `style` | `"bold dimmed green"` | 這個模組的風格。 | | `format` | `"[$ssh_symbol$hostname]($style) in "` | The format for the module. |
| `disabled` | `false` | 停用 `hostname` 模組。 | | `style` | `"bold dimmed green"` | 這個模組的風格。 |
| `disabled` | `false` | 停用 `hostname` 模組。 |
### Variables ### Variables
| 變數 | 範例 | 說明 | | 變數 | 範例 | 說明 |
| --------- | ---------- | ----------------------------------- | | ---------- | ---------- | ----------------------------------------------------- |
| 主機名稱 | `computer` | The hostname of the computer | | 主機名稱 | `computer` | The hostname of the computer |
| style\* | | Mirrors the value of option `style` | | style\* | | Mirrors the value of option `style` |
| ssh_symbol | `"🌏 "` | The symbol to represent when connected to SSH session |
*: This variable can only be used as a part of a style string *: This variable can only be used as a part of a style string
@ -1743,7 +1748,7 @@ format = "via [⎈ $version](bold white) "
[hostname] [hostname]
ssh_only = false ssh_only = false
format = "on [$hostname](bold red) " format = "[$ssh_symbol](bold blue) on [$hostname](bold red) "
trim_at = ".companyname.com" trim_at = ".companyname.com"
disabled = false disabled = false
``` ```
@ -2383,22 +2388,22 @@ symbol = "☁️ "
## 套件版本 ## 套件版本
The `package` 模組在現在資料夾是一個套件的儲藏庫時出現，並顯示他的現在版本。 The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `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` 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 - [**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 - [**Cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory
- [**Nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command - [**Nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command
- [**Poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory - [**Poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory
- [**Python**](https://www.python.org) - The `python` package version is extracted from the `setup.cfg` present in the current directory - [**Python**](https://www.python.org) - The `python` package version is extracted from a [PEP 621](https://peps.python.org/pep-0621/) compliant `pyproject.toml` or a `setup.cfg` present in the current directory
- [**Composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory - [**Composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory
- [**Gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present - [**Gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present in the current directory
- [**Julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present - [**Julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present in the current directory
- [**Mix**](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present - [**Mix**](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present in the current directory
- [**Helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present - [**Helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present in the current directory
- [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present - [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present in the current directory
- [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present - [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present in the current directory
- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present - [**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 - [**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 - [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory
- [**Dart**](https://pub.dev/) - The `dart` package version is extracted from the `pubspec.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
@ -2845,11 +2850,13 @@ By default the `rust` module shows the currently installed version of [Rust](htt
### Variables ### Variables
| 變數 | 範例 | 說明 | | 變數 | 範例 | 說明 |
| --------- | ----------------- | ------------------------------------ | | --------- | ----------------- | -------------------------------------------- |
| version | `v1.43.0-nightly` | The version of `rustc` | | version | `v1.43.0-nightly` | The version of `rustc` |
| symbol | | Mirrors the value of option `symbol` | | numver | `1.51.0` | The numeric component of the `rustc` version |
| style\* | | Mirrors the value of option `style` | | toolchain | `beta` | The toolchain version |
| 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 *: This variable can only be used as a part of a style string

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

@ -326,7 +326,7 @@ eval $(starship init ion)
<details> <details>
<summary>Nushell</summary> <summary>Nushell</summary>
Run the following: Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell):
```sh ```sh
mkdir ~/.cache/starship mkdir ~/.cache/starship
@ -336,11 +336,10 @@ 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`): And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`):
```sh ```sh
starship init nu | save ~/.cache/starship/init.nu
source ~/.cache/starship/init.nu source ~/.cache/starship/init.nu
``` ```
Note: Only Nushell v0.60+ is supported Note: Only Nushell v0.61+ is supported
</details> </details>