diff --git a/docs/ar-SA/README.md b/docs/ar-SA/README.md index e899fb40..18f935c4 100644 --- a/docs/ar-SA/README.md +++ b/docs/ar-SA/README.md @@ -149,14 +149,14 @@ description: Starship is the minimal, blazing fast, and extremely customizable p ::: warning - This will change in the future. Only Nushell v0.61+ is supported. + This will change in the future. Only Nushell v0.73+ is supported. ::: - Add the following to to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell): + Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell): ```sh mkdir ~/.cache/starship - starship init nu | save ~/.cache/starship/init.nu + starship init nu | save -f ~/.cache/starship/init.nu ``` And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`): diff --git a/docs/ar-SA/advanced-config/README.md b/docs/ar-SA/advanced-config/README.md index 110d965c..7fd8bfb9 100644 --- a/docs/ar-SA/advanced-config/README.md +++ b/docs/ar-SA/advanced-config/README.md @@ -207,8 +207,6 @@ Note: The right prompt is a single line following the input location. To right a `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell. -Note: Nushell 0.71.0 or later is required - ### مثال ```toml @@ -231,7 +229,7 @@ Produces a prompt like the following: Some shells support a continuation prompt along with the normal prompt. This prompt is rendered instead of the normal prompt when the user has entered an incomplete statement (such as a single left parenthesis or quote). -Starship can set the continuation prompt using the `continuation_prompt` option. The default prompt is `"[∙](bright-black) "`. +Starship can set the continuation prompt using the `continuation_prompt` option. The default prompt is `'[∙](bright-black) '`. Note: `continuation_prompt` should be set to a literal string without any variables. @@ -247,7 +245,7 @@ Note: Continuation prompts are only available in the following shells: # ~/.config/starship.toml # A continuation prompt that displays two filled in arrows -continuation_prompt = "▶▶" +continuation_prompt = '▶▶ ' ``` ## Style Strings diff --git a/docs/ar-SA/config/README.md b/docs/ar-SA/config/README.md index 23b26afe..51efe18e 100644 --- a/docs/ar-SA/config/README.md +++ b/docs/ar-SA/config/README.md @@ -252,12 +252,14 @@ $singularity\ $kubernetes\ $directory\ $vcsh\ +$fossil_branch\ $git_branch\ $git_commit\ $git_state\ $git_metrics\ $git_status\ $hg_branch\ +$pijul_channel\ $docker_context\ $package\ $c\ @@ -270,6 +272,7 @@ $dotnet\ $elixir\ $elm\ $erlang\ +$fennel\ $golang\ $guix_shell\ $haskell\ @@ -278,6 +281,7 @@ $helm\ $java\ $julia\ $kotlin\ +$gradle\ $lua\ $nim\ $nodejs\ @@ -1305,6 +1309,12 @@ The `env_var` module displays the current value of a selected environment variab ::: tip +The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. + +::: + +::: 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 @@ -1320,13 +1330,14 @@ default = 'unknown user' ### Options -| Option | الافتراضي | الوصف | -| ----------- | ------------------------------ | ---------------------------------------------------------------------------- | -| `symbol` | `''` | The symbol used before displaying the variable value. | -| `variable` | | The environment variable to be displayed. | -| `الافتراضي` | | The default value to be displayed when the selected variable is not defined. | -| `format` | `'with [$env_value]($style) '` | The format for the module. | -| `disabled` | `false` | Disables the `env_var` module. | +| Option | الافتراضي | الوصف | +| ------------- | ------------------------------ | ---------------------------------------------------------------------------- | +| `symbol` | `""` | The symbol used before displaying the variable value. | +| `variable` | | The environment variable to be displayed. | +| `الافتراضي` | | The default value to be displayed when the selected variable is not defined. | +| `format` | `"with [$env_value]($style) "` | The format for the module. | +| `description` | `""` | The description of the module that is shown when running `starship explain`. | +| `disabled` | `false` | Disables the `env_var` module. | ### Variables @@ -1399,6 +1410,44 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https: format = 'via [e $version](bold red) ' ``` +## Fennel + +The `fennel` module shows the currently installed version of [Fennel](https://fennel-lang.org). By default the module will be shown if any of the following conditions are met: + +- The current directory contains a file with the `.fnl` extension + +### Options + +| Option | الافتراضي | الوصف | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. | +| `style` | `'bold green'` | The style for the module. | +| `detect_extensions` | `[fnl]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `disabled` | `false` | Disables the `fennel` module. | + +### Variables + +| Variable | مثال | الوصف | +| --------- | -------- | ------------------------------------ | +| version | `v1.2.1` | The version of `fennel` | +| symbol | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | + +*: This variable can only be used as a part of a style string + +### مثال + +```toml +# ~/.config/starship.toml + +[fennel] +symbol = '⫰ ' +``` + ## Fill The `fill` module fills any extra space on the line with a symbol. If multiple `fill` modules are present in a line they will split the space evenly between them. This is useful for aligning other modules. @@ -1428,6 +1477,42 @@ Produces a prompt that looks like: AA -------------------------------------------- BB -------------------------------------------- CC ``` +## Fossil Branch + +The `fossil_branch` module shows the name of the active branch of the check-out in your current directory. + +### Options + +| Option | الافتراضي | الوصف | +| ------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | +| `format` | `'on [$symbol$branch]($style) '` | The format for the module. Use `'$branch'` to refer to the current branch name. | +| `symbol` | `' '` | The symbol used before the branch name of the check-out in your current directory. | +| `style` | `'bold purple'` | The style for the module. | +| `truncation_length` | `2^63 - 1` | Truncates a Fossil branch name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. | +| `disabled` | `true` | Disables the `fossil_branch` module. | + +### Variables + +| Variable | مثال | الوصف | +| --------- | ------- | ------------------------------------ | +| branch | `trunk` | The active Fossil branch | +| symbol | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | + +*: This variable can only be used as a part of a style string + +### مثال + +```toml +# ~/.config/starship.toml + +[fossil_branch] +symbol = '🦎 ' +truncation_length = 4 +truncation_symbol = '' +``` + ## Google Cloud (`gcloud`) The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var. @@ -1562,10 +1647,11 @@ The `git_commit` module shows the current commit hash and also the tag (if any) ### Variables -| Variable | مثال | الوصف | -| --------- | --------- | ----------------------------------- | -| hash | `b703eb3` | The current git commit hash | -| style\* | | Mirrors the value of option `style` | +| Variable | مثال | الوصف | +| --------- | --------- | -------------------------------------------- | +| hash | `b703eb3` | The current git commit hash | +| tag | `v1.0.0` | The tag name if showing tag info is enabled. | +| style\* | | Mirrors the value of option `style` | *: This variable can only be used as a part of a style string @@ -1840,6 +1926,41 @@ disabled = true format = 'via [🐂](yellow bold) ' ``` +## Gradle + +The `gradle` module shows the version of the [Gradle Wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html) currently used in the project directory. + +By default the module will be shown if any of the following conditions are met: + +- The current directory contains a `gradle/wrapper/gradle-wrapper.properties` directory. +- The current directory contains a file ending with `.gradle` or `.gradle.kts`. + +The `gradle` module is only able to read your Gradle Wrapper version from your config file, we don't execute your wrapper, because of the security concerns. + +### Options + +| Option | الافتراضي | الوصف | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🅶 "` | A format string representing the symbol of Gradle. | +| `detect_extensions` | `["gradle", "gradle.kts"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `["gradle"]` | Which folders should trigger this module. | +| `style` | `"bold bright-cyan"` | The style for the module. | +| `disabled` | `false` | Disables the `gradle` module. | +| `recursive` | `false` | Enables recursive finding for the `gradle` directory. | + +### Variables + +| Variable | مثال | الوصف | +| -------- | -------- | ------------------------------------ | +| version | `v7.5.1` | The version of `gradle` | +| 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 + ## Haskell The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot. @@ -2038,13 +2159,13 @@ The default functionality is: - 1 job -> `symbol` is shown. - 2 jobs or more -> `symbol` + `number` are shown. -::: warning +::: تحذير This module is not supported on tcsh and nu. ::: -::: warning +::: تحذير The `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. @@ -2440,26 +2561,27 @@ style = 'bold dimmed green' ## Mercurial Branch -The `hg_branch` module shows the active branch of the repo in your current directory. +The `hg_branch` module shows the active branch and topic of the repo in your current directory. ### Options -| Option | الافتراضي | الوصف | -| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------- | -| `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. | -| `format` | `'on [$symbol$branch]($style) '` | The format for the module. | -| `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. | -| `disabled` | `true` | Disables the `hg_branch` module. | +| Option | الافتراضي | الوصف | +| ------------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------- | +| `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. | +| `format` | `'on [$symbol$branch(:$topic)]($style) '` | The format for the module. | +| `truncation_length` | `2^63 - 1` | Truncates the hg branch / topic name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. | +| `disabled` | `true` | Disables the `hg_branch` module. | ### Variables -| Variable | مثال | الوصف | -| --------- | -------- | ------------------------------------ | -| branch | `master` | The active mercurial branch | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| Variable | مثال | الوصف | +| --------- | --------- | ------------------------------------ | +| branch | `master` | The active mercurial branch | +| topic | `feature` | The active mercurial topic | +| 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 @@ -2522,14 +2644,16 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/ ### Options -| Option | الافتراضي | الوصف | -| ------------ | ---------------------------------------------- | ----------------------------------------------------- | -| `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. | -| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | -| `style` | `'bold blue'` | The style for the module. | -| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | -| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | -| `disabled` | `false` | Disables the `nix_shell` module. | +| Option | الافتراضي | الوصف | +| ------------- | ---------------------------------------------- | --------------------------------------------------------------------- | +| `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. | +| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | +| `style` | `'bold blue'` | The style for the module. | +| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | +| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | +| `unknown_msg` | `''` | A format string shown when it is unknown if the shell is pure/impure. | +| `disabled` | `false` | Disables the `nix_shell` module. | +| `heuristic` | `false` | Attempts to detect new `nix shell`-style shells with a heuristic. | ### Variables @@ -2551,6 +2675,7 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/ disabled = true impure_msg = '[impure shell](bold red)' pure_msg = '[pure shell](bold green)' +unknown_msg = '[unknown shell](bold yellow)' format = 'via [☃️ $state( \($name\))](bold blue) ' ``` @@ -2720,7 +2845,7 @@ symbol = '☁️ ' The `os` module shows the current operating system. OS information is detected via the [os_info](https://lib.rs/crates/os_info) crate. -::: warning +::: تحذير The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. @@ -2947,6 +3072,21 @@ The `php` module shows the currently installed version of [PHP](https://www.php. format = 'via [🔹 $version](147 bold) ' ``` +## Pijul Channel + +The `pijul_channel` module shows the active channel of the repo in your current directory. + +### Options + +| Option | الافتراضي | الوصف | +| ------------------- | --------------------------------- | ------------------------------------------------------------------------------------ | +| `symbol` | `' '` | The symbol used before the pijul channel name of the repo in your current directory. | +| `style` | `'bold purple'` | The style for the module. | +| `format` | `'on [$symbol$channel]($style) '` | The format for the module. | +| `truncation_length` | `2^63 - 1` | Truncates the pijul channel name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. | +| `disabled` | `true` | Disables the `pijul` module. | + ## Pulumi The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. @@ -4016,7 +4156,7 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt | `command` | `''` | The command whose output should be printed. The command will be passed on stdin to the shell. | | `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. | | `shell` | | [See below](#custom-command-shell) | -| `الوصف` | `''` | The description of the module that is shown when running `starship explain`. | +| `description` | `''` | The description of the module that is shown when running `starship explain`. | | `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_extensions` | `[]` | The extensions that will be searched in the working directory for a match. | diff --git a/docs/ar-SA/guide/README.md b/docs/ar-SA/guide/README.md index 30d9e145..c5c3e807 100644 --- a/docs/ar-SA/guide/README.md +++ b/docs/ar-SA/guide/README.md @@ -9,7 +9,7 @@

GitHub Actions workflow status @@ -423,6 +423,7 @@ Support this project by [becoming a sponsor](https://github.com/sponsors/starshi **Supporter Tier** - [Dimension](https://dimension.dev/) +- [Appwrite](https://appwrite.io/)


diff --git a/docs/ar-SA/installing/README.md b/docs/ar-SA/installing/README.md index 9f8b27f5..69b986a5 100644 --- a/docs/ar-SA/installing/README.md +++ b/docs/ar-SA/installing/README.md @@ -15,7 +15,7 @@ There are so many platforms out there that they didn't fit into the main README. Head over to the [Chocolatey installation page](https://chocolatey.org/install) and follow the instructions to install Chocolatey. -### Installation +### التثبيت ```powershell choco install starship @@ -29,7 +29,7 @@ choco install starship pkg install getconf ``` -### Installation +### التثبيت ```sh curl -sS https://starship.rs/install.sh | sh -s -- --bin-dir /data/data/com.termux/files/usr/bin @@ -37,7 +37,7 @@ curl -sS https://starship.rs/install.sh | sh -s -- --bin-dir /data/data/com.term ## [Funtoo Linux](https://www.funtoo.org/Welcome) -### Installation +### التثبيت On Funtoo Linux, starship can be installed from [core-kit](https://github.com/funtoo/core-kit/tree/1.4-release/app-shells/starship) via Portage: diff --git a/docs/ar-SA/presets/README.md b/docs/ar-SA/presets/README.md index cb3dcf1b..3903bc17 100644 --- a/docs/ar-SA/presets/README.md +++ b/docs/ar-SA/presets/README.md @@ -14,7 +14,11 @@ This preset changes the symbols for each module to use Nerd Font symbols. This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt. -::: tip This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). ::: +::: tip + +This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). + +::: [Click to view No Nerd Font preset](./no-nerd-font) diff --git a/docs/ckb-IR/README.md b/docs/ckb-IR/README.md index 068d2147..37c6a778 100644 --- a/docs/ckb-IR/README.md +++ b/docs/ckb-IR/README.md @@ -149,14 +149,14 @@ description: 'Starship: یەکێ لە promptـە سوکەڵە، خێرا، و ب ::: warning - This will change in the future. Only Nushell v0.61+ is supported. + This will change in the future. Only Nushell v0.73+ is supported. ::: - Add the following to to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell): + Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell): ```sh mkdir ~/.cache/starship - starship init nu | save ~/.cache/starship/init.nu + starship init nu | save -f ~/.cache/starship/init.nu ``` And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`): diff --git a/docs/ckb-IR/advanced-config/README.md b/docs/ckb-IR/advanced-config/README.md index 23c3bd21..68f03211 100644 --- a/docs/ckb-IR/advanced-config/README.md +++ b/docs/ckb-IR/advanced-config/README.md @@ -207,8 +207,6 @@ Note: The right prompt is a single line following the input location. To right a `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell. -Note: Nushell 0.71.0 or later is required - ### نموونە ```toml @@ -231,7 +229,7 @@ Produces a prompt like the following: Some shells support a continuation prompt along with the normal prompt. This prompt is rendered instead of the normal prompt when the user has entered an incomplete statement (such as a single left parenthesis or quote). -Starship can set the continuation prompt using the `continuation_prompt` option. The default prompt is `"[∙](bright-black) "`. +Starship can set the continuation prompt using the `continuation_prompt` option. The default prompt is `'[∙](bright-black) '`. Note: `continuation_prompt` should be set to a literal string without any variables. @@ -247,7 +245,7 @@ Note: Continuation prompts are only available in the following shells: # ~/.config/starship.toml # A continuation prompt that displays two filled in arrows -continuation_prompt = "▶▶" +continuation_prompt = '▶▶ ' ``` ## Style Strings diff --git a/docs/ckb-IR/config/README.md b/docs/ckb-IR/config/README.md index bac6c66c..ac669c12 100644 --- a/docs/ckb-IR/config/README.md +++ b/docs/ckb-IR/config/README.md @@ -252,12 +252,14 @@ $singularity\ $kubernetes\ $directory\ $vcsh\ +$fossil_branch\ $git_branch\ $git_commit\ $git_state\ $git_metrics\ $git_status\ $hg_branch\ +$pijul_channel\ $docker_context\ $package\ $c\ @@ -270,6 +272,7 @@ $dotnet\ $elixir\ $elm\ $erlang\ +$fennel\ $golang\ $guix_shell\ $haskell\ @@ -278,6 +281,7 @@ $helm\ $java\ $julia\ $kotlin\ +$gradle\ $lua\ $nim\ $nodejs\ @@ -1305,6 +1309,12 @@ The `env_var` module displays the current value of a selected environment variab ::: tip +The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. + +::: + +::: 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 @@ -1320,13 +1330,14 @@ default = 'unknown user' ### Options -| Option | Default | Description | -| ---------- | ------------------------------ | ---------------------------------------------------------------------------- | -| `symbol` | `''` | The symbol used before displaying the variable value. | -| `گۆڕاو` | | The environment variable to be displayed. | -| `default` | | The default value to be displayed when the selected variable is not defined. | -| `format` | `'with [$env_value]($style) '` | The format for the module. | -| `disabled` | `false` | Disables the `env_var` module. | +| Option | Default | Description | +| ------------- | ------------------------------ | ---------------------------------------------------------------------------- | +| `symbol` | `""` | The symbol used before displaying the variable value. | +| `گۆڕاو` | | The environment variable to be displayed. | +| `default` | | The default value to be displayed when the selected variable is not defined. | +| `format` | `"with [$env_value]($style) "` | The format for the module. | +| `description` | `""` | The description of the module that is shown when running `starship explain`. | +| `disabled` | `false` | Disables the `env_var` module. | ### Variables @@ -1399,6 +1410,44 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https: format = 'via [e $version](bold red) ' ``` +## Fennel + +The `fennel` module shows the currently installed version of [Fennel](https://fennel-lang.org). By default the module will be shown if any of the following conditions are met: + +- The current directory contains a file with the `.fnl` extension + +### Options + +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. | +| `style` | `'bold green'` | The style for the module. | +| `detect_extensions` | `[fnl]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `disabled` | `false` | Disables the `fennel` module. | + +### Variables + +| گۆڕاو | نموونە | Description | +| --------- | -------- | ------------------------------------ | +| version | `v1.2.1` | The version of `fennel` | +| symbol | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | + +*: This variable can only be used as a part of a style string + +### نموونە + +```toml +# ~/.config/starship.toml + +[fennel] +symbol = '⫰ ' +``` + ## Fill The `fill` module fills any extra space on the line with a symbol. If multiple `fill` modules are present in a line they will split the space evenly between them. This is useful for aligning other modules. @@ -1428,6 +1477,42 @@ Produces a prompt that looks like: AA -------------------------------------------- BB -------------------------------------------- CC ``` +## Fossil Branch + +The `fossil_branch` module shows the name of the active branch of the check-out in your current directory. + +### Options + +| Option | Default | Description | +| ------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | +| `format` | `'on [$symbol$branch]($style) '` | The format for the module. Use `'$branch'` to refer to the current branch name. | +| `symbol` | `' '` | The symbol used before the branch name of the check-out in your current directory. | +| `style` | `'bold purple'` | The style for the module. | +| `truncation_length` | `2^63 - 1` | Truncates a Fossil branch name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. | +| `disabled` | `true` | Disables the `fossil_branch` module. | + +### Variables + +| گۆڕاو | نموونە | Description | +| --------- | ------- | ------------------------------------ | +| branch | `trunk` | The active Fossil branch | +| symbol | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | + +*: This variable can only be used as a part of a style string + +### نموونە + +```toml +# ~/.config/starship.toml + +[fossil_branch] +symbol = '🦎 ' +truncation_length = 4 +truncation_symbol = '' +``` + ## Google Cloud (`gcloud`) The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var. @@ -1562,10 +1647,11 @@ The `git_commit` module shows the current commit hash and also the tag (if any) ### Variables -| گۆڕاو | نموونە | Description | -| --------- | --------- | ----------------------------------- | -| hash | `b703eb3` | The current git commit hash | -| style\* | | Mirrors the value of option `style` | +| گۆڕاو | نموونە | Description | +| --------- | --------- | -------------------------------------------- | +| hash | `b703eb3` | The current git commit hash | +| tag | `v1.0.0` | The tag name if showing tag info is enabled. | +| style\* | | Mirrors the value of option `style` | *: This variable can only be used as a part of a style string @@ -1840,6 +1926,41 @@ disabled = true format = 'via [🐂](yellow bold) ' ``` +## Gradle + +The `gradle` module shows the version of the [Gradle Wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html) currently used in the project directory. + +By default the module will be shown if any of the following conditions are met: + +- The current directory contains a `gradle/wrapper/gradle-wrapper.properties` directory. +- The current directory contains a file ending with `.gradle` or `.gradle.kts`. + +The `gradle` module is only able to read your Gradle Wrapper version from your config file, we don't execute your wrapper, because of the security concerns. + +### Options + +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🅶 "` | A format string representing the symbol of Gradle. | +| `detect_extensions` | `["gradle", "gradle.kts"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `["gradle"]` | Which folders should trigger this module. | +| `style` | `"bold bright-cyan"` | The style for the module. | +| `disabled` | `false` | Disables the `gradle` module. | +| `recursive` | `false` | Enables recursive finding for the `gradle` directory. | + +### Variables + +| گۆڕاو | نموونە | Description | +| ------- | -------- | ------------------------------------ | +| version | `v7.5.1` | The version of `gradle` | +| 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 + ## Haskell The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot. @@ -2038,13 +2159,13 @@ The default functionality is: - 1 job -> `symbol` is shown. - 2 jobs or more -> `symbol` + `number` are shown. -::: warning +::: ئاگادارکردنەوە This module is not supported on tcsh and nu. ::: -::: warning +::: ئاگادارکردنەوە The `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. @@ -2440,26 +2561,27 @@ style = 'bold dimmed green' ## Mercurial Branch -The `hg_branch` module shows the active branch of the repo in your current directory. +The `hg_branch` module shows the active branch and topic of the repo in your current directory. ### Options -| Option | Default | Description | -| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------- | -| `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. | -| `format` | `'on [$symbol$branch]($style) '` | The format for the module. | -| `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. | -| `disabled` | `true` | Disables the `hg_branch` module. | +| Option | Default | Description | +| ------------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------- | +| `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. | +| `format` | `'on [$symbol$branch(:$topic)]($style) '` | The format for the module. | +| `truncation_length` | `2^63 - 1` | Truncates the hg branch / topic name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. | +| `disabled` | `true` | Disables the `hg_branch` module. | ### Variables -| گۆڕاو | نموونە | Description | -| --------- | -------- | ------------------------------------ | -| branch | `master` | The active mercurial branch | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| گۆڕاو | نموونە | Description | +| --------- | --------- | ------------------------------------ | +| branch | `master` | The active mercurial branch | +| topic | `feature` | The active mercurial topic | +| 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 @@ -2522,23 +2644,25 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/ ### Options -| Option | Default | Description | -| ------------ | ---------------------------------------------- | ----------------------------------------------------- | -| `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. | -| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | -| `style` | `'bold blue'` | The style for the module. | -| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | -| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | -| `disabled` | `false` | Disables the `nix_shell` module. | +| Option | Default | Description | +| ------------- | ---------------------------------------------- | --------------------------------------------------------------------- | +| `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. | +| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | +| `style` | `'bold blue'` | The style for the module. | +| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | +| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | +| `unknown_msg` | `''` | A format string shown when it is unknown if the shell is pure/impure. | +| `disabled` | `false` | Disables the `nix_shell` module. | +| `heuristic` | `false` | Attempts to detect new `nix shell`-style shells with a heuristic. | ### Variables -| گۆڕاو | نموونە | Description | -| --------- | -------- | ------------------------------------ | -| state | `بێخەوش` | The state of the nix-shell | -| name | `lorri` | The name of the nix-shell | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| گۆڕاو | نموونە | Description | +| --------- | ------- | ------------------------------------ | +| state | `pure` | The state of the nix-shell | +| name | `lorri` | The name of the nix-shell | +| 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 @@ -2551,6 +2675,7 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/ disabled = true impure_msg = '[impure shell](bold red)' pure_msg = '[pure shell](bold green)' +unknown_msg = '[unknown shell](bold yellow)' format = 'via [☃️ $state( \($name\))](bold blue) ' ``` @@ -2720,7 +2845,7 @@ symbol = '☁️ ' The `os` module shows the current operating system. OS information is detected via the [os_info](https://lib.rs/crates/os_info) crate. -::: warning +::: ئاگادارکردنەوە The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. @@ -2947,6 +3072,21 @@ The `php` module shows the currently installed version of [PHP](https://www.php. format = 'via [🔹 $version](147 bold) ' ``` +## Pijul Channel + +The `pijul_channel` module shows the active channel of the repo in your current directory. + +### Options + +| Option | Default | Description | +| ------------------- | --------------------------------- | ------------------------------------------------------------------------------------ | +| `symbol` | `' '` | The symbol used before the pijul channel name of the repo in your current directory. | +| `style` | `'bold purple'` | The style for the module. | +| `format` | `'on [$symbol$channel]($style) '` | The format for the module. | +| `truncation_length` | `2^63 - 1` | Truncates the pijul channel name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. | +| `disabled` | `true` | Disables the `pijul` module. | + ## Pulumi The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. diff --git a/docs/ckb-IR/guide/README.md b/docs/ckb-IR/guide/README.md index d9344f93..469e323d 100644 --- a/docs/ckb-IR/guide/README.md +++ b/docs/ckb-IR/guide/README.md @@ -9,7 +9,7 @@

دۆخی ڕێڕەوی کارەکان لە GitHub Actions @@ -419,6 +419,7 @@ Support this project by [becoming a sponsor](https://github.com/sponsors/starshi **Supporter Tier** - [Dimension](https://dimension.dev/) +- [Appwrite](https://appwrite.io/)


diff --git a/docs/ckb-IR/installing/README.md b/docs/ckb-IR/installing/README.md index b5ecf298..1b4d1333 100644 --- a/docs/ckb-IR/installing/README.md +++ b/docs/ckb-IR/installing/README.md @@ -15,7 +15,7 @@ There are so many platforms out there that they didn't fit into the main README. Head over to the [Chocolatey installation page](https://chocolatey.org/install) and follow the instructions to install Chocolatey. -### Installation +### دامەزراندن ```powershell choco install starship @@ -29,7 +29,7 @@ choco install starship pkg install getconf ``` -### Installation +### دامەزراندن ```sh curl -sS https://starship.rs/install.sh | sh -s -- --bin-dir /data/data/com.termux/files/usr/bin @@ -37,7 +37,7 @@ curl -sS https://starship.rs/install.sh | sh -s -- --bin-dir /data/data/com.term ## [Funtoo Linux](https://www.funtoo.org/Welcome) -### Installation +### دامەزراندن On Funtoo Linux, starship can be installed from [core-kit](https://github.com/funtoo/core-kit/tree/1.4-release/app-shells/starship) via Portage: diff --git a/docs/ckb-IR/presets/README.md b/docs/ckb-IR/presets/README.md index fd49eb65..58dece9f 100644 --- a/docs/ckb-IR/presets/README.md +++ b/docs/ckb-IR/presets/README.md @@ -14,7 +14,11 @@ This preset changes the symbols for each module to use Nerd Font symbols. This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt. -::: tip This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). ::: +::: tip + +This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). + +::: [Click to view No Nerd Font preset](./no-nerd-font) diff --git a/docs/de-DE/README.md b/docs/de-DE/README.md index a03344d8..b81c2937 100644 --- a/docs/de-DE/README.md +++ b/docs/de-DE/README.md @@ -149,14 +149,14 @@ description: Starship ist eine minimale, super schnelle, und extrem anpassbare P ::: warning - Das wird sich in Zukunft ändern. Nur Nushell v0.61+ wird unterstützt. + Das wird sich in Zukunft ändern. Nur Nushell v0.73+ wird unterstützt. ::: - Füge folgendes an das Ende deiner Nushell env Datei hinzu (du findest diese, indem du folgenden Befehl in Nushell ausführst `$nu.env-path`): + Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell): ```sh mkdir ~/.cache/starship - starship init nu | save ~/.cache/starship/init.nu + starship init nu | save -f ~/.cache/starship/init.nu ``` Und füge folgendes am Ende deiner Nushell-Konfiguration hinzu (du findest diese, indem du folgenden Befehl in Nushell ausführst `$nu.config-path`): diff --git a/docs/de-DE/advanced-config/README.md b/docs/de-DE/advanced-config/README.md index bc1de8bb..8b76a6f4 100644 --- a/docs/de-DE/advanced-config/README.md +++ b/docs/de-DE/advanced-config/README.md @@ -207,8 +207,6 @@ Note: The right prompt is a single line following the input location. To right a `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell. -Note: Nushell 0.71.0 or later is required - ### Beispiel ```toml @@ -231,7 +229,7 @@ Produces a prompt like the following: Einige Shells unterstützen einen speziellen Fortsetzungsprompt zusätzlich zum normalen Prompt. Dieser Prompt wird anstelle des normalen Prompts ausgegeben, wenn der Benutzer ein unvollständiges Kommando eingegeben hat (etwa wie eine einzelne linke Klammer oder ein einzelnes Anführungszeichen). -Starship kann das Aussehen des Fortsetzungs-Prompts mit der `continuation_prompt` Option einstellen. The default prompt is `"[∙](bright-black) "`. +Starship kann das Aussehen des Fortsetzungs-Prompts mit der `continuation_prompt` Option einstellen. The default prompt is `'[∙](bright-black) '`. Hinweis: Die `continuation_prompt` Anweisung sollte auf einen literalen String ohne Variablen gesetzt werden. @@ -247,7 +245,7 @@ Hinweis: Fortsetzungs-Prompts sind nur für folgende Shells verfügbar: # ~/.config/starship.toml # Ein Fortsetzungs-Prompt der 2 ausgefüllte Pfeile darstellt -continuation_prompt = "▶▶" +continuation_prompt = '▶▶ ' ``` ## Style-Strings diff --git a/docs/de-DE/config/README.md b/docs/de-DE/config/README.md index 49426fae..f4fa2f6e 100644 --- a/docs/de-DE/config/README.md +++ b/docs/de-DE/config/README.md @@ -252,12 +252,14 @@ $singularity\ $kubernetes\ $directory\ $vcsh\ +$fossil_branch\ $git_branch\ $git_commit\ $git_state\ $git_metrics\ $git_status\ $hg_branch\ +$pijul_channel\ $docker_context\ $package\ $c\ @@ -270,6 +272,7 @@ $dotnet\ $elixir\ $elm\ $erlang\ +$fennel\ $golang\ $guix_shell\ $haskell\ @@ -278,6 +281,7 @@ $helm\ $java\ $julia\ $kotlin\ +$gradle\ $lua\ $nim\ $nodejs\ @@ -1305,6 +1309,12 @@ The `env_var` module displays the current value of a selected environment variab ::: tip +The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. + +::: + +::: 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 @@ -1320,13 +1330,14 @@ default = 'unknown user' ### Optionen -| Option | Standartwert | Beschreibung | -| ---------- | ------------------------------ | ---------------------------------------------------------------------------------------- | -| `symbol` | `''` | Das Symbol, das vor der Anzeige der Variable verwendet wird. | -| `variable` | | Die anzuzeigende Umgebungsvariable. | -| `default` | | Der Standardwert, der angezeigt wird, wenn die ausgewählte Variable nicht definiert ist. | -| `format` | `'with [$env_value]($style) '` | Das Format für das Modul. | -| `disabled` | `false` | Deaktiviert das `env_var`-Modul. | +| Option | Standartwert | Beschreibung | +| ------------- | ------------------------------ | ---------------------------------------------------------------------------------------- | +| `symbol` | `""` | Das Symbol, das vor der Anzeige der Variable verwendet wird. | +| `variable` | | Die anzuzeigende Umgebungsvariable. | +| `default` | | Der Standardwert, der angezeigt wird, wenn die ausgewählte Variable nicht definiert ist. | +| `format` | `"with [$env_value]($style) "` | Das Format für das Modul. | +| `description` | `""` | The description of the module that is shown when running `starship explain`. | +| `disabled` | `false` | Deaktiviert das `env_var`-Modul. | ### Variables @@ -1399,6 +1410,44 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https: format = 'via [e $version](bold red) ' ``` +## Fennel + +The `fennel` module shows the currently installed version of [Fennel](https://fennel-lang.org). By default the module will be shown if any of the following conditions are met: + +- The current directory contains a file with the `.fnl` extension + +### Optionen + +| Option | Standartwert | Beschreibung | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | Das Format für das Modul. | +| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. | +| `style` | `'bold green'` | Stil für dieses Modul. | +| `detect_extensions` | `[fnl]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `disabled` | `false` | Disables the `fennel` module. | + +### Variables + +| Variable | Beispiel | Beschreibung | +| --------- | -------- | ------------------------------------- | +| version | `v1.2.1` | The version of `fennel` | +| symbol | | Spiegelt den Wert der Option `symbol` | +| style\* | | Spiegelt den Wert der Option `style` | + +*: This variable can only be used as a part of a style string + +### Beispiel + +```toml +# ~/.config/starship.toml + +[fennel] +symbol = '⫰ ' +``` + ## Fill The `fill` module fills any extra space on the line with a symbol. If multiple `fill` modules are present in a line they will split the space evenly between them. This is useful for aligning other modules. @@ -1428,6 +1477,42 @@ Produces a prompt that looks like: AA -------------------------------------------- BB -------------------------------------------- CC ``` +## Fossil Branch + +The `fossil_branch` module shows the name of the active branch of the check-out in your current directory. + +### Optionen + +| Option | Standartwert | Beschreibung | +| ------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | +| `format` | `'on [$symbol$branch]($style) '` | Das Format für das Modul. Use `'$branch'` to refer to the current branch name. | +| `symbol` | `' '` | The symbol used before the branch name of the check-out in your current directory. | +| `style` | `'bold purple'` | Stil für dieses Modul. | +| `truncation_length` | `2^63 - 1` | Truncates a Fossil branch name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. | +| `disabled` | `true` | Disables the `fossil_branch` module. | + +### Variables + +| Variable | Beispiel | Beschreibung | +| --------- | -------- | ------------------------------------- | +| branch | `trunk` | The active Fossil branch | +| symbol | | Spiegelt den Wert der Option `symbol` | +| style\* | | Spiegelt den Wert der Option `style` | + +*: This variable can only be used as a part of a style string + +### Beispiel + +```toml +# ~/.config/starship.toml + +[fossil_branch] +symbol = '🦎 ' +truncation_length = 4 +truncation_symbol = '' +``` + ## Google Cloud (`gcloud`) The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var. @@ -1501,9 +1586,9 @@ format = 'on [$symbol$account(@$domain)(\($project\))]($style) ' very-long-project-name = 'vlpn' ``` -## Git-Branch +## Git Branch -Das `git_branch`-Modul zeigt den aktiven Git-Branch des Repositories im aktuellen Verzeichnis an. +The `git_branch` module shows the active branch of the repo in your current directory. ### Optionen @@ -1517,7 +1602,7 @@ Das `git_branch`-Modul zeigt den aktiven Git-Branch des Repositories im aktuelle | `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. | | `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. | -| `disabled` | `false` | Deaktiviert das `git_branch`-Modul. | +| `disabled` | `false` | Disables the `git_branch` module. | ### Variables @@ -1562,10 +1647,11 @@ The `git_commit` module shows the current commit hash and also the tag (if any) ### Variables -| Variable | Beispiel | Beschreibung | -| --------- | --------- | ------------------------------------ | -| hash | `b703eb3` | The current git commit hash | -| style\* | | Spiegelt den Wert der Option `style` | +| Variable | Beispiel | Beschreibung | +| --------- | --------- | -------------------------------------------- | +| hash | `b703eb3` | The current git commit hash | +| tag | `v1.0.0` | The tag name if showing tag info is enabled. | +| style\* | | Spiegelt den Wert der Option `style` | *: This variable can only be used as a part of a style string @@ -1579,7 +1665,7 @@ commit_hash_length = 4 tag_symbol = '🔖 ' ``` -## Git-Zustand +## Git State The `git_state` module will show in directories which are part of a git repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. If there is progress information (e.g., REBASING 3/10), that information will be shown too. @@ -1596,7 +1682,7 @@ The `git_state` module will show in directories which are part of a git reposito | `am_or_rebase` | `'AM/REBASE'` | A format string displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. | | `style` | `'bold yellow'` | Stil für dieses Modul. | | `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | Das Format für das Modul. | -| `disabled` | `false` | Deaktiviert das `git_state`-Modul. | +| `disabled` | `false` | Disables the `git_state` module. | ### Variables @@ -1625,7 +1711,7 @@ The `git_metrics` module will show the number of added and deleted lines in the ::: tip -Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -1688,7 +1774,7 @@ The Git Status module is very slow in Windows directories (for example under `/m | `deleted` | `'✘'` | The format of `deleted` | | `style` | `'bold red'` | Stil für dieses Modul. | | `ignore_submodules` | `false` | Ignore changes to submodules. | -| `disabled` | `false` | Deaktiviert das `git_status`-Modul. | +| `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. | ### Variables @@ -1787,7 +1873,7 @@ The `golang` module shows the currently installed version of [Go](https://golang | `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. | | `style` | `'bold cyan'` | Stil für dieses Modul. | -| `disabled` | `false` | Deaktiviert das `golang`-Modul. | +| `disabled` | `false` | Disables the `golang` module. | ### Variables @@ -1840,6 +1926,41 @@ disabled = true format = 'via [🐂](yellow bold) ' ``` +## Gradle + +The `gradle` module shows the version of the [Gradle Wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html) currently used in the project directory. + +By default the module will be shown if any of the following conditions are met: + +- The current directory contains a `gradle/wrapper/gradle-wrapper.properties` directory. +- The current directory contains a file ending with `.gradle` or `.gradle.kts`. + +The `gradle` module is only able to read your Gradle Wrapper version from your config file, we don't execute your wrapper, because of the security concerns. + +### Optionen + +| Option | Standartwert | Beschreibung | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Das Format für das Modul. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🅶 "` | A format string representing the symbol of Gradle. | +| `detect_extensions` | `["gradle", "gradle.kts"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `["gradle"]` | Which folders should trigger this module. | +| `style` | `"bold bright-cyan"` | Stil für dieses Modul. | +| `disabled` | `false` | Disables the `gradle` module. | +| `recursive` | `false` | Enables recursive finding for the `gradle` directory. | + +### Variables + +| Variable | Beispiel | Beschreibung | +| -------- | -------- | ------------------------------------- | +| version | `v7.5.1` | The version of `gradle` | +| 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 + ## Haskell The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot. @@ -1954,18 +2075,18 @@ format = 'via [⎈ $version](bold white) ' ## Hostname -Das `hostname`-Modul zeigt den Hostnamen des Systems an. +The `hostname` module shows the system hostname. ### Optionen | Option | Standartwert | Beschreibung | | ------------ | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | -| `ssh_only` | `true` | Zeigt den Hostnamen nur, wenn via SSH-Sitzung verbunden. | +| `ssh_only` | `true` | Only show hostname when connected to an SSH session. | | `ssh_symbol` | `'🌐 '` | A format string representing the symbol when connected to SSH session. | | `trim_at` | `'.'` | String that the hostname is cut off at, after the first match. `'.'` will stop after the first dot. `''` will disable any truncation | | `format` | `'[$ssh_symbol$hostname]($style) in '` | Das Format für das Modul. | | `style` | `'bold dimmed green'` | Stil für dieses Modul. | -| `disabled` | `false` | Deaktiviert das `hostname`-Modul. | +| `disabled` | `false` | Disables the `hostname` module. | ### Variables @@ -2007,7 +2128,7 @@ The `java` module shows the currently installed version of [Java](https://www.or | `detect_folders` | `[]` | Which folders should trigger this modules. | | `symbol` | `'☕ '` | A format string representing the symbol of Java | | `style` | `'red dimmed'` | Stil für dieses Modul. | -| `disabled` | `false` | Deaktiviert das `Java`-Modul. | +| `disabled` | `false` | Disables the `java` module. | ### Variables @@ -2052,15 +2173,15 @@ The `threshold` option is deprecated, but if you want to use it, the module will ### Optionen -| Option | Standartwert | Beschreibung | -| ------------------ | ----------------------------- | -------------------------------------------------------------------------------- | -| `threshold`* | `1` | Zeigt die Anzahl der Jobs wenn der angegebene Schwellenwert überschritten wurde. | -| `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. | -| `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. | -| `format` | `'[$symbol$number]($style) '` | Das Format für das Modul. | -| `symbol` | `'✦'` | The string used to represent the `symbol` variable. | -| `style` | `'bold blue'` | Stil für dieses Modul. | -| `disabled` | `false` | Deaktiviert das `jobs`-Modul. | +| Option | Standartwert | Beschreibung | +| ------------------ | ----------------------------- | ------------------------------------------------------------------------ | +| `threshold`* | `1` | Show number of jobs if exceeded. | +| `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. | +| `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. | +| `format` | `'[$symbol$number]($style) '` | Das Format für das Modul. | +| `symbol` | `'✦'` | The string used to represent the `symbol` variable. | +| `style` | `'bold blue'` | Stil für dieses Modul. | +| `disabled` | `false` | Disables the `jobs` module. | *: This option is deprecated, please use the `number_threshold` and `symbol_threshold` options instead. @@ -2178,7 +2299,7 @@ Displays the current [Kubernetes context](https://kubernetes.io/docs/concepts/co ::: tip -Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. When the module is enabled it will always be active, unless any of `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions. @@ -2196,7 +2317,7 @@ When the module is enabled it will always be active, unless any of `detect_exten | `detect_extensions` | `[]` | Which extensions should trigger this module. | | `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this modules. | -| `disabled` | `true` | Deaktiviert das `kubernetes`-Modul. | +| `disabled` | `true` | Disables the `kubernetes` module. | ### Variables @@ -2259,15 +2380,15 @@ Long and automatically generated cluster names can be identified and shortened u 'gke_.*_(?P[\\w-]+)' = 'gke-$var_cluster' ``` -## Zeilenumbruch +## Line Break -Das `line_break`-Modul unterteilt den Prompt in zwei Zeilen. +The `line_break` module separates the prompt into two lines. ### Optionen -| Option | Standartwert | Beschreibung | -| ---------- | ------------ | ---------------------------------------------------------------------- | -| `disabled` | `false` | Deaktiviert das `line_break`-Modul, wodurch der Prompt einzeilig wird. | +| Option | Standartwert | Beschreibung | +| ---------- | ------------ | ------------------------------------------------------------------ | +| `disabled` | `false` | Disables the `line_break` module, making the prompt a single line. | ### Beispiel @@ -2352,27 +2473,27 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o format = 'via [🌕 $version](bold blue) ' ``` -## Speicherauslastung +## Memory Usage -Das `memory_usage` Modul zeigt den aktuellen Systemspeicher und die swap-Nutzung an. +The `memory_usage` module shows current system memory and swap usage. -Standardmäßig wird die swap-Nutzung angezeigt, wenn der gesamte System-swap nicht Null ist. +By default the swap usage is displayed if the total system swap is non-zero. ::: tip -Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### Optionen -| Option | Standartwert | Beschreibung | -| ----------- | ----------------------------------------------- | --------------------------------------------------------------------- | -| `threshold` | `75` | Speicherauslastung ausblenden, wenn sie unter diesem Prozentsatz ist. | -| `format` | `'via $symbol [${ram}( \| ${swap})]($style) '` | Das Format für das Modul. | -| `symbol` | `'🐏'` | Symbol das vor der Speicherauslastung angezeigt wird. | -| `style` | `'bold dimmed white'` | Stil für dieses Modul. | -| `disabled` | `true` | Deaktiviert das `memory_usage`-Modul. | +| Option | Standartwert | Beschreibung | +| ----------- | ----------------------------------------------- | -------------------------------------------------------- | +| `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. | +| `format` | `'via $symbol [${ram}( \| ${swap})]($style) '` | Das Format für das Modul. | +| `symbol` | `'🐏'` | The symbol used before displaying the memory usage. | +| `style` | `'bold dimmed white'` | Stil für dieses Modul. | +| `disabled` | `true` | Disables the `memory_usage` module. | ### Variables @@ -2440,26 +2561,27 @@ style = 'bold dimmed green' ## Mercurial Branch -The `hg_branch` module shows the active branch of the repo in your current directory. +The `hg_branch` module shows the active branch and topic of the repo in your current directory. ### Optionen -| Option | Standartwert | Beschreibung | -| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------- | -| `symbol` | `' '` | The symbol used before the hg bookmark or branch name of the repo in your current directory. | -| `style` | `'bold purple'` | Stil für dieses Modul. | -| `format` | `'on [$symbol$branch]($style) '` | Das Format für das Modul. | -| `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. | -| `disabled` | `true` | Disables the `hg_branch` module. | +| Option | Standartwert | Beschreibung | +| ------------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------- | +| `symbol` | `' '` | The symbol used before the hg bookmark or branch name of the repo in your current directory. | +| `style` | `'bold purple'` | Stil für dieses Modul. | +| `format` | `'on [$symbol$branch(:$topic)]($style) '` | Das Format für das Modul. | +| `truncation_length` | `2^63 - 1` | Truncates the hg branch / topic name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. | +| `disabled` | `true` | Disables the `hg_branch` module. | ### Variables -| Variable | Beispiel | Beschreibung | -| --------- | -------- | ------------------------------------- | -| branch | `master` | The active mercurial branch | -| symbol | | Spiegelt den Wert der Option `symbol` | -| style\* | | Spiegelt den Wert der Option `style` | +| Variable | Beispiel | Beschreibung | +| --------- | --------- | ------------------------------------- | +| branch | `master` | The active mercurial branch | +| topic | `feature` | The active mercurial topic | +| 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 @@ -2487,7 +2609,7 @@ The `nim` module shows the currently installed version of [Nim](https://nim-lang | Option | Standartwert | Beschreibung | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | Das Format für das Modul | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `symbol` | `'👑 '` | The symbol used before displaying the version of Nim. | | `detect_extensions` | `['nim', 'nims', 'nimble']` | Which extensions should trigger this module. | @@ -2516,20 +2638,22 @@ style = 'yellow' symbol = '🎣 ' ``` -## Nix-Shell +## Nix-shell -The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html) environment. Das Modul wird angezeigt, wenn es sich in einer nix-Shell-Umgebung befindet. +The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html) environment. The module will be shown when inside a nix-shell environment. ### Optionen -| Option | Standartwert | Beschreibung | -| ------------ | ---------------------------------------------- | ----------------------------------------------------- | -| `format` | `'via [$symbol$state( \($name\))]($style) '` | Das Format für das Modul. | -| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | -| `style` | `'bold blue'` | Stil für dieses Modul. | -| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | -| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | -| `disabled` | `false` | Deaktiviert das `nix_shell`-Modul. | +| Option | Standartwert | Beschreibung | +| ------------- | ---------------------------------------------- | --------------------------------------------------------------------- | +| `format` | `'via [$symbol$state( \($name\))]($style) '` | Das Format für das Modul. | +| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | +| `style` | `'bold blue'` | Stil für dieses Modul. | +| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | +| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | +| `unknown_msg` | `''` | A format string shown when it is unknown if the shell is pure/impure. | +| `disabled` | `false` | Disables the `nix_shell` module. | +| `heuristic` | `false` | Attempts to detect new `nix shell`-style shells with a heuristic. | ### Variables @@ -2551,6 +2675,7 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/ disabled = true impure_msg = '[impure shell](bold red)' pure_msg = '[pure shell](bold green)' +unknown_msg = '[unknown shell](bold yellow)' format = 'via [☃️ $state( \($name\))](bold blue) ' ``` @@ -2576,7 +2701,7 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n | `detect_files` | `['package.json', '.node-version']` | Which filenames should trigger this module. | | `detect_folders` | `['node_modules']` | Which folders should trigger this module. | | `style` | `'bold green'` | Stil für dieses Modul. | -| `disabled` | `false` | Deaktiviert das `nodejs`-Modul. | +| `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. | ### Variables @@ -2728,7 +2853,7 @@ The [os_info](https://lib.rs/crates/os_info) crate used by this module is known ::: tip -Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -2813,9 +2938,9 @@ Windows = " " Arch = "Arch is the best! " ``` -## Paketversion +## Package Version -Das `Package` Modul wird angezeigt, wenn das aktuelle Verzeichnis das Repository für ein Paket ist, und zeigt dessen aktuelle Version an. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages. +The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages. - [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory - [**Cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory @@ -2842,11 +2967,11 @@ Das `Package` Modul wird angezeigt, wenn das aktuelle Verzeichnis das Repository | Option | Standartwert | Beschreibung | | ----------------- | --------------------------------- | ------------------------------------------------------------------------- | | `format` | `'is [$symbol$version]($style) '` | Das Format für das Modul. | -| `symbol` | `'📦 '` | Symbol das vor der Paketversion angezeigt wird. | +| `symbol` | `'📦 '` | The symbol used before displaying the version the package. | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `style` | `'bold 208'` | Stil für dieses Modul. | | `display_private` | `false` | Enable displaying version for packages marked as private. | -| `disabled` | `false` | Deaktiviert das `package`-Modul. | +| `disabled` | `false` | Disables the `package` module. | ### Variables @@ -2911,7 +3036,7 @@ format = 'via [🦪 $version]($style) ' The `php` module shows the currently installed version of [PHP](https://www.php.net/). By default the module will be shown if any of the following conditions are met: -- The current directory contains a `composer.json` file +- Das aktuelle Verzeichnis enthält eine `composer.json`-Datei - The current directory contains a `.php-version` file - The current directory contains a `.php` extension @@ -2921,12 +3046,12 @@ The `php` module shows the currently installed version of [PHP](https://www.php. | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | | `format` | `'via [$symbol($version )]($style)'` | Das Format für das Modul. | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'🐘 '` | Symbol das vor der PHP-Version angezeigt wird. | +| `symbol` | `'🐘 '` | The symbol used before displaying the version of PHP. | | `detect_extensions` | `['php']` | Which extensions should trigger this module. | | `detect_files` | `['composer.json', '.php-version']` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `'147 bold'` | Stil für dieses Modul. | -| `disabled` | `false` | Deaktiviert das `php`-Modul. | +| `disabled` | `false` | Disables the `php` module. | ### Variables @@ -2947,6 +3072,21 @@ The `php` module shows the currently installed version of [PHP](https://www.php. format = 'via [🔹 $version](147 bold) ' ``` +## Pijul Channel + +The `pijul_channel` module shows the active channel of the repo in your current directory. + +### Optionen + +| Option | Standartwert | Beschreibung | +| ------------------- | --------------------------------- | ------------------------------------------------------------------------------------ | +| `symbol` | `' '` | The symbol used before the pijul channel name of the repo in your current directory. | +| `style` | `'bold purple'` | Stil für dieses Modul. | +| `format` | `'on [$symbol$channel]($style) '` | Das Format für das Modul. | +| `truncation_length` | `2^63 - 1` | Truncates the pijul channel name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. | +| `disabled` | `true` | Disables the `pijul` module. | + ## Pulumi The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. @@ -3070,13 +3210,13 @@ By default the module will be shown if any of the following conditions are met: | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `symbol` | `'🐍 '` | A format string representing the symbol of Python | | `style` | `'yellow bold'` | Stil für dieses Modul. | -| `pyenv_version_name` | `false` | Verwende `pyenv` um die Python-Versionzu beziehen. | +| `pyenv_version_name` | `false` | Use pyenv to get Python version | | `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `python_binary` | `['python', 'python3', 'python2']` | Configures the python binaries that Starship should executes when getting the version. | | `detect_extensions` | `['py']` | Which extensions should trigger this module | | `detect_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | -| `disabled` | `false` | Deaktiviert das `python`-Modul. | +| `disabled` | `false` | Disables the `python` module. | ::: tip @@ -3215,7 +3355,7 @@ format = 'via [🦪 $version]($style) ' ## Red -By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: +By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a file with `.red` or `.reds` extension @@ -3253,7 +3393,7 @@ symbol = '🔴 ' ## Ruby -By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: +By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). The module will be shown if any of the following conditions are met: - Das aktuelle Verzeichnis enthält eine `Gemfile`-Datei - The current directory contains a `.ruby-version` file @@ -3274,7 +3414,7 @@ Starship gets the current Ruby version by running `ruby -v`. | `detect_folders` | `[]` | Which folders should trigger this module. | | `detect_variables` | `['RUBY_VERSION', 'RBENV_VERSION']` | Which environment variables should trigger this module. | | `style` | `'bold red'` | Stil für dieses Modul. | -| `disabled` | `false` | Deaktiviert das `ruby`-Modul. | +| `disabled` | `false` | Disables the `ruby` module. | ### Variables @@ -3297,7 +3437,7 @@ symbol = '🔺 ' ## Rust -By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: +By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). The module will be shown if any of the following conditions are met: - Das aktuelle Verzeichnis enthält eine `Cargo.toml`-Datei - Das aktuelle Verzeichnis enthält eine Datei mit der `.rs`-Erweiterung @@ -3313,7 +3453,7 @@ By default the `rust` module shows the currently installed version of [Rust](htt | `detect_files` | `['Cargo.toml']` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `'bold red'` | Stil für dieses Modul. | -| `disabled` | `false` | Deaktiviert das `rust`-Modul. | +| `disabled` | `false` | Disables the `rust` module. | ### Variables @@ -3382,7 +3522,7 @@ The `shell` module shows an indicator for currently used shell. ::: tip -Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -3410,7 +3550,7 @@ Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `dis | Variable | Standartwert | Beschreibung | | --------- | ------------ | ---------------------------------------------------------- | | indicator | | Mirrors the value of `indicator` for currently used shell. | -| style\* | | Spiegelt den Wert der Option `style`. | +| style\* | | Mirrors the value of option `style`. | *: This variable can only be used as a part of a style string @@ -3534,7 +3674,7 @@ The `status` module displays the exit code of the previous command. If $success_ ::: tip -Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -3595,7 +3735,7 @@ The `sudo` module displays if sudo credentials are currently cached. The module ::: tip -Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -3640,7 +3780,7 @@ disabled = false ## Swift -By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: +By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `Package.swift` file - The current directory contains a file with the `.swift` extension @@ -3703,7 +3843,7 @@ By default the module will be shown if any of the following conditions are met: | `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_folders` | `['.terraform']` | Which folders should trigger this module. | | `style` | `'bold 105'` | Stil für dieses Modul. | -| `disabled` | `false` | Deaktiviert das `terraform` Modul. | +| `disabled` | `false` | Disables the `terraform` module. | ### Variables @@ -3736,27 +3876,27 @@ format = '[🏎💨 $version$workspace]($style) ' format = '[🏎💨 $workspace]($style) ' ``` -## Zeit +## Uhrzeit -Das `time` Modul zeigt die aktuelle **lokale** Zeit an. Der `format` Wert wird von der crate [`chrono`](https://crates.io/crates/chrono) benutzt um die Zeit zu formatieren. Schau dir [die chrono strftime Dokumentation](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) an, um die möglichen Optionen zu sehen. +The `time` module shows the current **local** time. The `format` configuration value is used by the [`chrono`](https://crates.io/crates/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) to see what options are available. ::: tip -Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### Optionen -| Option | Standartwert | Beschreibung | -| ----------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | -| `format` | `'at [$time]($style) '` | The format string for the module. | -| `use_12hr` | `false` | Aktiviert 12-Stunden-Format | -| `time_format` | siehe unten | Das Format zum Anzeigen der Uhrzeit in [chrono-Formatierung](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html). | -| `style` | `'bold yellow'` | Stil für dieses Modul | -| `utc_time_offset` | `'local'` | Verwendetes Zeitzonen-Offset. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. | -| `disabled` | `true` | Deaktiviert das `time`-Modul. | -| `time_range` | `'-'` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | +| Option | Standartwert | Beschreibung | +| ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | +| `format` | `'at [$time]($style) '` | The format string for the module. | +| `use_12hr` | `false` | Enables 12 hour formatting | +| `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. | +| `style` | `'bold yellow'` | The style for the module time | +| `utc_time_offset` | `'local'` | Sets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. | +| `disabled` | `true` | Disables the `time` module. | +| `time_range` | `'-'` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | If `use_12hr` is `true`, then `time_format` defaults to `'%r'`. Otherwise, it defaults to `'%T'`. Manually setting `time_format` will override the `use_12hr` setting. @@ -3764,7 +3904,7 @@ If `use_12hr` is `true`, then `time_format` defaults to `'%r'`. Otherwise, it de | Variable | Beispiel | Beschreibung | | --------- | ---------- | ------------------------------------ | -| zeit | `13:08:10` | The current time. | +| time | `13:08:10` | The current time. | | style\* | | Spiegelt den Wert der Option `style` | *: This variable can only be used as a part of a style string @@ -3784,7 +3924,7 @@ time_range = '10:00:00-14:00:00' ## Username -Das `username` Modul zeigt den Namen des aktiven Benutzers. Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: +The `username` module shows active user's username. The module will be shown if any of the following conditions are met: - The current user is root/admin - Der aktuelle Benutzer ist nicht der eingeloggte Benutzer @@ -3799,13 +3939,13 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, ` ### Optionen -| Option | Standartwert | Beschreibung | -| ------------- | ----------------------- | ---------------------------------------------- | -| `style_root` | `'bold red'` | The style used when the user is root/admin. | -| `style_user` | `'bold yellow'` | Stil wenn der Benutzer nicht unter root läuft. | -| `format` | `'[$user]($style) in '` | Das Format für das Modul. | -| `show_always` | `false` | Immer das `username` Modul anzeigen. | -| `disabled` | `false` | Deavktiviert das `username` Modul. | +| Option | Standartwert | Beschreibung | +| ------------- | ----------------------- | ------------------------------------------- | +| `style_root` | `'bold red'` | The style used when the user is root/admin. | +| `style_user` | `'bold yellow'` | The style used for non-root users. | +| `format` | `'[$user]($style) in '` | Das Format für das Modul. | +| `show_always` | `false` | Always shows the `username` module. | +| `disabled` | `false` | Disables the `username` module. | ### Variables @@ -3935,7 +4075,7 @@ format = '[🆅 $repo](bold blue) ' ## Zig -By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). Das Modul wird gezeigt, wenn mindestens einer der folgenden Punkte erfüllt ist: +By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `.zig` file @@ -4016,7 +4156,7 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt | `command` | `''` | The command whose output should be printed. The command will be passed on stdin to the shell. | | `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. | | `shell` | | [See below](#custom-command-shell) | -| `beschreibung` | `''` | The description of the module that is shown when running `starship explain`. | +| `description` | `''` | The description of the module that is shown when running `starship explain`. | | `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_extensions` | `[]` | The extensions that will be searched in the working directory for a match. | diff --git a/docs/de-DE/guide/README.md b/docs/de-DE/guide/README.md index 2c1db5b4..5078c896 100644 --- a/docs/de-DE/guide/README.md +++ b/docs/de-DE/guide/README.md @@ -9,7 +9,7 @@

Workflow-Status der GitHub Actions @@ -423,6 +423,7 @@ Support this project by [becoming a sponsor](https://github.com/sponsors/starshi **Supporter Tier** - [Dimension](https://dimension.dev/) +- [Appwrite](https://appwrite.io/)


diff --git a/docs/de-DE/presets/README.md b/docs/de-DE/presets/README.md index 5bea36f0..bf65e778 100644 --- a/docs/de-DE/presets/README.md +++ b/docs/de-DE/presets/README.md @@ -14,7 +14,11 @@ This preset changes the symbols for each module to use Nerd Font symbols. This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt. -::: tip This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). ::: +::: tip + +This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). + +::: [Click to view No Nerd Font preset](./no-nerd-font) diff --git a/docs/es-ES/README.md b/docs/es-ES/README.md index bb1c47db..f0dfb145 100644 --- a/docs/es-ES/README.md +++ b/docs/es-ES/README.md @@ -149,14 +149,14 @@ description: '¡Starship es el prompt minimalista, ultrarápido e infinitamente ::: warning - Esto cambiará en el futuro. Sólo se admite Nushell v0.61+. + Esto cambiará en el futuro. Sólo se admite Nushell v0.73+. ::: Añade lo siguiente al final de tu archivo Nushell env (encuéntralo ejecutando `$nu.env-path` en Nushell): ```sh mkdir ~/.cache/starship - starship init nu | save ~/.cache/starship/init.nu + starship init nu | save -f ~/.cache/starship/init.nu ``` Añade lo siguiente al final de tu configuración de Nushell (encuéntrala ejecutando `$nu.config-path`): diff --git a/docs/es-ES/advanced-config/README.md b/docs/es-ES/advanced-config/README.md index 9dc17fc9..1ec3c7f7 100644 --- a/docs/es-ES/advanced-config/README.md +++ b/docs/es-ES/advanced-config/README.md @@ -1,18 +1,18 @@ # Configuración Avanzada -Mientras que Starship es un prompt versátil, a veces necesitas más que editar `starhip.toml` para que haga ciertas cosas. Esta página detalla algunas de las técnicas de configuración más avanzadas en Starship. +A pesar de que Starship es una prompt versátil, a veces necesitas hacer más que editar `starhip.toml` para que haga ciertas cosas. Esta página detalla algunas de las técnicas de configuración más avanzadas en Starship. ::: warning -Las configuraciones de esta sección están sujetos a cambios en futuras versiones de Starship. +Las configuraciones de esta sección están sujetas a cambios en futuras versiones de Starship. ::: -## TransientPrompt en PowerShell +## Prompt Transitoria en PowerShell -Es posible reemplazar la entrada impresa anteriormente con una cadena personalizada. Esto es útil en los casos que toda la información de la entrada no es siempre necesaria. Para habilitar esto, ejecuta `Enable-TransientPrompt` en la línea de comandos. Para hacerlo permanente, haz esta declaración en tu `$PROFILE`. La transitoriedad puede ser desactivada al momento con `Disable-TransientPrompt`. +Con una cadena personalizada, es posible reemplazar la prompt anteriormente impresa. Esto es útil en los casos en que toda la información de la prompt no es siempre necesaria. Para habilitar esto, ejecuta `Enable-TransientPrompt` en la línea de comandos. Para hacerlo permanente, pon esta misma sentencia en tu `$PROFILE`. La transitoriedad puede ser desactivada al momento con `Disable-TransientPrompt`. -Por defecto, el lado izquierdo de la entrada es reemplazado por `>`. Para personalizar esto, defina una nueva función llamada `Invoke-Starship-TransientFunction`. Por ejemplo, para mostrar el módulo `character` de Starship aquí, harías +Por defecto, el lado izquierdo de la prompt es reemplazado por `>`. Para personalizar esto, defina una nueva función llamada `Invoke-Starship-TransientFunction`. Por ejemplo, para mostrar el módulo `character` de Starship aquí, harías ```powershell function Invoke-Starship-TransientFunction { @@ -207,8 +207,6 @@ Nota: El prompt derecho es una sola línea siguiendo la ubicación de entrada. P `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell. -Note: Nushell 0.71.0 or later is required - ### Ejemplo ```toml @@ -231,7 +229,7 @@ Produce un prompt como el siguiente: Algunos intérpretes de comandos admiten un prompt de continuacion junto con el prompt normal. Este prompt es renderizado en lugar del prompt normal cuando el usuario ha introducido una orden incompleta (como solamente un paréntesis izquierdo o comilla). -Starship puede establecer el prompt de continuación usando la opción `continuation_prompt`. El prompt por defecto es `"[∙](bright-black) "`. +Starship puede establecer el prompt de continuación usando la opción `continuation_prompt`. El indicador por defecto es `'[∙](bright-black) '`. Nota: `continuation_prompt` debe establecerse en una cadena literal sin ninguna variable. @@ -247,7 +245,7 @@ Nota: Los prompts de continuación solo están disponibles en los siguientes int # ~/.config/starship.toml # Un prompt de continuación que muestra dos flechas rellenas -continuation_prompt = "▶▶" +continuation_prompt = '▶▶ ' ``` ## Cadenas de Estilo @@ -279,7 +277,7 @@ Un especificador de color puede ser uno de los siguientes: Si se especifican varios colores para el primer plano/fondo, el último en la cadena tendrá prioridad. -Not every style string will be displayed correctly by every terminal. In particular, the following known quirks exist: +No todas las cadenas de estilo se mostrarán correctamente en cada terminal. En particular, existen las siguientes rarezas conocidas: - Many terminals disable support for `blink` by default - `hidden` is [not supported on iTerm](https://gitlab.com/gnachman/iterm2/-/issues/4564). diff --git a/docs/es-ES/config/README.md b/docs/es-ES/config/README.md index 5f978f61..2975c3a0 100644 --- a/docs/es-ES/config/README.md +++ b/docs/es-ES/config/README.md @@ -252,12 +252,14 @@ $singularity\ $kubernetes\ $directory\ $vcsh\ +$fossil_branch\ $git_branch\ $git_commit\ $git_state\ $git_metrics\ $git_status\ $hg_branch\ +$pijul_channel\ $docker_context\ $package\ $c\ @@ -270,6 +272,7 @@ $dotnet\ $elixir\ $elm\ $erlang\ +$fennel\ $golang\ $guix_shell\ $haskell\ @@ -278,6 +281,7 @@ $helm\ $java\ $julia\ $kotlin\ +$gradle\ $lua\ $nim\ $nodejs\ @@ -1305,6 +1309,12 @@ El módulo `env_var` muestra el valor actual de una variable de entorno seleccio ::: tip +The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. + +::: + +::: 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 @@ -1320,13 +1330,14 @@ default = 'unknown user' ### Opciones -| Opción | Predeterminado | Descripción | -| ---------- | ----------------------------- | -------------------------------------------------------------------------------------- | -| `symbol` | `''` | El símbolo usado antes de mostrar el valor de la variable. | -| `variable` | | La variable de entorno a mostrar. | -| `default` | | El valor por defecto que se mostrará cuando la variable seleccionada no está definida. | -| `format` | `'con [$env_value]($style) '` | El formato del módulo. | -| `disabled` | `false` | Deshabilita el módulo `env_var`. | +| Opción | Predeterminado | Descripción | +| ------------- | ----------------------------- | -------------------------------------------------------------------------------------- | +| `symbol` | `""` | El símbolo usado antes de mostrar el valor de la variable. | +| `variable` | | La variable de entorno a mostrar. | +| `default` | | El valor por defecto que se mostrará cuando la variable seleccionada no está definida. | +| `format` | `"con [$env_value]($style) "` | El formato del módulo. | +| `description` | `""` | The description of the module that is shown when running `starship explain`. | +| `disabled` | `false` | Deshabilita el módulo `env_var`. | ### Variables @@ -1399,6 +1410,44 @@ El módulo `erlang` muestra la versión instalada de [Erlang/OTP](https://erlang format = 'via [e $version](bold red) ' ``` +## Fennel + +The `fennel` module shows the currently installed version of [Fennel](https://fennel-lang.org). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: + +- The current directory contains a file with the `.fnl` extension + +### Opciones + +| Opción | Predeterminado | Descripción | +| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. | +| `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. | +| `style` | `'bold green'` | El estilo del módulo. | +| `detect_extensions` | `[fnl]` | Qué extensiones deberían activar este módulo. | +| `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. | +| `detect_folders` | `[]` | Qué carpetas deberían activar estos módulos. | +| `disabled` | `false` | Disables the `fennel` module. | + +### Variables + +| Variable | Ejemplo | Descripción | +| --------- | -------- | -------------------------------------- | +| version | `v1.2.1` | The version of `fennel` | +| symbol | | Refleja el valor de la opción `symbol` | +| style\* | | Refleja el valor de la opción `style` | + +*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo + +### Ejemplo + +```toml +# ~/.config/starship.toml + +[fennel] +symbol = '⫰ ' +``` + ## Rellenar El módulo `fill` llena cualquier espacio extra en la línea con un símbolo. Si múltiples módulos `fill` están presentes en una línea, dividirán el espacio equitativamente entre ellos. Esto es útil para alinear otros módulos. @@ -1428,32 +1477,68 @@ Produce un prompt que se ve como: AA -------------------------------------------- BB -------------------------------------------- CC ``` -## Google Cloud (`gcloud`) +## Fossil Branch -El módulo `gcloud` muestra la configuración actual para el CLI de [`gcloud`](https://cloud.google.com/sdk/gcloud). Esto se basa en el archivo `~/.config/gcloud/active_config`, el archivo `~/.config/gcloud/configurations/config_{CONFIG NAME}` y la variable de entorno `CLOUDSDK_CONFIG`. +The `fossil_branch` module shows the name of the active branch of the check-out in your current directory. ### Opciones -| Opción | Predeterminado | Descripción | -| ----------------- | ---------------------------------------------------------- | ------------------------------------------------------------ | -| `format` | `'on [$symbol$account(@$domain)(\($region\))]($style) '` | El formato del módulo. | -| `symbol` | `'☁️ '` | El símbolo usado antes de mostrar el perfil actual de GCP. | -| `region_aliases` | `{}` | Tabla de alias de región a mostrar además del nombre GCP. | -| `project_aliases` | `{}` | Tabla de alias del proyecto a mostrar además del nombre GCP. | -| `style` | `'bold blue'` | El estilo del módulo. | -| `disabled` | `false` | Deshabilita el módulo `gcloud`. | +| Opción | Predeterminado | Descripción | +| ------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | +| `format` | `'on [$symbol$branch]($style) '` | El formato del módulo. Use `'$branch'` to refer to the current branch name. | +| `symbol` | `' '` | The symbol used before the branch name of the check-out in your current directory. | +| `style` | `'bold purple'` | El estilo del módulo. | +| `truncation_length` | `2^63 - 1` | Truncates a Fossil branch name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. | +| `disabled` | `true` | Disables the `fossil_branch` module. | ### Variables -| Variable | Ejemplo | Descripción | -| --------- | ------------- | ----------------------------------------------------------------------------- | -| region | `us-central1` | La actual región GCP | -| cuenta | `foo` | El perfil actual de GCP | -| dominio | `ejemplo.com` | El dominio actual del perfil GCP | -| proyecto | | El proyecto GCP actual | -| activo | `default` | El nombre de configuración activo escrito en `~/.config/gcloud/active_config` | -| symbol | | Refleja el valor de la opción `symbol` | -| style\* | | Refleja el valor de la opción `style` | +| Variable | Ejemplo | Descripción | +| --------- | ------- | -------------------------------------- | +| branch | `trunk` | The active Fossil branch | +| symbol | | Refleja el valor de la opción `symbol` | +| style\* | | Refleja el valor de la opción `style` | + +*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo + +### Ejemplo + +```toml +# ~/.config/starship.toml + +[fossil_branch] +symbol = '🦎 ' +truncation_length = 4 +truncation_symbol = '' +``` + +## Google Cloud (`gcloud`) + +The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var. + +### Opciones + +| Opción | Predeterminado | Descripción | +| ----------------- | ---------------------------------------------------------- | ---------------------------------------------------------------- | +| `format` | `'on [$symbol$account(@$domain)(\($region\))]($style) '` | El formato del módulo. | +| `symbol` | `'☁️ '` | The symbol used before displaying the current GCP profile. | +| `region_aliases` | `{}` | Table of region aliases to display in addition to the GCP name. | +| `project_aliases` | `{}` | Table of project aliases to display in addition to the GCP name. | +| `style` | `'bold blue'` | El estilo del módulo. | +| `disabled` | `false` | Disables the `gcloud` module. | + +### Variables + +| Variable | Ejemplo | Descripción | +| --------- | ------------- | ------------------------------------------------------------------ | +| region | `us-central1` | The current GCP region | +| account | `foo` | The current GCP profile | +| domain | `example.com` | The current GCP profile domain | +| project | | The current GCP project | +| active | `default` | The active config name written in `~/.config/gcloud/active_config` | +| symbol | | Refleja el valor de la opción `symbol` | +| style\* | | Refleja el valor de la opción `style` | *: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo @@ -1501,33 +1586,33 @@ format = 'on [$symbol$account(@$domain)(\($project\))]($style) ' very-long-project-name = 'vlpn' ``` -## Rama Git +## Git Branch -El módulo `git_branch` muestra la rama activa del repositorio en tu directorio actual. +The `git_branch` module shows the active branch of the repo in your current directory. ### Opciones -| Opción | Predeterminado | 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. | -| `format` | `'on [$symbol$branch(:$remote_branch)]($style) '` | El formato del módulo. Use `'$branch'` to refer to the current branch name. | -| `symbol` | `' '` | Una cadena de formato que representa el símbolo de la rama git. | -| `style` | `'bold purple'` | El estilo del módulo. | -| `truncation_length` | `2^63 - 1` | Trunca el nombre de la rama a `N` grafemas. | -| `truncation_symbol` | `'…'` | El símbolo usado para indicar que un nombre de rama fue truncado. You can use `''` for no symbol. | -| `only_attached` | `false` | Mostrar solo el hash de la confirmación de git cuando esté en estado "detached `HEAD`" | -| `ignore_branches` | `[]` | Una lista de nombres a evitar ser visualizados. Useful for 'master' or 'main'. | -| `disabled` | `false` | Deshabilita el módulo `git_branch`. | +| Opción | Predeterminado | Descripción | +| -------------------- | ------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | +| `format` | `'on [$symbol$branch(:$remote_branch)]($style) '` | El formato del módulo. Use `'$branch'` to refer to the current branch name. | +| `symbol` | `' '` | A format string representing the symbol of git branch. | +| `style` | `'bold purple'` | El estilo del módulo. | +| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. | +| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | +| `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. | +| `disabled` | `false` | Disables the `git_branch` module. | ### Variables -| Variable | Ejemplo | Descripción | -| ------------- | --------- | -------------------------------------------------------------------------------------------------------------- | -| rama | `maestro` | El nombre de la rama actual, vuelve a `HEAD` si no hay ninguna rama actual (por ejemplo, git detached `HEAD`). | -| remote_name | `origen` | El nombre remoto. | -| remote_branch | `maestro` | El nombre de la rama rastreada en `remote_name`. | -| symbol | | Refleja el valor de la opción `symbol` | -| style\* | | Refleja el valor de la opción `style` | +| Variable | Ejemplo | Descripción | +| ------------- | -------- | ------------------------------------------------------------------------------------------------------ | +| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached `HEAD`). | +| remote_name | `origin` | The remote name. | +| remote_branch | `master` | The name of the branch tracked on `remote_name`. | +| symbol | | Refleja el valor de la opción `symbol` | +| style\* | | Refleja el valor de la opción `style` | *: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo @@ -1545,27 +1630,28 @@ ignore_branches = ['master', 'main'] ## Git commit -El módulo `git_commit` muestra el hash de la confirmación actual y también la etiqueta (si existe) del repositorio en su directorio actual. +The `git_commit` module shows the current commit hash and also the tag (if any) of the repo in your current directory. ### Opciones -| Opción | Predeterminado | Descripción | -| -------------------- | ------------------------------ | ------------------------------------------------------------------------------------------------------ | -| `commit_hash_length` | `7` | La longitud del hash de la confirmación de git mostrado. | -| `format` | `'[\($hash$tag\)]($style) '` | El formato del módulo. | -| `style` | `'bold green'` | El estilo del módulo. | -| `only_detached` | `true` | Mostrar solo el hash de la confirmación de git cuando esté en estado "detached `HEAD`" | -| `tag_disabled` | `true` | Deshabilita mostrar información de etiquetas en el módulo `git_commit`. | -| `tag_max_candidates` | `0` | How many commits to consider for tag display. El valor por defecto sólo permite coincidencias exactas. | -| `tag_symbol` | `' 🏷 '` | Símbolo de etiqueta prefijando la información mostrada | -| `disabled` | `false` | Deshabilita el módulo `git_commit`. | +| Opción | Predeterminado | Descripción | +| -------------------- | ------------------------------ | ------------------------------------------------------------------------------------ | +| `commit_hash_length` | `7` | The length of the displayed git commit hash. | +| `format` | `'[\($hash$tag\)]($style) '` | El formato del módulo. | +| `style` | `'bold green'` | El estilo del módulo. | +| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state | +| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. | +| `tag_max_candidates` | `0` | How many commits to consider for tag display. The default only allows exact matches. | +| `tag_symbol` | `' 🏷 '` | Tag symbol prefixing the info shown | +| `disabled` | `false` | Disables the `git_commit` module. | ### Variables -| Variable | Ejemplo | Descripción | -| --------- | --------- | ---------------------------------------- | -| hash | `b703eb3` | El hash actual de la confirmación de git | -| style\* | | Refleja el valor de la opción `style` | +| Variable | Ejemplo | Descripción | +| --------- | --------- | -------------------------------------------- | +| hash | `b703eb3` | The current git commit hash | +| tag | `v1.0.0` | The tag name if showing tag info is enabled. | +| style\* | | Refleja el valor de la opción `style` | *: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo @@ -1581,30 +1667,30 @@ tag_symbol = '🔖 ' ## Git State -El módulo `git_state` se mostrará en directorios que son parte de un repositorio git, y donde hay una operación en curso, tales como: _REBASING_, _BISECTING_, etc. Si hay información de progreso (por ejemplo, REBASING 3/10), esa información será mostrada también. +The `git_state` module will show in directories which are part of a git repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. If there is progress information (e.g., REBASING 3/10), that information will be shown too. ### Opciones -| Opción | Predeterminado | Descripción | -| -------------- | --------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `rebase` | `'REBASING'` | Una cadena de formato que se muestra cuando un `rebase` está en progreso. | -| `fusionar` | `'FUSIONANDO'` | Una cadena de formato que se muestra cuando un `merge` está en progreso. | -| `revertir` | `'REVERTING'` | Una cadena de formato mostrada cuando un `revert` está en progreso. | -| `cherry_pick` | `'CHERRY-PICKING'` | Una cadena de formato que se muestra cuando un `cherry-pick` está en progreso. | -| `bisect` | `'BISECTING'` | Una cadena de formato que se muestra cuando un `bisect` está en progreso. | -| `am` | `'AM'` | Una cadena de formato que se muestra cuando un `apply-mailbox` (`git am`) está en progeso. | -| `am_or_rebase` | `'AM/REBASE'` | Una cadena de formato que se muestra cuando un ambiguo `apply-mailbox` o `rebase` está en progreso. | -| `style` | `'bold yellow'` | El estilo del módulo. | -| `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | El formato del módulo. | -| `disabled` | `false` | Deshabilita el módulo `git_state`. | +| Opción | Predeterminado | Descripción | +| -------------- | --------------------------------------------------------------- | --------------------------------------------------------------------------------------- | +| `rebase` | `'REBASING'` | A format string displayed when a `rebase` is in progress. | +| `merge` | `'MERGING'` | A format string displayed when a `merge` is in progress. | +| `revert` | `'REVERTING'` | A format string displayed when a `revert` is in progress. | +| `cherry_pick` | `'CHERRY-PICKING'` | A format string displayed when a `cherry-pick` is in progress. | +| `bisect` | `'BISECTING'` | A format string displayed when a `bisect` is in progress. | +| `am` | `'AM'` | A format string displayed when an `apply-mailbox` (`git am`) is in progress. | +| `am_or_rebase` | `'AM/REBASE'` | A format string displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. | +| `style` | `'bold yellow'` | El estilo del módulo. | +| `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | El formato del módulo. | +| `disabled` | `false` | Disables the `git_state` module. | ### Variables | Variable | Ejemplo | Descripción | | ---------------- | ---------- | ------------------------------------- | | state | `REBASING` | The current state of the repo | -| progress_current | `1` | El progreso de la operación actual | -| progress_total | `2` | El progreso total de la operación | +| progress_current | `1` | The current operation progress | +| progress_total | `2` | The total operation progress | | style\* | | Refleja el valor de la opción `style` | *: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo @@ -1619,34 +1705,34 @@ format = '[\($state( $progress_current of $progress_total)\)]($style) ' cherry_pick = '[🍒 PICKING](bold red)' ``` -## Métricas de Git +## Git Metrics -El módulo `git_metrics` mostrará el número de líneas añadidas y eliminadas en el repositorio git actual. +The `git_metrics` module will show the number of added and deleted lines in the current git repository. ::: tip -Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` como `false` en tu archivo de configuración. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### Opciones -| Opción | Predeterminado | Descripción | -| -------------------- | ------------------------------------------------------------ | -------------------------------------------------- | -| `added_style` | `'bold green'` | El estilo para el recuento añadido. | -| `deleted_style` | `'bold red'` | El estilo para el recuento eliminado. | -| `only_nonzero_diffs` | `true` | Mostrar sólo el estado de los elementos cambiados. | -| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | El formato del módulo. | -| `disabled` | `true` | Deshabilita el módulo `git_metrics`. | +| Opción | Predeterminado | Descripción | +| -------------------- | ------------------------------------------------------------ | ------------------------------------- | +| `added_style` | `'bold green'` | The style for the added count. | +| `deleted_style` | `'bold red'` | The style for the deleted count. | +| `only_nonzero_diffs` | `true` | Render status only for changed items. | +| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | El formato del módulo. | +| `disabled` | `true` | Disables the `git_metrics` module. | ### Variables -| Variable | Ejemplo | Descripción | -| ----------------- | ------- | --------------------------------------------- | -| añadido | `1` | El número actual de líneas añadidas | -| borrado | `2` | El número actual de líneas eliminadas | -| added_style\* | | Refleja el valor de la opción `added_style` | -| deleted_style\* | | Refleja el valor de la opción `deleted_style` | +| Variable | Ejemplo | Descripción | +| ----------------- | ------- | ------------------------------------------- | +| added | `1` | The current number of added lines | +| deleted | `2` | The current number of deleted lines | +| added_style\* | | Mirrors the value of option `added_style` | +| deleted_style\* | | Mirrors the value of option `deleted_style` | *: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo @@ -1662,66 +1748,66 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) ' ## Git status -El módulo `git_status` muestra símbolos que representan el estado del repositorio en su directorio actual. +The `git_status` module shows symbols representing the state of the repo in your current directory. ::: tip -El módulo Git Status es muy lento en los directorios de Windows (por ejemplo bajo `/mnt/c/`) en un entorno WSL. Puedes desactivar el módulo o utilizar la opción `windows_starship` para usar un ejecutable de la Starship nativa de Windows para calcular `git_status` para esas rutas. +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. ::: ### Opciones -| Opción | Predeterminado | Descripción | -| ------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | -| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | El formato predeterminado para `git_status` | -| `conflicted` | `'='` | Esta rama tiene conflictos de fusión. | -| `ahead` | `'⇡'` | El formato de `ahead` | -| `behind` | `'⇣'` | El formato de `behind` | -| `diverged` | `'⇕'` | El formato de `diverged` | -| `up_to_date` | `''` | El formato de `up_to_date` | -| `sin seguimiento` | `'?'` | El formato de `untracked` | -| `stashed` | `'$'` | El formato de `stashed` | -| `modificado` | `'!'` | El formato de `modified` | -| `staged` | `'+'` | El formato de `staged` | -| `renamed` | `'»'` | El formato de `renamed` | -| `borrado` | `'✘'` | El formato de `deleted` | -| `style` | `'bold red'` | El estilo del módulo. | -| `ignore_submodules` | `false` | Ignorar cambios a los submódulos. | -| `disabled` | `false` | Deshabilita el módulo `git_status`. | -| `windows_starship` | | Utiliza esta ruta (Linux) a un ejecutable de Starship de Windows para renderizar `git_status` cuando está en las rutas de Windows en WSL. | +| Opción | Predeterminado | Descripción | +| ------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | +| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | The default format for `git_status` | +| `conflicted` | `'='` | This branch has merge conflicts. | +| `ahead` | `'⇡'` | The format of `ahead` | +| `behind` | `'⇣'` | The format of `behind` | +| `diverged` | `'⇕'` | The format of `diverged` | +| `up_to_date` | `''` | The format of `up_to_date` | +| `untracked` | `'?'` | The format of `untracked` | +| `stashed` | `'$'` | The format of `stashed` | +| `modified` | `'!'` | The format of `modified` | +| `staged` | `'+'` | The format of `staged` | +| `renamed` | `'»'` | The format of `renamed` | +| `deleted` | `'✘'` | The format of `deleted` | +| `style` | `'bold red'` | El estilo del módulo. | +| `ignore_submodules` | `false` | Ignore changes to submodules. | +| `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. | ### Variables -Las siguientes variables se pueden utilizar en `format`: +The following variables can be used in `format`: -| Variable | Descripción | -| ----------------- | ------------------------------------------------------------------------------------------------------------------------ | -| `all_status` | Atajo para `$conflicted$stashed$deleted$renamed$modified$staged$untracked` | -| `ahead_behind` | Muestra la cadena de formato de `diverged` `ahead` o `behind` o `up_to_date` basado en el estado actual del repositorio. | -| `conflicted` | Muestra `conflicted` cuando esta rama tiene conflictos de fusión. | -| `sin seguimiento` | Muestra `untracked` cuando hay archivos sin rastrear en el directorio de trabajo. | -| `stashed` | Muestra `stashed` cuando existe un archivo en el área de preparación para el repositorio local. | -| `modificado` | Muestra `modified` cuando hay modificaciones de archivo en el directorio de trabajo. | -| `staged` | Muestra `staged` cuando se ha añadido un nuevo archivo al área de preparación. | -| `renamed` | Muestra `renamed` cuando un archivo renombrado ha sido añadido al área de preparación. | -| `borrado` | Muestra `deleted` cuando un archivo ha sido añadido al área de preparación. | -| style\* | Refleja el valor de la opción `style` | +| Variable | Descripción | +| -------------- | ------------------------------------------------------------------------------------------------------------- | +| `all_status` | Shortcut for`$conflicted$stashed$deleted$renamed$modified$staged$untracked` | +| `ahead_behind` | Displays `diverged`, `ahead`, `behind` or `up_to_date` format string based on the current status of the repo. | +| `conflicted` | Displays `conflicted` when this branch has merge conflicts. | +| `untracked` | Displays `untracked` when there are untracked files in the working directory. | +| `stashed` | Displays `stashed` when a stash exists for the local repository. | +| `modified` | Displays `modified` when there are file modifications in the working directory. | +| `staged` | Displays `staged` when a new file has been added to the staging area. | +| `renamed` | Displays `renamed` when a renamed file has been added to the staging area. | +| `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. | +| style\* | Refleja el valor de la opción `style` | *: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo -Las siguientes variables pueden ser usadas en `diverged`: +The following variables can be used in `diverged`: -| Variable | Descripción | -| -------------- | -------------------------------------------------------------- | -| `ahead_count` | Número de confirmaciones por delante de la rama de seguimiento | -| `behind_count` | Número de confirmaciones detrás de la rama de seguimiento | +| Variable | Descripción | +| -------------- | ---------------------------------------------- | +| `ahead_count` | Number of commits ahead of the tracking branch | +| `behind_count` | Number of commits behind the tracking branch | -Las siguientes variales pueden ser usadas en `conflicted`, `ahead`, `behind`, `untracked`, `stashed`, `modified`, `staged`, `renamed` y `deleted`: +The following variables can be used in `conflicted`, `ahead`, `behind`, `untracked`, `stashed`, `modified`, `staged`, `renamed` and `deleted`: -| Variable | Descripción | -| -------- | ----------------------------- | -| `count` | Mostrar el número de archivos | +| Variable | Descripción | +| -------- | ------------------------ | +| `count` | Show the number of files | ### Ejemplo @@ -1742,7 +1828,7 @@ renamed = '👅' deleted = '🗑' ``` -Muestra el conteo delante/detrás de la rama que está siendo rastreada +Show ahead/behind count of the branch being tracked ```toml # ~/.config/starship.toml @@ -1753,7 +1839,7 @@ diverged = '⇕⇡${ahead_count}⇣${behind_count}' behind = '⇣${count}' ``` -Usar el ejecutable de Starship de Windows en las rutas de Windows en WSL +Use Windows Starship executable on Windows paths in WSL ```toml # ~/.config/starship.toml @@ -1764,7 +1850,7 @@ windows_starship = '/mnt/c/Users/username/scoop/apps/starship/current/starship.e ## Go -El módulo `golang` muestra la versión instalada de [Go](https://golang.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `golang` module shows the currently installed version of [Go](https://golang.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: - El directorio actual contiene un archivo `go.mod` - El directorio actual contiene un archivo `go.sum` @@ -1782,18 +1868,18 @@ El módulo `golang` muestra la versión instalada de [Go](https://golang.org/). | ------------------- | ----------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | | `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. | | `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'🐹 '` | Una cadena de formato que representa el símbolo de Go. | +| `symbol` | `'🐹 '` | A format string representing the symbol of Go. | | `detect_extensions` | `['go']` | Qué extensiones 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. | | `style` | `'bold cyan'` | El estilo del módulo. | -| `disabled` | `false` | Deshabilita el módulo de `golang`. | +| `disabled` | `false` | Disables the `golang` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | --------- | -------------------------------------- | -| version | `v1.12.1` | La versión de `go` | +| version | `v1.12.1` | The version of `go` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -1816,7 +1902,7 @@ The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel | Opción | Predeterminado | Descripción | | ---------- | -------------------------- | ------------------------------------------------------ | -| `format` | `'vía [$symbol]($style) '` | El formato del módulo. | +| `format` | `'via [$symbol]($style) '` | El formato del módulo. | | `symbol` | `"🐃 "` | A format string representing the symbol of guix-shell. | | `style` | `"yellow bold"` | El estilo del módulo. | | `disabled` | `false` | Disables the `guix_shell` module. | @@ -1840,9 +1926,44 @@ disabled = true format = 'via [🐂](yellow bold) ' ``` +## Gradle + +The `gradle` module shows the version of the [Gradle Wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html) currently used in the project directory. + +Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: + +- The current directory contains a `gradle/wrapper/gradle-wrapper.properties` directory. +- The current directory contains a file ending with `.gradle` or `.gradle.kts`. + +The `gradle` module is only able to read your Gradle Wrapper version from your config file, we don't execute your wrapper, because of the security concerns. + +### Opciones + +| Opción | Predeterminado | Descripción | +| ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | +| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🅶 "` | A format string representing the symbol of Gradle. | +| `detect_extensions` | `["gradle", "gradle.kts"]` | Qué extensiones deberían activar este módulo. | +| `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. | +| `detect_folders` | `["gradle"]` | Qué carpetas deberían activar este módulo. | +| `style` | `"bold bright-cyan"` | El estilo del módulo. | +| `disabled` | `false` | Disables the `gradle` module. | +| `recursive` | `false` | Enables recursive finding for the `gradle` directory. | + +### Variables + +| Variable | Ejemplo | Descripción | +| -------- | -------- | -------------------------------------- | +| version | `v7.5.1` | The version of `gradle` | +| symbol | | Refleja el valor de la opción `symbol` | +| style* | | Refleja el valor de la opción `style` | + +*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo + ## Haskell -El módulo `haskell` encuentra la versión GHC seleccionada y/o la instantánea de la pila seleccionada. +The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: @@ -1851,25 +1972,25 @@ Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes ### Opciones -| Opción | Predeterminado | Descripción | -| ------------------- | ------------------------------------ | ---------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. | -| `symbol` | `'λ '` | Una cadena de formato que representa el símbolo de Haskell | -| `detect_extensions` | `['hs', 'cabal', 'hs-boot']` | Qué extensiones deberían activar este módulo. | -| `detect_files` | `['stack.yaml', 'cabal.project']` | Qué nombres de archivo deberían activar este módulo. | -| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | -| `style` | `'bold purple'` | El estilo del módulo. | -| `disabled` | `false` | Deshabilita el módulo `haskell`. | +| Opción | Predeterminado | Descripción | +| ------------------- | ------------------------------------ | ---------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. | +| `symbol` | `'λ '` | A format string representing the symbol of Haskell | +| `detect_extensions` | `['hs', 'cabal', 'hs-boot']` | Qué extensiones deberían activar este módulo. | +| `detect_files` | `['stack.yaml', 'cabal.project']` | Qué nombres de archivo deberían activar este módulo. | +| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | +| `style` | `'bold purple'` | El estilo del módulo. | +| `disabled` | `false` | Disables the `haskell` module. | ### Variables -| Variable | Ejemplo | Descripción | -| -------------- | ----------- | ------------------------------------------------------------------------------------ | -| version | | `ghc_version` o `snapshot` dependiendo de si el proyecto actual es un proyecto Stack | -| snapshot | `lts-18.12` | Instantánea de Stack seleccionada actualmente | -| ghc\_version | `9.2.1` | Versión GHC instalada actualmente | -| symbol | | Refleja el valor de la opción `symbol` | -| style\* | | Refleja el valor de la opción `style` | +| Variable | Ejemplo | Descripción | +| -------------- | ----------- | --------------------------------------------------------------------------------------- | +| version | | `ghc_version` or `snapshot` depending on whether the current project is a Stack project | +| snapshot | `lts-18.12` | Currently selected Stack snapshot | +| ghc\_version | `9.2.1` | Currently installed GHC version | +| symbol | | Refleja el valor de la opción `symbol` | +| style\* | | Refleja el valor de la opción `style` | *: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo @@ -1890,7 +2011,7 @@ The `haxe` module shows the currently installed version of [Haxe](https://haxe.o | `detect_extensions` | `["hx", "hxml"]` | Qué extensiones deberían activar este módulo. | | `detect_files` | `["project.xml", "Project.xml", "application.xml", "haxelib.json", "hxformat.json", ".haxerc"]` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `[".haxelib", "haxe_libraries"]` | Qué carpetas deberían activar estos módulos. | -| `symbol` | `"⌘ "` | Una cadena de formato que representa el símbolo de Helm. | +| `symbol` | `"⌘ "` | A format string representing the symbol of Helm. | | `style` | `"bold fg:202"` | El estilo del módulo. | | `disabled` | `false` | Disables the `haxe` module. | @@ -1915,7 +2036,7 @@ format = "via [⌘ $version](bold fg:202) " ## Helm -El módulo `helm` muestra la versión instalada de [Helm](https://helm.sh/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `helm` module shows the currently installed version of [Helm](https://helm.sh/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: - El directorio actual contiene un fichero `helmfile.yaml` - El directorio actual contiene un archivo `Chart.yaml` @@ -1929,15 +2050,15 @@ El módulo `helm` muestra la versión instalada de [Helm](https://helm.sh/). Por | `detect_extensions` | `[]` | Qué extensiones deberían activar este módulo. | | `detect_files` | `['helmfile.yaml', 'Chart.yaml']` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `[]` | Qué carpetas deberían activar estos módulos. | -| `symbol` | `'⎈ '` | Una cadena de formato que representa el símbolo de Helm. | +| `symbol` | `'⎈ '` | A format string representing the symbol of Helm. | | `style` | `'bold white'` | El estilo del módulo. | -| `disabled` | `false` | Deshabilita el módulo `helm`. | +| `disabled` | `false` | Disables the `helm` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `v3.1.1` | La versión de `helm` | +| version | `v3.1.1` | The version of `helm` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -1954,26 +2075,26 @@ format = 'via [⎈ $version](bold white) ' ## Hostname -El módulo `hostname` muestra el nombre de host del sistema. +The `hostname` module shows the system hostname. ### Opciones -| Opción | Predeterminado | Descripción | -| ------------ | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ssh_only` | `true` | Mostrar sólo el nombre de host cuando esté conectado a una sesión SSH. | -| `ssh_symbol` | `'🌐 '` | Una cadena de formato que representa el símbolo cuando se conecta a la sesión SSH. | -| `trim_at` | `'.'` | Cadena en la que el nombre del host se corta, después de la primera coincidencia. `'.'` will stop after the first dot. `''` will disable any truncation | -| `format` | `'[$ssh_symbol$hostname]($style) in '` | El formato del módulo. | -| `style` | `'negrita oscurecida verde'` | El estilo del módulo. | -| `disabled` | `false` | Deshabilita el módulo `hostname`. | +| Opción | Predeterminado | Descripción | +| ------------ | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | +| `ssh_only` | `true` | Only show hostname when connected to an SSH session. | +| `ssh_symbol` | `'🌐 '` | A format string representing the symbol when connected to SSH session. | +| `trim_at` | `'.'` | String that the hostname is cut off at, after the first match. `'.'` will stop after the first dot. `''` will disable any truncation | +| `format` | `'[$ssh_symbol$hostname]($style) in '` | El formato del módulo. | +| `style` | `'bold dimmed green'` | El estilo del módulo. | +| `disabled` | `false` | Disables the `hostname` module. | ### Variables -| Variable | Ejemplo | Descripción | -| --------------- | ------------- | -------------------------------------------------------------- | -| nombre del host | `computadora` | El nombre de host de la computadora | -| style\* | | Refleja el valor de la opción `style` | -| ssh_symbol | `'🌏 '` | El símbolo a representar cuando está conectado a la sesión SSH | +| Variable | Ejemplo | Descripción | +| ---------- | ---------- | ----------------------------------------------------- | +| hostname | `computer` | The hostname of the computer | +| style\* | | Refleja el valor de la opción `style` | +| ssh_symbol | `'🌏 '` | The symbol to represent when connected to SSH session | *: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo @@ -1991,7 +2112,7 @@ disabled = false ## Java -El módulo `java` muestra la versión instalada de [Java](https://www.oracle.com/java/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `java` module shows the currently installed version of [Java](https://www.oracle.com/java/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: - The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `deps.edn`, `project.clj`, or `build.boot` file - El directorio actual contiene un archivo con la extensión `.java`, `.class`, `.gradle` o `.jar`, `.clj` o `.cljc` @@ -2005,15 +2126,15 @@ El módulo `java` muestra la versión instalada de [Java](https://www.oracle.com | `detect_extensions` | `['java', 'class', 'gradle', 'jar', 'cljs', 'cljc']` | Qué extensiones deberían activar este módulo. | | `detect_files` | `['pom.xml', 'build.gradle.kts', 'build.sbt', '.java-version', 'deps.edn', 'project.clj', 'build.boot']` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `[]` | Qué carpetas deberían activar estos módulos. | -| `symbol` | `'☕ '` | Una cadena de formato que representa el símbolo de Java | +| `symbol` | `'☕ '` | A format string representing the symbol of Java | | `style` | `'red dimmed'` | El estilo del módulo. | -| `disabled` | `false` | Deshabilita el módulo `java`. | +| `disabled` | `false` | Disables the `java` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | ------- | -------------------------------------- | -| version | `v14` | La versión de `java` | +| version | `v14` | The version of `java` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -2028,11 +2149,11 @@ El módulo `java` muestra la versión instalada de [Java](https://www.oracle.com symbol = '🌟 ' ``` -## Trabajos +## Jobs -El módulo `jobs` muestra el número actual de tareas en ejecución. El módulo se mostrará sólo si hay tareas en segundo plano ejecutándose. El módulo mostrará el número de tareas ejecutados si hay al menos 2 tareas, o más del valor de configuración de `number_threshold`, si existe. El módulo mostrará un símbolo si hay al menos 1 tarea, o más del valor de configuración de `symbol_threshold`, si existe. Puedes establecer ambos valores a 0 para _siempre_ mostrar el símbolo y el número de tareas, incluso si hay 0 tareas en ejecución. +The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to _always_ show the symbol and number of jobs, even if there are 0 jobs running. -La funcionalidad por defecto es: +The default functionality is: - 0 tareas -> No se muestra nada. - 1 tarea -> `symbol` se muestra. @@ -2040,35 +2161,35 @@ La funcionalidad por defecto es: ::: warning -Este módulo no está soportado por tcsh y nu. +This module is not supported on tcsh and nu. ::: ::: warning -La opción `threshold` está obsoleta, pero si deseas usarla, el módulo mostrará el número de tareas en ejecución si hay más de 1 tarea, o más que el valor de configuración `threshold`, si existe. Si `threshold` se establece en 0, entonces el módulo también se mostrará cuando haya 0 tareas en ejecución. +The `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. ::: ### Opciones -| Opción | Predeterminado | Descripción | -| ------------------ | ----------------------------- | ---------------------------------------------------------------------------------- | -| `threshold`* | `1` | Muestra el número de tareas si se exceden. | -| `symbol_threshold` | `1` | Muestra `symbol` si el conteo de tareas es al menos `symbol_threshold`. | -| `number_threshold` | `2` | Muestra el número de tareas si el conteo de tareas es al menos `symbol_threshold`. | -| `format` | `'[$symbol$number]($style) '` | El formato del módulo. | -| `symbol` | `'✦'` | La cadena utilizada para representar la variable `symbol`. | -| `style` | `'bold blue'` | El estilo del módulo. | -| `disabled` | `false` | Desactiva el módulo `jobs`. | +| Opción | Predeterminado | Descripción | +| ------------------ | ----------------------------- | ------------------------------------------------------------------------ | +| `threshold`* | `1` | Show number of jobs if exceeded. | +| `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. | +| `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. | +| `format` | `'[$symbol$number]($style) '` | El formato del módulo. | +| `symbol` | `'✦'` | The string used to represent the `symbol` variable. | +| `style` | `'bold blue'` | El estilo del módulo. | +| `disabled` | `false` | Disables the `jobs` module. | -*: Esta opción está desaprobada, por favor utiliza las opciones `number_threshold` y `symbol_threshold` en su lugar. +*: This option is deprecated, please use the `number_threshold` and `symbol_threshold` options instead. ### Variables | Variable | Ejemplo | Descripción | | --------- | ------- | -------------------------------------- | -| número | `1` | El número de tareas | +| number | `1` | The number of jobs | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -2087,7 +2208,7 @@ symbol_threshold = 0 ## Julia -El módulo `julia` muestra la versión instalada de [Julia](https://julialang.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `julia` module shows the currently installed version of [Julia](https://julialang.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: - El directorio actual contiene un archivo `Project.toml` - El directorio actual contiene un archivo `Manifest.toml` @@ -2102,15 +2223,15 @@ El módulo `julia` muestra la versión instalada de [Julia](https://julialang.or | `detect_extensions` | `['jl']` | Qué extensiones deberían activar este módulo. | | `detect_files` | `['Project.toml', 'Manifest.toml']` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `[]` | Qué carpetas deberían activar estos módulos. | -| `symbol` | `'ஃ '` | Una cadena de formato que representa el símbolo de Julia. | +| `symbol` | `'ஃ '` | A format string representing the symbol of Julia. | | `style` | `'bold purple'` | El estilo del módulo. | -| `disabled` | `false` | Deshabilita el módulo `julia`. | +| `disabled` | `false` | Disables the `julia` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `v1.4.0` | La versión de `julia` | +| version | `v1.4.0` | The version of `julia` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -2127,7 +2248,7 @@ symbol = '∴ ' ## Kotlin -El módulo `kotlin` muestra la versión instalada de [Kotlin](https://kotlinlang.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `kotlin` module shows the currently installed version of [Kotlin](https://kotlinlang.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: - El directorio actual contiene un archivo `.kt` o un `.kts` @@ -2140,16 +2261,16 @@ El módulo `kotlin` muestra la versión instalada de [Kotlin](https://kotlinlang | `detect_extensions` | `['kt', 'kts']` | Qué extensiones deberían activar este módulo. | | `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `[]` | Qué carpetas deberían activar estos módulos. | -| `symbol` | `'🅺 '` | Una cadena de formato que representa el símbolo de Kotlin. | +| `symbol` | `'🅺 '` | A format string representing the symbol of Kotlin. | | `style` | `'bold blue'` | El estilo del módulo. | -| `kotlin_binary` | `'kotlin'` | Configura el binario kotlin que Starship ejecuta al obtener la versión. | -| `disabled` | `false` | Deshabilita el módulo `kotlin`. | +| `kotlin_binary` | `'kotlin'` | Configures the kotlin binary that Starship executes when getting the version. | +| `disabled` | `false` | Disables the `kotlin` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | --------- | -------------------------------------- | -| version | `v1.4.21` | La versión de `kotlin` | +| version | `v1.4.21` | The version of `kotlin` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -2174,11 +2295,11 @@ kotlin_binary = 'kotlinc' ## Kubernetes -Muestra el nombre actual del [contexto de Kubernetes](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context) y, si se establece, el espacio de nombres, el usuario y el clúster del archivo kubeconfig. El espacio de nombres necesita establecerse en el archivo kubeconfig, esto puede hacerse mediante `kubectl config set-context starship-context --namespace astronaut`. Del mismo modo, el usuario y clúster pueden establecerse con `kubectl config set-context starship-context --user starship-user` y `kubectl config set-context starship-context --cluster starship-cluster`. Si se establece la variable de entorno `$KUBECONFIG`, el módulo usará eso si no usará el `~/.kube/config`. +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`. If the `$KUBECONFIG` env var is set the module will use that if not it will use the `~/.kube/config`. ::: tip -Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` como `false` en tu archivo de configuración. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. When the module is enabled it will always be active, unless any of `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions. @@ -2186,28 +2307,28 @@ When the module is enabled it will always be active, unless any of `detect_exten ### Opciones -| Opción | Predeterminado | Descripción | -| ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------------- | -| `symbol` | `'☸ '` | Una cadena de formato que representa el símbolo mostrado antes del Cluster. | -| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | El formato del módulo. | -| `style` | `'cyan bold'` | El estilo del módulo. | -| `context_aliases` | `{}` | Tabla de alias de contexto a mostrar. | -| `user_aliases` | `{}` | Table of user aliases to display. | -| `detect_extensions` | `[]` | Qué extensiones deberían activar este módulo. | -| `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. | -| `detect_folders` | `[]` | Qué carpetas deberían activar estos módulos. | -| `disabled` | `true` | Desactiva el módulo `kubernetes`. | +| Opción | Predeterminado | Descripción | +| ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | +| `symbol` | `'☸ '` | A format string representing the symbol displayed before the Cluster. | +| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | El formato del módulo. | +| `style` | `'cyan bold'` | El estilo del módulo. | +| `context_aliases` | `{}` | Table of context aliases to display. | +| `user_aliases` | `{}` | Table of user aliases to display. | +| `detect_extensions` | `[]` | Qué extensiones deberían activar este módulo. | +| `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. | +| `detect_folders` | `[]` | Qué carpetas deberían activar estos módulos. | +| `disabled` | `true` | Disables the `kubernetes` module. | ### Variables -| Variable | Ejemplo | Descripción | -| --------- | -------------------- | ----------------------------------------------------------- | -| contexto | `starship-context` | El nombre del contexto actual de kubernetes | -| namespace | `starship-namespace` | Si se establece, el espacio de nombres actual de kubernetes | -| usuario | `starship-user` | Si se establece, el espacio de nombres actual de kubernetes | -| cluster | `starship-cluster` | Si se establece, el clúster actual de kubernetes | -| symbol | | Refleja el valor de la opción `symbol` | -| style\* | | Refleja el valor de la opción `style` | +| Variable | Ejemplo | Descripción | +| --------- | -------------------- | ---------------------------------------- | +| contexto | `starship-context` | The current kubernetes context name | +| namespace | `starship-namespace` | If set, the current kubernetes namespace | +| user | `starship-user` | If set, the current kubernetes user | +| cluster | `starship-cluster` | If set, the current kubernetes cluster | +| symbol | | Refleja el valor de la opción `symbol` | +| style\* | | Refleja el valor de la opción `style` | *: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo @@ -2242,9 +2363,9 @@ detect_files = ['k8s'] Additional to simple aliasing, `context_aliases` and `user_aliases` also supports extended matching and renaming using regular expressions. -La expresión regular debe coincidir en todo el contexto de kube. los grupos de captura pueden ser referenciados usando `$name` y `$N` en el reemplazo. Esto está más explicado en la documentación del [crate regex](https://docs.rs/regex/1.5.4/regex/struct.Regex.html#method.replace). +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. -Los nombres de cluster generados de forma larga y automática pueden ser identificados y abreviados usando expresiones regulares: +Long and automatically generated cluster names can be identified and shortened using regular expressions: ```toml [kubernetes.context_aliases] @@ -2259,15 +2380,15 @@ Los nombres de cluster generados de forma larga y automática pueden ser identif 'gke_.*_(?P[\\w-]+)' = 'gke-$var_cluster' ``` -## Salto de línea +## Line Break -El módulo `line_break` separa el prompt en dos líneas. +The `line_break` module separates the prompt into two lines. ### Opciones -| Opción | Predeterminado | Descripción | -| ---------- | -------------- | ------------------------------------------------------------------------------ | -| `disabled` | `false` | Deshabilita el módulo `line_break`, haciendo que el prompt sea una sola línea. | +| Opción | Predeterminado | Descripción | +| ---------- | -------------- | ------------------------------------------------------------------ | +| `disabled` | `false` | Disables the `line_break` module, making the prompt a single line. | ### Ejemplo @@ -2278,24 +2399,24 @@ El módulo `line_break` separa el prompt en dos líneas. disabled = true ``` -## IP local +## Local IP -El módulo `localip` muestra la dirección IPv4 de la interfaz de red principal. +The `localip` module shows the IPv4 address of the primary network interface. ### Opciones -| Opción | Predeterminado | Descripción | -| ---------- | ------------------------- | ----------------------------------------------------------------------- | -| `ssh_only` | `true` | Solo muestra la direccion IP cuando se está conectado a una sesión SSH. | -| `format` | `'[$localipv4]($style) '` | El formato del módulo. | -| `style` | `'bold yellow'` | El estilo del módulo. | -| `disabled` | `true` | Deshabilita el módulo `localip`. | +| Opción | Predeterminado | Descripción | +| ---------- | ------------------------- | ------------------------------------------------------ | +| `ssh_only` | `true` | Only show IP address when connected to an SSH session. | +| `format` | `'[$localipv4]($style) '` | El formato del módulo. | +| `style` | `'bold yellow'` | El estilo del módulo. | +| `disabled` | `true` | Disables the `localip` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | ------------ | ------------------------------------- | -| localipv4 | 192.168.1.13 | Contiene la dirección IPv4 primaria | +| localipv4 | 192.168.1.13 | Contains the primary IPv4 address | | style\* | | Refleja el valor de la opción `style` | *: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo @@ -2313,7 +2434,7 @@ disabled = false ## Lua -El módulo `lua` muestra la versión instalada de [Lua](http://www.lua.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `lua` module shows the currently installed version of [Lua](http://www.lua.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: - El directorio actual contiene un archivo `.lua-version` - El directorio actual contiene un directorio `lua` @@ -2325,19 +2446,19 @@ El módulo `lua` muestra la versión instalada de [Lua](http://www.lua.org/). Po | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | | `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. | | `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'🌙 '` | Una cadena de formato que representa el símbolo de Lua. | +| `symbol` | `'🌙 '` | A format string representing the symbol of Lua. | | `detect_extensions` | `['lua']` | Qué extensiones deberían activar este módulo. | | `detect_files` | `['.lua-version']` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `['lua']` | Qué carpetas deberían activar este módulo. | | `style` | `'bold blue'` | El estilo del módulo. | -| `lua_binary` | `'lua'` | Configura el binario lua que Starship ejecuta al obtener la versión. | -| `disabled` | `false` | Deshabilita el módulo `lua`. | +| `lua_binary` | `'lua'` | Configures the lua binary that Starship executes when getting the version. | +| `disabled` | `false` | Disables the `lua` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `v5.4.0` | La versión de `lua` | +| version | `v5.4.0` | The version of `lua` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -2352,40 +2473,40 @@ El módulo `lua` muestra la versión instalada de [Lua](http://www.lua.org/). Po format = 'via [🌕 $version](bold blue) ' ``` -## Uso de la memoria +## Memory Usage -El módulo `memory_usage` muestra la memoria del sistema actual y el uso de la memoria de intercambio. +The `memory_usage` module shows current system memory and swap usage. -Por defecto, el uso de la memoria de intercambio se muestra si no es cero. +By default the swap usage is displayed if the total system swap is non-zero. ::: tip -Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` como `false` en tu archivo de configuración. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### Opciones -| Opción | Predeterminado | Descripción | -| ----------- | ----------------------------------------------- | ------------------------------------------------------------- | -| `threshold` | `75` | Ocultar el uso de memoria a menos que supere este porcentaje. | -| `format` | `'via $symbol [${ram}( \| ${swap})]($style) '` | El formato del módulo. | -| `symbol` | `'🐏'` | El símbolo usado antes de mostrar el uso de memoria. | -| `style` | `'bold dimmed white'` | El estilo del módulo. | -| `disabled` | `true` | Desactiva el módulo `memory_usage`. | +| Opción | Predeterminado | Descripción | +| ----------- | ----------------------------------------------- | -------------------------------------------------------- | +| `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. | +| `format` | `'via $symbol [${ram}( \| ${swap})]($style) '` | El formato del módulo. | +| `symbol` | `'🐏'` | The symbol used before displaying the memory usage. | +| `style` | `'bold dimmed white'` | El estilo del módulo. | +| `disabled` | `true` | Disables the `memory_usage` module. | ### Variables -| Variable | Ejemplo | Descripción | -| ---------------- | ------------- | ---------------------------------------------------------------------------------- | -| ram | `31GiB/65GiB` | La memoria RAM usada/total del sistema actual. | -| ram_pct | `48%` | El porcentaje de la memoria actual del sistema. | -| swap\*\* | `1GiB/4GiB` | El tamaño de la memoria de intercambio del archivo de memoria del sistema actual. | -| swap_pct\*\* | `77%` | El porcentaje de memoria de intercambio del archivo de memoria del sistema actual. | -| symbol | `🐏` | Refleja el valor de la opción `symbol` | -| style\* | | Refleja el valor de la opción `style` | +| Variable | Ejemplo | Descripción | +| ---------------- | ------------- | ------------------------------------------------------------------ | +| ram | `31GiB/65GiB` | The usage/total RAM of the current system memory. | +| ram_pct | `48%` | The percentage of the current system memory. | +| swap\*\* | `1GiB/4GiB` | The swap memory size of the current system swap memory file. | +| swap_pct\*\* | `77%` | The swap memory percentage of the current system swap memory file. | +| symbol | `🐏` | Refleja el valor de la opción `symbol` | +| style\* | | Refleja el valor de la opción `style` | -*: Está variable solo puede utilizarse como parte de una cadena de estilo *\*: La información del archivo SWAP solo se muestra si se detecta en el sistema actual +*: This variable can only be used as a part of a style string *\*: The SWAP file information is only displayed if detected on the current system ### Ejemplo @@ -2420,7 +2541,7 @@ By default the Meson project name is displayed, if `$MESON_DEVENV` is set. | Variable | Ejemplo | Descripción | | --------- | ---------- | -------------------------------------- | -| proyecto | `starship` | El nombre actual del proyecto Meson | +| project | `starship` | The current Meson project name | | symbol | `🐏` | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -2438,26 +2559,27 @@ symbol = ' ' style = 'bold dimmed green' ``` -## Rama Mercurial +## Mercurial Branch -El módulo `hg_branch` muestra la rama activa del repositorio del directorio actual. +The `hg_branch` module shows the active branch and topic of the repo in your current directory. ### Opciones -| Opción | Predeterminado | Descripción | -| ------------------- | -------------------------------- | --------------------------------------------------------------------------------------------------- | -| `symbol` | `' '` | El símbolo usado antes del marcador hg o nombre de la rama del repositorio en su directorio actual. | -| `style` | `'bold purple'` | El estilo del módulo. | -| `format` | `'on [$symbol$branch]($style) '` | El formato del módulo. | -| `truncation_length` | `2^63 - 1` | Trunca el nombre de la rama hg a `N` grafemas | -| `truncation_symbol` | `'…'` | El símbolo usado para indicar que un nombre de rama fue truncado. | -| `disabled` | `true` | Deshabilita el módulo `hg_branch`. | +| Opción | Predeterminado | Descripción | +| ------------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------- | +| `symbol` | `' '` | The symbol used before the hg bookmark or branch name of the repo in your current directory. | +| `style` | `'bold purple'` | El estilo del módulo. | +| `format` | `'on [$symbol$branch(:$topic)]($style) '` | El formato del módulo. | +| `truncation_length` | `2^63 - 1` | Truncates the hg branch / topic name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. | +| `disabled` | `true` | Disables the `hg_branch` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | --------- | -------------------------------------- | -| rama | `maestro` | La rama mercurial activa | +| branch | `master` | The active mercurial branch | +| topic | `feature` | The active mercurial topic | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -2476,7 +2598,7 @@ truncation_symbol = '' ## Nim -El módulo `nim` muestra la versión instalada de [Nim](https://nim-lang.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `nim` module shows the currently installed version of [Nim](https://nim-lang.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: - El directorio actual contiene un archivo `nim.cfg` - El directorio actual contiene un archivo con la extensión `.nim` @@ -2487,20 +2609,20 @@ El módulo `nim` muestra la versión instalada de [Nim](https://nim-lang.org/). | Opción | Predeterminado | Descripción | | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | El formato del módulo | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module | | `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'👑 '` | El símbolo usado antes de mostrar la versión de Nim. | +| `symbol` | `'👑 '` | The symbol used before displaying the version of Nim. | | `detect_extensions` | `['nim', 'nims', 'nimble']` | Qué extensiones deberían activar este módulo. | | `detect_files` | `['nim.cfg']` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | | `style` | `'bold yellow'` | El estilo del módulo. | -| `disabled` | `false` | Deshabilita el módulo `nim`. | +| `disabled` | `false` | Disables the `nim` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `v1.2.0` | La versión de `nimc` | +| version | `v1.2.0` | The version of `nimc` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -2518,25 +2640,27 @@ symbol = '🎣 ' ## Nix-shell -El módulo `nix_shell` muestra el entorno [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html). El módulo se mostrará dentro de un entorno nix-shell. +The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html) environment. The module will be shown when inside a nix-shell environment. ### Opciones -| Opción | Predeterminado | Descripción | -| ------------ | ---------------------------------------------- | -------------------------------------------------------------------------------- | -| `format` | `'via [$symbol$state( \($name\))]($style) '` | El formato del módulo. | -| `symbol` | `'❄️ '` | Una cadena de formato que representa el símbolo de nix-shell. | -| `style` | `'bold blue'` | El estilo del módulo. | -| `impure_msg` | `'impure'` | Una cadena de formato que se muestra cuando el intérprete de comandos es impuro. | -| `pure_msg` | `'pure'` | Una cadena de formato que se muestra cuando el intérprete de comandos es puro. | -| `disabled` | `false` | Desactiva el módulo `nix_shell`. | +| Opción | Predeterminado | Descripción | +| ------------- | ---------------------------------------------- | --------------------------------------------------------------------- | +| `format` | `'via [$symbol$state( \($name\))]($style) '` | El formato del módulo. | +| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | +| `style` | `'bold blue'` | El estilo del módulo. | +| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | +| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | +| `unknown_msg` | `''` | A format string shown when it is unknown if the shell is pure/impure. | +| `disabled` | `false` | Disables the `nix_shell` module. | +| `heuristic` | `false` | Attempts to detect new `nix shell`-style shells with a heuristic. | ### Variables | Variable | Ejemplo | Descripción | | --------- | ------- | -------------------------------------- | -| state | `pure` | El estado de nix-shell | -| name | `lorri` | El nombre de nix-shell | +| state | `pure` | The state of the nix-shell | +| name | `lorri` | The name of the nix-shell | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -2551,12 +2675,13 @@ El módulo `nix_shell` muestra el entorno [nix-shell](https://nixos.org/guides/n disabled = true impure_msg = '[impure shell](bold red)' pure_msg = '[pure shell](bold green)' +unknown_msg = '[unknown shell](bold yellow)' format = 'via [☃️ $state( \($name\))](bold blue) ' ``` ## Node.js -El módulo `nodejs` muestra la versión instalada de [Node.js](https://nodejs.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `nodejs` module shows the currently installed version of [Node.js](https://nodejs.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: - El directorio actual contiene un archivo `package.json` - El directorio actual contiene un archivo `.node-version` @@ -2567,23 +2692,23 @@ El módulo `nodejs` muestra la versión instalada de [Node.js](https://nodejs.or ### Opciones -| Opción | Predeterminado | Descripción | -| ------------------- | ------------------------------------------ | --------------------------------------------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. | -| `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `' '` | Una cadena de formato que representa el símbolo de Node.js. | -| `detect_extensions` | `['js', 'mjs', 'cjs', 'ts', 'mts', 'cts']` | Qué extensiones deberían activar este módulo. | -| `detect_files` | `['package.json', '.node-version']` | Qué nombres de archivo deberían activar este módulo. | -| `detect_folders` | `['node_modules']` | Qué carpetas deberían activar este módulo. | -| `style` | `'bold green'` | El estilo del módulo. | -| `disabled` | `false` | Deshabilita el módulo `nodejs`. | -| `not_capable_style` | `bold red` | El estilo para el módulo cuando una propiedad de motores en package.json no coincide con la versión de Node.js. | +| Opción | Predeterminado | Descripción | +| ------------------- | ------------------------------------------ | ----------------------------------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. | +| `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | +| `symbol` | `' '` | A format string representing the symbol of Node.js. | +| `detect_extensions` | `['js', 'mjs', 'cjs', 'ts', 'mts', 'cts']` | Qué extensiones deberían activar este módulo. | +| `detect_files` | `['package.json', '.node-version']` | Qué nombres de archivo deberían activar este módulo. | +| `detect_folders` | `['node_modules']` | Qué carpetas deberían activar este módulo. | +| `style` | `'bold green'` | El estilo del módulo. | +| `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. | ### Variables | Variable | Ejemplo | Descripción | | --------- | ---------- | -------------------------------------- | -| version | `v13.12.0` | La versión de `node` | +| version | `v13.12.0` | The version of `node` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -2598,9 +2723,9 @@ El módulo `nodejs` muestra la versión instalada de [Node.js](https://nodejs.or format = 'via [🤖 $version](bold green) ' ``` -## OCamlz +## OCaml -El módulo `ocaml` muestra la versión instalada de [OCaml](https://ocaml.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `ocaml` module shows the currently installed version of [OCaml](https://ocaml.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: - El directorio actual contiene un archivo con extensión `.opam` o directorio `_opam` - El directorio actual contiene un directorio `esy.lock` @@ -2615,26 +2740,26 @@ El módulo `ocaml` muestra la versión instalada de [OCaml](https://ocaml.org/). | ------------------------- | -------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | | `format` | `'via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)'` | La cadena de formato para el módulo. | | `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'🐫 '` | El símbolo usado antes de mostrar la versión de OCaml. | -| `global_switch_indicator` | `''` | La cadena de formato usada para representar el interruptor global de OPAM. | -| `local_switch_indicator` | `'*'` | La cadena de formato usada para representar el interruptor local de OPAM. | +| `symbol` | `'🐫 '` | The symbol used before displaying the version of OCaml. | +| `global_switch_indicator` | `''` | The format string used to represent global OPAM switch. | +| `local_switch_indicator` | `'*'` | The format string used to represent local OPAM switch. | | `detect_extensions` | `['opam', 'ml', 'mli', 're', 'rei']` | Qué extensiones deberían activar este módulo. | | `detect_files` | `['dune', 'dune-project', 'jbuild', 'jbuild-ignore', '.merlin']` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `['_opam', 'esy.lock']` | Qué carpetas deberían activar este módulo. | | `style` | `'bold yellow'` | El estilo del módulo. | -| `disabled` | `false` | Deshabilita el módulo `ocaml`. | +| `disabled` | `false` | Disables the `ocaml` module. | ### Variables -| Variable | Ejemplo | Descripción | -| ---------------- | ------------ | --------------------------------------------------------------------------- | -| version | `v4.10.0` | La versión de `ocaml` | -| switch_name | `my-project` | El interruptor OPAM activo | -| switch_indicator | | Refleja el valor de `indicator` para el interruptor OPAM activo actualmente | -| symbol | | Refleja el valor de la opción `symbol` | -| style\* | | Refleja el valor de la opción `style` | +| Variable | Ejemplo | Descripción | +| ---------------- | ------------ | ----------------------------------------------------------------- | +| version | `v4.10.0` | The version of `ocaml` | +| switch_name | `my-project` | The active OPAM switch | +| switch_indicator | | Mirrors the value of `indicator` for currently active OPAM switch | +| 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 solamente puede ser usada como parte de una cadena de caracteres de estilo ### Ejemplo @@ -2683,23 +2808,23 @@ format = 'via [⛑️ $version](bold red) ' ## OpenStack -El módulo `openstack` muestra la nube actual y el proyecto OpenStack. El módulo solo está activo cuando la variable de entorno `OS_CLOUD` está definida, en cuyo caso leerá el archivo `clouds.yaml` desde cualquiera de las [ubicaciones por defecto](https://docs.openstack.org/python-openstackclient/latest/configuration/index.html#configuration-files). para obtener el proyecto actual en uso. +The `openstack` module shows the current OpenStack cloud and project. The module only active when the `OS_CLOUD` env var is set, in which case it will read `clouds.yaml` file from any of the [default locations](https://docs.openstack.org/python-openstackclient/latest/configuration/index.html#configuration-files). to fetch the current project in use. ### Opciones -| Opción | Predeterminado | Descripción | -| ---------- | ----------------------------------------------- | ----------------------------------------------------------- | -| `format` | `'on [$symbol$cloud(\($project\))]($style) '` | El formato del módulo. | -| `symbol` | `'☁️ '` | El símbolo usado antes de mostrar la nube OpenStack actual. | -| `style` | `'bold yellow'` | El estilo del módulo. | -| `disabled` | `false` | Deshabilita el módulo `openstack`. | +| Opción | Predeterminado | Descripción | +| ---------- | ----------------------------------------------- | -------------------------------------------------------------- | +| `format` | `'on [$symbol$cloud(\($project\))]($style) '` | El formato del módulo. | +| `symbol` | `'☁️ '` | The symbol used before displaying the current OpenStack cloud. | +| `style` | `'bold yellow'` | El estilo del módulo. | +| `disabled` | `false` | Disables the `openstack` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | ------- | -------------------------------------- | -| nube | `corp` | La nube OpenStack actual | -| proyecto | `dev` | El actual proyecto OpenStack | +| cloud | `corp` | The current OpenStack cloud | +| project | `dev` | The current OpenStack project | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -2728,7 +2853,7 @@ The [os_info](https://lib.rs/crates/os_info) crate used by this module is known ::: tip -Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` como `false` en tu archivo de configuración. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -2815,7 +2940,7 @@ Arch = "Arch is the best! " ## Package Version -El módulo `package` se muestra cuando el directorio actual es el repositorio de un paquete, y muestra su versión actual. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages. +The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages. - [**npm**](https://docs.npmjs.com/cli/commands/npm) – La versión del paquete `npm` se extrae del `package.json` presente en el directorio actual - [**Cargo**](https://doc.rust-lang.org/cargo/) – La versión del paquete `cargo` se extrae del `Cargo.toml` presente en el directorio actual @@ -2842,17 +2967,17 @@ El módulo `package` se muestra cuando el directorio actual es el repositorio de | Opción | Predeterminado | Descripción | | ----------------- | --------------------------------- | --------------------------------------------------------------------------------------- | | `format` | `'is [$symbol$version]($style) '` | El formato del módulo. | -| `symbol` | `'📦 '` | El símbolo usado antes de mostrar la versión del paquete. | +| `symbol` | `'📦 '` | The symbol used before displaying the version the package. | | `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | | `style` | `'bold 208'` | El estilo del módulo. | -| `display_private` | `false` | Activar la visualización de la versión para los paquetes marcados como privados. | -| `disabled` | `false` | Desactiva el módulo `package`. | +| `display_private` | `false` | Enable displaying version for packages marked as private. | +| `disabled` | `false` | Disables the `package` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `v1.0.0` | La versión de su paquete | +| version | `v1.0.0` | The version of your package | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -2869,7 +2994,7 @@ format = 'via [🎁 $version](208 bold) ' ## Perl -El módulo `perl` muestra la versión instalada de [Perl](https://www.perl.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `perl` module shows the currently installed version of [Perl](https://www.perl.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: - El directorio actual contiene un archivo `Makefile.PL` o `Build.PL` - El directorio actual contiene un archivo `cpanfile` o `cpanfile.snapshot` @@ -2883,18 +3008,18 @@ El módulo `perl` muestra la versión instalada de [Perl](https://www.perl.org/) | ------------------- | -------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | | `format` | `'via [$symbol($version )]($style)'` | La cadena de formato para el módulo. | | `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'🐪 '` | El símbolo usado antes de mostrar la versión de Perl | +| `symbol` | `'🐪 '` | The symbol used before displaying the version of Perl | | `detect_extensions` | `['pl', 'pm', 'pod']` | Qué extensiones deberían activar este módulo. | | `detect_files` | `['Makefile.PL', 'Build.PL', 'cpanfile', 'cpanfile.snapshot', 'META.json', 'META.yml', '.perl-version']` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | | `style` | `'bold 149'` | El estilo del módulo. | -| `disabled` | `false` | Deshabilita el módulo `perl`. | +| `disabled` | `false` | Disables the `perl` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | --------- | -------------------------------------- | -| version | `v5.26.1` | La versión de `perl` | +| version | `v5.26.1` | The version of `perl` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -2909,7 +3034,7 @@ format = 'via [🦪 $version]($style) ' ## PHP -El módulo `php` muestra la versión instalada de [PHP](https://www.php.net/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `php` module shows the currently installed version of [PHP](https://www.php.net/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: - El directorio actual contiene un archivo `composer.json` - El directorio actual contiene un archivo `.php-version` @@ -2921,18 +3046,18 @@ El módulo `php` muestra la versión instalada de [PHP](https://www.php.net/). P | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | | `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. | | `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'🐘 '` | El símbolo usado antes de mostrar la versión de PHP. | +| `symbol` | `'🐘 '` | The symbol used before displaying the version of PHP. | | `detect_extensions` | `['php']` | Qué extensiones deberían activar este módulo. | | `detect_files` | `['composer.json', '.php-version']` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | | `style` | `'147 bold'` | El estilo del módulo. | -| `disabled` | `false` | Deshabilita el módulo `php`. | +| `disabled` | `false` | Disables the `php` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `v7.3.8` | La versión de `php` | +| version | `v7.3.8` | The version of `php` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -2947,13 +3072,28 @@ El módulo `php` muestra la versión instalada de [PHP](https://www.php.net/). P format = 'via [🔹 $version](147 bold) ' ``` +## Pijul Channel + +The `pijul_channel` module shows the active channel of the repo in your current directory. + +### Opciones + +| Opción | Predeterminado | Descripción | +| ------------------- | --------------------------------- | ------------------------------------------------------------------------------------ | +| `symbol` | `' '` | The symbol used before the pijul channel name of the repo in your current directory. | +| `style` | `'bold purple'` | El estilo del módulo. | +| `format` | `'on [$symbol$channel]($style) '` | El formato del módulo. | +| `truncation_length` | `2^63 - 1` | Truncates the pijul channel name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. | +| `disabled` | `true` | Disables the `pijul` module. | + ## Pulumi -El módulo `pulumi` muestra el nombre de usuario actual, [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/)seleccionado y la versión. +The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. ::: tip -Por defecto la versión de Pulumi no se muestra, ya que toma un orden de magnitud más largo para cargar que la mayoría de los plugins (~70ms). Si aún deseas activarlo, [sigue el ejemplo que se muestra a continuación](#with-pulumi-version). +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). ::: @@ -2968,18 +3108,18 @@ Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes | ---------------- | -------------------------------------------- | --------------------------------------------------------------------------------------- | | `format` | `'via [$symbol($username@)$stack]($style) '` | La cadena de formato para el módulo. | | `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `' '` | Una cadena de formato que se muestra antes de la pila de Pulumi. | +| `symbol` | `' '` | A format string shown before the Pulumi stack. | | `style` | `'bold 5'` | El estilo del módulo. | | `search_upwards` | `true` | Enable discovery of pulumi config files in parent directories. | -| `disabled` | `false` | Deshabilita el módulo `pulumi`. | +| `disabled` | `false` | Disables the `pulumi` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | ---------- | -------------------------------------- | -| version | `v0.12.24` | La versión de `pulumi` | -| stack | `dev` | La pila actual de Pulumi | -| username | `alice` | El usuario actual de Pulumi | +| version | `v0.12.24` | The version of `pulumi` | +| stack | `dev` | The current Pulumi stack | +| username | `alice` | The current Pulumi username | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -3007,7 +3147,7 @@ format = '[$symbol$stack]($style) ' ## PureScript -El módulo `purescript` muestra la versión instalada de [PureScript](https://www.purescript.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: - El directorio actual contiene un archivo `spago.dhall` - El directorio actual contiene un archivo con la extensión `.purs` @@ -3018,18 +3158,18 @@ El módulo `purescript` muestra la versión instalada de [PureScript](https://ww | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | | `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. | | `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'<=> '` | El símbolo usado antes de mostrar la versión de PureScript. | +| `symbol` | `'<=> '` | The symbol used before displaying the version of PureScript. | | `detect_extensions` | `['purs']` | Qué extensiones deberían activar este módulo. | | `detect_files` | `['spago.dhall']` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | | `style` | `'bold white'` | El estilo del módulo. | -| `disabled` | `false` | Desactiva el módulo `purescript`. | +| `disabled` | `false` | Disables the `purescript` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `0.13.5` | La versión de `purescript` | +| version | `0.13.5` | The version of `purescript` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -3046,9 +3186,9 @@ format = 'via [$symbol$version](bold white)' ## Python -El módulo `python` muestra la versión instalada de [Python](https://www.python.org/) y el entorno virtual actual [Python](https://docs.python.org/tutorial/venv.html) si uno está activado. +The `python` module shows the currently installed version of [Python](https://www.python.org/) and the current [Python virtual environment](https://docs.python.org/tutorial/venv.html) if one is activated. -Si `pyenv_version_name` se establece en `true`, mostrará el nombre de la versión de pyenv. De lo contrario, se mostrará el número de versión de `python --version`. +If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: @@ -3068,33 +3208,33 @@ Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes | -------------------- | ------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------- | | `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | El formato del módulo. | | `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'🐍 '` | Una cadena de formato que representa el símbolo de Python | +| `symbol` | `'🐍 '` | A format string representing the symbol of Python | | `style` | `'yellow bold'` | El estilo del módulo. | -| `pyenv_version_name` | `false` | Usar pyenv para obtener la versión de Python | -| `pyenv_prefix` | `pyenv` | Prefijo antes de mostrar la versión de pyenv sólo se utiliza si se utiliza pyenv | -| `python_binary` | `['python', 'python3', 'python2']` | Configura los binarios de python que Starship debería ejecutar al obtener la versión. | +| `pyenv_version_name` | `false` | Use pyenv to get Python version | +| `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. | | `detect_extensions` | `['py']` | Qué extensiones deben activar este módulo | | `detect_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` | Qué nombres de archivo deben activar este módulo | | `detect_folders` | `[]` | Qué carpetas deben activar este módulo | -| `disabled` | `false` | Deshabilita el módulo `python`. | +| `disabled` | `false` | Disables the `python` module. | ::: tip -La variable `python_binary` acepta una cadena o una lista de cadenas. La Starship intentará ejecutar cada binario hasta que obtenga un resultado. Ten en cuenta que sólo puedes cambiar el binario que Starship ejecuta para obtener la versión de Python no los argumentos que se utilizan. +The `python_binary` variable accepts either a string or a list of strings. Starship will try executing each binary until it gets a result. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used. -Los valores por defecto y el orden para `python_binary` fue elegido para identificar primero la versión de Python en un entorno virtualenv/conda (que actualmente añade un `python`, no importa si apunta a `python3` o `python2`). Esto tiene el efecto secundario que si todavía tienes un sistema de Python 2 instalado, puede ser recogido antes de cualquier Python 3 (al menos en las Distros de Linux que siempre enlazan `/usr/bin/python` a Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below. +The default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `/usr/bin/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below. ::: ### Variables -| Variable | Ejemplo | Descripción | -| ------------ | --------------- | -------------------------------------------- | -| version | `'v3.8.1'` | La versión de `python` | -| symbol | `'🐍 '` | Refleja el valor de la opción `symbol` | -| style | `'yellow bold'` | Refleja el valor de la opción `style` | -| pyenv_prefix | `'pyenv '` | Refleja el valor de la opción `pyenv_prefix` | -| virtualenv | `'venv'` | El nombre actual del `virtualenv` | +| Variable | Ejemplo | Descripción | +| ------------ | --------------- | ------------------------------------------ | +| version | `'v3.8.1'` | The version of `python` | +| symbol | `'🐍 '` | Refleja el valor de la opción `symbol` | +| style | `'yellow bold'` | Refleja el valor de la opción `style` | +| pyenv_prefix | `'pyenv '` | Mirrors the value of option `pyenv_prefix` | +| virtualenv | `'venv'` | The current `virtualenv` name | ### Ejemplo @@ -3110,7 +3250,7 @@ pyenv_version_name = true # ~/.config/starship.toml [python] -# Solo usa el binario `python3` para obtener la versión. +# Only use the `python3` binary to get the version. python_binary = 'python3' ``` @@ -3118,7 +3258,7 @@ python_binary = 'python3' # ~/.config/starship.toml [python] -# No se dispara con archivos con extensión py +# Don't trigger for files with the py extension detect_extensions = [] ``` @@ -3126,16 +3266,16 @@ detect_extensions = [] # ~/.config/starship.toml [python] -# Muestra la versión de python desde dentro de un entorno virtual local. +# Display the version of python from inside a local venv. # -# Ten en cuenta que esto solo funcionará cuando el venv esté dentro del proyecto y sólo -# funcionará en el directorio que contiene el directorio venv dir pero ¿tal vez esté bien? +# Note this will only work when the venv is inside the project and it will only +# work in the directory that contains the venv dir but maybe this is ok? python_binary = ['./venv/bin/python', 'python', 'python3', 'python2'] ``` ## R -El módulo `rlang` muestra la versión instalada de [R](https://www.r-project.org/). El módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `rlang` module shows the currently installed version of [R](https://www.r-project.org/). The module will be shown if any of the following conditions are met: - El directorio actual contiene un archivo con la extensión `.R`. - El directorio actual contiene un archivo con la extensión `.Rd`. @@ -3151,18 +3291,18 @@ El módulo `rlang` muestra la versión instalada de [R](https://www.r-project.or | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | | `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. | | `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'📐'` | Una cadena de formato que representa el símbolo de R. | +| `symbol` | `'📐'` | A format string representing the symbol of R. | | `style` | `'blue bold'` | El estilo del módulo. | | `detect_extensions` | `['R', 'Rd', 'Rmd', 'Rproj', 'Rsx']` | Qué extensiones deben activar este módulo | | `detect_files` | `['.Rprofile']` | Qué nombres de archivo deben activar este módulo | | `detect_folders` | `['.Rproj.user']` | Qué carpetas deben activar este módulo | -| `disabled` | `false` | Deshabilita el módulo `r`. | +| `disabled` | `false` | Disables the `r` module. | ### Variables | Variable | Ejemplo | Descripción | | -------- | ------------- | -------------------------------------- | -| version | `v4.0.5` | La versión de `R` | +| version | `v4.0.5` | The version of `R` | | symbol | | Refleja el valor de la opción `symbol` | | style | `'blue bold'` | Refleja el valor de la opción `style` | @@ -3177,7 +3317,7 @@ format = 'with [📐 $version](blue bold) ' ## Raku -El módulo `raku` muestra la versión instalada de [Raku](https://www.raku.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `raku` module shows the currently installed version of [Raku](https://www.raku.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: - El directorio actual contiene un archivo `META6.json` - El directorio actual contiene un `.p6`, `.pm6`, `.raku`, `.rakumod` o `.pod6` @@ -3188,21 +3328,21 @@ El módulo `raku` muestra la versión instalada de [Raku](https://www.raku.org/) | ------------------- | ------------------------------------------------ | --------------------------------------------------------------------------------------- | | `format` | `'via [$symbol($version-$vm_version )]($style)'` | La cadena de formato para el módulo. | | `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'🦋 '` | El símbolo usado antes de mostrar la versión de Raku | +| `symbol` | `'🦋 '` | The symbol used before displaying the version of Raku | | `detect_extensions` | `['p6', 'pm6', 'pod6', 'raku', 'rakumod']` | Qué extensiones deberían activar este módulo. | | `detect_files` | `['META6.json']` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | | `style` | `'bold 149'` | El estilo del módulo. | -| `disabled` | `false` | Deshabilita el módulo `raku`. | +| `disabled` | `false` | Disables the `raku` module. | ### Variables -| Variable | Ejemplo | Descripción | -| ---------- | ------- | ---------------------------------------------------------- | -| version | `v6.d` | La versión de `raku` | -| vm_version | `moar` | La versión de la máquina virtual `raku` está construida en | -| symbol | | Refleja el valor de la opción `symbol` | -| style\* | | Refleja el valor de la opción `style` | +| Variable | Ejemplo | Descripción | +| ---------- | ------- | -------------------------------------- | +| version | `v6.d` | The version of `raku` | +| vm_version | `moar` | The version of VM `raku` is built on | +| symbol | | Refleja el valor de la opción `symbol` | +| style\* | | Refleja el valor de la opción `style` | ### Ejemplo @@ -3215,7 +3355,7 @@ format = 'via [🦪 $version]($style) ' ## Red -Por defecto, el módulo `red` muestra la versión actualmente instalada de [Red](https://www.red-lang.org/). El módulo se mostrará si se cumplen alguna de las siguientes condiciones: +By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met: - El directorio actual contiene un archivo con extensión `.red` o `.Red` @@ -3225,18 +3365,18 @@ Por defecto, el módulo `red` muestra la versión actualmente instalada de [Red] | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | | `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. | | `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'🔺 '` | Una cadena de formato que representa el símbolo de Red. | +| `symbol` | `'🔺 '` | A format string representing the symbol of Red. | | `detect_extensions` | `['red']` | Qué extensiones deberían activar este módulo. | | `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | | `style` | `'red bold'` | El estilo del módulo. | -| `disabled` | `false` | Deshabilita el módulo `red`. | +| `disabled` | `false` | Disables the `red` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `v2.5.1` | La versión de `red` | +| version | `v2.5.1` | The version of `red` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -3253,14 +3393,14 @@ symbol = '🔴 ' ## Ruby -Por defecto, el módulo `ruby` muestra la versión actualmente instalada de [Ruby](https://www.ruby-lang.org/). El módulo se mostrará si se cumplen alguna de las siguientes condiciones: +By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). The module will be shown if any of the following conditions are met: - El directorio actual contiene un archivo `Gemfile` - El directorio actual contiene un archivo `.ruby-version` - El directorio actual contiene un archivo `.rb` - Las variables de entorno `RUBY_VERSION` o `RBENV_VERSION` están configuradas -Starship obtiene la versión actual de Ruby ejecutando `ruby -v`. +Starship gets the current Ruby version by running `ruby -v`. ### Opciones @@ -3268,19 +3408,19 @@ Starship obtiene la versión actual de Ruby ejecutando `ruby -v`. | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | | `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. | | `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'💎 '` | Una cadena de formato que representa el símbolo de Ruby. | +| `symbol` | `'💎 '` | A format string representing the symbol of Ruby. | | `detect_extensions` | `['rb']` | Qué extensiones deberían activar este módulo. | | `detect_files` | `['Gemfile', '.ruby-version']` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | -| `detect_variables` | `['RUBY_VERSION', 'RBENV_VERSION']` | Qué variables de entorno deben activar este módulo. | +| `detect_variables` | `['RUBY_VERSION', 'RBENV_VERSION']` | Which environment variables should trigger this module. | | `style` | `'bold red'` | El estilo del módulo. | -| `disabled` | `false` | Deshabilita el módulo `ruby`. | +| `disabled` | `false` | Disables the `ruby` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `v2.5.1` | La versión de `ruby` | +| version | `v2.5.1` | The version of `ruby` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -3297,7 +3437,7 @@ symbol = '🔺 ' ## Rust -Por defecto, el módulo `rust` muestra la versión instalada de [Rust](https://www.rust-lang.org/). El módulo se mostrará si se cumplen alguna de las siguientes condiciones: +By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). The module will be shown if any of the following conditions are met: - El directorio actual contiene un archivo `Cargo.toml` - El directorio actual contiene un archivo con la extensión `.rs` @@ -3308,20 +3448,20 @@ Por defecto, el módulo `rust` muestra la versión instalada de [Rust](https://w | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | | `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. | | `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'🦀 '` | Una cadena de formato que representa el símbolo de Rust | +| `symbol` | `'🦀 '` | A format string representing the symbol of Rust | | `detect_extensions` | `['rs']` | Qué extensiones deberían activar este módulo. | | `detect_files` | `['Cargo.toml']` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | | `style` | `'bold red'` | El estilo del módulo. | -| `disabled` | `false` | Deshabilita el módulo `rust`. | +| `disabled` | `false` | Disables the `rust` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | ----------------- | -------------------------------------------- | -| version | `v1.43.0-nightly` | La versión de `rustc` | -| numver | `1.51.0` | El componente numérico de la versión `rustc` | -| toolchain | `beta` | La versión de toolchain | +| version | `v1.43.0-nightly` | The version of `rustc` | +| numver | `1.51.0` | The numeric component of the `rustc` version | +| toolchain | `beta` | The toolchain version | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -3338,7 +3478,7 @@ format = 'via [⚙️ $version](red bold)' ## Scala -El módulo `scala` muestra la versión actualmente instalada de [Scala](https://www.scala-lang.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: - El directorio actual contiene un archivo `build.sbt`, `.scalaenv` o `.sbtenv` - El directorio actual contiene un archivo con la extensión `.scala` o `.sbt` @@ -3353,15 +3493,15 @@ El módulo `scala` muestra la versión actualmente instalada de [Scala](https:// | `detect_extensions` | `['sbt', 'scala']` | Qué extensiones deberían activar este módulo. | | `detect_files` | `['.scalaenv', '.sbtenv', 'build.sbt']` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `['.metals']` | Qué carpetas deberían activar estos módulos. | -| `symbol` | `'🆂 '` | Una cadena de formato que representa el símbolo de Scala. | +| `symbol` | `'🆂 '` | A format string representing the symbol of Scala. | | `style` | `'red dimmed'` | El estilo del módulo. | -| `disabled` | `false` | Deshabilita el módulo `scala`. | +| `disabled` | `false` | Disables the `scala` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `2.13.5` | La versión de `scala` | +| version | `2.13.5` | The version of `scala` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -3378,39 +3518,39 @@ symbol = '🌟 ' ## Shell -El módulo `shell` muestra un indicador para el intérprete de comandos actualmente utilizado. +The `shell` module shows an indicator for currently used shell. ::: tip -Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` como `false` en tu archivo de configuración. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### Opciones -| Opción | Predeterminado | Descripción | -| ---------------------- | ------------------------- | ----------------------------------------------------------------------- | -| `bash_indicator` | `'bsh'` | Una cadena de formato usada para representar bash. | -| `fish_indicator` | `'fsh'` | Una cadena de formato usada para representar fish. | -| `zsh_indicator` | `'zsh'` | Una cadena de formato usada para representar zsh. | -| `powershell_indicator` | `'psh'` | Una cadena de formato usada para representar powershell. | -| `ion_indicator` | `'ion'` | Una cadena de formato usada para representar ion. | -| `elvish_indicator` | `'esh'` | Una cadena de formato usada para representar elvish. | -| `tcsh_indicator` | `'tsh'` | A format string used to represent tcsh. | -| `xonsh_indicator` | `'xsh'` | Una cadena de formato usada para representar xonsh. | -| `cmd_indicator` | `'cmd'` | Una cadena de formato usada para representar cmd. | -| `nu_indicator` | `'nu'` | Una cadena de formato usada para representar nu. | -| `unknown_indicator` | `''` | El valor por defecto que se mostrará cuando se desconoce el intérprete. | -| `format` | `'[$indicator]($style) '` | El formato del módulo. | -| `style` | `'white bold'` | El estilo del módulo. | -| `disabled` | `true` | Deshabilita el módulo `shell`. | +| Opción | Predeterminado | Descripción | +| ---------------------- | ------------------------- | ------------------------------------------------------------ | +| `bash_indicator` | `'bsh'` | A format string used to represent bash. | +| `fish_indicator` | `'fsh'` | A format string used to represent fish. | +| `zsh_indicator` | `'zsh'` | A format string used to represent zsh. | +| `powershell_indicator` | `'psh'` | A format string used to represent powershell. | +| `ion_indicator` | `'ion'` | A format string used to represent ion. | +| `elvish_indicator` | `'esh'` | A format string used to represent elvish. | +| `tcsh_indicator` | `'tsh'` | A format string used to represent tcsh. | +| `xonsh_indicator` | `'xsh'` | A format string used to represent xonsh. | +| `cmd_indicator` | `'cmd'` | A format string used to represent cmd. | +| `nu_indicator` | `'nu'` | A format string used to represent nu. | +| `unknown_indicator` | `''` | The default value to be displayed when the shell is unknown. | +| `format` | `'[$indicator]($style) '` | El formato del módulo. | +| `style` | `'white bold'` | El estilo del módulo. | +| `disabled` | `true` | Disables the `shell` module. | ### Variables -| Variable | Predeterminado | Descripción | -| --------- | -------------- | ------------------------------------------------------------------------------------- | -| indicador | | Refleja el valor de `indicator` para el intérprete de comandos actualmente utilizado. | -| style\* | | Refleja el valor de la opción `style`. | +| Variable | Predeterminado | Descripción | +| --------- | -------------- | ---------------------------------------------------------- | +| indicator | | Mirrors the value of `indicator` for currently used shell. | +| style\* | | Mirrors the value of option `style`. | *: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo @@ -3433,20 +3573,20 @@ The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/int ### Opciones -| Opción | Predeterminado | Descripción | -| ----------- | ---------------------------- | ----------------------------------------------------------------- | -| `threshold` | `2` | Mostrar el umbral. | -| `format` | `'[$symbol$shlvl]($style) '` | El formato del módulo. | -| `symbol` | `'↕️ '` | El símbolo utilizado para representar el `SHLVL`. | -| `repetir` | `false` | Hace que el `symbol` se repita con la cantidad actual de `SHLVL`. | -| `style` | `'bold yellow'` | El estilo del módulo. | -| `disabled` | `true` | Deshabilita el módulo `shlvl`. | +| Opción | Predeterminado | Descripción | +| ----------- | ---------------------------- | ------------------------------------------------------------- | +| `threshold` | `2` | Display threshold. | +| `format` | `'[$symbol$shlvl]($style) '` | El formato del módulo. | +| `symbol` | `'↕️ '` | The symbol used to represent the `SHLVL`. | +| `repeat` | `false` | Causes `symbol` to be repeated by the current `SHLVL` amount. | +| `style` | `'bold yellow'` | El estilo del módulo. | +| `disabled` | `true` | Disables the `shlvl` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | ------- | -------------------------------------- | -| shlvl | `3` | El valor actual de `SHLVL` | +| shlvl | `3` | The current value of `SHLVL` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -3465,22 +3605,22 @@ threshold = 3 ## Singularity -El módulo `singularity` muestra la imagen de [singularity](https://sylabs.io/singularity/) actual, si se encuentra dentro de un contenedor y `$SINGULARITY_NAME` está establecido. +The `singularity` module shows the current [Singularity](https://sylabs.io/singularity/) image, if inside a container and `$SINGULARITY_NAME` is set. ### Opciones -| Opción | Predeterminado | Descripción | -| ---------- | -------------------------------- | ------------------------------------------------------------------- | -| `format` | `'[$symbol\[$env\]]($style) '` | El formato del módulo. | -| `symbol` | `''` | Una cadena de formato que se muestra antes del nombre de la imagen. | -| `style` | `'bold dimmed blue'` | El estilo del módulo. | -| `disabled` | `false` | Deshabilita el módulo de `singularity`. | +| Opción | Predeterminado | Descripción | +| ---------- | -------------------------------- | ------------------------------------------------ | +| `format` | `'[$symbol\[$env\]]($style) '` | El formato del módulo. | +| `symbol` | `''` | A format string displayed before the image name. | +| `style` | `'bold dimmed blue'` | El estilo del módulo. | +| `disabled` | `false` | Disables the `singularity` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | ------------ | -------------------------------------- | -| env | `centos.img` | La imagen de Singularity actual | +| env | `centos.img` | The current Singularity image | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -3497,23 +3637,23 @@ format = '[📦 \[$env\]]($style) ' ## Spack -El módulo `spack` muestra el entorno actual [Spack](https://spack.readthedocs.io/en/latest/), si `$SPACK_ENV` está configurado. +The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set. ### Opciones | Opción | Predeterminado | Descripción | | ------------------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `truncation_length` | `1` | El número de directorios a los que se debe truncar la ruta de entorno. `0` significa sin truncamiento. Vea también el módulo [`directory`](#directory). | +| `truncation_length` | `1` | The number of directories the environment path should be truncated to. `0` significa sin truncamiento. Vea también el módulo [`directory`](#directory). | | `symbol` | `'🅢 '` | El símbolo usado antes del nombre del entorno. | | `style` | `'bold blue'` | El estilo del módulo. | | `format` | `'via [$symbol$environment]($style) '` | El formato del módulo. | -| `disabled` | `false` | Deshabilita el módulo `spack`. | +| `disabled` | `false` | Disables the `spack` module. | ### Variables | Variable | Ejemplo | Descripción | | ----------- | ------------ | -------------------------------------- | -| environment | `astronauts` | El entorno de spack actual | +| environment | `astronauts` | The current spack environment | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -3528,50 +3668,50 @@ El módulo `spack` muestra el entorno actual [Spack](https://spack.readthedocs.i format = '[$symbol$environment](dimmed blue) ' ``` -## Estado +## Status -El módulo `status` muestra el código de salida del comando anterior. Si $success_symbol está vacío (por defecto), el módulo solo se mostrará si el código de salida no es `0`. El código de estado se convertirá a un entero con signo de 32 bits. +The `status` module displays the exit code of the previous command. If $success_symbol is empty (default), the module will be shown only if the exit code is not `0`. The status code will cast to a signed 32-bit integer. ::: tip -Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` como `false` en tu archivo de configuración. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### Opciones -| Opción | Predeterminado | Descripción | -| --------------------------- | ---------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | -| `format` | `'[$symbol$status]($style) '` | El formato del módulo | -| `symbol` | `'❌'` | El símbolo mostrado en el error del programa | -| `success_symbol` | `''` | El símbolo mostrado en el éxito del programa | -| `not_executable_symbol` | `'🚫'` | El símbolo mostrado cuando el archivo no es ejecutable | -| `not_found_symbol` | `'🔍'` | El símbolo mostrado cuando no se encuentra el comando | -| `sigint_symbol` | `'🧱'` | El símbolo mostrado en SIGINT (Ctrl + c) | -| `signal_symbol` | `'⚡'` | El símbolo mostrado en cualquier señal | -| `style` | `'bold red'` | El estilo del módulo. | -| `recognize_signal_code` | `true` | Habilita el mapeo de señales desde el código de salida | -| `map_symbol` | `false` | Habilita el mapeo de símbolos desde el código de salida | -| `pipestatus` | `false` | Habilita el reporte de pipstatus | -| `pipestatus_separator` | | | El símbolo usado para separar segmentos de pipestatus (soporta formato) | -| `pipestatus_format` | `'\[$pipestatus\] => [$symbol$common_meaning$signal_name$maybe_int]($style)'` | El formato del módulo cuando el comando es un pipeline | -| `pipestatus_segment_format` | | Cuando se especifica, reemplaza `formato` al formatear segmentos de pipestatus | -| `disabled` | `true` | Deshabilita el módulo `status`. | +| Opción | Predeterminado | Descripción | +| --------------------------- | ---------------------------------------------------------------------------------- | --------------------------------------------------------------------- | +| `format` | `'[$symbol$status]($style) '` | The format of the module | +| `symbol` | `'❌'` | The symbol displayed on program error | +| `success_symbol` | `''` | The symbol displayed on program success | +| `not_executable_symbol` | `'🚫'` | The symbol displayed when file isn't executable | +| `not_found_symbol` | `'🔍'` | The symbol displayed when the command can't be found | +| `sigint_symbol` | `'🧱'` | The symbol displayed on SIGINT (Ctrl + c) | +| `signal_symbol` | `'⚡'` | The symbol displayed on any signal | +| `style` | `'bold red'` | El estilo del módulo. | +| `recognize_signal_code` | `true` | Enable signal mapping from exit code | +| `map_symbol` | `false` | Enable symbols mapping from exit code | +| `pipestatus` | `false` | Enable pipestatus reporting | +| `pipestatus_separator` | | | The symbol used to separate pipestatus segments (supports formatting) | +| `pipestatus_format` | `'\[$pipestatus\] => [$symbol$common_meaning$signal_name$maybe_int]($style)'` | The format of the module when the command is a pipeline | +| `pipestatus_segment_format` | | When specified, replaces `format` when formatting pipestatus segments | +| `disabled` | `true` | Disables the `status` module. | ### Variables -| Variable | Ejemplo | Descripción | -| -------------- | ------- | ------------------------------------------------------------------------------------------------------------------ | -| status | `127` | El código de salida del último comando | -| hex_status | `0x7F` | El código de salida del último comando en hexadecimal | -| int | `127` | El código de salida del último comando | -| common_meaning | `ERROR` | Comprobación del código si no es una señal | -| signal_number | `9` | Número de señal correspondiente al código de salida, sólo si está señalizado | -| signal_name | `KILL` | Nombre de la señal correspondiente al código de salida, sólo si está señalizada | -| maybe_int | `7` | Contiene el número de código de salida cuando no se ha encontrado ningún significado | -| pipestatus | | Renderizado en los códigos de salida de los programas del pipeline, esto sólo está disponible en pipestatus_format | -| symbol | | Refleja el valor de la opción `symbol` | -| style\* | | Refleja el valor de la opción `style` | +| Variable | Ejemplo | Descripción | +| -------------- | ------- | ------------------------------------------------------------------------------------------- | +| status | `127` | The exit code of the last command | +| hex_status | `0x7F` | The exit code of the last command in hex | +| int | `127` | The exit code of the last command | +| common_meaning | `ERROR` | Meaning of the code if not a signal | +| signal_number | `9` | Signal number corresponding to the exit code, only if signalled | +| signal_name | `KILL` | Name of the signal corresponding to the exit code, only if signalled | +| maybe_int | `7` | Contains the exit code number when no meaning has been found | +| pipestatus | | Rendering of in pipeline programs's exit codes, this is only available in pipestatus_format | +| symbol | | Refleja el valor de la opción `symbol` | +| style\* | | Refleja el valor de la opción `style` | *: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo @@ -3591,23 +3731,23 @@ disabled = false ## Sudo -El módulo `sudo` muestra si las credenciales de sudo están actualmente en caché. El módulo solo se mostrará si las credenciales están guardadas en caché. +The `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached. ::: tip -Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` como `false` en tu archivo de configuración. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### Opciones -| Opción | Predeterminado | Descripción | -| --------------- | ------------------------ | -------------------------------------------------------------------------------- | -| `format` | `'[as $symbol]($style)'` | El formato del módulo | -| `symbol` | `'🧙 '` | El símbolo mostrado cuando las credenciales se almacenan en caché | -| `style` | `'bold blue'` | El estilo del módulo. | -| `allow_windows` | `false` | Como Windows no tiene sudo por defecto, el valor por defecto está deshabilitado. | -| `disabled` | `true` | Deshabilita el módulo `sudo`. | +| Opción | Predeterminado | Descripción | +| --------------- | ------------------------ | ------------------------------------------------------- | +| `format` | `'[as $symbol]($style)'` | The format of the module | +| `symbol` | `'🧙 '` | The symbol displayed when credentials are cached | +| `style` | `'bold blue'` | El estilo del módulo. | +| `allow_windows` | `false` | Since windows has no default sudo, default is disabled. | +| `disabled` | `true` | Disables the `sudo` module. | ### Variables @@ -3630,7 +3770,7 @@ disabled = false ``` ```toml -# En Windows +# On windows # $HOME\.starship\config.toml [sudo] @@ -3640,7 +3780,7 @@ disabled = false ## Swift -Por defecto, el módulo `swift` muestra la versión instalada de [Swift](https://swift.org/). El módulo se mostrará si se cumplen alguna de las siguientes condiciones: +By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). The module will be shown if any of the following conditions are met: - El directorio actual contiene un archivo `Package.swift` - El directorio actual contiene un archivo con la extensión `.swift` @@ -3651,18 +3791,18 @@ Por defecto, el módulo `swift` muestra la versión instalada de [Swift](https:/ | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | | `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. | | `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'🐦 '` | Una cadena de formato que representa el símbolo de Swift | +| `symbol` | `'🐦 '` | A format string representing the symbol of Swift | | `detect_extensions` | `['swift']` | Qué extensiones deberían activar este módulo. | | `detect_files` | `['Package.swift']` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | | `style` | `'bold 202'` | El estilo del módulo. | -| `disabled` | `false` | Deshabilita el módulo `swift`. | +| `disabled` | `false` | Disables the `swift` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `v5.2.4` | La versión de `swift` | +| version | `v5.2.4` | The version of `swift` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -3679,11 +3819,11 @@ format = 'via [🏎 $version](red bold)' ## Terraform -El módulo `Terraform` muestra el [espacio de trabajo de Terraform](https://www.terraform.io/docs/language/state/workspaces.html) y la versión seleccionados actualmente. +The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. ::: tip -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). +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). ::: @@ -3698,21 +3838,21 @@ Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | | `format` | `'via [$symbol$workspace]($style) '` | La cadena de formato para el módulo. | | `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'💠'` | Una cadena de formato que se muestra antes del espacio de trabajo terraform. | +| `symbol` | `'💠'` | A format string shown before the terraform workspace. | | `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Qué extensiones deberían activar este módulo. | | `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `['.terraform']` | Qué carpetas deberían activar este módulo. | | `style` | `'bold 105'` | El estilo del módulo. | -| `disabled` | `false` | Deshabilita el módulo `terraform`. | +| `disabled` | `false` | Disables the `terraform` module. | ### Variables -| Variable | Ejemplo | Descripción | -| --------------- | ---------- | ----------------------------------------- | -| version | `v0.12.24` | La versión de `terraform` | -| área de trabajo | `default` | El espacio de trabajo actual de Terraform | -| symbol | | Refleja el valor de la opción `symbol` | -| style\* | | Refleja el valor de la opción `style` | +| Variable | Ejemplo | Descripción | +| --------- | ---------- | -------------------------------------- | +| version | `v0.12.24` | The version of `terraform` | +| workspace | `default` | The current Terraform workspace | +| symbol | | Refleja el valor de la opción `symbol` | +| style\* | | Refleja el valor de la opción `style` | *: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo @@ -3738,33 +3878,33 @@ format = '[🏎💨 $workspace]($style) ' ## Time -El módulo `time` muestra la hora **local** actual. El valor de configuración de `format` es usado por el crate de [`chrono`](https://crates.io/crates/chrono) para controlar cómo se muestra la hora. Echa un vistazo a [los documentos de chrono strftime](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) para ver qué opciones están disponibles. +The `time` module shows the current **local** time. The `format` configuration value is used by the [`chrono`](https://crates.io/crates/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) to see what options are available. ::: tip -Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` como `false` en tu archivo de configuración. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### Opciones -| Opción | Predeterminado | Descripción | -| ----------------- | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `format` | `'at [$time]($style) '` | La cadena de formato para el módulo. | -| `use_12hr` | `false` | Habilita el formato de 12 horas | -| `time_format` | see below | La [cadena de formato de chrono](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) utilizada para dar formato a la hora. | -| `style` | `'bold yellow'` | El estilo para el módulo de time | -| `utc_time_offset` | `'local'` | Establece el desplazamiento UTC a utilizar. Rango de -24 < x < 24. Permite a los flotantes acomodar los desplazamientos de zona horaria de 30/45 minutos. | -| `disabled` | `true` | 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 | +| Opción | Predeterminado | Descripción | +| ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | +| `format` | `'at [$time]($style) '` | La cadena de formato para el módulo. | +| `use_12hr` | `false` | Enables 12 hour formatting | +| `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. | +| `style` | `'bold yellow'` | The style for the module time | +| `utc_time_offset` | `'local'` | Sets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. | +| `disabled` | `true` | Disables the `time` module. | +| `time_range` | `'-'` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | -If `use_12hr` is `true`, then `time_format` defaults to `'%r'`. Otherwise, it defaults to `'%T'`. Configurar manualmente `time_format` sobrescribirá la configuración `use_12hr`. +If `use_12hr` is `true`, then `time_format` defaults to `'%r'`. Otherwise, it defaults to `'%T'`. Manually setting `time_format` will override the `use_12hr` setting. ### Variables | Variable | Ejemplo | Descripción | | --------- | ---------- | ------------------------------------- | -| tiempo | `13:08:10` | La hora actual. | +| time | `13:08:10` | The current time. | | style\* | | Refleja el valor de la opción `style` | *: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo @@ -3784,7 +3924,7 @@ time_range = '10:00:00-14:00:00' ## Username -El módulo `username` muestra el nombre de usuario activo. El módulo se mostrará si se cumplen alguna de las siguientes condiciones: +The `username` module shows active user's username. The module will be shown if any of the following conditions are met: - El usuario actual es root/admin - El usuario actual no es el mismo que el que está conectado @@ -3793,26 +3933,26 @@ El módulo `username` muestra el nombre de usuario activo. El módulo se mostrar ::: 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. +SSH connection is detected by checking environment variables `SSH_CONNECTION`, `SSH_CLIENT`, and `SSH_TTY`. If your SSH host does not set up these variables, one workaround is to set one of them with a dummy value. ::: ### Opciones -| Opción | Predeterminado | Descripción | -| ------------- | ----------------------- | ------------------------------------------------ | -| `style_root` | `'bold red'` | El estilo usado cuando el usuario es root/admin. | -| `style_user` | `'bold yellow'` | El estilo usado para usuarios no root. | -| `format` | `'[$user]($style) in '` | El formato del módulo. | -| `show_always` | `false` | Siempre muestra el módulo `username`. | -| `disabled` | `false` | Deshabilita el módulo `username`. | +| Opción | Predeterminado | Descripción | +| ------------- | ----------------------- | ------------------------------------------- | +| `style_root` | `'bold red'` | The style used when the user is root/admin. | +| `style_user` | `'bold yellow'` | The style used for non-root users. | +| `format` | `'[$user]($style) in '` | El formato del módulo. | +| `show_always` | `false` | Always shows the `username` module. | +| `disabled` | `false` | Disables the `username` module. | ### Variables -| Variable | Ejemplo | Descripción | -| --------- | ------------ | --------------------------------------------------------------------------------------------------- | -| `style` | `'red bold'` | Refleja el valor de la opción `style_root` cuando root inició sesión y `style_user` por otra parte. | -| `usuario` | `'matchai'` | El ID de usuario conectado actualmente. | +| Variable | Ejemplo | Descripción | +| -------- | ------------ | ------------------------------------------------------------------------------------------- | +| `style` | `'red bold'` | Mirrors the value of option `style_root` when root is logged in and `style_user` otherwise. | +| `user` | `'matchai'` | The currently logged-in user ID. | ### Ejemplo @@ -3829,7 +3969,7 @@ show_always = true ## Vagrant -El módulo `vagrant` muestra la versión instalada de [Vagrant](https://www.vagrantup.com/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `vagrant` module shows the currently installed version of [Vagrant](https://www.vagrantup.com/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: - El directorio actual contiene un archivo `Vagrantfile` @@ -3839,18 +3979,18 @@ El módulo `vagrant` muestra la versión instalada de [Vagrant](https://www.vagr | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | | `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. | | `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'⍱ '` | Una cadena de formato que representa el símbolo de Vagrant. | +| `symbol` | `'⍱ '` | A format string representing the symbol of Vagrant. | | `detect_extensions` | `[]` | Qué extensiones deberían activar este módulo. | | `detect_files` | `['Vagrantfile']` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | | `style` | `'cyan bold'` | El estilo del módulo. | -| `disabled` | `false` | Deshabilita el módulo `vagrant`. | +| `disabled` | `false` | Disables the `vagrant` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | ---------------- | -------------------------------------- | -| version | `Vagrant 2.2.10` | La versión de `Vagrant` | +| version | `Vagrant 2.2.10` | The version of `Vagrant` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -3867,7 +4007,7 @@ format = 'via [⍱ $version](bold white) ' ## V -El módulo `vlang` te muestra la versión instalada de [V](https://vlang.io/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `vlang` module shows you your currently installed version of [V](https://vlang.io/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: - El directorio actual contiene un archivo con la extensión `.v` - El directorio actual contiene un archivo `v.mod`, `vpkg.json` o `.vpkg-lock.json` @@ -3878,18 +4018,18 @@ El módulo `vlang` te muestra la versión instalada de [V](https://vlang.io/). P | ------------------- | -------------------------------------------- | --------------------------------------------------------------------------------------- | | `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. | | `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'V '` | Una cadena de formato que representa el símbolo de V | +| `symbol` | `'V '` | A format string representing the symbol of V | | `detect_extensions` | `['v']` | Qué extensiones deberían activar este módulo. | | `detect_files` | `['v.mod', 'vpkg.json', '.vpkg-lock.json' ]` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | | `style` | `'blue bold'` | El estilo del módulo. | -| `disabled` | `false` | Deshabilita el módulo `vlang`. | +| `disabled` | `false` | Disables the `vlang` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | ------- | -------------------------------------- | -| version | `v0.2` | La versión de `v` | +| version | `v0.2` | The version of `v` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -3903,24 +4043,24 @@ format = 'via [V $version](blue bold) ' ## VCSH -El módulo `vcsh` muestra el repositorio activo [VCSH](https://github.com/RichiH/vcsh) actual. El módulo sólo se mostrará si un repositorio está actualmente en uso. +The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. The module will be shown only if a repository is currently in use. ### Opciones -| Opción | Predeterminado | Descripción | -| ---------- | -------------------------------- | ------------------------------------------------------------ | -| `symbol` | `''` | El símbolo usado antes de mostrar el nombre del repositorio. | -| `style` | `'bold yellow'` | El estilo del módulo. | -| `format` | `'vcsh [$symbol$repo]($style) '` | El formato del módulo. | -| `disabled` | `false` | Deshabilita el módulo `vcsh`. | +| Opción | Predeterminado | Descripción | +| ---------- | -------------------------------- | ------------------------------------------------------ | +| `symbol` | `''` | The symbol used before displaying the repository name. | +| `style` | `'bold yellow'` | El estilo del módulo. | +| `format` | `'vcsh [$symbol$repo]($style) '` | El formato del módulo. | +| `disabled` | `false` | Disables the `vcsh` module. | ### Variables -| Variable | Ejemplo | Descripción | -| --------- | ----------------------------------------------------------- | -------------------------------------- | -| repo | `dotfiles` si está en un repositorio VCSH nombrado dotfiles | El nombre del repositorio activo | -| symbol | | Refleja el valor de la opción `symbol` | -| style\* | `black bold dimmed` | Refleja el valor de la opción `style` | +| Variable | Ejemplo | Descripción | +| --------- | ------------------------------------------- | -------------------------------------- | +| repo | `dotfiles` if in a VCSH repo named dotfiles | The active repository name | +| symbol | | Refleja el valor de la opción `symbol` | +| style\* | `black bold dimmed` | Refleja el valor de la opción `style` | *: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo @@ -3935,7 +4075,7 @@ format = '[🆅 $repo](bold blue) ' ## Zig -Por defecto, el módulo `zig` muestra la versión instalada de [Zig](https://ziglang.org/). El módulo se mostrará si se cumplen alguna de las siguientes condiciones: +By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met: - El directorio actual contiene un archivo `.zig` @@ -3945,9 +4085,9 @@ Por defecto, el módulo `zig` muestra la versión instalada de [Zig](https://zig | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | | `format` | `'via [$symbol($version )]($style)'` | El formato del módulo. | | `version_format` | `'v${raw}'` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'↯ '` | El símbolo usado antes de mostrar la versión de Zig. | +| `symbol` | `'↯ '` | The symbol used before displaying the version of Zig. | | `style` | `'bold yellow'` | El estilo del módulo. | -| `disabled` | `false` | Deshabilita el módulo `zig`. | +| `disabled` | `false` | Disables the `zig` module. | | `detect_extensions` | `['zig']` | Qué extensiones deberían activar este módulo. | | `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | @@ -3956,7 +4096,7 @@ Por defecto, el módulo `zig` muestra la versión instalada de [Zig](https://zig | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `v0.6.0` | La versión de `zig` | +| version | `v0.6.0` | The version of `zig` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -3971,11 +4111,11 @@ Por defecto, el módulo `zig` muestra la versión instalada de [Zig](https://zig symbol = '⚡️ ' ``` -## Comandos personalizados +## Custom commands -Los módulos `personalizados` muestran la salida de algunos comandos arbitrarios. +The `custom` modules show the output of some arbitrary commands. -Estos módulos se mostrarán si se cumple alguna de las siguientes condiciones: +These modules will be shown if any of the following conditions are met: - El directorio actual contiene un archivo cuyo nombre está en `detect_files` - El directorio actual contiene un directorio cuyo nombre está en `detect_folders` @@ -3985,85 +4125,85 @@ Estos módulos se mostrarán si se cumple alguna de las siguientes condiciones: ::: tip -Múltiples módulos personalizados pueden definirse usando un `.` (un punto). +Multiple custom modules can be defined by using a `.`. ::: ::: tip -El orden en el que se muestran los módulos personalizados se puede establecer individualmente incluyendo `${custom.foo}` en el `format` de nivel superior (ya que incluye un punto, necesita usar `${...}`). Por defecto, el módulo `personalizado` simplemente mostrará todos los módulos personalizados en el orden en que fueron definidos. +The order in which custom modules are shown can be individually set by including `${custom.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `custom` module will simply show all custom modules in the order they were defined. ::: ::: tip -[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í! +[Issue #1252](https://github.com/starship/starship/discussions/1252) contains examples of custom modules. If you have an interesting example not covered there, feel free to share it there! ::: -::: warning la salida de comandos se imprime sin escapar al prompt +::: warning Command output is printed unescaped to the prompt -Cualquiera que sea la salida que genere el comando se imprime sin modificar en el prompt. Esto significa que si la salida contiene secuencias especiales que son interpretadas por el intérprete, se expandirán cuando se muestre. Estas secuencias especiales son específicas del intérprete, por ejemplo, puedes escribir un módulo de comando que escribe secuencias de bash, por ejemplo, `\h`, pero este módulo no funcionará en el intérprete fish o zsh. +Whatever output the command generates is printed unmodified in the prompt. This means if the output contains special sequences that are interpreted by your shell they will be expanded when displayed. These special sequences are shell specific, e.g. you can write a command module that writes bash sequences, e.g. `\h`, but this module will not work in a fish or zsh shell. -Las cadenas de formato también pueden contener secuencias específicas del intérprete, por ejemplo, [Bash](https://www.gnu.org/software/bash/manual/html_node/Controlling-the-Prompt.html), [Zsh](https://zsh.sourceforge.io/Doc/Release/Prompt-Expansion.html). +Format strings can also contain shell specific prompt sequences, e.g. [Bash](https://www.gnu.org/software/bash/manual/html_node/Controlling-the-Prompt.html), [Zsh](https://zsh.sourceforge.io/Doc/Release/Prompt-Expansion.html). ::: ### Opciones -| Opción | Predeterminado | Descripción | -| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `comando` | `''` | El comando cuya salida debe ser impresa. El comando se pasará en stdin al intérprete de comandos. | -| `cuando` | `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 a continuación](#custom-command-shell) | -| `description` | `''` | La descripción del módulo que se muestra al ejecutar `starship explain`. | -| `detect_files` | `[]` | Los archivos que se buscarán en el directorio de trabajo para obtener una coincidencia. | -| `detect_folders` | `[]` | Los directorios que se buscarán en el directorio de trabajo para una coincidencia. | -| `detect_extensions` | `[]` | Las extensiones que se buscarán en el directorio de trabajo para obtener una coincidencia. | -| `symbol` | `''` | El símbolo usado antes de mostrar la salida del comando. | -| `style` | `'bold green'` | El estilo del módulo. | -| `format` | `'[$symbol($output )]($style)'` | El formato del módulo. | -| `disabled` | `false` | Deshabilita este módulo `custom`. | -| `os` | | Nombre del sistema operativo en el que se mostrará el módulo (unix, linux, macos, windows, ... ) [Ver valores posibles](https://doc.rust-lang.org/std/env/consts/constant.OS.html). | -| `use_stdin` | | Un valor booleano opcional que anula si los comandos deben ser reenviados al shell a través de la entrada estándar o como argumento. Si la entrada estándar unset es usada de manera predeterminada, a menos que el shell no lo soporte (cmd, nushell). Configurar esto desactiva el manejo de argumentos específicos del shell. | -| `ignore_timeout` | `false` | Ignorar la configuración global de `command_timeout` y seguir ejecutando comandos externos, sin importar el tiempo que tarden. | +| Opción | Predeterminado | Descripción | +| ------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `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. | +| `shell` | | [See below](#custom-command-shell) | +| `description` | `''` | The description of the module that is shown when running `starship explain`. | +| `detect_files` | `[]` | The files that will be searched in the working directory for a match. | +| `detect_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. | +| `symbol` | `''` | The symbol used before displaying the command output. | +| `style` | `'bold green'` | El estilo del módulo. | +| `format` | `'[$symbol($output )]($style)'` | El formato del módulo. | +| `disabled` | `false` | Disables this `custom` module. | +| `os` | | Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) [See possible values](https://doc.rust-lang.org/std/env/consts/constant.OS.html). | +| `use_stdin` | | An optional boolean value that overrides whether commands should be forwarded to the shell via the standard input or as an argument. If unset standard input is used by default, unless the shell does not support it (cmd, nushell). Setting this disables shell-specific argument handling. | +| `ignore_timeout` | `false` | Ignore global `command_timeout` setting and keep running external commands, no matter how long they take. | ### Variables -| Variable | Descripción | -| --------- | ----------------------------------------------------------- | -| salida | La salida del comando del intérprete de comandos en `shell` | -| symbol | Refleja el valor de la opción `symbol` | -| style\* | Refleja el valor de la opción `style` | +| Variable | Descripción | +| --------- | -------------------------------------- | +| output | The output of shell command in `shell` | +| symbol | Refleja el valor de la opción `symbol` | +| style\* | Refleja el valor de la opción `style` | *: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo #### Comando personalizado del intérprete de comandos -`shell` acepta una lista no vacía de cadenas, donde: +`shell` accepts a non-empty list of strings, where: - La primera cadena es la ruta al intérprete de comandos a usar para ejecutar el comando. - Otros argumentos siguientes son pasados al intérprete de comandos. If unset, it will fallback to STARSHIP_SHELL and then to 'sh' on Linux, and 'cmd /C' on Windows. -El `comando` será pasado en stdin. +The `command` will be passed in on stdin. -Si no se da el `shell` o solo contiene un elemento y Starship detecta PowerShell los siguientes argumentos se añadirán automáticamente: `-NoProfile -Command -`. If `shell` is not given or only contains one element and Starship detects Cmd will be used, the following argument will automatically be added: `/C` and `stdin` will be set to `false`. If `shell` is not given or only contains one element and Starship detects Nushell will be used, the following arguments will automatically be added: `-c` and `stdin` will be set to `false`. Este comportamiento puede evitarse pasando explícitamente argumentos al intérprete de comandos, p.ej. +If `shell` is not given or only contains one element and Starship detects PowerShell will be used, the following arguments will automatically be added: `-NoProfile -Command -`. If `shell` is not given or only contains one element and Starship detects Cmd will be used, the following argument will automatically be added: `/C` and `stdin` will be set to `false`. If `shell` is not given or only contains one element and Starship detects Nushell will be used, the following arguments will automatically be added: `-c` and `stdin` will be set to `false`. This behavior can be avoided by explicitly passing arguments to the shell, e.g. ```toml shell = ['pwsh', '-Command', '-'] ``` -::: warning Asegúrate de que tu configuración personalizada de shell salga con éxito +::: warning Make sure your custom shell configuration exits gracefully -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`). +If you set a custom command, make sure that the default Shell used by starship will properly execute the command with a graceful exit (via the `shell` option). -Por ejemplo, PowerShell requiere el parámetro `-Command` para ejecutar una sola línea. Omitir este parámetro puede arrojar a 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. +For example, PowerShell requires the `-Command` parameter to execute a one liner. Omitting this parameter might throw starship into a recursive loop where the shell might try to load a full profile environment with starship itself again and hence re-execute the custom command, getting into a never ending loop. -Se recomiendan parámetros similares a `-NoProfile` en PowerShell para otros intérprete de comandos también para evitar tiempo extra de carga de un perfil personalizado en cada invocación de Starship. +Parameters similar to `-NoProfile` in PowerShell are recommended for other shells as well to avoid extra loading time of a custom profile on every starship invocation. -La detección automática de 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. +Automatic detection of shells and proper parameters addition are currently implemented, but it's possible that not all shells are covered. [Please open an issue](https://github.com/starship/starship/issues/new/choose) with shell details and starship configuration if you hit such scenario. ::: diff --git a/docs/es-ES/guide/README.md b/docs/es-ES/guide/README.md index d620b873..45e455e7 100644 --- a/docs/es-ES/guide/README.md +++ b/docs/es-ES/guide/README.md @@ -9,7 +9,7 @@

Estado del flujo de trabajo de GitHub Actions @@ -423,6 +423,7 @@ Apoya este proyecto [convirtiéndote en patrocinador](https://github.com/sponsor **Patrocinadores** - [Dimension](https://dimension.dev/) +- [Appwrite](https://appwrite.io/)


diff --git a/docs/es-ES/presets/README.md b/docs/es-ES/presets/README.md index 062405d7..ad7a0c0c 100644 --- a/docs/es-ES/presets/README.md +++ b/docs/es-ES/presets/README.md @@ -14,7 +14,11 @@ Este preajuste cambia los símbolos de cada módulo para usar símbolos Nerd Fon This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt. -::: tip This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). ::: +::: tip + +This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). + +::: [Click to view No Nerd Font preset](./no-nerd-font) @@ -52,7 +56,7 @@ Esta preajuste emula la apariencia y el comportamiento de [Pure](https://github. Este preajuste está inspirado en [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). También muestra cómo funciona la sustitución de rutas en Starship. -[![Captura de pantalla del preajuste Pastel Powerline](/presets/img/pastel-powerline.png "Haga clic para ver el preajuste del Prompt de Pure")](./pastel-powerline) +[![Captura de pantalla del preajuste de Pastel Powerline](/presets/img/pastel-powerline.png "Haga clic para ver el preajuste del Prompt de Pure")](./pastel-powerline) ## [Tokyo Night](./tokyo-night.md) diff --git a/docs/fr-FR/README.md b/docs/fr-FR/README.md index d3c684fb..6e641db1 100644 --- a/docs/fr-FR/README.md +++ b/docs/fr-FR/README.md @@ -149,14 +149,14 @@ description: Starship est une invite minimaliste, ultra-rapide et hautement pers ::: warning - Ceci va changer dans le futur. Seul Nushell v0.61+ est supporté. + Ceci va changer dans le futur. Seul Nushell v0.73+ est supporté. ::: - Add the following to to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell): + Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell): ```sh mkdir ~/.cache/starship - starship init nu | save ~/.cache/starship/init.nu + starship init nu | save -f ~/.cache/starship/init.nu ``` Ajoutez le code suivant à la fin de votre configuration Nushell (trouvez-la en exécutant `$nu.config path`): diff --git a/docs/fr-FR/advanced-config/README.md b/docs/fr-FR/advanced-config/README.md index 2fcf7908..526a78a3 100644 --- a/docs/fr-FR/advanced-config/README.md +++ b/docs/fr-FR/advanced-config/README.md @@ -207,8 +207,6 @@ Note: l’invite à droite est une seule ligne, sur la même ligne que l’entr `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell. -Note: Nushell 0.71.0 or later is required - ### Exemple ```toml @@ -231,7 +229,7 @@ Génère l’invite suivante: Certains shells gèrent une invite de continuation en plus de l’invite normale. Cette invite est affichée à la place de l’invite normale quand l’utilisateur a entré une expression incomplète (par exemple, une parenthèse gauche ou une apostrophe seule). -Starship peut définir l’invite de continuation en utilisant l’option `continuation_prompt`. L’invite par défaut est `"[∙](bright-black) "`. +Starship peut définir l’invite de continuation en utilisant l’option `continuation_prompt`. The default prompt is `'[∙](bright-black) '`. Note: la valeur de `continuation_prompt` doit être une chaine littérale, sans variable. @@ -247,7 +245,7 @@ Note: les invites de confirmation sont uniquement disponibles pour les shells su # ~/.config/starship.toml # Un invite de continuation qui affiche deux flèches pleines -continuation_prompt = "▶▶" +continuation_prompt = '▶▶ ' ``` ## Chaînes de style diff --git a/docs/fr-FR/config/README.md b/docs/fr-FR/config/README.md index ca9c1579..c293080c 100644 --- a/docs/fr-FR/config/README.md +++ b/docs/fr-FR/config/README.md @@ -252,12 +252,14 @@ $singularity\ $kubernetes\ $directory\ $vcsh\ +$fossil_branch\ $git_branch\ $git_commit\ $git_state\ $git_metrics\ $git_status\ $hg_branch\ +$pijul_channel\ $docker_context\ $package\ $c\ @@ -270,6 +272,7 @@ $dotnet\ $elixir\ $elm\ $erlang\ +$fennel\ $golang\ $guix_shell\ $haskell\ @@ -278,6 +281,7 @@ $helm\ $java\ $julia\ $kotlin\ +$gradle\ $lua\ $nim\ $nodejs\ @@ -1305,6 +1309,12 @@ Le module `env_var` affiche la valeur actuelle de la variable d’environnement ::: tip +The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. + +::: + +::: 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 @@ -1320,13 +1330,14 @@ default = 'unknown user' ### Options -| Option | Défaut | Description | -| ---------- | ------------------------------ | ----------------------------------------------------------------------------------- | -| `symbole` | `''` | Le symbole utilisé avant d'afficher la valeur de la variable. | -| `variable` | | La variable d'environnement à afficher. | -| `default` | | La valeur par défaut à afficher lorsque la variable sélectionnée n'est pas définie. | -| `format` | `'with [$env_value]($style) '` | Format du module. | -| `disabled` | `false` | Désactive le module `env_var`. | +| Option | Défaut | Description | +| ------------- | ------------------------------ | ----------------------------------------------------------------------------------- | +| `symbole` | `""` | Le symbole utilisé avant d'afficher la valeur de la variable. | +| `variable` | | La variable d'environnement à afficher. | +| `default` | | La valeur par défaut à afficher lorsque la variable sélectionnée n'est pas définie. | +| `format` | `"with [$env_value]($style) "` | Format du module. | +| `description` | `""` | The description of the module that is shown when running `starship explain`. | +| `disabled` | `false` | Désactive le module `env_var`. | ### Variables @@ -1399,6 +1410,44 @@ Le module `erlang` affiche la version de [Erlang/OTP](https://erlang.org/doc/) i format = 'via [e $version](bold red) ' ``` +## Fennel + +The `fennel` module shows the currently installed version of [Fennel](https://fennel-lang.org). Par défaut, le module sera affiché si l’une de ces conditions est remplie: + +- The current directory contains a file with the `.fnl` extension + +### Options + +| Option | Défaut | Description | +| ------------------------------------ | ------------------------------------ | ------------------------------------------------------------------------------------------ | +| `format` | `'via [$symbol($version )]($style)'` | Format du module. | +| `version_format` | `'v${raw}'` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | +| `symbole` | `'🧅 '` | The symbol used before displaying the version of fennel. | +| `style` | `'bold green'` | Le style pour le module. | +| `detect_extensionsdetect_extensions` | `[fnl]` | Les extensions qui déclenchent ce module. | +| `detect_files` | `[]` | Les fichiers qui activent ce module. | +| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. | +| `disabled` | `false` | Disables the `fennel` module. | + +### Variables + +| Variable | Exemple | Description | +| --------- | -------- | -------------------------------------- | +| version | `v1.2.1` | The version of `fennel` | +| symbole | | Reflète la valeur de l'option `symbol` | +| style\* | | Reflète la valeur de l'option `style` | + +*: Cette variable peut uniquement être utilisée dans une chaine de style + +### Exemple + +```toml +# ~/.config/starship.toml + +[fennel] +symbol = '⫰ ' +``` + ## Remplissage Le module `fill` remplit l’espace restant sur la ligne avec un symbole. Si plusieurs modules `fill` sont présents sur une ligne, ils divisent de manière égale l’espace entre eux. C’est utile pour aligner d’autres modules. @@ -1428,32 +1477,68 @@ Produit une invite qui ressemble à : AA -------------------------------------------- BB -------------------------------------------- CC ``` -## Google Cloud (`gcloud`) +## Fossil Branch -Le module `gcloud` affiche la version de la commande [`gcloud`](https://cloud.google.com/sdk/gcloud) installée. Ceci est basé sur les fichiers `~/.config/gcloud/active_config` et `~/.config/gcloud/configurations/config_{CONFIG NAME}` et la variable d'environnement `CLOUDSDK_CONFIG`. +The `fossil_branch` module shows the name of the active branch of the check-out in your current directory. ### Options -| Option | Défaut | Description | -| ----------------- | ---------------------------------------------------------- | ----------------------------------------------------------- | -| `format` | `'on [$symbol$account(@$domain)(\($region\))]($style) '` | Format du module. | -| `symbole` | `'☁️ '` | Le symbole affiché avant le profil GCP actuel. | -| `region_aliases` | `{}` | Table des alias de région à afficher en plus du nom du GCP. | -| `project_aliases` | `{}` | Table des alias de projet à afficher en plus du nom du GCP. | -| `style` | `'bold blue'` | Le style pour le module. | -| `disabled` | `false` | Désactive le module `gcloud`. | +| Option | Défaut | Description | +| ------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | +| `format` | `'on [$symbol$branch]($style) '` | Format du module. Use `'$branch'` to refer to the current branch name. | +| `symbole` | `' '` | The symbol used before the branch name of the check-out in your current directory. | +| `style` | `'bold purple'` | Le style pour le module. | +| `truncation_length` | `2^63 - 1` | Truncates a Fossil branch name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. | +| `disabled` | `true` | Disables the `fossil_branch` module. | ### Variables -| Variable | Exemple | Description | -| --------- | ------------- | ----------------------------------------------------------------------------- | -| region | `us-central1` | La région GCP actuelle | -| account | `foo` | Le profil GCP actuel | -| domain | `exemple.com` | Le domaine du profil GCP actuel | -| project | | Le projet GCP actuel | -| active | `default` | Le nom de la configuration active écrit dans `~/.config/gcloud/active_config` | -| symbole | | Reflète la valeur de l'option `symbol` | -| style\* | | Reflète la valeur de l'option `style` | +| Variable | Exemple | Description | +| --------- | ------- | -------------------------------------- | +| branch | `trunk` | The active Fossil branch | +| symbole | | Reflète la valeur de l'option `symbol` | +| style\* | | Reflète la valeur de l'option `style` | + +*: Cette variable peut uniquement être utilisée dans une chaine de style + +### Exemple + +```toml +# ~/.config/starship.toml + +[fossil_branch] +symbol = '🦎 ' +truncation_length = 4 +truncation_symbol = '' +``` + +## Google Cloud (`gcloud`) + +The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var. + +### Options + +| Option | Défaut | Description | +| ----------------- | ---------------------------------------------------------- | ---------------------------------------------------------------- | +| `format` | `'on [$symbol$account(@$domain)(\($region\))]($style) '` | Format du module. | +| `symbole` | `'☁️ '` | The symbol used before displaying the current GCP profile. | +| `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. | +| `style` | `'bold blue'` | Le style pour le module. | +| `disabled` | `false` | Disables the `gcloud` module. | + +### Variables + +| Variable | Exemple | Description | +| --------- | ------------- | ------------------------------------------------------------------ | +| region | `us-central1` | The current GCP region | +| account | `foo` | The current GCP profile | +| domain | `example.com` | The current GCP profile domain | +| project | | The current GCP project | +| active | `default` | The active config name written in `~/.config/gcloud/active_config` | +| symbole | | 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 @@ -1501,33 +1586,33 @@ format = 'on [$symbol$account(@$domain)(\($project\))]($style) ' very-long-project-name = 'vlpn' ``` -## Branche Git +## Git Branch -Le module `git_branch` affiche la branche active du dépôt dans le dossier courant. +The `git_branch` module shows the active branch of the repo in your current directory. ### Options -| 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. | -| `format` | `'on [$symbol$branch(:$remote_branch)]($style) '` | Format du module. Use `'$branch'` to refer to the current branch name. | -| `symbole` | `' '` | Une chaîne de format représentant le symbole de la branche git. | -| `style` | `'bold purple'` | Le style pour le module. | -| `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é. You can use `''` for no symbol. | -| `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. Useful for 'master' or 'main'. | -| `disabled` | `false` | Désactive le module `git_branch`. | +| Option | Défaut | Description | +| -------------------- | ------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | +| `format` | `'on [$symbol$branch(:$remote_branch)]($style) '` | Format du module. Use `'$branch'` to refer to the current branch name. | +| `symbole` | `' '` | A format string representing the symbol of git branch. | +| `style` | `'bold purple'` | Le style pour le module. | +| `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. | +| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | +| `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. | +| `disabled` | `false` | Disables the `git_branch` module. | ### Variables -| Variable | Exemple | Description | -| ------------- | -------- | -------------------------------------------------------------------------------------------------------------------- | -| branch | `master` | Le nom de la branche actuelle, par défaut à `HEAD` s'il n'y a pas de branche actuelle (par exemple `HEAD` détachée). | -| remote_name | `origin` | Le nom du dépôt distant. | -| remote_branch | `master` | Le nom de la branche suivie sur `remote_name`. | -| symbole | | Reflète la valeur de l'option `symbol` | -| style\* | | Reflète la valeur de l'option `style` | +| Variable | Exemple | Description | +| ------------- | -------- | ------------------------------------------------------------------------------------------------------ | +| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached `HEAD`). | +| remote_name | `origin` | The remote name. | +| remote_branch | `master` | The name of the branch tracked on `remote_name`. | +| symbole | | 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 @@ -1545,27 +1630,28 @@ ignore_branches = ['master', 'main'] ## Commit Git -Le module `git_commit` affiche le hash du commit courant et l’étiquette (s’il y en a) du dépôt dans le dossier courant. +The `git_commit` module shows the current commit hash and also the tag (if any) of the repo in your current directory. ### Options | Option | Défaut | Description | | -------------------- | ------------------------------ | ------------------------------------------------------------------------------------ | -| `commit_hash_length` | `7` | La longueur du hash affiché du commit git. | +| `commit_hash_length` | `7` | The length of the displayed git commit hash. | | `format` | `'[\($hash$tag\)]($style) '` | Format du module. | | `style` | `'bold green'` | Le style pour le module. | -| `only_detached` | `true` | Ne montrer le hash du commit qu'en mode `HEAD` détachée. | -| `tag_disabled` | `true` | Désactive l'affichage des informations du tag dans le module `git_commit`. | +| `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_max_candidates` | `0` | How many commits to consider for tag display. The default only allows exact matches. | -| `tag_symbol` | `' 🏷 '` | Symbole préfixant les informations affichées concernant le tag | -| `disabled` | `false` | Désactive le module `git_commit`. | +| `tag_symbol` | `' 🏷 '` | Tag symbol prefixing the info shown | +| `disabled` | `false` | Disables the `git_commit` module. | ### Variables -| Variable | Exemple | Description | -| --------- | --------- | ------------------------------------- | -| hash | `b703eb3` | Le hash du commit git actuel | -| style\* | | Reflète la valeur de l'option `style` | +| Variable | Exemple | Description | +| --------- | --------- | -------------------------------------------- | +| hash | `b703eb3` | The current git commit hash | +| tag | `v1.0.0` | The tag name if showing tag info is enabled. | +| style\* | | Reflète la valeur de l'option `style` | *: Cette variable peut uniquement être utilisée dans une chaine de style @@ -1579,32 +1665,32 @@ commit_hash_length = 4 tag_symbol = '🔖 ' ``` -## État Git +## Git State -Le module `git_state` s'affichera dans les répertoires qui font partie d'un dépôt git, dans lesquels une opération est en cours, comme : _REBASING_, _BISECTING_, etc. S'il y a des informations de progression (par exemple, REBASING 3/10), ces informations seront également affichées. +The `git_state` module will show in directories which are part of a git repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. If there is progress information (e.g., REBASING 3/10), that information will be shown too. ### Options -| Option | Défaut | Description | -| -------------- | --------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------- | -| `rebase` | `'REBASING'` | Une chaîne de format affichée lorsqu'un `rebase` est en cours. | -| `merge` | `'MERGING'` | Une chaîne de format affichée quand un `merge` est en cours. | -| `revert` | `'REVERTING'` | Une chaîne de format affichée quand un `revert` est en cours. | -| `cherry_pick` | `'CHERRY-PICKING'` | Une chaîne de format affichée quand un `cherry-pick` est en cours. | -| `bisect` | `'BISECTING'` | Une chaîne de format affichée quand un `bisect` est en cours. | -| `am` | `'AM'` | Une chaîne de format affichée lorsqu'un `apply-mailbox` (`git am`) est en cours. | -| `am_or_rebase` | `'AM/REBASE'` | Une chaîne de format affichée lorsqu'une `apply-mailbox` ou un `rebase` est en cours sans pouvoir les différencier. | -| `style` | `'bold yellow'` | Le style pour le module. | -| `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | Format du module. | -| `disabled` | `false` | Désactive le module `git_state`. | +| Option | Défaut | Description | +| -------------- | --------------------------------------------------------------- | --------------------------------------------------------------------------------------- | +| `rebase` | `'REBASING'` | A format string displayed when a `rebase` is in progress. | +| `merge` | `'MERGING'` | A format string displayed when a `merge` is in progress. | +| `revert` | `'REVERTING'` | A format string displayed when a `revert` is in progress. | +| `cherry_pick` | `'CHERRY-PICKING'` | A format string displayed when a `cherry-pick` is in progress. | +| `bisect` | `'BISECTING'` | A format string displayed when a `bisect` is in progress. | +| `am` | `'AM'` | A format string displayed when an `apply-mailbox` (`git am`) is in progress. | +| `am_or_rebase` | `'AM/REBASE'` | A format string displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. | +| `style` | `'bold yellow'` | Le style pour le module. | +| `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | Format du module. | +| `disabled` | `false` | Disables the `git_state` module. | ### Variables | Variable | Exemple | Description | | ---------------- | ---------- | ------------------------------------- | -| state | `REBASING` | L'état actuel du dépôt | -| progress_current | `1` | Progression de l'opération en cours | -| progress_total | `2` | Progression maximale de l'opération | +| state | `REBASING` | The current state of the repo | +| progress_current | `1` | The current operation progress | +| progress_total | `2` | The total operation progress | | style\* | | Reflète la valeur de l'option `style` | *: Cette variable peut uniquement être utilisée dans une chaine de style @@ -1619,34 +1705,34 @@ format = '[\($state( $progress_current of $progress_total)\)]($style) ' cherry_pick = '[🍒 PICKING](bold red)' ``` -## Métriques Git +## Git Metrics -Le module `git_metrics` affiche le nombre de lignes ajoutées et supprimées dans le dépôt Git courant. +The `git_metrics` module will show the number of added and deleted lines in the current git repository. ::: tip -Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### Options -| Option | Défaut | Description | -| -------------------- | ------------------------------------------------------------ | ----------------------------------------------------- | -| `added_style` | `'bold green'` | Le style pour le compte des ajouts. | -| `deleted_style` | `'bold red'` | Le style pour le compte des suppressions. | -| `only_nonzero_diffs` | `true` | Afficher le statut seulement pour les items modifiés. | -| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | Format du module. | -| `disabled` | `true` | Désactive le module `git_metrics`. | +| Option | Défaut | Description | +| -------------------- | ------------------------------------------------------------ | ------------------------------------- | +| `added_style` | `'bold green'` | The style for the added count. | +| `deleted_style` | `'bold red'` | The style for the deleted count. | +| `only_nonzero_diffs` | `true` | Render status only for changed items. | +| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | Format du module. | +| `disabled` | `true` | Disables the `git_metrics` module. | ### Variables -| Variable | Exemple | Description | -| ----------------- | ------- | --------------------------------------------- | -| added | `1` | Le nombre de lignes ajoutées | -| deleted | `2` | Le nombre de lignes supprimées | -| added_style\* | | Possède la valeur de l’option `added_style` | -| deleted_style\* | | Possède la valeur de l’option `deleted_style` | +| Variable | Exemple | Description | +| ----------------- | ------- | ------------------------------------------- | +| added | `1` | The current number of added lines | +| deleted | `2` | The current number of deleted lines | +| added_style\* | | Mirrors the value of option `added_style` | +| deleted_style\* | | Mirrors the value of option `deleted_style` | *: Cette variable peut uniquement être utilisée dans une chaine de style @@ -1662,66 +1748,66 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) ' ## Statut Git -Le module `git_status` affiche des symboles représentant l’état du dépôt dans le dossier courant. +The `git_status` module shows symbols representing the state of the repo in your current directory. ::: tip -Le module Statut Git est très lent dans les dossiers Windows (par exemple sous `/mnt/c/`) dans un environnement WSL. Vous pouvez désactiver le module ou utiliser l’option `windows_starship` pour utiliser un exécutable Starship natif pour calculer le `git_status` pour ces chemins. +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. ::: ### Options -| Option | Défaut | Description | -| ------------------- | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | -| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | Le format par défaut du module `git_status` | -| `conflicted` | `'='` | Cette branche a des conflits de fusion. | -| `ahead` | `'⇡'` | Le format de `ahead` | -| `behind` | `'⇣'` | Le format de `behind` | -| `diverged` | `'⇕'` | Le format de `diverged` | -| `up_to_date` | `''` | The format de `up_to_date` | -| `untracked` | `'?'` | Le format de `untracked` | -| `stashed` | `'$'` | Le format de `stashed` | -| `modified` | `'!'` | Le format de `modified` | -| `staged` | `'+'` | Le format de `staged` | -| `renamed` | `'»'` | Le format de `renamed` | -| `deleted` | `'✘'` | Le format de `deleted` | -| `style` | `'bold red'` | Le style pour le module. | -| `ignore_submodules` | `false` | Ignorer les changements des sous-modules. | -| `disabled` | `false` | Désactive le module `git_status`. | -| `windows_starship` | | Utiliser ce chemin (Linux) vers un exécutable Starship Windows pour afficher le `git_status` pour les chemins Windows dans WSL. | +| Option | Défaut | Description | +| ------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | +| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | The default format for `git_status` | +| `conflicted` | `'='` | This branch has merge conflicts. | +| `ahead` | `'⇡'` | The format of `ahead` | +| `behind` | `'⇣'` | The format of `behind` | +| `diverged` | `'⇕'` | The format of `diverged` | +| `up_to_date` | `''` | The format of `up_to_date` | +| `untracked` | `'?'` | The format of `untracked` | +| `stashed` | `'$'` | The format of `stashed` | +| `modified` | `'!'` | The format of `modified` | +| `staged` | `'+'` | The format of `staged` | +| `renamed` | `'»'` | The format of `renamed` | +| `deleted` | `'✘'` | The format of `deleted` | +| `style` | `'bold red'` | Le style pour le module. | +| `ignore_submodules` | `false` | Ignore changes to submodules. | +| `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. | ### Variables -Les variables suivantes peuvent être utilisées pour la valeur de `format`: +The following variables can be used in `format`: -| Variable | Description | -| -------------- | --------------------------------------------------------------------------------------------------------------------- | -| `all_status` | Raccourci pour `$conflicted$stashed$deleted$renamed$modified$staged$untracked` | -| `ahead_behind` | Affiche la chaine de formatage `diverged`, `ahead`, `behind` ou `up_to_date` en se basant sur l’état actuel du dépôt. | -| `conflicted` | Affiche `conflicted` lorsque la branche courante a des conflits de fusion. | -| `untracked` | Affiche `untracked` lorsqu'il y a des fichiers non suivis dans le répertoire de travail. | -| `stashed` | Affiche `stashed` lorsqu'une remise existe pour le dépôt local. | -| `modified` | Affiche `modified` lorsqu'il y a des fichiers modifiés dans le répertoire de travail. | -| `staged` | Affiche `staged` lorsqu'un nouveau fichier a été ajouté à la zone de validation. | -| `renamed` | Affiche `renamed` lorsqu'un fichier renommé a été ajouté à la zone de validation. | -| `deleted` | Affiche `deleted` lorsque la suppression d'un fichier a été ajoutée à la zone de validation. | -| style\* | Reflète la valeur de l'option `style` | +| Variable | Description | +| -------------- | ------------------------------------------------------------------------------------------------------------- | +| `all_status` | Shortcut for`$conflicted$stashed$deleted$renamed$modified$staged$untracked` | +| `ahead_behind` | Displays `diverged`, `ahead`, `behind` or `up_to_date` format string based on the current status of the repo. | +| `conflicted` | Displays `conflicted` when this branch has merge conflicts. | +| `untracked` | Displays `untracked` when there are untracked files in the working directory. | +| `stashed` | Displays `stashed` when a stash exists for the local repository. | +| `modified` | Displays `modified` when there are file modifications in the working directory. | +| `staged` | Displays `staged` when a new file has been added to the staging area. | +| `renamed` | Displays `renamed` when a renamed file has been added to the staging area. | +| `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. | +| style\* | Reflète la valeur de l'option `style` | *: Cette variable peut uniquement être utilisée dans une chaine de style -Les variables suivantes peuvent être utilisées pour la valeur de `diverged`: +The following variables can be used in `diverged`: -| Variable | Description | -| -------------- | ------------------------------------------------- | -| `ahead_count` | Nombre de commits en avance sur la branche suivie | -| `behind_count` | Nombre de commits en retard sur la branche suivie | +| Variable | Description | +| -------------- | ---------------------------------------------- | +| `ahead_count` | Number of commits ahead of the tracking branch | +| `behind_count` | Number of commits behind the tracking branch | -Les variables suivantes peuvent êtres utilisées dans `conflicted`, `ahead`, `behind`, `untracked`, `stashed`, `modified`, `staged`, `renamed` et `deleted`: +The following variables can be used in `conflicted`, `ahead`, `behind`, `untracked`, `stashed`, `modified`, `staged`, `renamed` and `deleted`: -| Variable | Description | -| -------- | --------------------------------------- | -| `count` | Affiche le nombre de fichiers concernés | +| Variable | Description | +| -------- | ------------------------ | +| `count` | Show the number of files | ### Exemple @@ -1742,7 +1828,7 @@ renamed = '👅' deleted = '🗑' ``` -Afficher le nombre de commits en avance/en retard par rapport à la branche suivie +Show ahead/behind count of the branch being tracked ```toml # ~/.config/starship.toml @@ -1753,7 +1839,7 @@ diverged = '⇕⇡${ahead_count}⇣${behind_count}' behind = '⇣${count}' ``` -Utiliser un exécutable Starship Windows pour les chemins Windows dans WSL +Use Windows Starship executable on Windows paths in WSL ```toml # ~/.config/starship.toml @@ -1764,7 +1850,7 @@ windows_starship = '/mnt/c/Users/username/scoop/apps/starship/current/starship.e ## Go -Le module `golang` affiche la version de [Go](https://golang.org/) installée. Par défaut, le module sera affiché si l’une de ces conditions est remplie: +The `golang` module shows the currently installed version of [Go](https://golang.org/). Par défaut, le module sera affiché si l’une de ces conditions est remplie: - Le dossier courant contient un fichier `go.mod` - Le dossier courant contient un fichier `go.sum` @@ -1782,18 +1868,18 @@ Le module `golang` affiche la version de [Go](https://golang.org/) installée. P | ------------------------------------ | ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | | `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` | -| `symbole` | `'🐹 '` | Une chaîne de caractères représentant le symbole de Go. | +| `symbole` | `'🐹 '` | A format string representing the symbol of Go. | | `detect_extensionsdetect_extensions` | `['go']` | Les extensions qui déclenchent 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. | | `style` | `'bold cyan'` | Le style pour le module. | -| `disabled` | `false` | Désactive le module `golang`. | +| `disabled` | `false` | Disables the `golang` module. | ### Variables | Variable | Exemple | Description | | --------- | --------- | -------------------------------------- | -| version | `v1.12.1` | La version de `go` | +| version | `v1.12.1` | The version of `go` | | symbole | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -1840,9 +1926,44 @@ disabled = true format = 'via [🐂](yellow bold) ' ``` +## Gradle + +The `gradle` module shows the version of the [Gradle Wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html) currently used in the project directory. + +Par défaut, le module sera affiché si l’une de ces conditions est remplie: + +- The current directory contains a `gradle/wrapper/gradle-wrapper.properties` directory. +- The current directory contains a file ending with `.gradle` or `.gradle.kts`. + +The `gradle` module is only able to read your Gradle Wrapper version from your config file, we don't execute your wrapper, because of the security concerns. + +### Options + +| Option | Défaut | Description | +| ------------------------------------ | ------------------------------------ | ------------------------------------------------------------------------------------------ | +| `format` | `"via [$symbol($version )]($style)"` | Format du module. | +| `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | +| `symbole` | `"🅶 "` | A format string representing the symbol of Gradle. | +| `detect_extensionsdetect_extensions` | `["gradle", "gradle.kts"]` | Les extensions qui déclenchent ce module. | +| `detect_files` | `[]` | Les fichiers qui activent ce module. | +| `detect_folders` | `["gradle"]` | Les dossiers qui activent ce module. | +| `style` | `"bold bright-cyan"` | Le style pour le module. | +| `disabled` | `false` | Disables the `gradle` module. | +| `recursive` | `false` | Enables recursive finding for the `gradle` directory. | + +### Variables + +| Variable | Exemple | Description | +| -------- | -------- | -------------------------------------- | +| version | `v7.5.1` | The version of `gradle` | +| symbole | | 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 + ## Haskell -Le module `haskell` affiche la version de GHC et/ou l’instantané Stack sélectionnée. +The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot. Par défaut, le module sera affiché si l’une de ces conditions est remplie: @@ -1851,25 +1972,25 @@ Par défaut, le module sera affiché si l’une de ces conditions est remplie: ### Options -| Option | Défaut | Description | -| ------------------------------------ | ------------------------------------ | ------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | Format du module. | -| `symbole` | `'λ '` | Une chaîne de format représentant le symbole de Haskell | -| `detect_extensionsdetect_extensions` | `['hs', 'cabal', 'hs-boot']` | Les extensions qui déclenchent ce module. | -| `detect_files` | `['stack.yaml', 'cabal.project']` | Les fichiers qui activent ce module. | -| `detect_folders` | `[]` | Les dossiers qui activent ce module. | -| `style` | `'bold purple'` | Le style pour le module. | -| `disabled` | `false` | Désactive le module `haskell`. | +| Option | Défaut | Description | +| ------------------------------------ | ------------------------------------ | -------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | Format du module. | +| `symbole` | `'λ '` | A format string representing the symbol of Haskell | +| `detect_extensionsdetect_extensions` | `['hs', 'cabal', 'hs-boot']` | Les extensions qui déclenchent ce module. | +| `detect_files` | `['stack.yaml', 'cabal.project']` | Les fichiers qui activent ce module. | +| `detect_folders` | `[]` | Les dossiers qui activent ce module. | +| `style` | `'bold purple'` | Le style pour le module. | +| `disabled` | `false` | Disables the `haskell` module. | ### Variables -| Variable | Exemple | Description | -| -------------- | ----------- | -------------------------------------------------------------------------------------------- | -| version | | `ghc_version` ou `snapshot` en fonction de si le dossier courant est un project Stack ou pas | -| snapshot | `lts-18.12` | L’instantané de Stack sélectionné | -| ghc\_version | `9.2.1` | Version de GHC installée | -| symbole | | Reflète la valeur de l'option `symbol` | -| style\* | | Reflète la valeur de l'option `style` | +| Variable | Exemple | Description | +| -------------- | ----------- | --------------------------------------------------------------------------------------- | +| version | | `ghc_version` or `snapshot` depending on whether the current project is a Stack project | +| snapshot | `lts-18.12` | Currently selected Stack snapshot | +| ghc\_version | `9.2.1` | Currently installed GHC version | +| symbole | | 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 @@ -1890,7 +2011,7 @@ The `haxe` module shows the currently installed version of [Haxe](https://haxe.o | `detect_extensionsdetect_extensions` | `["hx", "hxml"]` | Les extensions qui déclenchent ce module. | | `detect_files` | `["project.xml", "Project.xml", "application.xml", "haxelib.json", "hxformat.json", ".haxerc"]` | Les fichiers qui activent ce module. | | `detect_folders` | `[".haxelib", "haxe_libraries"]` | Quels dossiers devraient activer ce module. | -| `symbole` | `"⌘ "` | Une chaîne de format représentant le symbole de Helm. | +| `symbole` | `"⌘ "` | A format string representing the symbol of Helm. | | `style` | `"bold fg:202"` | Le style pour le module. | | `disabled` | `false` | Disables the `haxe` module. | @@ -1915,7 +2036,7 @@ format = "via [⌘ $version](bold fg:202) " ## Helm -Le module `helm` affiche la version de [Helm](https://helm.sh/) installée. Par défaut, le module sera affiché si l’une de ces conditions est remplie: +The `helm` module shows the currently installed version of [Helm](https://helm.sh/). Par défaut, le module sera affiché si l’une de ces conditions est remplie: - Le dossier courant contient un fichier `helmfile.yaml` - Le dossier courant contient un fichier `Chart.yaml` @@ -1929,15 +2050,15 @@ Le module `helm` affiche la version de [Helm](https://helm.sh/) installée. Par | `detect_extensionsdetect_extensions` | `[]` | Les extensions qui déclenchent ce module. | | `detect_files` | `['helmfile.yaml', 'Chart.yaml']` | Les fichiers qui activent ce module. | | `detect_folders` | `[]` | Quels dossiers devraient activer ce module. | -| `symbole` | `'⎈ '` | Une chaîne de format représentant le symbole de Helm. | +| `symbole` | `'⎈ '` | A format string representing the symbol of Helm. | | `style` | `'bold white'` | Le style pour le module. | -| `disabled` | `false` | Désactive le module `helm`. | +| `disabled` | `false` | Disables the `helm` module. | ### Variables | Variable | Exemple | Description | | --------- | -------- | -------------------------------------- | -| version | `v3.1.1` | La version de `helm` | +| version | `v3.1.1` | The version of `helm` | | symbole | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -1954,24 +2075,24 @@ format = 'via [⎈ $version](bold white) ' ## Nom d'hôte -Le module `hostname` affiche le nom d’hôte du système system. +The `hostname` module shows the system hostname. ### Options -| Option | Défaut | Description | -| ------------ | -------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ssh_only` | `true` | Afficher uniquement le nom d'hôte lorsque vous êtes connecté à une session SSH. | -| `ssh_symbol` | `'🌐 '` | A format string representing the symbol when connected to SSH session. | -| `trim_at` | `'.'` | Chaîne à laquelle le nom d'hôte est coupé, après la première correspondance. `'.'` will stop after the first dot. `''` will disable any truncation | -| `format` | `'[$ssh_symbol$hostname]($style) in '` | Format du module. | -| `style` | `'bold dimmed green'` | Le style pour le module. | -| `disabled` | `false` | Désactive le module `hostname`. | +| Option | Défaut | Description | +| ------------ | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | +| `ssh_only` | `true` | Only show hostname when connected to an SSH session. | +| `ssh_symbol` | `'🌐 '` | A format string representing the symbol when connected to SSH session. | +| `trim_at` | `'.'` | String that the hostname is cut off at, after the first match. `'.'` will stop after the first dot. `''` will disable any truncation | +| `format` | `'[$ssh_symbol$hostname]($style) in '` | Format du module. | +| `style` | `'bold dimmed green'` | Le style pour le module. | +| `disabled` | `false` | Disables the `hostname` module. | ### Variables | Variable | Exemple | Description | | ---------- | ---------- | ----------------------------------------------------- | -| nom d'hôte | `computer` | Le nom d’hôte de l’ordinateur | +| hostname | `computer` | The hostname of the computer | | style\* | | Reflète la valeur de l'option `style` | | ssh_symbol | `'🌏 '` | The symbol to represent when connected to SSH session | @@ -1991,7 +2112,7 @@ disabled = false ## Java -Le module `java` affiche la version de [Java](https://www.oracle.com/java/) installée. Par défaut, le module sera affiché si l’une de ces conditions est remplie: +The `java` module shows the currently installed version of [Java](https://www.oracle.com/java/). Par défaut, le module sera affiché si l’une de ces conditions est remplie: - The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `deps.edn`, `project.clj`, or `build.boot` file - Le dossier courant contient un fichier avec l’extension `.java`, `.class`, `.gradle`, `.jar`, `.clj` ou `.cljc` @@ -2005,15 +2126,15 @@ Le module `java` affiche la version de [Java](https://www.oracle.com/java/) inst | `detect_extensionsdetect_extensions` | `['java', 'class', 'gradle', 'jar', 'cljs', 'cljc']` | Les extensions qui déclenchent ce module. | | `detect_files` | `['pom.xml', 'build.gradle.kts', 'build.sbt', '.java-version', 'deps.edn', 'project.clj', 'build.boot']` | Les fichiers qui activent ce module. | | `detect_folders` | `[]` | Quels dossiers devraient activer ce module. | -| `symbole` | `'☕ '` | Une chaîne de caractères représentant le symbole de Java | +| `symbole` | `'☕ '` | A format string representing the symbol of Java | | `style` | `'red dimmed'` | Le style pour le module. | -| `disabled` | `false` | Désactive le module `java`. | +| `disabled` | `false` | Disables the `java` module. | ### Variables | Variable | Exemple | Description | | --------- | ------- | -------------------------------------- | -| version | `v14` | La version de `java` | +| version | `v14` | The version of `java` | | symbole | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -2030,9 +2151,9 @@ symbol = '🌟 ' ## Jobs -Le module `jobs` affiche le nombre de tâches en cours. Le module ne sera affiché que s'il y a des tâches de fond. Le module affichera le nombre de tâches en cours d’exécution s’il y en a au moins 2, ou plus que la valeur `threshold`, si elle existe. Le monde affichera un symbole s’il y a au moins 1 tâche, ou plus que la valeur de `symbol_threshold`, si elle existe. Vous pouvez définir les deux valeurs à 0 pour _toujours_ montrer le symbole et le nombre de tâches, même s’il n’y a aucune tâche en cours d’exécution. +The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to _always_ show the symbol and number of jobs, even if there are 0 jobs running. -Le fonctionnement par défaut est: +The default functionality is: - 0 tâche -> Rien n’est affiché. - 1 tâche -> `symbol` est affiché. @@ -2040,35 +2161,35 @@ Le fonctionnement par défaut est: ::: warning -Ce module n'est pas pris en charge sur tcsh et nu. +This module is not supported on tcsh and nu. ::: ::: warning -L’option `threshold` est dépréciée, mais si vous voulez l’utiliser, le module affichera le nombre de tâches en cours s’il y a plus d'une tâche, ou plus que la valeur de `threshold`, si elle existe. Si `threshold` est définie à 0, alors le module s'affichera également lorsqu'il n'y a pas de tâches de fond en cours. +The `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. ::: ### Options -| Option | Défaut | Description | -| ------------------ | ----------------------------- | ------------------------------------------------------------------------- | -| `threshold`* | `1` | Afficher le nombre de jobs si dépassé. | -| `symbol_threshold` | `1` | Affiche `symbol` si le nombre de tâches vaut au moins `symbol_threshold`. | -| `number_threshold` | `2` | Affiche le nombre de tâches s’il y en a au moins `number_threshold`. | -| `format` | `'[$symbol$number]($style) '` | Format du module. | -| `symbole` | `'✦'` | La chaine utilisée pour représenter la variable `symbole`. | -| `style` | `'bold blue'` | Le style pour le module. | -| `disabled` | `false` | Désactive le module `jobs`. | +| Option | Défaut | Description | +| ------------------ | ----------------------------- | ------------------------------------------------------------------------ | +| `threshold`* | `1` | Show number of jobs if exceeded. | +| `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. | +| `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. | +| `format` | `'[$symbol$number]($style) '` | Format du module. | +| `symbole` | `'✦'` | The string used to represent the `symbol` variable. | +| `style` | `'bold blue'` | Le style pour le module. | +| `disabled` | `false` | Disables the `jobs` module. | -*: Cette option is dépréciée, utilisez les options `number_threshold` et `symbol_threshold` à la place. +*: This option is deprecated, please use the `number_threshold` and `symbol_threshold` options instead. ### Variables | Variable | Exemple | Description | | --------- | ------- | -------------------------------------- | -| number | `1` | Le nombre de tâches | +| number | `1` | The number of jobs | | symbole | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -2087,7 +2208,7 @@ symbol_threshold = 0 ## Julia -Le module `julia` affiche la version de [Julia](https://julialang.org/) installée. Par défaut, le module sera affiché si l’une de ces conditions est remplie: +The `julia` module shows the currently installed version of [Julia](https://julialang.org/). Par défaut, le module sera affiché si l’une de ces conditions est remplie: - Le dossier courant contient un fichier `Project.toml` - Le dossier courant contient un fichier `Manifest.toml` @@ -2102,15 +2223,15 @@ Le module `julia` affiche la version de [Julia](https://julialang.org/) install | `detect_extensionsdetect_extensions` | `['jl']` | Les extensions qui déclenchent ce module. | | `detect_files` | `['Project.toml', 'Manifest.toml']` | Les fichiers qui activent ce module. | | `detect_folders` | `[]` | Quels dossiers devraient activer ce module. | -| `symbole` | `'ஃ '` | Une chaîne de caractères représentant le symbole de Julia. | +| `symbole` | `'ஃ '` | A format string representing the symbol of Julia. | | `style` | `'bold purple'` | Le style pour le module. | -| `disabled` | `false` | Désactive le module `Julia`. | +| `disabled` | `false` | Disables the `julia` module. | ### Variables | Variable | Exemple | Description | | --------- | -------- | -------------------------------------- | -| version | `v1.4.0` | La version de `julia` | +| version | `v1.4.0` | The version of `julia` | | symbole | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -2127,7 +2248,7 @@ symbol = '∴ ' ## Kotlin -Le module `kotlin` affiche la version de [Kotlin](https://kotlinlang.org/) installée. Par défaut, le module sera affiché si l’une de ces conditions est remplie: +The `kotlin` module shows the currently installed version of [Kotlin](https://kotlinlang.org/). Par défaut, le module sera affiché si l’une de ces conditions est remplie: - Le dossier courant contient un fichier `.kt` ou `.kts` @@ -2140,16 +2261,16 @@ Le module `kotlin` affiche la version de [Kotlin](https://kotlinlang.org/) insta | `detect_extensionsdetect_extensions` | `['kt', 'kts']` | Les extensions qui déclenchent ce module. | | `detect_files` | `[]` | Les fichiers qui activent ce module. | | `detect_folders` | `[]` | Quels dossiers devraient activer ce module. | -| `symbole` | `'🅺 '` | Une chaîne de caractères représentant le symbole de Kotlin. | +| `symbole` | `'🅺 '` | A format string representing the symbol of Kotlin. | | `style` | `'bold blue'` | Le style pour le module. | -| `kotlin_binary` | `'kotlin'` | Configure le binaire kotlin que Starship exécute lors de l'obtention de la version. | -| `disabled` | `false` | Désactive le module `kotlin`. | +| `kotlin_binary` | `'kotlin'` | Configures the kotlin binary that Starship executes when getting the version. | +| `disabled` | `false` | Disables the `kotlin` module. | ### Variables | Variable | Exemple | Description | | --------- | --------- | -------------------------------------- | -| version | `v1.4.21` | La version de `kotlin` | +| version | `v1.4.21` | The version of `kotlin` | | symbole | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -2174,11 +2295,11 @@ kotlin_binary = 'kotlinc' ## Kubernetes -Afficher le nom du [contexte Kubernetes](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context) courant, et, si défini, 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`. +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`. If the `$KUBECONFIG` env var is set the module will use that if not it will use the `~/.kube/config`. ::: tip -Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. When the module is enabled it will always be active, unless any of `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions. @@ -2186,28 +2307,28 @@ When the module is enabled it will always be active, unless any of `detect_exten ### Options -| Option | Défaut | Description | -| ------------------------------------ | ---------------------------------------------------- | ---------------------------------------------------------------------- | -| `symbole` | `'☸ '` | Une chaîne de format représentant le symbole affiché avant le Cluster. | -| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | Format du module. | -| `style` | `'cyan bold'` | Le style pour le module. | -| `context_aliases` | `{}` | Tableau des alias de contexte à afficher. | -| `user_aliases` | `{}` | Table of user aliases to display. | -| `detect_extensionsdetect_extensions` | `[]` | Les extensions qui déclenchent ce module. | -| `detect_files` | `[]` | Les fichiers qui activent ce module. | -| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. | -| `disabled` | `true` | Désactiver le module `kubernetes`. | +| Option | Défaut | Description | +| ------------------------------------ | ---------------------------------------------------- | --------------------------------------------------------------------- | +| `symbole` | `'☸ '` | A format string representing the symbol displayed before the Cluster. | +| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | Format du module. | +| `style` | `'cyan bold'` | Le style pour le module. | +| `context_aliases` | `{}` | Table of context aliases to display. | +| `user_aliases` | `{}` | Table of user aliases to display. | +| `detect_extensionsdetect_extensions` | `[]` | Les extensions qui déclenchent ce module. | +| `detect_files` | `[]` | Les fichiers qui activent ce module. | +| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. | +| `disabled` | `true` | Disables the `kubernetes` module. | ### Variables -| Variable | Exemple | Description | -| --------- | -------------------- | ------------------------------------------------ | -| context | `starship-context` | Le nom du contexte de kubernetes actuel | -| namespace | `starship-namespace` | Si défini, l'espace de noms de kubernetes actuel | -| user | `starship-user` | Si défini, l’utilisateur de kubernetes actuel | -| cluster | `starship-cluster` | Si défini, le cluster de kubernetes actuel | -| symbole | | Reflète la valeur de l'option `symbol` | -| style\* | | Reflète la valeur de l'option `style` | +| Variable | Exemple | Description | +| --------- | -------------------- | ---------------------------------------- | +| context | `starship-context` | The current kubernetes context name | +| namespace | `starship-namespace` | If set, the current kubernetes namespace | +| user | `starship-user` | If set, the current kubernetes user | +| cluster | `starship-cluster` | If set, the current kubernetes cluster | +| symbole | | 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 @@ -2242,9 +2363,9 @@ detect_files = ['k8s'] Additional to simple aliasing, `context_aliases` and `user_aliases` also supports extended matching and renaming using regular expressions. -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). +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. -Les noms de cluster long ou générés automatiquement peuvent être identifiés et raccourcis en utilisant des expressions rationnelles: +Long and automatically generated cluster names can be identified and shortened using regular expressions: ```toml [kubernetes.context_aliases] @@ -2259,15 +2380,15 @@ Les noms de cluster long ou générés automatiquement peuvent être identifiés 'gke_.*_(?P[\\w-]+)' = 'gke-$var_cluster' ``` -## Saut de ligne +## Line Break -Le module `line_break` sépare l'invite en deux lignes. +The `line_break` module separates the prompt into two lines. ### Options -| Option | Défaut | Description | -| ---------- | ------- | ----------------------------------------------------------------------- | -| `disabled` | `false` | Désactive le module `line_break`, mettant l'invite sur une seule ligne. | +| Option | Défaut | Description | +| ---------- | ------- | ------------------------------------------------------------------ | +| `disabled` | `false` | Disables the `line_break` module, making the prompt a single line. | ### Exemple @@ -2278,24 +2399,24 @@ Le module `line_break` sépare l'invite en deux lignes. disabled = true ``` -## IP locale +## Local IP -Le module `localip` affiche l’adresse IPv4 de l’interface réseau principale. +The `localip` module shows the IPv4 address of the primary network interface. ### Options -| Option | Défaut | Description | -| ---------- | ------------------------- | ----------------------------------------------------------------- | -| `ssh_only` | `true` | Afficher uniquenement l’adresse IP si connecté à une session SSH. | -| `format` | `'[$localipv4]($style) '` | Format du module. | -| `style` | `'bold yellow'` | Le style pour le module. | -| `disabled` | `true` | Désactive le module `localip`. | +| Option | Défaut | Description | +| ---------- | ------------------------- | ------------------------------------------------------ | +| `ssh_only` | `true` | Only show IP address when connected to an SSH session. | +| `format` | `'[$localipv4]($style) '` | Format du module. | +| `style` | `'bold yellow'` | Le style pour le module. | +| `disabled` | `true` | Disables the `localip` module. | ### Variables | Variable | Exemple | Description | | --------- | ------------ | ------------------------------------- | -| localipv4 | 192.168.1.13 | Contient l’adresse IPv4 principale | +| localipv4 | 192.168.1.13 | Contains the primary IPv4 address | | style\* | | Reflète la valeur de l'option `style` | *: Cette variable peut uniquement être utilisée dans une chaine de style @@ -2313,7 +2434,7 @@ disabled = false ## Lua -Le module `lua` affiche la version de [Lua](http://www.lua.org/) installée. Par défaut, le module sera affiché si l’une de ces conditions est remplie: +The `lua` module shows the currently installed version of [Lua](http://www.lua.org/). Par défaut, le module sera affiché si l’une de ces conditions est remplie: - Le dossier courant contient un fichier `.lua-version` - Le dossier courant contient un dossier `lua` @@ -2325,19 +2446,19 @@ Le module `lua` affiche la version de [Lua](http://www.lua.org/) installée. Par | ------------------------------------ | ------------------------------------ | ------------------------------------------------------------------------------------------ | | `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` | -| `symbole` | `'🌙 '` | Une chaîne de caractères représentant le symbole de Lua. | +| `symbole` | `'🌙 '` | A format string representing the symbol of Lua. | | `detect_extensionsdetect_extensions` | `['lua']` | Les extensions qui déclenchent ce module. | | `detect_files` | `['.lua-version']` | Les fichiers qui activent ce module. | | `detect_folders` | `['lua']` | Les dossiers qui activent ce module. | | `style` | `'bold blue'` | Le style pour le module. | -| `lua_binary` | `'lua'` | Configure le binaire lua que Starship exécute lors de l'obtention de la version. | -| `disabled` | `false` | Désactive le module `lua`. | +| `lua_binary` | `'lua'` | Configures the lua binary that Starship executes when getting the version. | +| `disabled` | `false` | Disables the `lua` module. | ### Variables | Variable | Exemple | Description | | --------- | -------- | -------------------------------------- | -| version | `v5.4.0` | La version de `lua` | +| version | `v5.4.0` | The version of `lua` | | symbole | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -2352,40 +2473,40 @@ Le module `lua` affiche la version de [Lua](http://www.lua.org/) installée. Par format = 'via [🌕 $version](bold blue) ' ``` -## Utilisation mémoire +## Memory Usage -Le module `memory_usage` affiche la mémoire système actuelle et l'utilisation de swap. +The `memory_usage` module shows current system memory and swap usage. -Par défaut, l'utilisation du swap est affichée si le swap total du système n'est pas nul. +By default the swap usage is displayed if the total system swap is non-zero. ::: tip -Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### Options -| Option | Défaut | Description | -| ----------- | ----------------------------------------------- | ------------------------------------------------------------------------------ | -| `threshold` | `75` | Masquer l'utilisation de la mémoire à moins qu'elle ne dépasse ce pourcentage. | -| `format` | `'via $symbol [${ram}( \| ${swap})]($style) '` | Format du module. | -| `symbole` | `'🐏'` | Le symbole utilisé avant d'afficher l'utilisation de la mémoire. | -| `style` | `'bold dimmed white'` | Le style pour le module. | -| `disabled` | `true` | Désactiver le module `memory_usage`. | +| Option | Défaut | Description | +| ----------- | ----------------------------------------------- | -------------------------------------------------------- | +| `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. | +| `format` | `'via $symbol [${ram}( \| ${swap})]($style) '` | Format du module. | +| `symbole` | `'🐏'` | The symbol used before displaying the memory usage. | +| `style` | `'bold dimmed white'` | Le style pour le module. | +| `disabled` | `true` | Disables the `memory_usage` module. | ### Variables -| Variable | Exemple | Description | -| ---------------- | ------------- | ------------------------------------------------------------------------------- | -| ram | `31GiB/65GiB` | La mémoire système utilisée/totale . | -| ram_pct | `48%` | Le pourcentage de la mémoire du système actuel. | -| swap\*\* | `1GiB/4GiB` | La taille de la mémoire swap du fichier de mémoire swap du système courant. | -| swap_pct\*\* | `77%` | Le poucentage de la mémoire swap du fichier de mémoire swap du système courant. | -| symbole | `🐏` | Reflète la valeur de l'option `symbol` | -| style\* | | Reflète la valeur de l'option `style` | +| Variable | Exemple | Description | +| ---------------- | ------------- | ------------------------------------------------------------------ | +| ram | `31GiB/65GiB` | The usage/total RAM of the current system memory. | +| ram_pct | `48%` | The percentage of the current system memory. | +| swap\*\* | `1GiB/4GiB` | The swap memory size of the current system swap memory file. | +| swap_pct\*\* | `77%` | The swap memory percentage of the current system swap memory file. | +| symbole | `🐏` | 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 *\*: Les informations sur le fichier SWAP est uniquement affichée si détectée sur le système courant +*: This variable can only be used as a part of a style string *\*: The SWAP file information is only displayed if detected on the current system ### Exemple @@ -2438,28 +2559,29 @@ symbol = ' ' style = 'bold dimmed green' ``` -## Branche Mercurial +## Mercurial Branch -Le module `hg_branch` affiche la branche active du dépôt dans le dossier courant. +The `hg_branch` module shows the active branch and topic of the repo in your current directory. ### Options -| Option | Défaut | Description | -| ------------------- | -------------------------------- | ---------------------------------------------------------------------------------------------------------- | -| `symbole` | `' '` | Le symbole utilisé avant le marque-page hg ou le nom de la branche du dépôt dans votre répertoire courant. | -| `style` | `'bold purple'` | Le style pour le module. | -| `format` | `'on [$symbol$branch]($style) '` | Format du module. | -| `truncation_length` | `2^63 - 1` | Tronque le nom de la branche hg à `N` graphèmes | -| `truncation_symbol` | `'…'` | Le symbole utilisé pour indiquer qu'un nom de branche a été tronqué. | -| `disabled` | `true` | Désactive le module `hg_branch`. | +| Option | Défaut | Description | +| ------------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------- | +| `symbole` | `' '` | The symbol used before the hg bookmark or branch name of the repo in your current directory. | +| `style` | `'bold purple'` | Le style pour le module. | +| `format` | `'on [$symbol$branch(:$topic)]($style) '` | Format du module. | +| `truncation_length` | `2^63 - 1` | Truncates the hg branch / topic name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. | +| `disabled` | `true` | Disables the `hg_branch` module. | ### Variables -| Variable | Exemple | Description | -| --------- | -------- | -------------------------------------- | -| branch | `master` | La branche mercuriale active | -| symbole | | Reflète la valeur de l'option `symbol` | -| style\* | | Reflète la valeur de l'option `style` | +| Variable | Exemple | Description | +| --------- | --------- | -------------------------------------- | +| branch | `master` | The active mercurial branch | +| topic | `feature` | The active mercurial topic | +| symbole | | 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 @@ -2476,7 +2598,7 @@ truncation_symbol = '' ## Nim -Le module `nim` affiche la version de [Nim](https://nim-lang.org/) installée. Par défaut, le module sera affiché si l’une de ces conditions est remplie: +The `nim` module shows the currently installed version of [Nim](https://nim-lang.org/). Par défaut, le module sera affiché si l’une de ces conditions est remplie: - Le dossier courant contient un fichier `nim.cfg` - Le dossier courant contient un fichier avec l’extension `.nim` @@ -2487,20 +2609,20 @@ Le module `nim` affiche la version de [Nim](https://nim-lang.org/) installée. P | Option | Défaut | Description | | ------------------------------------ | ------------------------------------ | ------------------------------------------------------------------------------------------ | -| `format` | `'via [$symbol($version )]($style)'` | Format du module | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module | | `version_format` | `'v${raw}'` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | -| `symbole` | `'👑 '` | Le symbole utilisé avant d'afficher la version de Nim. | +| `symbole` | `'👑 '` | The symbol used before displaying the version of Nim. | | `detect_extensionsdetect_extensions` | `['nim', 'nims', 'nimble']` | Les extensions qui déclenchent ce module. | | `detect_files` | `['nim.cfg']` | Les fichiers qui activent ce module. | | `detect_folders` | `[]` | Les dossiers qui activent ce module. | | `style` | `'bold yellow'` | Le style pour le module. | -| `disabled` | `false` | Désactive le module `nim`. | +| `disabled` | `false` | Disables the `nim` module. | ### Variables | Variable | Exemple | Description | | --------- | -------- | -------------------------------------- | -| version | `v1.2.0` | La version de `nim` | +| version | `v1.2.0` | The version of `nimc` | | symbole | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -2518,25 +2640,27 @@ symbol = '🎣 ' ## Nix-shell -Le module `nix_shell` affiche la version de l’environnement [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html). Ce module s’affichera quand vous serez à l’intérieur d’un environnement nix-shell. +The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html) environment. The module will be shown when inside a nix-shell environment. ### Options -| Option | Défaut | Description | -| ------------ | ---------------------------------------------- | ---------------------------------------------------------- | -| `format` | `'via [$symbol$state( \($name\))]($style) '` | Format du module. | -| `symbole` | `'❄️ '` | Une chaîne de format représentant le symbole de nix-shell. | -| `style` | `'bold blue'` | Le style pour le module. | -| `impure_msg` | `'impure'` | Une chaîne de format affichée lorsque le shell est impur. | -| `pure_msg` | `'pure'` | Une chaîne de format affichée lorsque le shell est pur. | -| `disabled` | `false` | Désactive le module `nix_shell`. | +| Option | Défaut | Description | +| ------------- | ---------------------------------------------- | --------------------------------------------------------------------- | +| `format` | `'via [$symbol$state( \($name\))]($style) '` | Format du module. | +| `symbole` | `'❄️ '` | A format string representing the symbol of nix-shell. | +| `style` | `'bold blue'` | Le style pour le module. | +| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | +| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | +| `unknown_msg` | `''` | A format string shown when it is unknown if the shell is pure/impure. | +| `disabled` | `false` | Disables the `nix_shell` module. | +| `heuristic` | `false` | Attempts to detect new `nix shell`-style shells with a heuristic. | ### Variables | Variable | Exemple | Description | | --------- | ------- | -------------------------------------- | -| state | `pure` | L’état du nix-shell | -| name | `lorri` | Le nom du nix-shell | +| state | `pure` | The state of the nix-shell | +| name | `lorri` | The name of the nix-shell | | symbole | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -2551,12 +2675,13 @@ Le module `nix_shell` affiche la version de l’environnement [nix-shell](https: disabled = true impure_msg = '[impure shell](bold red)' pure_msg = '[pure shell](bold green)' +unknown_msg = '[unknown shell](bold yellow)' format = 'via [☃️ $state( \($name\))](bold blue) ' ``` ## Node.js -Le module `nodejs` affiche la version de [Node.js](https://nodejs.org/) installée. Par défaut, le module sera affiché si l’une de ces conditions est remplie: +The `nodejs` module shows the currently installed version of [Node.js](https://nodejs.org/). Par défaut, le module sera affiché si l’une de ces conditions est remplie: - Le dossier courant contient un fichier `package.json` - Le dossier courant contient un fichier `.node-version` @@ -2567,23 +2692,23 @@ Le module `nodejs` affiche la version de [Node.js](https://nodejs.org/) install ### Options -| Option | Défaut | Description | -| ------------------------------------ | ------------------------------------------ | ----------------------------------------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | Format du module. | -| `version_format` | `'v${raw}'` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | -| `symbole` | `' '` | Une chaîne de caractères représentant le symbole de Node.js. | -| `detect_extensionsdetect_extensions` | `['js', 'mjs', 'cjs', 'ts', 'mts', 'cts']` | Les extensions 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. | -| `style` | `'bold green'` | Le style pour le module. | -| `disabled` | `false` | Désactive le module `nodejs`. | -| `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. | +| Option | Défaut | Description | +| ------------------------------------ | ------------------------------------------ | ----------------------------------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | Format du module. | +| `version_format` | `'v${raw}'` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | +| `symbole` | `' '` | A format string representing the symbol of Node.js. | +| `detect_extensionsdetect_extensions` | `['js', 'mjs', 'cjs', 'ts', 'mts', 'cts']` | Les extensions qui déclenchent ce module. | +| `detect_files` | `['package.json', '.node-version']` | Les fichiers qui activent ce module. | +| `detect_folders` | `['node_modules']` | Les dossiers qui activent ce module. | +| `style` | `'bold green'` | Le style pour le 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. | ### Variables | Variable | Exemple | Description | | --------- | ---------- | -------------------------------------- | -| version | `v13.12.0` | La version de `node` | +| version | `v13.12.0` | The version of `node` | | symbole | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -2600,7 +2725,7 @@ format = 'via [🤖 $version](bold green) ' ## OCaml -Le module `ocaml` affiche la version de [OCaml](https://ocaml.org/) installée. Par défaut, le module sera affiché si l’une de ces conditions est remplie: +The `ocaml` module shows the currently installed version of [OCaml](https://ocaml.org/). Par défaut, le module sera affiché si l’une de ces conditions est remplie: - Le dossier courant contient un fichier avec l’extension `.opam` ou un dossier `_opam` - Le répertoire courant contient un répertoire `esy.lock` @@ -2615,20 +2740,20 @@ Le module `ocaml` affiche la version de [OCaml](https://ocaml.org/) installée. | ------------------------------------ | -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | | `format` | `'via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)'` | La chaîne de format pour le module. | | `version_format` | `'v${raw}'` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | -| `symbole` | `'🐫 '` | Le symbole utilisé avant d'afficher la version de OCaml. | -| `global_switch_indicator` | `''` | La chaîne de caractères utilisée pour représenter le commutateur OPAM global. | -| `local_switch_indicator` | `'*'` | La chaîne de caractères utilisée pour représenter le commutateur OPAM local. | +| `symbole` | `'🐫 '` | The symbol used before displaying the version of OCaml. | +| `global_switch_indicator` | `''` | The format string used to represent global OPAM switch. | +| `local_switch_indicator` | `'*'` | The format string used to represent local OPAM switch. | | `detect_extensionsdetect_extensions` | `['opam', 'ml', 'mli', 're', 'rei']` | Les extensions qui déclenchent ce module. | | `detect_files` | `['dune', 'dune-project', 'jbuild', 'jbuild-ignore', '.merlin']` | Les fichiers qui activent ce module. | | `detect_folders` | `['_opam', 'esy.lock']` | Les dossiers qui activent ce module. | | `style` | `'bold yellow'` | Le style pour le module. | -| `disabled` | `false` | Désactive le module `ocaml`. | +| `disabled` | `false` | Disables the `ocaml` module. | ### Variables | Variable | Exemple | Description | | ---------------- | ------------ | ----------------------------------------------------------------- | -| version | `v4.10.0` | La version de `ocaml` | +| version | `v4.10.0` | The version of `ocaml` | | switch_name | `my-project` | The active OPAM switch | | switch_indicator | | Mirrors the value of `indicator` for currently active OPAM switch | | symbole | | Reflète la valeur de l'option `symbol` | @@ -2690,16 +2815,16 @@ The `openstack` module shows the current OpenStack cloud and project. The module | Option | Défaut | Description | | ---------- | ----------------------------------------------- | -------------------------------------------------------------- | | `format` | `'on [$symbol$cloud(\($project\))]($style) '` | Format du module. | -| `symbole` | `'☁️ '` | Le symbole utilisé avant d'afficher le cloud OpenStack actuel. | +| `symbole` | `'☁️ '` | The symbol used before displaying the current OpenStack cloud. | | `style` | `'bold yellow'` | Le style pour le module. | -| `disabled` | `false` | Désactive le module `openstack`. | +| `disabled` | `false` | Disables the `openstack` module. | ### Variables | Variable | Exemple | Description | | --------- | ------- | -------------------------------------- | -| cloud | `corp` | Le cloud OpenStack courant | -| project | `dev` | Le projet OpenStack courant | +| cloud | `corp` | The current OpenStack cloud | +| project | `dev` | The current OpenStack project | | symbole | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -2728,7 +2853,7 @@ The [os_info](https://lib.rs/crates/os_info) crate used by this module is known ::: tip -Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -2813,7 +2938,7 @@ Windows = " " Arch = "Arch is the best! " ``` -## Version du paquet +## Package Version The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages. @@ -2842,17 +2967,17 @@ The `package` module is shown when the current directory is the repository for a | Option | Défaut | Description | | ----------------- | --------------------------------- | ------------------------------------------------------------------------------------------ | | `format` | `'is [$symbol$version]($style) '` | Format du module. | -| `symbole` | `'📦 '` | Le symbole utilisé avant d'afficher la version du paquet. | +| `symbole` | `'📦 '` | The symbol used before displaying the version the package. | | `version_format` | `'v${raw}'` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | | `style` | `'bold 208'` | Le style pour le module. | -| `display_private` | `false` | Active l’affichage des versions des paquets marqués comme privés. | -| `disabled` | `false` | Désactive le module `package`. | +| `display_private` | `false` | Enable displaying version for packages marked as private. | +| `disabled` | `false` | Disables the `package` module. | ### Variables | Variable | Exemple | Description | | --------- | -------- | -------------------------------------- | -| version | `v1.0.0` | La version de votre package | +| version | `v1.0.0` | The version of your package | | symbole | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -2869,7 +2994,7 @@ format = 'via [🎁 $version](208 bold) ' ## Perl -Le module `perl` affiche la version de [Perl](https://www.perl.org/) installée. Par défaut, le module sera affiché si l’une de ces conditions est remplie: +The `perl` module shows the currently installed version of [Perl](https://www.perl.org/). Par défaut, le module sera affiché si l’une de ces conditions est remplie: - Le dossier courant contient un fichier `Makefile.PL` ou `Build.PL` - Le dossier courant contient un fichier `cpanfile` ou `cpanfile.snapshot` @@ -2883,18 +3008,18 @@ Le module `perl` affiche la version de [Perl](https://www.perl.org/) installée. | ------------------------------------ | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | | `format` | `'via [$symbol($version )]($style)'` | La chaîne de format pour le module. | | `version_format` | `'v${raw}'` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | -| `symbole` | `'🐪 '` | Le symbole utilisé avant d'afficher la version de Perl | +| `symbole` | `'🐪 '` | The symbol used before displaying the version of Perl | | `detect_extensionsdetect_extensions` | `['pl', 'pm', 'pod']` | Les extensions qui déclenchent ce module. | | `detect_files` | `['Makefile.PL', 'Build.PL', 'cpanfile', 'cpanfile.snapshot', 'META.json', 'META.yml', '.perl-version']` | Les fichiers qui activent ce module. | | `detect_folders` | `[]` | Les dossiers qui activent ce module. | | `style` | `'bold 149'` | Le style pour le module. | -| `disabled` | `false` | Désactive le module `perl`. | +| `disabled` | `false` | Disables the `perl` module. | ### Variables | Variable | Exemple | Description | | --------- | --------- | -------------------------------------- | -| version | `v5.26.1` | La version de `perl` | +| version | `v5.26.1` | The version of `perl` | | symbole | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -2909,7 +3034,7 @@ format = 'via [🦪 $version]($style) ' ## PHP -Le module `php` affiche la version de [PHP](https://www.php.net/) installée. Par défaut, le module sera affiché si l’une de ces conditions est remplie: +The `php` module shows the currently installed version of [PHP](https://www.php.net/). Par défaut, le module sera affiché si l’une de ces conditions est remplie: - Le dossier courant contient un fichier `composer.json` - Le dossier courant contient un fichier `.php-version` @@ -2921,18 +3046,18 @@ Le module `php` affiche la version de [PHP](https://www.php.net/) installée. Pa | ------------------------------------ | ------------------------------------ | ------------------------------------------------------------------------------------------ | | `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` | -| `symbole` | `'🐘 '` | Le symbole utilisé avant d'afficher la version de PHP. | +| `symbole` | `'🐘 '` | The symbol used before displaying the version of PHP. | | `detect_extensionsdetect_extensions` | `['php']` | Les extensions qui déclenchent ce module. | | `detect_files` | `['composer.json', '.php-version']` | Les fichiers qui activent ce module. | | `detect_folders` | `[]` | Les dossiers qui activent ce module. | | `style` | `'147 bold'` | Le style pour le module. | -| `disabled` | `false` | Désactive le module `php`. | +| `disabled` | `false` | Disables the `php` module. | ### Variables | Variable | Exemple | Description | | --------- | -------- | -------------------------------------- | -| version | `v7.3.8` | La version de `php` | +| version | `v7.3.8` | The version of `php` | | symbole | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -2947,13 +3072,28 @@ Le module `php` affiche la version de [PHP](https://www.php.net/) installée. Pa format = 'via [🔹 $version](147 bold) ' ``` +## Pijul Channel + +The `pijul_channel` module shows the active channel of the repo in your current directory. + +### Options + +| Option | Défaut | Description | +| ------------------- | --------------------------------- | ------------------------------------------------------------------------------------ | +| `symbole` | `' '` | The symbol used before the pijul channel name of the repo in your current directory. | +| `style` | `'bold purple'` | Le style pour le module. | +| `format` | `'on [$symbol$channel]($style) '` | Format du module. | +| `truncation_length` | `2^63 - 1` | Truncates the pijul channel name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. | +| `disabled` | `true` | Disables the `pijul` module. | + ## Pulumi The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. ::: tip -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). +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). ::: @@ -2971,17 +3111,17 @@ Par défaut, le module sera affiché si l’une de ces conditions est remplie: | `symbole` | `' '` | A format string shown before the Pulumi stack. | | `style` | `'bold 5'` | Le style pour le module. | | `search_upwards` | `true` | Enable discovery of pulumi config files in parent directories. | -| `disabled` | `false` | Désactive le module `pulumi`. | +| `disabled` | `false` | Disables the `pulumi` module. | ### Variables -| Variable | Exemple | Description | -| ----------------- | ---------- | -------------------------------------- | -| version | `v0.12.24` | La version de `pulumi` | -| stack | `dev` | The current Pulumi stack | -| nom d'utilisateur | `alice` | Le nom d’utilisateur Pulumi actuel | -| symbole | | Reflète la valeur de l'option `symbol` | -| style\* | | Reflète la valeur de l'option `style` | +| Variable | Exemple | Description | +| --------- | ---------- | -------------------------------------- | +| version | `v0.12.24` | The version of `pulumi` | +| stack | `dev` | The current Pulumi stack | +| username | `alice` | The current Pulumi username | +| symbole | | 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 @@ -3007,7 +3147,7 @@ format = '[$symbol$stack]($style) ' ## PureScript -Le module `purescript` affiche la version de [PureScript](https://www.purescript.org/) installée. Par défaut, le module sera affiché si l’une de ces conditions est remplie: +The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. Par défaut, le module sera affiché si l’une de ces conditions est remplie: - Le dossier courant contient un fichier `spago.dhall` - Le dossier courant contient un fichier avec l’extension `.purs` @@ -3018,18 +3158,18 @@ Le module `purescript` affiche la version de [PureScript](https://www.purescript | ------------------------------------ | ------------------------------------ | ------------------------------------------------------------------------------------------ | | `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` | -| `symbole` | `'<=> '` | Le symbole utilisé avant d'afficher la version de PureScript. | +| `symbole` | `'<=> '` | The symbol used before displaying the version of PureScript. | | `detect_extensionsdetect_extensions` | `['purs']` | Les extensions qui déclenchent ce module. | | `detect_files` | `['spago.dhall']` | Les fichiers qui activent ce module. | | `detect_folders` | `[]` | Les dossiers qui activent ce module. | | `style` | `'bold white'` | Le style pour le module. | -| `disabled` | `false` | Désactive le module `purescript`. | +| `disabled` | `false` | Disables the `purescript` module. | ### Variables | Variable | Exemple | Description | | --------- | -------- | -------------------------------------- | -| version | `0.13.5` | La version de `purescript` | +| version | `0.13.5` | The version of `purescript` | | symbole | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -3046,9 +3186,9 @@ format = 'via [$symbol$version](bold white)' ## Python -Le module `python` affiche la version de [Python](https://www.python.org/) installée et l’[environnement virtual Python](https://docs.python.org/tutorial/venv.html) actif s’il y en a un. +The `python` module shows the currently installed version of [Python](https://www.python.org/) and the current [Python virtual environment](https://docs.python.org/tutorial/venv.html) if one is activated. -Si `pyenv_version_name` est défini à `true`, il affichera le nom de la version de pyenv. Sinon, il affichera le numéro de version que donne `python --version`. +If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. Par défaut, le module sera affiché si l’une de ces conditions est remplie: @@ -3068,19 +3208,19 @@ Par défaut, le module sera affiché si l’une de ces conditions est remplie: | ------------------------------------ | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | | `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | Format du module. | | `version_format` | `'v${raw}'` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | -| `symbole` | `'🐍 '` | Une chaîne de caractères représentant le symbole de Python | +| `symbole` | `'🐍 '` | A format string representing the symbol of Python | | `style` | `'yellow bold'` | Le style pour le module. | -| `pyenv_version_name` | `false` | Utiliser pyenv pour obtenir la version de Python | +| `pyenv_version_name` | `false` | Use pyenv to get Python version | | `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `python_binary` | `['python', 'python3', 'python2']` | Configures the python binaries that Starship should executes when getting the version. | | `detect_extensionsdetect_extensions` | `['py']` | Les extensions qui déclenchent ce module | | `detect_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` | Quels fichiers devraient activer ce module | | `detect_folders` | `[]` | Quels dossiers devraient activer ce module | -| `disabled` | `false` | Désactive le module `python`. | +| `disabled` | `false` | Disables the `python` module. | ::: tip -La variable `python_binary` accepte soit une chaine, soit une liste de chaines de caractères. Starship essayera d'exécuter chaque binaire jusqu'à obtenir un résultat. Notez que vous ne pouvez modifier que le binaire que Starship exécute pour obtenir la version de Python, mais pas les arguments utilisés. +The `python_binary` variable accepts either a string or a list of strings. Starship will try executing each binary until it gets a result. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used. The default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `/usr/bin/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below. @@ -3088,13 +3228,13 @@ The default values and order for `python_binary` was chosen to first identify th ### Variables -| Variable | Exemple | Description | -| ------------ | --------------- | -------------------------------------------- | -| version | `'v3.8.1'` | La version de `python` | -| symbole | `'🐍 '` | Reflète la valeur de l'option `symbol` | -| style | `'yellow bold'` | Reflète la valeur de l'option `style` | -| pyenv_prefix | `'pyenv '` | Reflète la valeur de l'option `pyenv_prefix` | -| virtualenv | `'venv'` | Le nom du `virtualenv` courant | +| Variable | Exemple | Description | +| ------------ | --------------- | ------------------------------------------ | +| version | `'v3.8.1'` | The version of `python` | +| symbole | `'🐍 '` | Reflète la valeur de l'option `symbol` | +| style | `'yellow bold'` | Reflète la valeur de l'option `style` | +| pyenv_prefix | `'pyenv '` | Mirrors the value of option `pyenv_prefix` | +| virtualenv | `'venv'` | The current `virtualenv` name | ### Exemple @@ -3110,7 +3250,7 @@ pyenv_version_name = true # ~/.config/starship.toml [python] -# N'utilisez que le binaire `python3` pour obtenir la version. +# Only use the `python3` binary to get the version. python_binary = 'python3' ``` @@ -3118,7 +3258,7 @@ python_binary = 'python3' # ~/.config/starship.toml [python] -# Ne pas déclencher pour les fichiers avec l'extension py +# Don't trigger for files with the py extension detect_extensions = [] ``` @@ -3126,17 +3266,16 @@ detect_extensions = [] # ~/.config/starship.toml [python] -# Affiche la version de python depuis l'intérieur d'un venv local. +# Display the version of python from inside a local venv. # -# Notez que cela ne fonctionnera que lorsque le venv est à l'intérieur du projet, -# et uniquement lorsque vous vous situez dans le répertoire contenant le dossier du venv -# mais peut-être que c'est suffisant? +# Note this will only work when the venv is inside the project and it will only +# work in the directory that contains the venv dir but maybe this is ok? python_binary = ['./venv/bin/python', 'python', 'python3', 'python2'] ``` ## R -Le module `rlang` affiche la version de [R](https://www.r-project.org/) installée. Le module sera affiché si l'une de ces conditions est remplie: +The `rlang` module shows the currently installed version of [R](https://www.r-project.org/). The module will be shown if any of the following conditions are met: - Le dossier courant contient un fichier avec l’extension `.R`. - Le dossier courant contient un fichier avec l’extension `.Rd`. @@ -3152,18 +3291,18 @@ Le module `rlang` affiche la version de [R](https://www.r-project.org/) install | ------------------------------------ | ------------------------------------ | ------------------------------------------------------------------------------------------ | | `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` | -| `symbole` | `'📐'` | Une chaîne de caractères représentant le symbole de R. | +| `symbole` | `'📐'` | A format string representing the symbol of R. | | `style` | `'blue bold'` | Le style pour le module. | | `detect_extensionsdetect_extensions` | `['R', 'Rd', 'Rmd', 'Rproj', 'Rsx']` | Les extensions qui déclenchent ce module | | `detect_files` | `['.Rprofile']` | Quels fichiers devraient activer ce module | | `detect_folders` | `['.Rproj.user']` | Quels dossiers devraient activer ce module | -| `disabled` | `false` | Désactive le module `r`. | +| `disabled` | `false` | Disables the `r` module. | ### Variables | Variable | Exemple | Description | | -------- | ------------- | -------------------------------------- | -| version | `v4.0.5` | La version de `R` | +| version | `v4.0.5` | The version of `R` | | symbole | | Reflète la valeur de l'option `symbol` | | style | `'blue bold'` | Reflète la valeur de l'option `style` | @@ -3216,7 +3355,7 @@ format = 'via [🦪 $version]($style) ' ## Red -Par défaut, le module `red` affiche la version de [Red](https://www.red-lang.org/) installée. Le module sera affiché si l'une de ces conditions est remplie: +By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met: - Le dossier courant contient un fichier avec l’extension `.red` ou `.reds` @@ -3226,18 +3365,18 @@ Par défaut, le module `red` affiche la version de [Red](https://www.red-lang.or | ------------------------------------ | ------------------------------------ | ------------------------------------------------------------------------------------------ | | `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` | -| `symbole` | `'🔺 '` | Une chaîne de caractères représentant le symbole de Red. | +| `symbole` | `'🔺 '` | A format string representing the symbol of Red. | | `detect_extensionsdetect_extensions` | `['red']` | Les extensions qui déclenchent ce module. | | `detect_files` | `[]` | Les fichiers qui activent ce module. | | `detect_folders` | `[]` | Les dossiers qui activent ce module. | | `style` | `'red bold'` | Le style pour le module. | -| `disabled` | `false` | Désactive le module `red`. | +| `disabled` | `false` | Disables the `red` module. | ### Variables | Variable | Exemple | Description | | --------- | -------- | -------------------------------------- | -| version | `v2.5.1` | La version de `red` | +| version | `v2.5.1` | The version of `red` | | symbole | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -3254,14 +3393,14 @@ symbol = '🔴 ' ## Ruby -Le module `ruby` affiche la version de [Ruby](https://www.ruby-lang.org/) installée. Le module sera affiché si l'une de ces conditions est remplie: +By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). The module will be shown if any of the following conditions are met: - Le dossier courant contient un fichier `Gemfile` - Le dossier courant contient un fichier `.ruby-version` - Le dossier courant contient un fichier `.rb` - La variable d’environnement `RUBY_VERSION` ou `RBENV_VERSION` est définie -Starship obtient la version actuelle de Ruby en exécutant `ruby -v`. +Starship gets the current Ruby version by running `ruby -v`. ### Options @@ -3269,19 +3408,19 @@ Starship obtient la version actuelle de Ruby en exécutant `ruby -v`. | ------------------------------------ | ------------------------------------ | ------------------------------------------------------------------------------------------ | | `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` | -| `symbole` | `'💎 '` | Une chaîne de caractères représentant le symbole de Ruby. | +| `symbole` | `'💎 '` | A format string representing the symbol of Ruby. | | `detect_extensionsdetect_extensions` | `['rb']` | Les extensions qui déclenchent ce module. | | `detect_files` | `['Gemfile', '.ruby-version']` | Les fichiers qui activent ce module. | | `detect_folders` | `[]` | Les dossiers qui activent ce module. | -| `detect_variables` | `['RUBY_VERSION', 'RBENV_VERSION']` | Les variables d’environnement qui activent ce module. | +| `detect_variables` | `['RUBY_VERSION', 'RBENV_VERSION']` | Which environment variables should trigger this module. | | `style` | `'bold red'` | Le style pour le module. | -| `disabled` | `false` | Désactive le module `ruby`. | +| `disabled` | `false` | Disables the `ruby` module. | ### Variables | Variable | Exemple | Description | | --------- | -------- | -------------------------------------- | -| version | `v2.5.1` | La version de `ruby` | +| version | `v2.5.1` | The version of `ruby` | | symbole | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -3298,7 +3437,7 @@ symbol = '🔺 ' ## Rust -Le module `rust` affiche la version de [Rust](https://www.rust-lang.org/) installée. Le module sera affiché si l'une de ces conditions est remplie: +By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). The module will be shown if any of the following conditions are met: - Le dossier courant contient un fichier `Cargo.toml` - Le dossier courant contient un fichier avec l’extension `.rs` @@ -3309,18 +3448,18 @@ Le module `rust` affiche la version de [Rust](https://www.rust-lang.org/) instal | ------------------------------------ | ------------------------------------ | ------------------------------------------------------------------------------------------ | | `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` | -| `symbole` | `'🦀 '` | Une chaîne de caractères représentant le symbole de Rust | +| `symbole` | `'🦀 '` | A format string representing the symbol of Rust | | `detect_extensionsdetect_extensions` | `['rs']` | Les extensions qui déclenchent ce module. | | `detect_files` | `['Cargo.toml']` | Les fichiers qui activent ce module. | | `detect_folders` | `[]` | Les dossiers qui activent ce module. | | `style` | `'bold red'` | Le style pour le module. | -| `disabled` | `false` | Désactive le module `rust`. | +| `disabled` | `false` | Disables the `rust` module. | ### Variables | Variable | Exemple | Description | | --------- | ----------------- | -------------------------------------------- | -| version | `v1.43.0-nightly` | La version de `rustc` | +| version | `v1.43.0-nightly` | The version of `rustc` | | numver | `1.51.0` | The numeric component of the `rustc` version | | toolchain | `beta` | The toolchain version | | symbole | | Reflète la valeur de l'option `symbol` | @@ -3339,7 +3478,7 @@ format = 'via [⚙️ $version](red bold)' ## Scala -Le module `scale` affiche la version de [Scala](https://www.scala-lang.org/) installée. Par défaut, le module sera affiché si l’une de ces conditions est remplie: +The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). Par défaut, le module sera affiché si l’une de ces conditions est remplie: - Le dossier courant contient un fichier `build.sbt`, `.scalaenv` ou `.sbtenv` - Le dossier courant contient un fichier avec l’extension `.scala` ou `.sbt` @@ -3354,15 +3493,15 @@ Le module `scale` affiche la version de [Scala](https://www.scala-lang.org/) ins | `detect_extensionsdetect_extensions` | `['sbt', 'scala']` | Les extensions qui déclenchent ce module. | | `detect_files` | `['.scalaenv', '.sbtenv', 'build.sbt']` | Les fichiers qui activent ce module. | | `detect_folders` | `['.metals']` | Quels dossiers devraient activer ce module. | -| `symbole` | `'🆂 '` | Une chaîne de caractères représentant le symbole de Scala. | +| `symbole` | `'🆂 '` | A format string representing the symbol of Scala. | | `style` | `'red dimmed'` | Le style pour le module. | -| `disabled` | `false` | Désactive le module `scala`. | +| `disabled` | `false` | Disables the `scala` module. | ### Variables | Variable | Exemple | Description | | --------- | -------- | -------------------------------------- | -| version | `2.13.5` | La version de `scala` | +| version | `2.13.5` | The version of `scala` | | symbole | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -3379,39 +3518,39 @@ symbol = '🌟 ' ## Shell -Le module `shell` affiche un indicateur en fonction du shell actuellement utilisé. +The `shell` module shows an indicator for currently used shell. ::: tip -Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### Options -| Option | Défaut | Description | -| ---------------------- | ------------------------- | ----------------------------------------------------------- | -| `bash_indicator` | `'bsh'` | Chaine de formatage utilisée pour représenter bash. | -| `fish_indicator` | `'fsh'` | Chaine de formatage utilisée pour représenter fish. | -| `zsh_indicator` | `'zsh'` | Chaine de formatage utilisée pour représenter zsh. | -| `powershell_indicator` | `'psh'` | Chaine de formatage utilisée pour représenter powershell. | -| `ion_indicator` | `'ion'` | Chaine de formatage utilisée pour représenter ion. | -| `elvish_indicator` | `'esh'` | Chaine de formatage utilisée pour représenter elvish. | -| `tcsh_indicator` | `'tsh'` | Chaine de formatage utilisée pour représenter tcsh. | -| `xonsh_indicator` | `'xsh'` | Chaine de formatage utilisée pour représenter xonsh. | -| `cmd_indicator` | `'cmd'` | Chaine de formatage utilisée pour représenter cmd. | -| `nu_indicator` | `'nu'` | Chaine de formatage utilisée pour représenter nu. | -| `unknown_indicator` | `''` | La valeur par défaut à afficher quand le shell est inconnu. | -| `format` | `'[$indicator]($style) '` | Format du module. | -| `style` | `'white bold'` | Le style pour le module. | -| `disabled` | `true` | Désactive le module `shell`. | +| Option | Défaut | Description | +| ---------------------- | ------------------------- | ------------------------------------------------------------ | +| `bash_indicator` | `'bsh'` | A format string used to represent bash. | +| `fish_indicator` | `'fsh'` | A format string used to represent fish. | +| `zsh_indicator` | `'zsh'` | A format string used to represent zsh. | +| `powershell_indicator` | `'psh'` | A format string used to represent powershell. | +| `ion_indicator` | `'ion'` | A format string used to represent ion. | +| `elvish_indicator` | `'esh'` | A format string used to represent elvish. | +| `tcsh_indicator` | `'tsh'` | A format string used to represent tcsh. | +| `xonsh_indicator` | `'xsh'` | A format string used to represent xonsh. | +| `cmd_indicator` | `'cmd'` | A format string used to represent cmd. | +| `nu_indicator` | `'nu'` | A format string used to represent nu. | +| `unknown_indicator` | `''` | The default value to be displayed when the shell is unknown. | +| `format` | `'[$indicator]($style) '` | Format du module. | +| `style` | `'white bold'` | Le style pour le module. | +| `disabled` | `true` | Disables the `shell` module. | ### Variables -| Variable | Défaut | Description | -| --------- | ------ | ------------------------------------------------- | -| indicator | | Reflète la valeur de `indicator` du shell actuel. | -| style\* | | Reflète la valeur de l'option `style`. | +| Variable | Défaut | Description | +| --------- | ------ | ---------------------------------------------------------- | +| indicator | | Mirrors the value of `indicator` for currently used shell. | +| style\* | | Mirrors the value of option `style`. | *: Cette variable peut uniquement être utilisée dans une chaine de style @@ -3434,20 +3573,20 @@ The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/int ### Options -| Option | Défaut | Description | -| ----------- | ---------------------------- | ----------------------------------------------------------------------- | -| `threshold` | `2` | Seuil d’affichage. | -| `format` | `'[$symbol$shlvl]($style) '` | Format du module. | -| `symbole` | `'↕️ '` | Le symbole utilisée pour représenter le `SHLVL`. | -| `repeat` | `false` | Fait répéter `symbol` autant de fois que la valeur actuelle de `SHLVL`. | -| `style` | `'bold yellow'` | Le style pour le module. | -| `disabled` | `true` | Désactive le module `shlvl`. | +| Option | Défaut | Description | +| ----------- | ---------------------------- | ------------------------------------------------------------- | +| `threshold` | `2` | Display threshold. | +| `format` | `'[$symbol$shlvl]($style) '` | Format du module. | +| `symbole` | `'↕️ '` | The symbol used to represent the `SHLVL`. | +| `repeat` | `false` | Causes `symbol` to be repeated by the current `SHLVL` amount. | +| `style` | `'bold yellow'` | Le style pour le module. | +| `disabled` | `true` | Disables the `shlvl` module. | ### Variables | Variable | Exemple | Description | | --------- | ------- | -------------------------------------- | -| shlvl | `3` | La valeur actuelle de `SHLVL` | +| shlvl | `3` | The current value of `SHLVL` | | symbole | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -3466,22 +3605,22 @@ threshold = 3 ## Singularity -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. +The `singularity` module shows the current [Singularity](https://sylabs.io/singularity/) image, if inside a container and `$SINGULARITY_NAME` is set. ### Options -| Option | Défaut | Description | -| ---------- | -------------------------------- | ------------------------------------------------------ | -| `format` | `'[$symbol\[$env\]]($style) '` | Format du module. | -| `symbole` | `''` | Une chaîne de format affichée avant le nom de l'image. | -| `style` | `'bold dimmed blue'` | Le style pour le module. | -| `disabled` | `false` | Désactive le module `singularity`. | +| Option | Défaut | Description | +| ---------- | -------------------------------- | ------------------------------------------------ | +| `format` | `'[$symbol\[$env\]]($style) '` | Format du module. | +| `symbole` | `''` | A format string displayed before the image name. | +| `style` | `'bold dimmed blue'` | Le style pour le module. | +| `disabled` | `false` | Disables the `singularity` module. | ### Variables | Variable | Exemple | Description | | --------- | ------------ | -------------------------------------- | -| env | `centos.img` | L’image Singularity actuelle | +| env | `centos.img` | The current Singularity image | | symbole | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -3498,23 +3637,23 @@ format = '[📦 \[$env\]]($style) ' ## Spack -Le module `spack` affiche l’environnement [Spack](https://spack.readthedocs.io/en/latest/) courant, si `$SPACK_ENV` est définie. +The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set. ### Options -| Option | Défaut | Description | -| ------------------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `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). | -| `symbole` | `'🅢 '` | Le symbole utilisé avant le nom d'environnement. | -| `style` | `'bold blue'` | Le style pour le module. | -| `format` | `'via [$symbol$environment]($style) '` | Format du module. | -| `disabled` | `false` | Désactive le module `spack`. | +| 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). | +| `symbole` | `'🅢 '` | Le symbole utilisé avant le nom d'environnement. | +| `style` | `'bold blue'` | Le style pour le module. | +| `format` | `'via [$symbol$environment]($style) '` | Format du module. | +| `disabled` | `false` | Disables the `spack` module. | ### Variables | Variable | Exemple | Description | | ----------- | ------------ | -------------------------------------- | -| environment | `astronauts` | L’environnement de spack courant | +| environment | `astronauts` | The current spack environment | | symbole | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -3529,13 +3668,13 @@ Le module `spack` affiche l’environnement [Spack](https://spack.readthedocs.io format = '[$symbol$environment](dimmed blue) ' ``` -## Statut +## Status -Le module `status` affiche le code de sortie de la commande précédente. Si $success_symbol est vide (par défaut), ce module sera affiché uniquement quand le code de sortie n’est pas `0`. Le code de statut est converti en entier signé 32 bits. +The `status` module displays the exit code of the previous command. If $success_symbol is empty (default), the module will be shown only if the exit code is not `0`. The status code will cast to a signed 32-bit integer. ::: tip -Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -3543,7 +3682,7 @@ Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur | Option | Défaut | Description | | --------------------------- | ---------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -| `format` | `'[$symbol$status]($style) '` | Le format du module | +| `format` | `'[$symbol$status]($style) '` | The format of the module | | `symbole` | `'❌'` | The symbol displayed on program error | | `success_symbol` | `''` | The symbol displayed on program success | | `not_executable_symbol` | `'🚫'` | The symbol displayed when file isn't executable | @@ -3557,16 +3696,16 @@ Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur | `pipestatus_separator` | | | The symbol used to separate pipestatus segments (supports formatting) | | `pipestatus_format` | `'\[$pipestatus\] => [$symbol$common_meaning$signal_name$maybe_int]($style)'` | The format of the module when the command is a pipeline | | `pipestatus_segment_format` | | When specified, replaces `format` when formatting pipestatus segments | -| `disabled` | `true` | Désactiver le module `status`. | +| `disabled` | `true` | Disables the `status` module. | ### Variables | Variable | Exemple | Description | | -------------- | ------- | ------------------------------------------------------------------------------------------- | -| statut | `127` | Le code de sortie de la dernière commande | -| hex_status | `0x7F` | Le code de sortie de la dernière commande en hexa | -| int | `127` | Le code de sortie de la dernière commande | -| common_meaning | `ERROR` | Signification du code si n’est pas un signal | +| status | `127` | The exit code of the last command | +| hex_status | `0x7F` | The exit code of the last command in hex | +| int | `127` | The exit code of the last command | +| common_meaning | `ERROR` | Meaning of the code if not a signal | | signal_number | `9` | Signal number corresponding to the exit code, only if signalled | | signal_name | `KILL` | Name of the signal corresponding to the exit code, only if signalled | | maybe_int | `7` | Contains the exit code number when no meaning has been found | @@ -3592,23 +3731,23 @@ disabled = false ## Sudo -Le moduel `sudo` affiche si les identifiants sudo sont actuellement en cache. Le module sera uniquement affiché si les identifiants sont en cache. +The `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached. ::: tip -Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### Options -| Option | Défaut | Description | -| --------------- | ------------------------ | ----------------------------------------------------------------- | -| `format` | `'[as $symbol]($style)'` | Le format du module | -| `symbole` | `'🧙 '` | Le symbole affiché quand les identifiants sont en cache | -| `style` | `'bold blue'` | Le style pour le module. | -| `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`. | +| Option | Défaut | Description | +| --------------- | ------------------------ | ------------------------------------------------------- | +| `format` | `'[as $symbol]($style)'` | The format of the module | +| `symbole` | `'🧙 '` | The symbol displayed when credentials are cached | +| `style` | `'bold blue'` | Le style pour le module. | +| `allow_windows` | `false` | Since windows has no default sudo, default is disabled. | +| `disabled` | `true` | Disables the `sudo` module. | ### Variables @@ -3631,7 +3770,7 @@ disabled = false ``` ```toml -# Sous windows +# On windows # $HOME\.starship\config.toml [sudo] @@ -3641,7 +3780,7 @@ disabled = false ## Swift -Par défaut, le module `swift` affiche la version de [Swift](https://swift.org/) installée. Le module sera affiché si l'une de ces conditions est remplie: +By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). The module will be shown if any of the following conditions are met: - Le dossier courant contient un fichier `Package.swift` - Le dossier courant contient un fichier avec l’extension `.swift` @@ -3652,18 +3791,18 @@ Par défaut, le module `swift` affiche la version de [Swift](https://swift.org/) | ------------------------------------ | ------------------------------------ | ------------------------------------------------------------------------------------------ | | `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` | -| `symbole` | `'🐦 '` | Une chaîne de caractères représentant le symbole de Swift | +| `symbole` | `'🐦 '` | A format string representing the symbol of Swift | | `detect_extensionsdetect_extensions` | `['swift']` | Les extensions qui déclenchent ce module. | | `detect_files` | `['Package.swift']` | Les fichiers qui activent ce module. | | `detect_folders` | `[]` | Les dossiers qui activent ce module. | | `style` | `'bold 202'` | Le style pour le module. | -| `disabled` | `false` | Désactiver le module `swift`. | +| `disabled` | `false` | Disables the `swift` module. | ### Variables | Variable | Exemple | Description | | --------- | -------- | -------------------------------------- | -| version | `v5.2.4` | La version de `swift` | +| version | `v5.2.4` | The version of `swift` | | symbole | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -3680,11 +3819,11 @@ format = 'via [🏎 $version](red bold)' ## Terraform -Le module `terraform` affiche [l’espace de travail Terraform](https://www.terraform.io/docs/language/state/workspaces.html) sélectionné et sa version. +The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. ::: tip -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). +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). ::: @@ -3699,19 +3838,19 @@ Par défaut, le module sera affiché si l’une de ces conditions est remplie: | ------------------------------------ | ------------------------------------ | ------------------------------------------------------------------------------------------ | | `format` | `'via [$symbol$workspace]($style) '` | La chaîne de format pour le module. | | `version_format` | `'v${raw}'` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | -| `symbole` | `'💠'` | Une chaîne de format montrée avant l'espace de travail terraform. | +| `symbole` | `'💠'` | A format string shown before the terraform workspace. | | `detect_extensionsdetect_extensions` | `['tf', 'tfplan', 'tfstate']` | Les extensions qui déclenchent ce module. | | `detect_files` | `[]` | Les fichiers qui activent ce module. | | `detect_folders` | `['.terraform']` | Les dossiers qui activent ce module. | | `style` | `'bold 105'` | Le style pour le module. | -| `disabled` | `false` | Désactive le module `terraform`. | +| `disabled` | `false` | Disables the `terraform` module. | ### Variables | Variable | Exemple | Description | | --------- | ---------- | -------------------------------------- | -| version | `v0.12.24` | La version de `terraform` | -| workspace | `default` | L’espace de travail Terraform courant | +| version | `v0.12.24` | The version of `terraform` | +| workspace | `default` | The current Terraform workspace | | symbole | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -3739,33 +3878,33 @@ format = '[🏎💨 $workspace]($style) ' ## Date et Heure -Le module `time` affiche la date et heure **locale**. La valeur de `format` est utilisée par le package [`chrono`](https://crates.io/crates/chrono) pour contrôler la façon dont l'heure est affichée. Consultez la [doc de chrono strftime](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) pour découvrir les options disponibles. +The `time` module shows the current **local** time. The `format` configuration value is used by the [`chrono`](https://crates.io/crates/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) to see what options are available. ::: tip -Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### Options -| Option | Défaut | Description | -| ----------------- | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `format` | `'at [$time]($style) '` | La chaîne de format pour le module. | -| `use_12hr` | `false` | Activer le format 12h | -| `time_format` | voir plus bas | Le [format chrono](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) utilisé pour formater l'heure. | -| `style` | `'bold yellow'` | Le style utilisé par le module | -| `utc_time_offset` | `'local'` | Définir le décalage horaire UTC à utiliser. Intervalle de -24 < x < 24. Accepte des nombres décimaux pour s'adapter aux décalages de 30/45 minutes. | -| `disabled` | `true` | Désactive le module `time`. | -| `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 | +| Option | Défaut | Description | +| ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | +| `format` | `'at [$time]($style) '` | La chaîne de format pour le module. | +| `use_12hr` | `false` | Enables 12 hour formatting | +| `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. | +| `style` | `'bold yellow'` | The style for the module time | +| `utc_time_offset` | `'local'` | Sets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. | +| `disabled` | `true` | Disables the `time` module. | +| `time_range` | `'-'` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | -If `use_12hr` is `true`, then `time_format` defaults to `'%r'`. Otherwise, it defaults to `'%T'`. Définir manuellement `time_format` outrepasse le paramètre `use_12hr`. +If `use_12hr` is `true`, then `time_format` defaults to `'%r'`. Otherwise, it defaults to `'%T'`. Manually setting `time_format` will override the `use_12hr` setting. ### Variables | Variable | Exemple | Description | | --------- | ---------- | ------------------------------------- | -| time | `13:08:10` | L’heure actuelle. | +| time | `13:08:10` | The current time. | | style\* | | Reflète la valeur de l'option `style` | *: Cette variable peut uniquement être utilisée dans une chaine de style @@ -3783,9 +3922,9 @@ utc_time_offset = '-5' time_range = '10:00:00-14:00:00' ``` -## Nom d'utilisateur +## Username -Le module `username` affiche le nom de l’utilisateur actif. Le module sera affiché si l'une de ces conditions est remplie: +The `username` module shows active user's username. The module will be shown if any of the following conditions are met: - L'utilisateur courant est root/admin - L'utilisateur courant est différent de celui connecté @@ -3800,20 +3939,20 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, ` ### Options -| Option | Défaut | Description | -| ------------- | ----------------------- | ---------------------------------------------------- | -| `style_root` | `'bold red'` | Le style utilisé quand l'utilisateur est root/admin. | -| `style_user` | `'bold yellow'` | Le style utilisé pour les utilisateurs non-root. | -| `format` | `'[$user]($style) in '` | Format du module. | -| `show_always` | `false` | Toujours afficher le module `username`. | -| `disabled` | `false` | Désactive le module `username`. | +| Option | Défaut | Description | +| ------------- | ----------------------- | ------------------------------------------- | +| `style_root` | `'bold red'` | The style used when the user is root/admin. | +| `style_user` | `'bold yellow'` | The style used for non-root users. | +| `format` | `'[$user]($style) in '` | Format du module. | +| `show_always` | `false` | Always shows the `username` module. | +| `disabled` | `false` | Disables the `username` module. | ### Variables | Variable | Exemple | Description | | -------- | ------------ | ------------------------------------------------------------------------------------------- | | `style` | `'red bold'` | Mirrors the value of option `style_root` when root is logged in and `style_user` otherwise. | -| `user` | `'matchai'` | L’identifiant de l’utilisateur courant. | +| `user` | `'matchai'` | The currently logged-in user ID. | ### Exemple @@ -3830,7 +3969,7 @@ show_always = true ## Vagrant -Le module `vagrant` affiche la version de [Vagrant](https://www.vagrantup.com/) installée. Par défaut, le module sera affiché si l’une de ces conditions est remplie: +The `vagrant` module shows the currently installed version of [Vagrant](https://www.vagrantup.com/). Par défaut, le module sera affiché si l’une de ces conditions est remplie: - Le dossier courant contient un fichier `Vagrantfile` @@ -3840,18 +3979,18 @@ Le module `vagrant` affiche la version de [Vagrant](https://www.vagrantup.com/) | ------------------------------------ | ------------------------------------ | ------------------------------------------------------------------------------------------ | | `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` | -| `symbole` | `'⍱ '` | Une chaîne de caractères représentant le symbole de Vagrant. | +| `symbole` | `'⍱ '` | A format string representing the symbol of Vagrant. | | `detect_extensionsdetect_extensions` | `[]` | Les extensions qui déclenchent ce module. | | `detect_files` | `['Vagrantfile']` | Les fichiers qui activent ce module. | | `detect_folders` | `[]` | Les dossiers qui activent ce module. | | `style` | `'cyan bold'` | Le style pour le module. | -| `disabled` | `false` | Désactive le module `vagrant`. | +| `disabled` | `false` | Disables the `vagrant` module. | ### Variables | Variable | Exemple | Description | | --------- | ---------------- | -------------------------------------- | -| version | `Vagrant 2.2.10` | La version de `Vagrant` | +| version | `Vagrant 2.2.10` | The version of `Vagrant` | | symbole | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -3868,7 +4007,7 @@ format = 'via [⍱ $version](bold white) ' ## V -Le module `vlang` affiche la version de [V](https://vlang.io/) installée. Par défaut, le module sera affiché si l’une de ces conditions est remplie: +The `vlang` module shows you your currently installed version of [V](https://vlang.io/). Par défaut, le module sera affiché si l’une de ces conditions est remplie: - Le dossier courant contient un fichier avec l’extension `.v` - Le dossier courant contient un fichier `v.mod`, `vpkg.json` ou `.vpkg-lock.json` @@ -3879,18 +4018,18 @@ Le module `vlang` affiche la version de [V](https://vlang.io/) installée. Par d | ------------------------------------ | -------------------------------------------- | ------------------------------------------------------------------------------------------ | | `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` | -| `symbole` | `'V '` | Une chaîne de caractères représentant le symbole de V | +| `symbole` | `'V '` | A format string representing the symbol of V | | `detect_extensionsdetect_extensions` | `['v']` | Les extensions qui déclenchent ce module. | | `detect_files` | `['v.mod', 'vpkg.json', '.vpkg-lock.json' ]` | Les fichiers qui activent ce module. | | `detect_folders` | `[]` | Les dossiers qui activent ce module. | | `style` | `'blue bold'` | Le style pour le module. | -| `disabled` | `false` | Désactive le module `vlang`. | +| `disabled` | `false` | Disables the `vlang` module. | ### Variables | Variable | Exemple | Description | | --------- | ------- | -------------------------------------- | -| version | `v0.2` | La version de `v` | +| version | `v0.2` | The version of `v` | | symbole | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -3908,20 +4047,20 @@ The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/v ### Options -| Option | Défaut | Description | -| ---------- | -------------------------------- | ---------------------------------------------------- | -| `symbole` | `''` | Le symbole utilisé avant d'afficher le nom du dépôt. | -| `style` | `'bold yellow'` | Le style pour le module. | -| `format` | `'vcsh [$symbol$repo]($style) '` | Format du module. | -| `disabled` | `false` | Désactive le module `vcsh`. | +| Option | Défaut | Description | +| ---------- | -------------------------------- | ------------------------------------------------------ | +| `symbole` | `''` | The symbol used before displaying the repository name. | +| `style` | `'bold yellow'` | Le style pour le module. | +| `format` | `'vcsh [$symbol$repo]($style) '` | Format du module. | +| `disabled` | `false` | Disables the `vcsh` module. | ### Variables -| Variable | Exemple | Description | -| --------- | ----------------------------------------------- | -------------------------------------- | -| repo | `dotfiles` si dans un dépôt VCSH nommé dotfiles | Le nom du dépôt actif | -| symbole | | Reflète la valeur de l'option `symbol` | -| style\* | `black bold dimmed` | Reflète la valeur de l'option `style` | +| Variable | Exemple | Description | +| --------- | ------------------------------------------- | -------------------------------------- | +| repo | `dotfiles` if in a VCSH repo named dotfiles | The active repository name | +| symbole | | Reflète la valeur de l'option `symbol` | +| style\* | `black bold dimmed` | Reflète la valeur de l'option `style` | *: Cette variable peut uniquement être utilisée dans une chaine de style @@ -3936,7 +4075,7 @@ format = '[🆅 $repo](bold blue) ' ## Zig -Le module `zig` affiche la version de [Zig](https://ziglang.org/) installée. Le module sera affiché si l'une de ces conditions est remplie: +By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met: - Le dossier courant contient un fichier `.zip` @@ -3946,9 +4085,9 @@ Le module `zig` affiche la version de [Zig](https://ziglang.org/) installée. Le | ------------------------------------ | ------------------------------------ | ------------------------------------------------------------------------------------------ | | `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` | -| `symbole` | `'↯ '` | Le symbole utilisé avant d'afficher la version de Zig. | +| `symbole` | `'↯ '` | The symbol used before displaying the version of Zig. | | `style` | `'bold yellow'` | Le style pour le module. | -| `disabled` | `false` | Désactive le module `zig`. | +| `disabled` | `false` | Disables the `zig` module. | | `detect_extensionsdetect_extensions` | `['zig']` | Les extensions qui déclenchent ce module. | | `detect_files` | `[]` | Les fichiers qui activent ce module. | | `detect_folders` | `[]` | Les dossiers qui activent ce module. | @@ -3957,7 +4096,7 @@ Le module `zig` affiche la version de [Zig](https://ziglang.org/) installée. Le | Variable | Exemple | Description | | --------- | -------- | -------------------------------------- | -| version | `v0.6.0` | La version de `zip` | +| version | `v0.6.0` | The version of `zig` | | symbole | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -3972,11 +4111,11 @@ Le module `zig` affiche la version de [Zig](https://ziglang.org/) installée. Le symbol = '⚡️ ' ``` -## Commandes personnalisées +## Custom commands -Les modules `custom` affichent la sortie d’une commande arbitaitre. +The `custom` modules show the output of some arbitrary commands. -Ces modules seront affichés si l'une de ces conditions est remplie: +These modules will be shown if any of the following conditions are met: - Le dossier courant contient un fichier dont le nom est dans `detect_files` - Le dossier courant contient un dossier dont le nom est dans `detect_folders` @@ -3986,7 +4125,7 @@ Ces modules seront affichés si l'une de ces conditions est remplie: ::: tip -Plusieurs modules personnalisés peuvent être définis en utilisant un `.`. +Multiple custom modules can be defined by using a `.`. ::: @@ -4014,34 +4153,34 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt | Option | Défaut | Description | | ------------------------------------ | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `command` | `''` | La commande dont la sortie doit être affichée. La commande sera transmise au shell sur l’entrée standard. | -| `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` | | [Voir plus bas](#custom-command-shell) | -| `description` | `''` | La description du module qui est affichée lors de l’exécution de `starship explain`. | +| `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. | +| `shell` | | [See below](#custom-command-shell) | +| `description` | `''` | The description of the module that is shown when running `starship explain`. | | `detect_files` | `[]` | The files that will be searched in the working directory for a match. | | `detect_folders` | `[]` | The directories that will be searched in the working directory for a match. | | `detect_extensionsdetect_extensions` | `[]` | The extensions that will be searched in the working directory for a match. | -| `symbole` | `''` | Le symbole utilisé avant d'afficher la sortie de la commande. | +| `symbole` | `''` | The symbol used before displaying the command output. | | `style` | `'bold green'` | Le style pour le module. | | `format` | `'[$symbol($output )]($style)'` | Format du module. | -| `disabled` | `false` | Désactive le module `custom`. | -| `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). | +| `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). | | `use_stdin` | | An optional boolean value that overrides whether commands should be forwarded to the shell via the standard input or as an argument. If unset standard input is used by default, unless the shell does not support it (cmd, nushell). Setting this disables shell-specific argument handling. | -| `ignore_timeout` | `false` | Ignore le paramètre global `command_timeout` et continuer à exécuter des commandes externes, peu importe le temps qu'elles prennent. | +| `ignore_timeout` | `false` | Ignore global `command_timeout` setting and keep running external commands, no matter how long they take. | ### Variables -| Variable | Description | -| --------- | ------------------------------------------- | -| output | La sortie de la commande shell dans `shell` | -| symbole | Reflète la valeur de l'option `symbol` | -| style\* | Reflète la valeur de l'option `style` | +| Variable | Description | +| --------- | -------------------------------------- | +| output | The output of shell command in `shell` | +| symbole | 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 #### Commandes shell personnalisées -`shell` accepte une liste de chaînes non vide, où: +`shell` accepts a non-empty list of strings, where: - La première chaîne est le chemin vers le shell à utiliser pour exécuter la commande. - Other following arguments are passed to the shell. diff --git a/docs/fr-FR/guide/README.md b/docs/fr-FR/guide/README.md index adef840c..37cf70b8 100644 --- a/docs/fr-FR/guide/README.md +++ b/docs/fr-FR/guide/README.md @@ -9,7 +9,7 @@

Statut du workflow actions GitHub @@ -423,6 +423,7 @@ Support this project by [becoming a sponsor](https://github.com/sponsors/starshi **Supporter Tier** - [Dimension](https://dimension.dev/) +- [Appwrite](https://appwrite.io/)


diff --git a/docs/fr-FR/presets/README.md b/docs/fr-FR/presets/README.md index 88642827..efcf8061 100644 --- a/docs/fr-FR/presets/README.md +++ b/docs/fr-FR/presets/README.md @@ -14,7 +14,11 @@ Ce préréglage change les symboles de chaque module pour utiliser les symboles This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt. -::: tip This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). ::: +::: tip + +This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). + +::: [Click to view No Nerd Font preset](./no-nerd-font) @@ -28,7 +32,7 @@ Ce préréglage modifie le format de tous les modules intégrés pour afficher l Ce préréglage change les symboles de chaque module en texte brut. Idéal si vous n'avez pas accès à Unicode. -[![Capture d'écran du préréglage Symboles en texte brut](/presets/img/plain-text-symbols.png "Cliquez pour voir le préréglage Texte uniquement")](./plain-text) +[![Capture d'écran du préréglage Texte uniquement](/presets/img/plain-text-symbols.png "Cliquez pour voir le préréglage Texte uniquement")](./plain-text) ## [Pas de version des environnements](./no-runtimes.md) diff --git a/docs/id-ID/README.md b/docs/id-ID/README.md index f0d16676..e6226e9c 100644 --- a/docs/id-ID/README.md +++ b/docs/id-ID/README.md @@ -149,14 +149,14 @@ description: Starship merupakan sebuah prompt yang minimal, super cepat, dan san ::: warning - Hal ini dapat berubah di kemudian hari. Hanya Nushell v0.61+ yang menerima dukungan. + Hal ini dapat berubah di kemudian hari. Hanya Nushell v0.73+ yang menerima dukungan. ::: - Tambahkan baris berikut di akhir env file Nushell (dengan menjalankan `$nu.env-path` di Nushell): + Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell): ```sh mkdir ~/.cache/starship - starship init nu | save ~/.cache/starship/init.nu + starship init nu | save -f ~/.cache/starship/init.nu ``` Lalu tambahkan baris berikut di baris terakhir konfigurasi Nushell (temukan dengan menjalankan `$nu.config-path`): diff --git a/docs/id-ID/advanced-config/README.md b/docs/id-ID/advanced-config/README.md index c4f90b66..a36ced53 100644 --- a/docs/id-ID/advanced-config/README.md +++ b/docs/id-ID/advanced-config/README.md @@ -207,8 +207,6 @@ Catatan: Right propmt merupakan sebuah baris yang mengikuti lokasi baris inputan `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell. -Note: Nushell 0.71.0 or later is required - ### Contoh ```toml @@ -231,7 +229,7 @@ starship on  rprompt [!] is 📦 v0.57.0 via 🦀 v1.54.0 took 17s Beberapa shells mendukung continuation prompt bersamaan dengan prompt biasa. Prompt tersebutlah yang akan dirender daripada prompt biasa ketika pengguna memasukkan perintah yang kurang lengkap (seperti tanda kurung atau tanda kutipan tunggal). -Starship dapat mengatur continuation prompt dengan opsi `continuation_prompt`. Prompt bawaannya adalah `"[∙](bright-black) "`. +Starship dapat mengatur continuation prompt dengan opsi `continuation_prompt`. The default prompt is `'[∙](bright-black) '`. Catatan: `continuation_prompt` harus diubah menjadi string literal tanpa variabel apapun. @@ -247,7 +245,7 @@ Catatan: Continuation prompts hanya tersedia pada beberapa shells berikut: # ~/.config/starship.toml # Continuation prompt yang menampilkan dua panah solid -continuation_prompt = "▶▶" +continuation_prompt = '▶▶ ' ``` ## Penataan String diff --git a/docs/id-ID/config/README.md b/docs/id-ID/config/README.md index 6e245b86..481c8608 100644 --- a/docs/id-ID/config/README.md +++ b/docs/id-ID/config/README.md @@ -252,12 +252,14 @@ $singularity\ $kubernetes\ $directory\ $vcsh\ +$fossil_branch\ $git_branch\ $git_commit\ $git_state\ $git_metrics\ $git_status\ $hg_branch\ +$pijul_channel\ $docker_context\ $package\ $c\ @@ -270,6 +272,7 @@ $dotnet\ $elixir\ $elm\ $erlang\ +$fennel\ $golang\ $guix_shell\ $haskell\ @@ -278,6 +281,7 @@ $helm\ $java\ $julia\ $kotlin\ +$gradle\ $lua\ $nim\ $nodejs\ @@ -1305,6 +1309,12 @@ Modul `env_var` menampilkan nilai terkini dari variabel environment yang dipilih ::: tip +The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. + +::: + +::: 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 @@ -1320,13 +1330,14 @@ default = 'unknown user' ### Opsi -| Opsi | Bawaan | Deskripsi | -| ---------- | ------------------------------ | ------------------------------------------------------------------------------------- | -| `symbol` | `''` | Simbol yang digunakan sebelum menampilkan nilai dari variabel. | -| `variabel` | | Variabel environment yang akan ditampilkan. | -| `bawaan` | | Nilai bawaan yang akan ditampilkan ketika variabel yang terpilih tidak didefinisikan. | -| `format` | `'with [$env_value]($style) '` | Format dari modul. | -| `disabled` | `false` | Menonaktifkan modul `env_var`. | +| Opsi | Bawaan | Deskripsi | +| ------------- | ------------------------------ | ------------------------------------------------------------------------------------- | +| `symbol` | `""` | Simbol yang digunakan sebelum menampilkan nilai dari variabel. | +| `variabel` | | Variabel environment yang akan ditampilkan. | +| `bawaan` | | Nilai bawaan yang akan ditampilkan ketika variabel yang terpilih tidak didefinisikan. | +| `format` | `"with [$env_value]($style) "` | Format dari modul. | +| `description` | `""` | The description of the module that is shown when running `starship explain`. | +| `disabled` | `false` | Menonaktifkan modul `env_var`. | ### Variabel @@ -1388,7 +1399,7 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https: | symbol | | Menyalin nilai dari opsi `symbol` | | style\* | | Menyalin nilai dari opsi `style` | -*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string +*: This variable can only be used as a part of a style string ### Contoh @@ -1399,6 +1410,44 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https: format = 'via [e $version](bold red) ' ``` +## Fennel + +The `fennel` module shows the currently installed version of [Fennel](https://fennel-lang.org). Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: + +- The current directory contains a file with the `.fnl` extension + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | +| `fromat` | `'via [$symbol($version )]($style)'` | Format dari modul. | +| `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. | +| `style` | `'bold green'` | Gaya penataan untuk modul. | +| `detect_extensions` | `[fnl]` | Ekstensi mana yang sebaiknya memicu modul ini. | +| `detect_files` | `[]` | filenames mana yang sebaiknya memicu modul ini. | +| `detect_folders` | `[]` | Folder mana yang sebaiknya memicul modul ini. | +| `disabled` | `false` | Disables the `fennel` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | -------- | --------------------------------- | +| version | `v1.2.1` | The version of `fennel` | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml +# ~/.config/starship.toml + +[fennel] +symbol = '⫰ ' +``` + ## Fill The `fill` module fills any extra space on the line with a symbol. If multiple `fill` modules are present in a line they will split the space evenly between them. This is useful for aligning other modules. @@ -1428,6 +1477,42 @@ Produces a prompt that looks like: AA -------------------------------------------- BB -------------------------------------------- CC ``` +## Fossil Branch + +The `fossil_branch` module shows the name of the active branch of the check-out in your current directory. + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | +| `fromat` | `'on [$symbol$branch]($style) '` | Format dari modul. Use `'$branch'` to refer to the current branch name. | +| `symbol` | `' '` | The symbol used before the branch name of the check-out in your current directory. | +| `style` | `'bold purple'` | Gaya penataan untuk modul. | +| `truncation_length` | `2^63 - 1` | Truncates a Fossil branch name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. | +| `disabled` | `true` | Disables the `fossil_branch` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| --------- | ------- | --------------------------------- | +| branch | `trunk` | The active Fossil branch | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml +# ~/.config/starship.toml + +[fossil_branch] +symbol = '🦎 ' +truncation_length = 4 +truncation_symbol = '' +``` + ## Google Cloud (`gcloud`) The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var. @@ -1436,7 +1521,7 @@ The `gcloud` module shows the current configuration for [`gcloud`](https://cloud | Opsi | Bawaan | Deskripsi | | ----------------- | ---------------------------------------------------------- | ---------------------------------------------------------------- | -| `format` | `'on [$symbol$account(@$domain)(\($region\))]($style) '` | Format dari modul. | +| `fromat` | `'on [$symbol$account(@$domain)(\($region\))]($style) '` | Format dari modul. | | `symbol` | `'☁️ '` | The symbol used before displaying the current GCP profile. | | `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. | @@ -1510,7 +1595,7 @@ The `git_branch` module shows the active branch of the repo in your current dire | Opsi | Bawaan | Deskripsi | | -------------------- | ------------------------------------------------- | ---------------------------------------------------------------------------------------- | | `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | -| `format` | `'on [$symbol$branch(:$remote_branch)]($style) '` | 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. | | `style` | `'bold purple'` | Gaya penataan untuk modul. | | `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | @@ -1552,7 +1637,7 @@ The `git_commit` module shows the current commit hash and also the tag (if any) | Opsi | Bawaan | Deskripsi | | -------------------- | ------------------------------ | ------------------------------------------------------------------------------------ | | `commit_hash_length` | `7` | The length of the displayed git commit hash. | -| `format` | `'[\($hash$tag\)]($style) '` | Format dari modul. | +| `fromat` | `'[\($hash$tag\)]($style) '` | Format dari modul. | | `style` | `'bold green'` | Gaya penataan untuk modul. | | `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state | | `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. | @@ -1562,10 +1647,11 @@ The `git_commit` module shows the current commit hash and also the tag (if any) ### Variabel -| Variabel | Contoh | Deskripsi | -| --------- | --------- | -------------------------------- | -| hash | `b703eb3` | The current git commit hash | -| style\* | | Menyalin nilai dari opsi `style` | +| Variabel | Contoh | Deskripsi | +| --------- | --------- | -------------------------------------------- | +| hash | `b703eb3` | The current git commit hash | +| tag | `v1.0.0` | The tag name if showing tag info is enabled. | +| style\* | | Menyalin nilai dari opsi `style` | *: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string @@ -1595,7 +1681,7 @@ The `git_state` module will show in directories which are part of a git reposito | `am` | `'AM'` | A format string displayed when an `apply-mailbox` (`git am`) is in progress. | | `am_or_rebase` | `'AM/REBASE'` | A format string displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. | | `style` | `'bold yellow'` | Gaya penataan untuk modul. | -| `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | Format dari modul. | +| `fromat` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | Format dari modul. | | `disabled` | `false` | Disables the `git_state` module. | ### Variabel @@ -1607,7 +1693,7 @@ The `git_state` module will show in directories which are part of a git reposito | progress_total | `2` | The total operation progress | | style\* | | Menyalin nilai dari opsi `style` | -*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string +*: This variable can only be used as a part of a style string ### Contoh @@ -1636,7 +1722,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | `added_style` | `'bold green'` | The style for the added count. | | `deleted_style` | `'bold red'` | The style for the deleted count. | | `only_nonzero_diffs` | `true` | Render status only for changed items. | -| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | Format dari modul. | +| `fromat` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | Format dari modul. | | `disabled` | `true` | Disables the `git_metrics` module. | ### Variabel @@ -1648,7 +1734,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | added_style\* | | Mirrors the value of option `added_style` | | deleted_style\* | | Mirrors the value of option `deleted_style` | -*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string +*: This variable can only be used as a part of a style string ### Contoh @@ -1674,7 +1760,7 @@ The Git Status module is very slow in Windows directories (for example under `/m | Opsi | Bawaan | Deskripsi | | ------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | The default format for `git_status` | +| `fromat` | `'([\[$all_status$ahead_behind\]]($style) )'` | The default format for `git_status` | | `conflicted` | `'='` | This branch has merge conflicts. | | `ahead` | `'⇡'` | The format of `ahead` | | `behind` | `'⇣'` | The format of `behind` | @@ -1708,7 +1794,7 @@ The following variables can be used in `format`: | `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. | | style\* | Menyalin nilai dari opsi `style` | -*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string +*: This variable can only be used as a part of a style string The following variables can be used in `diverged`: @@ -1828,7 +1914,7 @@ The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel | symbol | | Menyalin nilai dari opsi `symbol` | | style\* | | Menyalin nilai dari opsi `style` | -*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string +*: This variable can only be used as a part of a style string ### Contoh @@ -1840,6 +1926,41 @@ disabled = true format = 'via [🐂](yellow bold) ' ``` +## Gradle + +The `gradle` module shows the version of the [Gradle Wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html) currently used in the project directory. + +Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: + +- The current directory contains a `gradle/wrapper/gradle-wrapper.properties` directory. +- The current directory contains a file ending with `.gradle` or `.gradle.kts`. + +The `gradle` module is only able to read your Gradle Wrapper version from your config file, we don't execute your wrapper, because of the security concerns. + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | +| `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🅶 "` | A format string representing the symbol of Gradle. | +| `detect_extensions` | `["gradle", "gradle.kts"]` | Ekstensi mana yang sebaiknya memicu modul ini. | +| `detect_files` | `[]` | filenames mana yang sebaiknya memicu modul ini. | +| `detect_folders` | `["gradle"]` | Folder mana yang sebaiknya memicul modul ini. | +| `style` | `"bold bright-cyan"` | Gaya penataan untuk modul. | +| `disabled` | `false` | Disables the `gradle` module. | +| `recursive` | `false` | Enables recursive finding for the `gradle` directory. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| -------- | -------- | --------------------------------- | +| version | `v7.5.1` | The version of `gradle` | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style* | | Menyalin nilai dari opsi `style` | + +*: This variable can only be used as a part of a style string + ## Haskell The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot. @@ -1853,7 +1974,7 @@ Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: | Opsi | Bawaan | Deskripsi | | ------------------- | ------------------------------------ | -------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | Format dari modul. | +| `fromat` | `'via [$symbol($version )]($style)'` | Format dari modul. | | `symbol` | `'λ '` | A format string representing the symbol of Haskell | | `detect_extensions` | `['hs', 'cabal', 'hs-boot']` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_files` | `['stack.yaml', 'cabal.project']` | filenames mana yang sebaiknya memicu modul ini. | @@ -1885,7 +2006,7 @@ The `haxe` module shows the currently installed version of [Haxe](https://haxe.o | Opsi | Bawaan | Deskripsi | | ------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `format` | `"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` | | `detect_extensions` | `["hx", "hxml"]` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_files` | `["project.xml", "Project.xml", "application.xml", "haxelib.json", "hxformat.json", ".haxerc"]` | filenames mana yang sebaiknya memicu modul ini. | @@ -1924,7 +2045,7 @@ The `helm` module shows the currently installed version of [Helm](https://helm.s | Opsi | Bawaan | Deskripsi | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | -| `format` | `'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` | | `detect_extensions` | `[]` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_files` | `['helmfile.yaml', 'Chart.yaml']` | filenames mana yang sebaiknya memicu modul ini. | @@ -1963,7 +2084,7 @@ The `hostname` module shows the system hostname. | `ssh_only` | `true` | Only show hostname when connected to an SSH session. | | `ssh_symbol` | `'🌐 '` | A format string representing the symbol when connected to SSH session. | | `trim_at` | `'.'` | String that the hostname is cut off at, after the first match. `'.'` will stop after the first dot. `''` will disable any truncation | -| `format` | `'[$ssh_symbol$hostname]($style) in '` | Format dari modul. | +| `fromat` | `'[$ssh_symbol$hostname]($style) in '` | Format dari modul. | | `style` | `'bold dimmed green'` | Gaya penataan untuk modul. | | `disabled` | `false` | Disables the `hostname` module. | @@ -2000,7 +2121,7 @@ The `java` module shows the currently installed version of [Java](https://www.or | Opsi | Bawaan | Deskripsi | | ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `format` | `'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` | | `detect_extensions` | `['java', 'class', 'gradle', 'jar', 'cljs', 'cljc']` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_files` | `['pom.xml', 'build.gradle.kts', 'build.sbt', '.java-version', 'deps.edn', 'project.clj', 'build.boot']` | filenames mana yang sebaiknya memicu modul ini. | @@ -2017,7 +2138,7 @@ The `java` module shows the currently installed version of [Java](https://www.or | symbol | | Menyalin nilai dari opsi `symbol` | | style\* | | Menyalin nilai dari opsi `style` | -*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string +*: This variable can only be used as a part of a style string ### Contoh @@ -2057,7 +2178,7 @@ The `threshold` option is deprecated, but if you want to use it, the module will | `threshold`* | `1` | Show number of jobs if exceeded. | | `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. | | `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. | -| `format` | `'[$symbol$number]($style) '` | Format dari modul. | +| `fromat` | `'[$symbol$number]($style) '` | Format dari modul. | | `symbol` | `'✦'` | The string used to represent the `symbol` variable. | | `style` | `'bold blue'` | Gaya penataan untuk modul. | | `disabled` | `false` | Disables the `jobs` module. | @@ -2097,7 +2218,7 @@ The `julia` module shows the currently installed version of [Julia](https://juli | Opsi | Bawaan | Deskripsi | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | -| `format` | `'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` | | `detect_extensions` | `['jl']` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_files` | `['Project.toml', 'Manifest.toml']` | filenames mana yang sebaiknya memicu modul ini. | @@ -2135,7 +2256,7 @@ The `kotlin` module shows the currently installed version of [Kotlin](https://ko | Opsi | Bawaan | Deskripsi | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | -| `format` | `'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` | | `detect_extensions` | `['kt', 'kts']` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_files` | `[]` | filenames mana yang sebaiknya memicu modul ini. | @@ -2153,7 +2274,7 @@ The `kotlin` module shows the currently installed version of [Kotlin](https://ko | symbol | | Menyalin nilai dari opsi `symbol` | | style\* | | Menyalin nilai dari opsi `style` | -*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string +*: This variable can only be used as a part of a style string ### Contoh @@ -2189,7 +2310,7 @@ When the module is enabled it will always be active, unless any of `detect_exten | Opsi | Bawaan | Deskripsi | | ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | | `symbol` | `'☸ '` | A format string representing the symbol displayed before the Cluster. | -| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | Format dari modul. | +| `fromat` | `'[$symbol$context( \($namespace\))]($style) in '` | Format dari modul. | | `style` | `'cyan bold'` | Gaya penataan untuk modul. | | `context_aliases` | `{}` | Table of context aliases to display. | | `user_aliases` | `{}` | Table of user aliases to display. | @@ -2209,7 +2330,7 @@ When the module is enabled it will always be active, unless any of `detect_exten | symbol | | Menyalin nilai dari opsi `symbol` | | style\* | | Menyalin nilai dari opsi `style` | -*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string +*: This variable can only be used as a part of a style string ### Contoh @@ -2287,7 +2408,7 @@ The `localip` module shows the IPv4 address of the primary network interface. | Opsi | Bawaan | Deskripsi | | ---------- | ------------------------- | ------------------------------------------------------ | | `ssh_only` | `true` | Only show IP address when connected to an SSH session. | -| `format` | `'[$localipv4]($style) '` | Format dari modul. | +| `fromat` | `'[$localipv4]($style) '` | Format dari modul. | | `style` | `'bold yellow'` | Gaya penataan untuk modul. | | `disabled` | `true` | Disables the `localip` module. | @@ -2323,7 +2444,7 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o | Opsi | Bawaan | Deskripsi | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | -| `format` | `'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` | | `symbol` | `'🌙 '` | A format string representing the symbol of Lua. | | `detect_extensions` | `['lua']` | Ekstensi mana yang sebaiknya memicu modul ini. | @@ -2341,7 +2462,7 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o | symbol | | Menyalin nilai dari opsi `symbol` | | style\* | | Menyalin nilai dari opsi `style` | -*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string +*: This variable can only be used as a part of a style string ### Contoh @@ -2369,7 +2490,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | Opsi | Bawaan | Deskripsi | | ----------- | ----------------------------------------------- | -------------------------------------------------------- | | `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. | -| `format` | `'via $symbol [${ram}( \| ${swap})]($style) '` | Format dari modul. | +| `fromat` | `'via $symbol [${ram}( \| ${swap})]($style) '` | Format dari modul. | | `symbol` | `'🐏'` | The symbol used before displaying the memory usage. | | `style` | `'bold dimmed white'` | Gaya penataan untuk modul. | | `disabled` | `true` | Disables the `memory_usage` module. | @@ -2411,7 +2532,7 @@ By default the Meson project name is displayed, if `$MESON_DEVENV` is set. | ------------------- | ---------------------------------- | ----------------------------------------------------------------------------------------- | | `truncation_length` | `2^32 - 1` | Truncates a project name to `N` graphemes. | | `truncation_symbol` | `'…'` | The symbol used to indicate a project name was truncated. You can use `''` for no symbol. | -| `format` | `'via [$symbol$project]($style) '` | Format dari modul. | +| `fromat` | `'via [$symbol$project]($style) '` | Format dari modul. | | `symbol` | `'⬢ '` | The symbol used before displaying the project name. | | `style` | `'blue bold'` | Gaya penataan untuk modul. | | `disabled` | `false` | Disables the `meson` module. | @@ -2440,26 +2561,27 @@ style = 'bold dimmed green' ## Mercurial Branch -The `hg_branch` module shows the active branch of the repo in your current directory. +The `hg_branch` module shows the active branch and topic of the repo in your current directory. ### Opsi -| Opsi | Bawaan | Deskripsi | -| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------- | -| `symbol` | `' '` | The symbol used before the hg bookmark or branch name of the repo in your current directory. | -| `style` | `'bold purple'` | Gaya penataan untuk modul. | -| `format` | `'on [$symbol$branch]($style) '` | Format dari modul. | -| `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. | -| `disabled` | `true` | Disables the `hg_branch` module. | +| Opsi | Bawaan | Deskripsi | +| ------------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------- | +| `symbol` | `' '` | The symbol used before the hg bookmark or branch name of the repo in your current directory. | +| `style` | `'bold purple'` | Gaya penataan untuk modul. | +| `fromat` | `'on [$symbol$branch(:$topic)]($style) '` | Format dari modul. | +| `truncation_length` | `2^63 - 1` | Truncates the hg branch / topic name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. | +| `disabled` | `true` | Disables the `hg_branch` module. | ### Variabel -| Variabel | Contoh | Deskripsi | -| --------- | -------- | --------------------------------- | -| branch | `master` | The active mercurial branch | -| symbol | | Menyalin nilai dari opsi `symbol` | -| style\* | | Menyalin nilai dari opsi `style` | +| Variabel | Contoh | Deskripsi | +| --------- | --------- | --------------------------------- | +| branch | `master` | The active mercurial branch | +| topic | `feature` | The active mercurial topic | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | *: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string @@ -2487,7 +2609,7 @@ The `nim` module shows the currently installed version of [Nim](https://nim-lang | Opsi | Bawaan | Deskripsi | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | Format dari modul | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module | | `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `symbol` | `'👑 '` | The symbol used before displaying the version of Nim. | | `detect_extensions` | `['nim', 'nims', 'nimble']` | Ekstensi mana yang sebaiknya memicu modul ini. | @@ -2522,14 +2644,16 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/ ### Opsi -| Opsi | Bawaan | Deskripsi | -| ------------ | ---------------------------------------------- | ----------------------------------------------------- | -| `format` | `'via [$symbol$state( \($name\))]($style) '` | Format dari modul. | -| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | -| `style` | `'bold blue'` | Gaya penataan untuk modul. | -| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | -| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | -| `disabled` | `false` | Disables the `nix_shell` module. | +| Opsi | Bawaan | Deskripsi | +| ------------- | ---------------------------------------------- | --------------------------------------------------------------------- | +| `format` | `'via [$symbol$state( \($name\))]($style) '` | Format dari modul. | +| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | +| `style` | `'bold blue'` | Gaya penataan untuk modul. | +| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | +| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | +| `unknown_msg` | `''` | A format string shown when it is unknown if the shell is pure/impure. | +| `disabled` | `false` | Disables the `nix_shell` module. | +| `heuristic` | `false` | Attempts to detect new `nix shell`-style shells with a heuristic. | ### Variabel @@ -2551,6 +2675,7 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/ disabled = true impure_msg = '[impure shell](bold red)' pure_msg = '[pure shell](bold green)' +unknown_msg = '[unknown shell](bold yellow)' format = 'via [☃️ $state( \($name\))](bold blue) ' ``` @@ -2703,7 +2828,7 @@ The `openstack` module shows the current OpenStack cloud and project. The module | symbol | | Menyalin nilai dari opsi `symbol` | | style\* | | Menyalin nilai dari opsi `style` | -*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string +*: This variable can only be used as a part of a style string ### Contoh @@ -2856,7 +2981,7 @@ The `package` module is shown when the current directory is the repository for a | symbol | | Menyalin nilai dari opsi `symbol` | | style\* | | Menyalin nilai dari opsi `style` | -*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string +*: This variable can only be used as a part of a style string ### Contoh @@ -2911,7 +3036,7 @@ format = 'via [🦪 $version]($style) ' The `php` module shows the currently installed version of [PHP](https://www.php.net/). Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: -- The current directory contains a `composer.json` file +- Direktori ini memiliki berkas `composer.json` - The current directory contains a `.php-version` file - The current directory contains a `.php` extension @@ -2919,7 +3044,7 @@ The `php` module shows the currently installed version of [PHP](https://www.php. | Opsi | Bawaan | Deskripsi | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | -| `format` | `'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` | | `symbol` | `'🐘 '` | The symbol used before displaying the version of PHP. | | `detect_extensions` | `['php']` | Ekstensi mana yang sebaiknya memicu modul ini. | @@ -2936,7 +3061,7 @@ The `php` module shows the currently installed version of [PHP](https://www.php. | symbol | | Menyalin nilai dari opsi `symbol` | | style\* | | Menyalin nilai dari opsi `style` | -*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string +*: This variable can only be used as a part of a style string ### Contoh @@ -2947,6 +3072,21 @@ The `php` module shows the currently installed version of [PHP](https://www.php. format = 'via [🔹 $version](147 bold) ' ``` +## Pijul Channel + +The `pijul_channel` module shows the active channel of the repo in your current directory. + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------------- | --------------------------------- | ------------------------------------------------------------------------------------ | +| `symbol` | `' '` | The symbol used before the pijul channel name of the repo in your current directory. | +| `style` | `'bold purple'` | Gaya penataan untuk modul. | +| `fromat` | `'on [$symbol$channel]($style) '` | Format dari modul. | +| `truncation_length` | `2^63 - 1` | Truncates the pijul channel name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. | +| `disabled` | `true` | Disables the `pijul` module. | + ## Pulumi The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. @@ -2966,7 +3106,7 @@ Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: | Opsi | Bawaan | Deskripsi | | ---------------- | -------------------------------------------- | ----------------------------------------------------------------------------------- | -| `format` | `'via [$symbol($username@)$stack]($style) '` | The format string for the module. | +| `fromat` | `'via [$symbol($username@)$stack]($style) '` | The format string for the module. | | `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `symbol` | `' '` | A format string shown before the Pulumi stack. | | `style` | `'bold 5'` | Gaya penataan untuk modul. | @@ -3016,7 +3156,7 @@ The `purescript` module shows the currently installed version of [PureScript](ht | Opsi | Bawaan | Deskripsi | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | -| `format` | `'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` | | `symbol` | `'<=> '` | The symbol used before displaying the version of PureScript. | | `detect_extensions` | `['purs']` | Ekstensi mana yang sebaiknya memicu modul ini. | @@ -3033,7 +3173,7 @@ The `purescript` module shows the currently installed version of [PureScript](ht | symbol | | Menyalin nilai dari opsi `symbol` | | style\* | | Menyalin nilai dari opsi `style` | -*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string +*: This variable can only be used as a part of a style string ### Contoh @@ -3066,7 +3206,7 @@ Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: | Opsi | Bawaan | Deskripsi | | -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- | -| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | Format dari modul. | +| `fromat` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | Format dari modul. | | `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `symbol` | `'🐍 '` | A format string representing the symbol of Python | | `style` | `'yellow bold'` | Gaya penataan untuk modul. | @@ -3149,7 +3289,7 @@ The `rlang` module shows the currently installed version of [R](https://www.r-pr | Opsi | Bawaan | Deskripsi | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | -| `format` | `'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` | | `symbol` | `'📐'` | A format string representing the symbol of R. | | `style` | `'blue bold'` | Gaya penataan untuk modul. | @@ -3186,7 +3326,7 @@ The `raku` module shows the currently installed version of [Raku](https://www.ra | Opsi | Bawaan | Deskripsi | | ------------------- | ------------------------------------------------ | ----------------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version-$vm_version )]($style)'` | The format string for the module. | +| `fromat` | `'via [$symbol($version-$vm_version )]($style)'` | The format string for the module. | | `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `symbol` | `'🦋 '` | The symbol used before displaying the version of Raku | | `detect_extensions` | `['p6', 'pm6', 'pod6', 'raku', 'rakumod']` | Ekstensi mana yang sebaiknya memicu modul ini. | @@ -3223,7 +3363,7 @@ By default the `red` module shows the currently installed version of [Red](https | Opsi | Bawaan | Deskripsi | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | -| `format` | `'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` | | `symbol` | `'🔺 '` | A format string representing the symbol of Red. | | `detect_extensions` | `['red']` | Ekstensi mana yang sebaiknya memicu modul ini. | @@ -3240,7 +3380,7 @@ By default the `red` module shows the currently installed version of [Red](https | symbol | | Menyalin nilai dari opsi `symbol` | | style\* | | Menyalin nilai dari opsi `style` | -*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string +*: This variable can only be used as a part of a style string ### Contoh @@ -3266,7 +3406,7 @@ Starship gets the current Ruby version by running `ruby -v`. | Opsi | Bawaan | Deskripsi | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | -| `format` | `'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` | | `symbol` | `'💎 '` | A format string representing the symbol of Ruby. | | `detect_extensions` | `['rb']` | Ekstensi mana yang sebaiknya memicu modul ini. | @@ -3306,7 +3446,7 @@ By default the `rust` module shows the currently installed version of [Rust](htt | Opsi | Bawaan | Deskripsi | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | -| `format` | `'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` | | `symbol` | `'🦀 '` | A format string representing the symbol of Rust | | `detect_extensions` | `['rs']` | Ekstensi mana yang sebaiknya memicu modul ini. | @@ -3348,7 +3488,7 @@ The `scala` module shows the currently installed version of [Scala](https://www. | Opsi | Bawaan | Deskripsi | | ------------------- | ---------------------------------------- | ----------------------------------------------------------------------------------- | -| `format` | `'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` | | `detect_extensions` | `['sbt', 'scala']` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_files` | `['.scalaenv', '.sbtenv', 'build.sbt']` | filenames mana yang sebaiknya memicu modul ini. | @@ -3365,7 +3505,7 @@ The `scala` module shows the currently installed version of [Scala](https://www. | symbol | | Menyalin nilai dari opsi `symbol` | | style\* | | Menyalin nilai dari opsi `style` | -*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string +*: This variable can only be used as a part of a style string ### Contoh @@ -3401,7 +3541,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | `cmd_indicator` | `'cmd'` | A format string used to represent cmd. | | `nu_indicator` | `'nu'` | A format string used to represent nu. | | `unknown_indicator` | `''` | The default value to be displayed when the shell is unknown. | -| `format` | `'[$indicator]($style) '` | Format dari modul. | +| `fromat` | `'[$indicator]($style) '` | Format dari modul. | | `style` | `'white bold'` | Gaya penataan untuk modul. | | `disabled` | `true` | Disables the `shell` module. | @@ -3410,7 +3550,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | Variabel | Bawaan | Deskripsi | | --------- | ------ | ---------------------------------------------------------- | | indicator | | Mirrors the value of `indicator` for currently used shell. | -| style\* | | Menyalin nilai dari opsi `style`. | +| style\* | | Mirrors the value of option `style`. | *: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string @@ -3436,7 +3576,7 @@ The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/int | Opsi | Bawaan | Deskripsi | | ----------- | ---------------------------- | ------------------------------------------------------------- | | `threshold` | `2` | Display threshold. | -| `format` | `'[$symbol$shlvl]($style) '` | Format dari modul. | +| `fromat` | `'[$symbol$shlvl]($style) '` | Format dari modul. | | `symbol` | `'↕️ '` | The symbol used to represent the `SHLVL`. | | `repeat` | `false` | Causes `symbol` to be repeated by the current `SHLVL` amount. | | `style` | `'bold yellow'` | Gaya penataan untuk modul. | @@ -3471,7 +3611,7 @@ The `singularity` module shows the current [Singularity](https://sylabs.io/singu | Opsi | Bawaan | Deskripsi | | ---------- | -------------------------------- | ------------------------------------------------ | -| `format` | `'[$symbol\[$env\]]($style) '` | Format dari modul. | +| `fromat` | `'[$symbol\[$env\]]($style) '` | Format dari modul. | | `symbol` | `''` | A format string displayed before the image name. | | `style` | `'bold dimmed blue'` | Gaya penataan untuk modul. | | `disabled` | `false` | Disables the `singularity` module. | @@ -3506,7 +3646,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` artinya tidak ada potongan. Lihat juga modul [`directory`](#directory). | | `symbol` | `'🅢 '` | Simbol yang digunakan sebelum nama environment. | | `style` | `'bold blue'` | Gaya penataan untuk modul. | -| `format` | `'via [$symbol$environment]($style) '` | Format dari modul. | +| `fromat` | `'via [$symbol$environment]($style) '` | Format dari modul. | | `disabled` | `false` | Disables the `spack` module. | ### Variabel @@ -3517,7 +3657,7 @@ The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/lat | symbol | | Menyalin nilai dari opsi `symbol` | | style\* | | Menyalin nilai dari opsi `style` | -*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string +*: This variable can only be used as a part of a style string ### Contoh @@ -3542,7 +3682,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | Opsi | Bawaan | Deskripsi | | --------------------------- | ---------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -| `format` | `'[$symbol$status]($style) '` | The format of the module | +| `fromat` | `'[$symbol$status]($style) '` | The format of the module | | `symbol` | `'❌'` | The symbol displayed on program error | | `success_symbol` | `''` | The symbol displayed on program success | | `not_executable_symbol` | `'🚫'` | The symbol displayed when file isn't executable | @@ -3573,7 +3713,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | symbol | | Menyalin nilai dari opsi `symbol` | | style\* | | Menyalin nilai dari opsi `style` | -*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string +*: This variable can only be used as a part of a style string ### Contoh @@ -3603,7 +3743,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | Opsi | Bawaan | Deskripsi | | --------------- | ------------------------ | ------------------------------------------------------- | -| `format` | `'[as $symbol]($style)'` | The format of the module | +| `fromat` | `'[as $symbol]($style)'` | The format of the module | | `symbol` | `'🧙 '` | The symbol displayed when credentials are cached | | `style` | `'bold blue'` | Gaya penataan untuk modul. | | `allow_windows` | `false` | Since windows has no default sudo, default is disabled. | @@ -3649,7 +3789,7 @@ By default the `swift` module shows the currently installed version of [Swift](h | Opsi | Bawaan | Deskripsi | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | -| `format` | `'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` | | `symbol` | `'🐦 '` | A format string representing the symbol of Swift | | `detect_extensions` | `['swift']` | Ekstensi mana yang sebaiknya memicu modul ini. | @@ -3666,7 +3806,7 @@ By default the `swift` module shows the currently installed version of [Swift](h | symbol | | Menyalin nilai dari opsi `symbol` | | style\* | | Menyalin nilai dari opsi `style` | -*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string +*: This variable can only be used as a part of a style string ### Contoh @@ -3696,7 +3836,7 @@ Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: | Opsi | Bawaan | Deskripsi | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | -| `format` | `'via [$symbol$workspace]($style) '` | The format string for the module. | +| `fromat` | `'via [$symbol$workspace]($style) '` | The format string for the module. | | `version_format` | `'v${raw}'` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `symbol` | `'💠'` | A format string shown before the terraform workspace. | | `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Ekstensi mana yang sebaiknya memicu modul ini. | @@ -3714,7 +3854,7 @@ Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: | symbol | | Menyalin nilai dari opsi `symbol` | | style\* | | Menyalin nilai dari opsi `style` | -*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string +*: This variable can only be used as a part of a style string ### Contoh @@ -3750,7 +3890,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | Opsi | Bawaan | Deskripsi | | ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `format` | `'at [$time]($style) '` | The format string for the module. | +| `fromat` | `'at [$time]($style) '` | The format string for the module. | | `use_12hr` | `false` | Enables 12 hour formatting | | `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. | | `style` | `'bold yellow'` | The style for the module time | @@ -3767,7 +3907,7 @@ If `use_12hr` is `true`, then `time_format` defaults to `'%r'`. Otherwise, it de | time | `13:08:10` | The current time. | | style\* | | Menyalin nilai dari opsi `style` | -*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string +*: This variable can only be used as a part of a style string ### Contoh @@ -3803,7 +3943,7 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, ` | ------------- | ----------------------- | ------------------------------------------- | | `style_root` | `'bold red'` | The style used when the user is root/admin. | | `style_user` | `'bold yellow'` | The style used for non-root users. | -| `format` | `'[$user]($style) in '` | Format dari modul. | +| `fromat` | `'[$user]($style) in '` | Format dari modul. | | `show_always` | `false` | Always shows the `username` module. | | `disabled` | `false` | Disables the `username` module. | @@ -3837,7 +3977,7 @@ The `vagrant` module shows the currently installed version of [Vagrant](https:// | Opsi | Bawaan | Deskripsi | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | -| `format` | `'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` | | `symbol` | `'⍱ '` | A format string representing the symbol of Vagrant. | | `detect_extensions` | `[]` | Ekstensi mana yang sebaiknya memicu modul ini. | @@ -3854,7 +3994,7 @@ The `vagrant` module shows the currently installed version of [Vagrant](https:// | symbol | | Menyalin nilai dari opsi `symbol` | | style\* | | Menyalin nilai dari opsi `style` | -*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string +*: This variable can only be used as a part of a style string ### Contoh @@ -3876,7 +4016,7 @@ The `vlang` module shows you your currently installed version of [V](https://vla | Opsi | Bawaan | Deskripsi | | ------------------- | -------------------------------------------- | ----------------------------------------------------------------------------------- | -| `format` | `'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` | | `symbol` | `'V '` | A format string representing the symbol of V | | `detect_extensions` | `['v']` | Ekstensi mana yang sebaiknya memicu modul ini. | @@ -3911,7 +4051,7 @@ The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/v | ---------- | -------------------------------- | ------------------------------------------------------ | | `symbol` | `''` | The symbol used before displaying the repository name. | | `style` | `'bold yellow'` | Gaya penataan untuk modul. | -| `format` | `'vcsh [$symbol$repo]($style) '` | Format dari modul. | +| `fromat` | `'vcsh [$symbol$repo]($style) '` | Format dari modul. | | `disabled` | `false` | Disables the `vcsh` module. | ### Variabel @@ -3943,7 +4083,7 @@ By default the the `zig` module shows the currently installed version of [Zig](h | Opsi | Bawaan | Deskripsi | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | -| `format` | `'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` | | `symbol` | `'↯ '` | The symbol used before displaying the version of Zig. | | `style` | `'bold yellow'` | Gaya penataan untuk modul. | @@ -3960,7 +4100,7 @@ By default the the `zig` module shows the currently installed version of [Zig](h | symbol | | Menyalin nilai dari opsi `symbol` | | style\* | | Menyalin nilai dari opsi `style` | -*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string +*: This variable can only be used as a part of a style string ### Contoh @@ -4016,13 +4156,13 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt | `command` | `''` | The command whose output should be printed. The command will be passed on stdin to the shell. | | `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. | | `shell` | | [See below](#custom-command-shell) | -| `deskripsi` | `''` | The description of the module that is shown when running `starship explain`. | +| `description` | `''` | The description of the module that is shown when running `starship explain`. | | `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_extensions` | `[]` | The extensions that will be searched in the working directory for a match. | | `symbol` | `''` | The symbol used before displaying the command output. | | `style` | `'bold green'` | Gaya penataan untuk modul. | -| `format` | `'[$symbol($output )]($style)'` | Format dari modul. | +| `fromat` | `'[$symbol($output )]($style)'` | Format dari modul. | | `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). | | `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. | @@ -4036,7 +4176,7 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt | symbol | Menyalin nilai dari opsi `symbol` | | style\* | Menyalin nilai dari opsi `style` | -*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string +*: This variable can only be used as a part of a style string #### Custom command shell diff --git a/docs/id-ID/guide/README.md b/docs/id-ID/guide/README.md index 9808e770..bb0bf950 100644 --- a/docs/id-ID/guide/README.md +++ b/docs/id-ID/guide/README.md @@ -9,7 +9,7 @@

Status alur kerja GitHub Actions @@ -423,6 +423,7 @@ Support this project by [becoming a sponsor](https://github.com/sponsors/starshi **Supporter Tier** - [Dimension](https://dimension.dev/) +- [Appwrite](https://appwrite.io/)


diff --git a/docs/id-ID/installing/README.md b/docs/id-ID/installing/README.md index ebd4312d..2b8b8499 100644 --- a/docs/id-ID/installing/README.md +++ b/docs/id-ID/installing/README.md @@ -15,7 +15,7 @@ There are so many platforms out there that they didn't fit into the main README. Head over to the [Chocolatey installation page](https://chocolatey.org/install) and follow the instructions to install Chocolatey. -### Installation +### Pemasangan ```powershell choco install starship @@ -29,7 +29,7 @@ choco install starship pkg install getconf ``` -### Installation +### Pemasangan ```sh curl -sS https://starship.rs/install.sh | sh -s -- --bin-dir /data/data/com.termux/files/usr/bin @@ -37,7 +37,7 @@ curl -sS https://starship.rs/install.sh | sh -s -- --bin-dir /data/data/com.term ## [Funtoo Linux](https://www.funtoo.org/Welcome) -### Installation +### Pemasangan On Funtoo Linux, starship can be installed from [core-kit](https://github.com/funtoo/core-kit/tree/1.4-release/app-shells/starship) via Portage: diff --git a/docs/id-ID/presets/README.md b/docs/id-ID/presets/README.md index 838e08db..ac15b0b0 100644 --- a/docs/id-ID/presets/README.md +++ b/docs/id-ID/presets/README.md @@ -14,7 +14,11 @@ This preset changes the symbols for each module to use Nerd Font symbols. This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt. -::: tip This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). ::: +::: tip + +This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). + +::: [Click to view No Nerd Font preset](./no-nerd-font) diff --git a/docs/it-IT/README.md b/docs/it-IT/README.md index 3dd18403..25fd57a3 100644 --- a/docs/it-IT/README.md +++ b/docs/it-IT/README.md @@ -149,14 +149,14 @@ description: Starship è il prompt minimalista, super veloce ed estremamente per ::: warning - This will change in the future. Only Nushell v0.61+ is supported. + This will change in the future. Only Nushell v0.73+ is supported. ::: - Add the following to to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell): + Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell): ```sh mkdir ~/.cache/starship - starship init nu | save ~/.cache/starship/init.nu + starship init nu | save -f ~/.cache/starship/init.nu ``` And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`): diff --git a/docs/it-IT/advanced-config/README.md b/docs/it-IT/advanced-config/README.md index b181b0a3..d902e7e6 100644 --- a/docs/it-IT/advanced-config/README.md +++ b/docs/it-IT/advanced-config/README.md @@ -24,15 +24,15 @@ Invoke-Expression (&starship init powershell) Enable-TransientPrompt ``` -## TransientPrompt and TransientRightPrompt in Cmd +## TransientPrompt e TransientRightPrompt in Cmd -Clink allows you to replace the previous-printed prompt with custom strings. È utile nei casi in cui alcune informazioni sulla shell non ci servono. To enable this, run `clink set prompt.transient ` where \ can be one of: +È possibile rimpiazzare il prompt precedente con una stringa di testo personalizzata. È utile nei casi in cui alcune informazioni sulla shell non ci servono. Per attivarlo, esegui `clink set prompt.transient ` dove \ può essere uno tra: -- `always`: always replace the previous prompt -- `same_dir`: replace the previous prompt only if the working directory is same -- `off`: do not replace the prompt (i.e. turn off transience) +- `always`: sostituisce sempre il prompt precedente +- `same_dir`: sostituisce il prompt precedente solo se la directory di lavoro è la stessa +- `off`: non sostituisce il prompt (cioè disattiva la transizione) -You need to do this only once. Make the following changes to your `starship.lua` to customize what gets displayed on the left and on the right: +Devi fare questo solo una volta. Fai le seguenti modifiche alla tua `starship.lua` per personalizzare ciò che viene visualizzato a sinistra e a destra: - Per impostazione predefinita, il simbolo predefinito prima dell'input sarà rimpiazzato con `>`. To customize this, define a new function called `starship_transient_prompt_func`. This function receives the current prompt as a string that you can utilize. Ad esempio, per mostrare il modulo dei `character`, dovresti fare @@ -207,8 +207,6 @@ Note: The right prompt is a single line following the input location. To right a `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell. -Note: Nushell 0.71.0 or later is required - ### Esempio ```toml @@ -231,7 +229,7 @@ Produces a prompt like the following: Some shells support a continuation prompt along with the normal prompt. This prompt is rendered instead of the normal prompt when the user has entered an incomplete statement (such as a single left parenthesis or quote). -Starship can set the continuation prompt using the `continuation_prompt` option. The default prompt is `"[∙](bright-black) "`. +Starship can set the continuation prompt using the `continuation_prompt` option. The default prompt is `'[∙](bright-black) '`. Note: `continuation_prompt` should be set to a literal string without any variables. @@ -247,7 +245,7 @@ Note: Continuation prompts are only available in the following shells: # ~/.config/starship.toml # A continuation prompt that displays two filled in arrows -continuation_prompt = "▶▶" +continuation_prompt = '▶▶ ' ``` ## Stile delle Stringhe diff --git a/docs/it-IT/config/README.md b/docs/it-IT/config/README.md index 80f4f4b0..d7a7c29a 100644 --- a/docs/it-IT/config/README.md +++ b/docs/it-IT/config/README.md @@ -252,12 +252,14 @@ $singularity\ $kubernetes\ $directory\ $vcsh\ +$fossil_branch\ $git_branch\ $git_commit\ $git_state\ $git_metrics\ $git_status\ $hg_branch\ +$pijul_channel\ $docker_context\ $package\ $c\ @@ -270,6 +272,7 @@ $dotnet\ $elixir\ $elm\ $erlang\ +$fennel\ $golang\ $guix_shell\ $haskell\ @@ -278,6 +281,7 @@ $helm\ $java\ $julia\ $kotlin\ +$gradle\ $lua\ $nim\ $nodejs\ @@ -1305,6 +1309,12 @@ The `env_var` module displays the current value of a selected environment variab ::: tip +The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. + +::: + +::: 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 @@ -1320,13 +1330,14 @@ default = 'unknown user' ### Opzioni -| Opzione | Default | Descrizione | -| ---------- | ------------------------------ | ---------------------------------------------------------------------------- | -| `symbol` | `''` | The symbol used before displaying the variable value. | -| `variable` | | The environment variable to be displayed. | -| `default` | | The default value to be displayed when the selected variable is not defined. | -| `format` | `'with [$env_value]($style) '` | The format for the module. | -| `disabled` | `false` | Disables the `env_var` module. | +| Opzione | Default | Descrizione | +| ------------- | ------------------------------ | ---------------------------------------------------------------------------- | +| `symbol` | `""` | The symbol used before displaying the variable value. | +| `variable` | | The environment variable to be displayed. | +| `default` | | The default value to be displayed when the selected variable is not defined. | +| `format` | `"with [$env_value]($style) "` | The format for the module. | +| `description` | `""` | The description of the module that is shown when running `starship explain`. | +| `disabled` | `false` | Disables the `env_var` module. | ### Variables @@ -1399,6 +1410,44 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https: format = 'via [e $version](bold red) ' ``` +## Fennel + +The `fennel` module shows the currently installed version of [Fennel](https://fennel-lang.org). By default the module will be shown if any of the following conditions are met: + +- The current directory contains a file with the `.fnl` extension + +### Opzioni + +| Opzione | Default | Descrizione | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `version_format` | `'v${raw}'` | Il formato della versione. Le variabili disponibili sono `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. | +| `style` | `'bold green'` | Lo stile per il modulo. | +| `detect_extensions` | `[fnl]` | Quali estensioni dovrebbero attivare questo modulo. | +| `detect_files` | `[]` | Quali nomi di file dovrebbero attivare questo modulo. | +| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `disabled` | `false` | Disables the `fennel` module. | + +### Variables + +| Variable | Esempio | Descrizione | +| --------- | -------- | ------------------------------------ | +| version | `v1.2.1` | The version of `fennel` | +| symbol | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | + +*: This variable can only be used as a part of a style string + +### Esempio + +```toml +# ~/.config/starship.toml + +[fennel] +symbol = '⫰ ' +``` + ## Fill The `fill` module fills any extra space on the line with a symbol. If multiple `fill` modules are present in a line they will split the space evenly between them. This is useful for aligning other modules. @@ -1428,6 +1477,42 @@ Produces a prompt that looks like: AA -------------------------------------------- BB -------------------------------------------- CC ``` +## Fossil Branch + +The `fossil_branch` module shows the name of the active branch of the check-out in your current directory. + +### Opzioni + +| Opzione | Default | Descrizione | +| ------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | +| `format` | `'on [$symbol$branch]($style) '` | The format for the module. Use `'$branch'` to refer to the current branch name. | +| `symbol` | `' '` | The symbol used before the branch name of the check-out in your current directory. | +| `style` | `'bold purple'` | Lo stile per il modulo. | +| `truncation_length` | `2^63 - 1` | Truncates a Fossil branch name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. | +| `disabled` | `true` | Disables the `fossil_branch` module. | + +### Variables + +| Variable | Esempio | Descrizione | +| --------- | ------- | ------------------------------------ | +| branch | `trunk` | The active Fossil branch | +| symbol | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | + +*: This variable can only be used as a part of a style string + +### Esempio + +```toml +# ~/.config/starship.toml + +[fossil_branch] +symbol = '🦎 ' +truncation_length = 4 +truncation_symbol = '' +``` + ## Google Cloud (`gcloud`) The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var. @@ -1562,10 +1647,11 @@ The `git_commit` module shows the current commit hash and also the tag (if any) ### Variables -| Variable | Esempio | Descrizione | -| --------- | --------- | ----------------------------------- | -| hash | `b703eb3` | The current git commit hash | -| style\* | | Mirrors the value of option `style` | +| Variable | Esempio | Descrizione | +| --------- | --------- | -------------------------------------------- | +| hash | `b703eb3` | The current git commit hash | +| tag | `v1.0.0` | The tag name if showing tag info is enabled. | +| style\* | | Mirrors the value of option `style` | *: This variable can only be used as a part of a style string @@ -1840,6 +1926,41 @@ disabled = true format = 'via [🐂](yellow bold) ' ``` +## Gradle + +The `gradle` module shows the version of the [Gradle Wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html) currently used in the project directory. + +By default the module will be shown if any of the following conditions are met: + +- The current directory contains a `gradle/wrapper/gradle-wrapper.properties` directory. +- The current directory contains a file ending with `.gradle` or `.gradle.kts`. + +The `gradle` module is only able to read your Gradle Wrapper version from your config file, we don't execute your wrapper, because of the security concerns. + +### Opzioni + +| Opzione | Default | Descrizione | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `"v${raw}"` | Il formato della versione. Le variabili disponibili sono `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🅶 "` | A format string representing the symbol of Gradle. | +| `detect_extensions` | `["gradle", "gradle.kts"]` | Quali estensioni dovrebbero attivare questo modulo. | +| `detect_files` | `[]` | Quali nomi di file dovrebbero attivare questo modulo. | +| `detect_folders` | `["gradle"]` | Quali cartelle dovrebbero attivare questo modulo. | +| `style` | `"bold bright-cyan"` | Lo stile per il modulo. | +| `disabled` | `false` | Disables the `gradle` module. | +| `recursive` | `false` | Enables recursive finding for the `gradle` directory. | + +### Variables + +| Variable | Esempio | Descrizione | +| -------- | -------- | ------------------------------------ | +| version | `v7.5.1` | The version of `gradle` | +| 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 + ## Haskell The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot. @@ -2440,26 +2561,27 @@ style = 'bold dimmed green' ## Mercurial Branch -The `hg_branch` module shows the active branch of the repo in your current directory. +The `hg_branch` module shows the active branch and topic of the repo in your current directory. ### Opzioni -| Opzione | Default | Descrizione | -| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------- | -| `symbol` | `' '` | The symbol used before the hg bookmark or branch name of the repo in your current directory. | -| `style` | `'bold purple'` | Lo stile per il modulo. | -| `format` | `'on [$symbol$branch]($style) '` | The format for the module. | -| `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. | -| `disabled` | `true` | Disables the `hg_branch` module. | +| Opzione | Default | Descrizione | +| ------------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------- | +| `symbol` | `' '` | The symbol used before the hg bookmark or branch name of the repo in your current directory. | +| `style` | `'bold purple'` | Lo stile per il modulo. | +| `format` | `'on [$symbol$branch(:$topic)]($style) '` | The format for the module. | +| `truncation_length` | `2^63 - 1` | Truncates the hg branch / topic name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. | +| `disabled` | `true` | Disables the `hg_branch` module. | ### Variables -| Variable | Esempio | Descrizione | -| --------- | -------- | ------------------------------------ | -| branch | `master` | The active mercurial branch | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| Variable | Esempio | Descrizione | +| --------- | --------- | ------------------------------------ | +| branch | `master` | The active mercurial branch | +| topic | `feature` | The active mercurial topic | +| 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 @@ -2522,14 +2644,16 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/ ### Opzioni -| Opzione | Default | Descrizione | -| ------------ | ---------------------------------------------- | ----------------------------------------------------- | -| `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. | -| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | -| `style` | `'bold blue'` | Lo stile per il modulo. | -| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | -| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | -| `disabled` | `false` | Disables the `nix_shell` module. | +| Opzione | Default | Descrizione | +| ------------- | ---------------------------------------------- | --------------------------------------------------------------------- | +| `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. | +| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | +| `style` | `'bold blue'` | Lo stile per il modulo. | +| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | +| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | +| `unknown_msg` | `''` | A format string shown when it is unknown if the shell is pure/impure. | +| `disabled` | `false` | Disables the `nix_shell` module. | +| `heuristic` | `false` | Attempts to detect new `nix shell`-style shells with a heuristic. | ### Variables @@ -2551,6 +2675,7 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/ disabled = true impure_msg = '[impure shell](bold red)' pure_msg = '[pure shell](bold green)' +unknown_msg = '[unknown shell](bold yellow)' format = 'via [☃️ $state( \($name\))](bold blue) ' ``` @@ -2845,8 +2970,8 @@ The `package` module is shown when the current directory is the repository for a | `symbol` | `'📦 '` | The symbol used before displaying the version the package. | | `version_format` | `'v${raw}'` | Il formato della versione. Le variabili disponibili sono `raw`, `major`, `minor`, & `patch` | | `style` | `'bold 208'` | Lo stile per il modulo. | -| `display_private` | `false` | Abilita la visualizzazione della versione per i pacchetti contrassegnati come privati. | -| `disabled` | `false` | Disabilita il modulo `package`. | +| `display_private` | `false` | Enable displaying version for packages marked as private. | +| `disabled` | `false` | Disables the `package` module. | ### Variables @@ -2879,16 +3004,16 @@ The `perl` module shows the currently installed version of [Perl](https://www.pe ### Opzioni -| Opzione | Default | Descrizione | -| ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format string for the module. | -| `version_format` | `'v${raw}'` | Il formato della versione. Le variabili disponibili sono `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'🐪 '` | The symbol used before displaying the version of Perl | -| `detect_extensions` | `['pl', 'pm', 'pod']` | Quali estensioni dovrebbero attivare questo modulo. | -| `detect_files` | `['Makefile.PL', 'Build.PL', 'cpanfile', 'cpanfile.snapshot', 'META.json', 'META.yml', '.perl-version']` | Quali nomi di file dovrebbero attivare questo modulo. | -| `detect_folders` | `[]` | Quali cartelle dovrebbero attivare questo modulo. | -| `style` | `'bold 149'` | Lo stile per il modulo. | -| `disabled` | `false` | Disables the `perl` module. | +| Opzione | Default | Descrizione | +| ------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | The format string for the module. | +| `version_format` | `'v${raw}'` | Il formato della versione. Le variabili disponibili sono `raw`, `major`, `minore`, & `patch` | +| `symbol` | `'🐪 '` | The symbol used before displaying the version of Perl | +| `detect_extensions` | `['pl', 'pm', 'pod']` | Quali estensioni dovrebbero attivare questo modulo. | +| `detect_files` | `['Makefile.PL', 'Build.PL', 'cpanfile', 'cpanfile.snapshot', 'META.json', 'META.yml', '.perl-version']` | Quali nomi di file dovrebbero attivare questo modulo. | +| `detect_folders` | `[]` | Quali cartelle dovrebbero attivare questo modulo. | +| `style` | `'bold 149'` | Lo stile per il modulo. | +| `disabled` | `false` | Disables the `perl` module. | ### Variables @@ -2947,6 +3072,21 @@ The `php` module shows the currently installed version of [PHP](https://www.php. format = 'via [🔹 $version](147 bold) ' ``` +## Pijul Channel + +The `pijul_channel` module shows the active channel of the repo in your current directory. + +### Opzioni + +| Opzione | Default | Descrizione | +| ------------------- | --------------------------------- | ------------------------------------------------------------------------------------ | +| `symbol` | `' '` | The symbol used before the pijul channel name of the repo in your current directory. | +| `style` | `'bold purple'` | Lo stile per il modulo. | +| `format` | `'on [$symbol$channel]($style) '` | The format for the module. | +| `truncation_length` | `2^63 - 1` | Truncates the pijul channel name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. | +| `disabled` | `true` | Disables the `pijul` module. | + ## Pulumi The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. @@ -3014,16 +3154,16 @@ The `purescript` module shows the currently installed version of [PureScript](ht ### Opzioni -| Opzione | Default | Descrizione | -| ------------------- | ------------------------------------ | -------------------------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | -| `version_format` | `'v${raw}'` | Il formato della versione. Le variabili disponibili sono `raw`, `major`, `minore`, & `patch` | -| `symbol` | `'<=> '` | The symbol used before displaying the version of PureScript. | -| `detect_extensions` | `['purs']` | Quali estensioni dovrebbero attivare questo modulo. | -| `detect_files` | `['spago.dhall']` | Quali nomi di file dovrebbero attivare questo modulo. | -| `detect_folders` | `[]` | Quali cartelle dovrebbero attivare questo modulo. | -| `style` | `'bold white'` | Lo stile per il modulo. | -| `disabled` | `false` | Disables the `purescript` module. | +| Opzione | Default | Descrizione | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `version_format` | `'v${raw}'` | Il formato della versione. Le variabili disponibili sono `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'<=> '` | The symbol used before displaying the version of PureScript. | +| `detect_extensions` | `['purs']` | Quali estensioni dovrebbero attivare questo modulo. | +| `detect_files` | `['spago.dhall']` | Quali nomi di file dovrebbero attivare questo modulo. | +| `detect_folders` | `[]` | Quali cartelle dovrebbero attivare questo modulo. | +| `style` | `'bold white'` | Lo stile per il modulo. | +| `disabled` | `false` | Disables the `purescript` module. | ### Variables @@ -3764,7 +3904,7 @@ If `use_12hr` is `true`, then `time_format` defaults to `'%r'`. Otherwise, it de | Variable | Esempio | Descrizione | | --------- | ---------- | ----------------------------------- | -| ora | `13:08:10` | The current time. | +| time | `13:08:10` | The current time. | | style\* | | Mirrors the value of option `style` | *: This variable can only be used as a part of a style string @@ -3878,12 +4018,12 @@ The `vlang` module shows you your currently installed version of [V](https://vla | ------------------- | -------------------------------------------- | ------------------------------------------------------------------------------------------- | | `format` | `'via [$symbol($version )]($style)'` | The format for the module. | | `version_format` | `'v${raw}'` | Il formato della versione. Le variabili disponibili sono `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'V '` | Una stringa di formato che rappresenta il simbolo di V | +| `symbol` | `'V '` | A format string representing the symbol of V | | `detect_extensions` | `['v']` | Quali estensioni dovrebbero attivare questo modulo. | | `detect_files` | `['v.mod', 'vpkg.json', '.vpkg-lock.json' ]` | Quali nomi di file dovrebbero attivare questo modulo. | | `detect_folders` | `[]` | Quali cartelle dovrebbero attivare questo modulo. | | `style` | `'blu grassetto'` | Lo stile per il modulo. | -| `disabled` | `false` | Disabilita il modulo `vlang`. | +| `disabled` | `false` | Disables the `vlang` module. | ### Variables @@ -4016,7 +4156,7 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt | `command` | `''` | The command whose output should be printed. The command will be passed on stdin to the shell. | | `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. | | `shell` | | [See below](#custom-command-shell) | -| `descrizione` | `''` | The description of the module that is shown when running `starship explain`. | +| `description` | `''` | The description of the module that is shown when running `starship explain`. | | `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_extensions` | `[]` | The extensions that will be searched in the working directory for a match. | diff --git a/docs/it-IT/guide/README.md b/docs/it-IT/guide/README.md index c371d77e..deade1a3 100644 --- a/docs/it-IT/guide/README.md +++ b/docs/it-IT/guide/README.md @@ -9,7 +9,7 @@

GitHub Actions workflow status @@ -423,6 +423,7 @@ Support this project by [becoming a sponsor](https://github.com/sponsors/starshi **Supporter Tier** - [Dimension](https://dimension.dev/) +- [Appwrite](https://appwrite.io/)


diff --git a/docs/it-IT/presets/README.md b/docs/it-IT/presets/README.md index 2b215073..532d5c7d 100644 --- a/docs/it-IT/presets/README.md +++ b/docs/it-IT/presets/README.md @@ -14,7 +14,11 @@ This preset changes the symbols for each module to use Nerd Font symbols. This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt. -::: tip This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). ::: +::: tip + +This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). + +::: [Click to view No Nerd Font preset](./no-nerd-font) diff --git a/docs/ja-JP/README.md b/docs/ja-JP/README.md index 63cf0283..7e8d44be 100644 --- a/docs/ja-JP/README.md +++ b/docs/ja-JP/README.md @@ -4,7 +4,7 @@ heroImage: /logo.svg heroText: tagline: シェル用の最小限の、非常に高速で、無限にカスタマイズ可能なプロンプトです！ actionText: Get Started → -actionLink: ./ja-JP/guide/ +actionLink: ./guide/ features: - title: 互換性優先 @@ -149,14 +149,14 @@ description: Starship はミニマルで、非常に高速で、カスタマイ ::: warning - これは将来的に変更される可能性があります。 Nushell v0.61+ のみサポートされています。 + これは将来的に変更される可能性があります。 Nushell v0.73+ のみサポートされています。 ::: - そして、Nushellの設定ファイルの最後に以下を追加してください（ `$nu.env-path` を実行してください）: + Nushellの環境ファイルの最後に以下を追記してください ( `$nu.env-path` を実行してください): ```sh mkdir ~/.cache/starship - starship init nu | save ~/.cache/starship/init.nu + starship init nu | save -f ~/.cache/starship/init.nu ``` そして、Nushellの設定ファイルの最後に以下を追記してください (`$nu.config-path` を実行してください): diff --git a/docs/ja-JP/advanced-config/README.md b/docs/ja-JP/advanced-config/README.md index 4669b10b..2831d1bc 100644 --- a/docs/ja-JP/advanced-config/README.md +++ b/docs/ja-JP/advanced-config/README.md @@ -91,7 +91,7 @@ function starship_preprompt_user_func(prompt) print("🚀") end -load(io.popen('starship init cmd'):read("*a"))() +load(io.popen('starship init cmd'):read("*a")() ``` - To run a custom function right before a command is executed, define a new function called `starship_precmd_user_func`. This function receives the current commandline as a string that you can utilize. For example, to print the command that's about to be executed, you would do @@ -207,8 +207,6 @@ Invoke-Expression (&starship init powershell) `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell. -Note: Nushell 0.71.0 or later is required - ### 設定例 ```toml @@ -231,7 +229,7 @@ right_format = """$all""" Some shells support a continuation prompt along with the normal prompt. This prompt is rendered instead of the normal prompt when the user has entered an incomplete statement (such as a single left parenthesis or quote). -Starship can set the continuation prompt using the `continuation_prompt` option. The default prompt is `"[∙](bright-black) "`. +Starship can set the continuation prompt using the `continuation_prompt` option. The default prompt is `'[∙](bright-black) '`. Note: `continuation_prompt` should be set to a literal string without any variables. @@ -247,7 +245,7 @@ Note: Continuation prompts are only available in the following shells: # ~/.config/starship.toml # A continuation prompt that displays two filled in arrows -continuation_prompt = "▶▶" +continuation_prompt = '▶▶ ' ``` ## スタイルの設定 diff --git a/docs/ja-JP/config/README.md b/docs/ja-JP/config/README.md index b177b4b0..986fe205 100644 --- a/docs/ja-JP/config/README.md +++ b/docs/ja-JP/config/README.md @@ -252,12 +252,14 @@ $singularity\ $kubernetes\ $directory\ $vcsh\ +$fossil_branch\ $git_branch\ $git_commit\ $git_state\ $git_metrics\ $git_status\ $hg_branch\ +$pijul_channel\ $docker_context\ $package\ $c\ @@ -270,6 +272,7 @@ $dotnet\ $elixir\ $elm\ $erlang\ +$fennel\ $golang\ $guix_shell\ $haskell\ @@ -278,6 +281,7 @@ $helm\ $java\ $julia\ $kotlin\ +$gradle\ $lua\ $nim\ $nodejs\ @@ -1305,6 +1309,12 @@ format = 'via [ $version](cyan bold) ' ::: tip +The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. + +::: + +::: tip + `.`を使うことで複数の環境変数を表示することができます。 (例を確認してみてください) `variable`が設定されていない場合、このモジュールは`.`以降に書かれている環境変数の値を表示します。 例: 次の設定ではUSER環境変数を表示します。 @@ -1320,13 +1330,14 @@ default = 'unknown user' ### オプション -| オプション | デフォルト | 説明 | -| ---------- | ------------------------------ | ------------------------------------- | -| `symbol` | `''` | 環境変数を表示する前に使用される記号です。 | -| `variable` | | 表示される環境変数です。 | -| `default` | | 上のvariableが定義されていない場合に表示されるデフォルトの値です。 | -| `format` | `'with [$env_value]($style) '` | module のフォーマットです。 | -| `disabled` | `false` | `env_var`モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| ------------- | ------------------------------ | ---------------------------------------------------------------------------- | +| `symbol` | `""` | 環境変数を表示する前に使用される記号です。 | +| `variable` | | 表示される環境変数です。 | +| `default` | | 上のvariableが定義されていない場合に表示されるデフォルトの値です。 | +| `format` | `"with [$env_value]($style) "` | module のフォーマットです。 | +| `description` | `""` | The description of the module that is shown when running `starship explain`. | +| `disabled` | `false` | `env_var`モジュールを無効にします。 | ### 変数 @@ -1399,6 +1410,44 @@ default = 'unknown user' format = 'via [e $version](bold red) ' ``` +## Fennel + +The `fennel` module shows the currently installed version of [Fennel](https://fennel-lang.org). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 + +- The current directory contains a file with the `.fnl` extension + +### オプション + +| オプション | デフォルト | 説明 | +| ------------------- | ------------------------------------ | -------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | module のフォーマットです。 | +| `version_format` | `'v${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | +| `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. | +| `style` | `'bold green'` | モジュールのスタイルです。 | +| `detect_extensions` | `[fnl]` | どの拡張子がこのモジュールをアクティブにするか | +| `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか | +| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | +| `disabled` | `false` | Disables the `fennel` module. | + +### 変数 + +| 変数 | 設定例 | 説明 | +| --------- | -------- | ----------------------- | +| version | `v1.2.1` | The version of `fennel` | +| symbol | | オプション `symbol` の値をミラーする | +| style\* | | オプション `style` の値をミラーする | + +*: この変数は、スタイル文字列の一部としてのみ使用することができます。 + +### 設定例 + +```toml +# ~/.config/starship.toml + +[fennel] +symbol = '⫰ ' +``` + ## Fill `fill` モジュールは行の余分なスペースを記号で埋めます。 一行に複数の`fill`モジュールが存在する場合、それらはスペースを均等に分割します。 これは、他のモジュールの位置合わせに便利です。 @@ -1428,32 +1477,68 @@ style = 'bold green' AA -------------------------------------------- BB -------------------------------------------- CC ``` -## Google Cloud (`gcloud`) +## Fossil Branch -`gcloud` モジュールは、 [`gcloud`](https://cloud.google.com/sdk/gcloud) CLIの現在の設定が表示されます。 これは `~/.config/gcloud/active_config` ファイルと `~/.config/gcloud/configurations/config_{CONFIG NAME}` ファイルと `CLOUDSDK_CONFIG` 環境変数に基づきます。 +The `fossil_branch` module shows the name of the active branch of the check-out in your current directory. ### オプション -| オプション | デフォルト | 説明 | -| ----------------- | ---------------------------------------------------------- | ----------------------------- | -| `format` | `'on [$symbol$account(@$domain)(\($region\))]($style) '` | module のフォーマットです。 | -| `symbol` | `'☁️ '` | 現在のGCPプロファイルを表示する前に表示される記号です。 | -| `region_aliases` | `{}` | GCP名に加えて表示するリージョンのエイリアスです。 | -| `project_aliases` | `{}` | GCP名に加えて表示するプロジェクトのエイリアスです。 | -| `style` | `'bold blue'` | モジュールのスタイルです。 | -| `disabled` | `false` | `gcloud`モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| ------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | +| `format` | `'on [$symbol$branch]($style) '` | module のフォーマットです。 Use `'$branch'` to refer to the current branch name. | +| `symbol` | `' '` | The symbol used before the branch name of the check-out in your current directory. | +| `style` | `'bold purple'` | モジュールのスタイルです。 | +| `truncation_length` | `2^63 - 1` | Truncates a Fossil branch name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. | +| `disabled` | `true` | Disables the `fossil_branch` module. | ### 変数 -| 変数 | 設定例 | 説明 | -| --------- | ------------- | ----------------------------------------------- | -| region | `us-central1` | 現在のGCPリージョン | -| account | `foo` | 現在のGCPプロファイル | -| domain | `example.com` | 現在のGCPプロファイルのドメイン | -| project | | 現在のGCPプロジェクト | -| active | `default` | `~/.config/gcloud/active_config` に書かれたアクティブな設定名 | -| symbol | | オプション `symbol` の値をミラーする | -| style\* | | オプション `style` の値をミラーする | +| 変数 | 設定例 | 説明 | +| --------- | ------- | ------------------------ | +| branch | `trunk` | The active Fossil branch | +| symbol | | オプション `symbol` の値をミラーする | +| style\* | | オプション `style` の値をミラーする | + +*: この変数は、スタイル文字列の一部としてのみ使用することができます。 + +### 設定例 + +```toml +# ~/.config/starship.toml + +[fossil_branch] +symbol = '🦎 ' +truncation_length = 4 +truncation_symbol = '' +``` + +## Google Cloud (`gcloud`) + +The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var. + +### オプション + +| オプション | デフォルト | 説明 | +| ----------------- | ---------------------------------------------------------- | ---------------------------------------------------------------- | +| `format` | `'on [$symbol$account(@$domain)(\($region\))]($style) '` | module のフォーマットです。 | +| `symbol` | `'☁️ '` | The symbol used before displaying the current GCP profile. | +| `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. | +| `style` | `'bold blue'` | モジュールのスタイルです。 | +| `disabled` | `false` | Disables the `gcloud` module. | + +### 変数 + +| 変数 | 設定例 | 説明 | +| --------- | ------------- | ------------------------------------------------------------------ | +| region | `us-central1` | The current GCP region | +| account | `foo` | The current GCP profile | +| domain | `example.com` | The current GCP profile domain | +| project | | The current GCP project | +| active | `default` | The active config name written in `~/.config/gcloud/active_config` | +| symbol | | オプション `symbol` の値をミラーする | +| style\* | | オプション `style` の値をミラーする | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -1503,31 +1588,31 @@ very-long-project-name = 'vlpn' ## Git Branch -`git_branch`モジュールは、現在のディレクトリにあるリポジトリのアクティブなブランチを表示します。 +The `git_branch` module shows the active branch of the repo in your current directory. ### オプション -| オプション | デフォルト | 説明 | -| -------------------- | ------------------------------------------------- | ---------------------------------------------------------------------- | -| `always_show_remote` | `false` | ローカルブランチ名と等しい場合でも、リモート追跡ブランチ名を表示します。 | -| `format` | `'on [$symbol$branch(:$remote_branch)]($style) '` | module のフォーマットです。 Use `'$branch'` to refer to the current branch name. | -| `symbol` | `' '` | gitブランチのシンボルを表すフォーマット文字列。 | -| `style` | `'bold purple'` | モジュールのスタイルです。 | -| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | -| `truncation_symbol` | `'…'` | ブランチ名切り捨てられていることを示すための記号です。 You can use `''` for no symbol. | -| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | -| `ignore_branches` | `[]` | 表示しない名前のリスト。 Useful for 'master' or 'main'. | -| `disabled` | `false` | `git_branch`モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| -------------------- | ------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | +| `format` | `'on [$symbol$branch(:$remote_branch)]($style) '` | module のフォーマットです。 Use `'$branch'` to refer to the current branch name. | +| `symbol` | `' '` | A format string representing the symbol of git branch. | +| `style` | `'bold purple'` | モジュールのスタイルです。 | +| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. | +| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | +| `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. | +| `disabled` | `false` | Disables the `git_branch` module. | ### 変数 -| 変数 | 設定例 | 説明 | -| ------------- | -------- | ---------------------------------------------------------- | -| branch | `master` | 現在のブランチがない場合は、現在のブランチ名は`HEAD`に戻ります(例: git detached `HEAD`) | -| remote_name | `origin` | リモート名 | -| remote_branch | `master` | `remote_name`で追跡されたブランチ名 | -| symbol | | オプション `symbol` の値をミラーする | -| style\* | | オプション `style` の値をミラーする | +| 変数 | 設定例 | 説明 | +| ------------- | -------- | ------------------------------------------------------------------------------------------------------ | +| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached `HEAD`). | +| remote_name | `origin` | The remote name. | +| remote_branch | `master` | The name of the branch tracked on `remote_name`. | +| symbol | | オプション `symbol` の値をミラーする | +| style\* | | オプション `style` の値をミラーする | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -1543,29 +1628,30 @@ truncation_symbol = '' ignore_branches = ['master', 'main'] ``` -## Git Commit +## Git コミット -`git_commit` モジュールは、カレントディレクトリのリポジトリの現在のコミットハッシュとタグ (もしあれば) を表示します。 +The `git_commit` module shows the current commit hash and also the tag (if any) of the repo in your current directory. ### オプション | オプション | デフォルト | 説明 | | -------------------- | ------------------------------ | ------------------------------------------------------------------------------------ | -| `commit_hash_length` | `7` | 表示される git コミットハッシュの長さ。 | +| `commit_hash_length` | `7` | The length of the displayed git commit hash. | | `format` | `'[\($hash$tag\)]($style) '` | module のフォーマットです。 | | `style` | `'bold green'` | モジュールのスタイルです。 | -| `only_detached` | `true` | detached `HEAD` 状態のときのみ git コミットハッシュを表示する | -| `tag_disabled` | `true` | `git_commit` モジュールのタグ情報の表示を無効にする。 | +| `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_max_candidates` | `0` | How many commits to consider for tag display. The default only allows exact matches. | -| `tag_symbol` | `' 🏷 '` | 表示される情報の前に追加されるタグシンボル | -| `disabled` | `false` | `git_commit` モジュールを無効にします。 | +| `tag_symbol` | `' 🏷 '` | Tag symbol prefixing the info shown | +| `disabled` | `false` | Disables the `git_commit` module. | ### 変数 -| 変数 | 設定例 | 説明 | -| --------- | --------- | ---------------------- | -| hash | `b703eb3` | 現在の git コミットハッシュ | -| style\* | | オプション `style` の値をミラーする | +| 変数 | 設定例 | 説明 | +| --------- | --------- | -------------------------------------------- | +| hash | `b703eb3` | The current git commit hash | +| tag | `v1.0.0` | The tag name if showing tag info is enabled. | +| style\* | | オプション `style` の値をミラーする | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -1581,31 +1667,31 @@ tag_symbol = '🔖 ' ## Git State -`git_state`モジュールはgitディレクトリの進行状態を表します。 (例: _REBASING_, _BISECTING_, その他) 進行状況の情報がある場合は (例:REBASING 3/10)、その情報も表示されます。 +The `git_state` module will show in directories which are part of a git repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. If there is progress information (e.g., REBASING 3/10), that information will be shown too. ### オプション -| オプション | デフォルト | 説明 | -| -------------- | --------------------------------------------------------------- | -------------------------------------------------------- | -| `rebase` | `'REBASING'` | `rebase`進行中に表示されるフォーマット文字列です。 | -| `merge` | `'MERGING'` | `merge`進行中に表示されるフォーマット文字列です。 | -| `revert` | `'REVERTING'` | `revert`進行中に表示されるフォーマット文字列です。 | -| `cherry_pick` | `'CHERRY-PICKING'` | `cherry-pick`進行中に表示されるフォーマット文字列です。 | -| `bisect` | `'BISECTING'` | `bisect`進行中に表示されるフォーマット文字列です。 | -| `am` | `'AM'` | `apply-mailbox` (`git am`) 進行中に表示されるフォーマット文字列です。 | -| `am_or_rebase` | `'AM/REBASE'` | あいまいな`apply-mailbox`または`rebase`が進行中のときに表示されるフォーマット文字列です。 | -| `style` | `'bold yellow'` | モジュールのスタイルです。 | -| `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | module のフォーマットです。 | -| `disabled` | `false` | `git_state`モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| -------------- | --------------------------------------------------------------- | --------------------------------------------------------------------------------------- | +| `rebase` | `'REBASING'` | A format string displayed when a `rebase` is in progress. | +| `merge` | `'MERGING'` | A format string displayed when a `merge` is in progress. | +| `revert` | `'REVERTING'` | A format string displayed when a `revert` is in progress. | +| `cherry_pick` | `'CHERRY-PICKING'` | A format string displayed when a `cherry-pick` is in progress. | +| `bisect` | `'BISECTING'` | A format string displayed when a `bisect` is in progress. | +| `am` | `'AM'` | A format string displayed when an `apply-mailbox` (`git am`) is in progress. | +| `am_or_rebase` | `'AM/REBASE'` | A format string displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. | +| `style` | `'bold yellow'` | モジュールのスタイルです。 | +| `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | module のフォーマットです。 | +| `disabled` | `false` | Disables the `git_state` module. | ### 変数 -| 変数 | 設定例 | 説明 | -| ---------------- | ---------- | ---------------------- | -| state | `REBASING` | 現在のリポジトリの状態 | -| progress_current | `1` | 現在の進行状態 | -| progress_total | `2` | 全体の進行状態 | -| style\* | | オプション `style` の値をミラーする | +| 変数 | 設定例 | 説明 | +| ---------------- | ---------- | ------------------------------ | +| state | `REBASING` | The current state of the repo | +| progress_current | `1` | The current operation progress | +| progress_total | `2` | The total operation progress | +| style\* | | オプション `style` の値をミラーする | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -1625,7 +1711,7 @@ The `git_metrics` module will show the number of added and deleted lines in the ::: tip -このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで `disabled` を `false` に設定します。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -1662,38 +1748,38 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) ' ## Git Status -`git_status` モジュールは、カレントディレクトリのリポジトリの状態を表すシンボルを表示します。 +The `git_status` module shows symbols representing the state of the repo in your current directory. ::: tip -WSL環境のWindowsディレクトリ(例: `/mnt/c/`以下) では、Git Statusモジュールは動作が非常に遅いです。 モジュールを無効にするか、`windows_starship`オプションを使用することで、WindowsネイティブのStarshipを使用し、対象の`git_status`を計算できます。 +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. ::: ### オプション -| オプション | デフォルト | 説明 | -| ------------------- | ----------------------------------------------- | ---------------------------------------------------------------------- | -| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | `git_status` のデフォルトフォーマット | -| `conflicted` | `'='` | このブランチにはマージの競合があります。 | -| `ahead` | `'⇡'` | `ahead`のフォーマット | -| `behind` | `'⇣'` | `behind`のフォーマット | -| `diverged` | `'⇕'` | `diverged`のフォーマット | -| `up_to_date` | `''` | `up_to_date`のフォーマット | -| `untracked` | `'?'` | `untracked`のフォーマット | -| `stashed` | `'$'` | `stashed`のフォーマット | -| `modified` | `'!'` | `modified`のフォーマット | -| `staged` | `'+'` | `staged`のフォーマット | -| `renamed` | `'»'` | `renamed`のフォーマット | -| `deleted` | `'✘'` | `deleted`のフォーマット | -| `style` | `'bold red'` | モジュールのスタイルです。 | -| `ignore_submodules` | `false` | サブモジュールの変更を無視します。 | -| `disabled` | `false` | `git_status`モジュールを無効にします。 | -| `windows_starship` | | WSLでWindowsディレクトリの`git_status`で使用するWindows Starshipの実行ファイルのLinux上でのパス。 | +| オプション | デフォルト | 説明 | +| ------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | +| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | The default format for `git_status` | +| `conflicted` | `'='` | This branch has merge conflicts. | +| `ahead` | `'⇡'` | The format of `ahead` | +| `behind` | `'⇣'` | The format of `behind` | +| `diverged` | `'⇕'` | The format of `diverged` | +| `up_to_date` | `''` | The format of `up_to_date` | +| `untracked` | `'?'` | The format of `untracked` | +| `stashed` | `'$'` | The format of `stashed` | +| `modified` | `'!'` | The format of `modified` | +| `staged` | `'+'` | The format of `staged` | +| `renamed` | `'»'` | The format of `renamed` | +| `deleted` | `'✘'` | The format of `deleted` | +| `style` | `'bold red'` | モジュールのスタイルです。 | +| `ignore_submodules` | `false` | Ignore changes to submodules. | +| `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. | ### 変数 -` format` 内では以下の変数が利用できます。 +The following variables can be used in `format`: | 変数 | 説明 | | -------------- | ------------------------------------------------------------------------------------------------------------- | @@ -1719,9 +1805,9 @@ The following variables can be used in `diverged`: The following variables can be used in `conflicted`, `ahead`, `behind`, `untracked`, `stashed`, `modified`, `staged`, `renamed` and `deleted`: -| 変数 | 説明 | -| ------- | ------------- | -| `count` | ファイルの数を表示します。 | +| 変数 | 説明 | +| ------- | ------------------------ | +| `count` | Show the number of files | ### 設定例 @@ -1764,7 +1850,7 @@ windows_starship = '/mnt/c/Users/username/scoop/apps/starship/current/starship.e ## Go -`golang`モジュールは、現在インストールされている[Go](https://golang.org/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +The `golang` module shows the currently installed version of [Go](https://golang.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - カレントディレクトリに`go.mod`ファイルが含まれている - カレントディレクトリに`go.sum`ファイルが含まれている @@ -1787,7 +1873,7 @@ windows_starship = '/mnt/c/Users/username/scoop/apps/starship/current/starship.e | `detect_files` | `['go.mod', 'go.sum', 'go.work', 'glide.yaml', 'Gopkg.yml', 'Gopkg.lock', '.go-version']` | どのファイル名がこのモジュールをアクティブにするか | | `detect_folders` | `['Godeps']` | どのフォルダーがこのモジュールをアクティブにするか | | `style` | `'bold cyan'` | モジュールのスタイルです。 | -| `disabled` | `false` | `golang`モジュールを無効にします。 | +| `disabled` | `false` | Disables the `golang` module. | ### 変数 @@ -1840,6 +1926,41 @@ disabled = true format = 'via [🐂](yellow bold) ' ``` +## Gradle + +The `gradle` module shows the version of the [Gradle Wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html) currently used in the project directory. + +デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 + +- The current directory contains a `gradle/wrapper/gradle-wrapper.properties` directory. +- The current directory contains a file ending with `.gradle` or `.gradle.kts`. + +The `gradle` module is only able to read your Gradle Wrapper version from your config file, we don't execute your wrapper, because of the security concerns. + +### オプション + +| オプション | デフォルト | 説明 | +| ------------------- | ------------------------------------ | ------------------------------------------------------ | +| `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 | +| `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | +| `symbol` | `"🅶 "` | A format string representing the symbol of Gradle. | +| `detect_extensions` | `["gradle", "gradle.kts"]` | どの拡張子がこのモジュールをアクティブにするか | +| `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか | +| `detect_folders` | `["gradle"]` | どのフォルダーがこのモジュールをアクティブにするか | +| `style` | `"bold bright-cyan"` | モジュールのスタイルです。 | +| `disabled` | `false` | Disables the `gradle` module. | +| `recursive` | `false` | Enables recursive finding for the `gradle` directory. | + +### 変数 + +| 変数 | 設定例 | 説明 | +| ------- | -------- | ----------------------- | +| version | `v7.5.1` | The version of `gradle` | +| symbol | | オプション `symbol` の値をミラーする | +| style* | | オプション `style` の値をミラーする | + +*: この変数は、スタイル文字列の一部としてのみ使用することができます。 + ## Haskell The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot. @@ -1915,7 +2036,7 @@ format = "via [⌘ $version](bold fg:202) " ## Helm -`helm`モジュールは、現在インストールされている[Helm](https://helm.sh/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +The `helm` module shows the currently installed version of [Helm](https://helm.sh/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - カレントディレクトリに`helmfile.yaml`ファイルが含まれている - カレントディレクトリに`Chart.yaml`ファイルが含まれている @@ -1952,20 +2073,20 @@ format = "via [⌘ $version](bold fg:202) " format = 'via [⎈ $version](bold white) ' ``` -## Hostname +## ホスト名 -`hostname`モジュールには、システムのホスト名が表示されます。 +The `hostname` module shows the system hostname. ### オプション -| オプション | デフォルト | 説明 | -| ------------ | -------------------------------------- | ------------------------------------------------------------------------------------------------- | -| `ssh_only` | `true` | SSHセッションに接続されている場合にのみホスト名を表示します。 | -| `ssh_symbol` | `'🌐 '` | A format string representing the symbol when connected to SSH session. | -| `trim_at` | `'.'` | この文字が最初にマッチするまでをホスト名と認識します。 `'.'` will stop after the first dot. `''` will disable any truncation | -| `format` | `'[$ssh_symbol$hostname]($style) in '` | module のフォーマットです。 | -| `style` | `'bold dimmed green'` | モジュールのスタイルです。 | -| `disabled` | `false` | `hostname`モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| ------------ | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | +| `ssh_only` | `true` | Only show hostname when connected to an SSH session. | +| `ssh_symbol` | `'🌐 '` | A format string representing the symbol when connected to SSH session. | +| `trim_at` | `'.'` | String that the hostname is cut off at, after the first match. `'.'` will stop after the first dot. `''` will disable any truncation | +| `format` | `'[$ssh_symbol$hostname]($style) in '` | module のフォーマットです。 | +| `style` | `'bold dimmed green'` | モジュールのスタイルです。 | +| `disabled` | `false` | Disables the `hostname` module. | ### 変数 @@ -1991,7 +2112,7 @@ disabled = false ## Java -`Java`モジュールは、現在インストールされている[Java](https://www.oracle.com/java/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +The `java` module shows the currently installed version of [Java](https://www.oracle.com/java/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `deps.edn`, `project.clj`, or `build.boot` file - カレントディレクトリに拡張子が`.java`、`.class`、`.gradle`、`.jar`、`.clj`または`.cljc`のファイルが含まれている @@ -2007,7 +2128,7 @@ disabled = false | `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | | `symbol` | `'☕ '` | A format string representing the symbol of Java | | `style` | `'red dimmed'` | モジュールのスタイルです。 | -| `disabled` | `false` | `java`モジュールを無効にします。 | +| `disabled` | `false` | Disables the `java` module. | ### 変数 @@ -2028,9 +2149,9 @@ disabled = false symbol = '🌟 ' ``` -## ジョブ +## Jobs -`jobs`モジュールには、実行中のジョブの現在の数が表示されます。 このモジュールは、実行中のバックグラウンドジョブがある場合にのみ表示されます。 The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to _always_ show the symbol and number of jobs, even if there are 0 jobs running. +The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to _always_ show the symbol and number of jobs, even if there are 0 jobs running. The default functionality is: @@ -2054,13 +2175,13 @@ The `threshold` option is deprecated, but if you want to use it, the module will | オプション | デフォルト | 説明 | | ------------------ | ----------------------------- | ------------------------------------------------------------------------ | -| `threshold`* | `1` | 超過した場合、ジョブの数を表示します。 | +| `threshold`* | `1` | Show number of jobs if exceeded. | | `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. | | `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. | | `format` | `'[$symbol$number]($style) '` | module のフォーマットです。 | | `symbol` | `'✦'` | The string used to represent the `symbol` variable. | | `style` | `'bold blue'` | モジュールのスタイルです。 | -| `disabled` | `false` | `jobs`モジュールを無効にします。 | +| `disabled` | `false` | Disables the `jobs` module. | *: This option is deprecated, please use the `number_threshold` and `symbol_threshold` options instead. @@ -2068,7 +2189,7 @@ The `threshold` option is deprecated, but if you want to use it, the module will | 変数 | 設定例 | 説明 | | --------- | --- | ----------------------- | -| number | `1` | ジョブの数 | +| number | `1` | The number of jobs | | symbol | | オプション `symbol` の値をミラーする | | style\* | | オプション `style` の値をミラーする | @@ -2087,7 +2208,7 @@ symbol_threshold = 0 ## Julia -`julia`モジュールは、現在インストールされている[Julia](https://julialang.org/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +The `julia` module shows the currently installed version of [Julia](https://julialang.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - カレントディレクトリに`Project.toml`ファイルが含まれている - カレントディレクトリに`Manifest.toml`ファイルが含まれている @@ -2102,15 +2223,15 @@ symbol_threshold = 0 | `detect_extensions` | `['jl']` | どの拡張子がこのモジュールをアクティブにするか | | `detect_files` | `['Project.toml', 'Manifest.toml']` | どのファイル名がこのモジュールをアクティブにするか | | `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | -| `symbol` | `'ஃ '` | Juliaのシンボルを表すフォーマット文字列 | +| `symbol` | `'ஃ '` | A format string representing the symbol of Julia. | | `style` | `'bold purple'` | モジュールのスタイルです。 | -| `disabled` | `false` | `julia`モジュールを無効にします。 | +| `disabled` | `false` | Disables the `julia` module. | ### 変数 | 変数 | 設定例 | 説明 | | --------- | -------- | ----------------------- | -| version | `v1.4.0` | `julia`のバージョン | +| version | `v1.4.0` | The version of `julia` | | symbol | | オプション `symbol` の値をミラーする | | style\* | | オプション `style` の値をミラーする | @@ -2127,29 +2248,29 @@ symbol = '∴ ' ## Kotlin -`kotlin`モジュールは、現在インストールされている[Kotlin](https://kotlinlang.org/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +The `kotlin` module shows the currently installed version of [Kotlin](https://kotlinlang.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - カレントディレクトリに`.kt`もしくは`.kts`ファイルが含まれている ### オプション -| オプション | デフォルト | 説明 | -| ------------------- | ------------------------------------ | ------------------------------------------------------ | -| `format` | `'via [$symbol($version )]($style)'` | module のフォーマットです。 | -| `version_format` | `'v${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | -| `detect_extensions` | `['kt', 'kts']` | どの拡張子がこのモジュールをアクティブにするか | -| `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか | -| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | -| `symbol` | `'🅺 '` | Kotlinのシンボルを表すフォーマット文字列 | -| `style` | `'bold blue'` | モジュールのスタイルです。 | -| `kotlin_binary` | `'kotlin'` | Starshipがバージョンを取得するときに実行するkotlinバイナリを設定します。 | -| `disabled` | `false` | `kotlin`モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | module のフォーマットです。 | +| `version_format` | `'v${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | +| `detect_extensions` | `['kt', 'kts']` | どの拡張子がこのモジュールをアクティブにするか | +| `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか | +| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | +| `symbol` | `'🅺 '` | A format string representing the symbol of Kotlin. | +| `style` | `'bold blue'` | モジュールのスタイルです。 | +| `kotlin_binary` | `'kotlin'` | Configures the kotlin binary that Starship executes when getting the version. | +| `disabled` | `false` | Disables the `kotlin` module. | ### 変数 | 変数 | 設定例 | 説明 | | --------- | --------- | ----------------------- | -| version | `v1.4.21` | `kotlin`のバージョン | +| version | `v1.4.21` | The version of `kotlin` | | symbol | | オプション `symbol` の値をミラーする | | style\* | | オプション `style` の値をミラーする | @@ -2174,11 +2295,11 @@ kotlin_binary = 'kotlinc' ## 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`. 環境変数`$KUBECONFIG`が設定されている場合、このモジュールはそれを利用し、`~/.kube/config`を利用しません。 +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`. If the `$KUBECONFIG` env var is set the module will use that if not it will use the `~/.kube/config`. ::: tip -このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで `disabled` を `false` に設定します。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. When the module is enabled it will always be active, unless any of `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions. @@ -2186,28 +2307,28 @@ When the module is enabled it will always be active, unless any of `detect_exten ### オプション -| オプション | デフォルト | 説明 | -| ------------------- | ---------------------------------------------------- | --------------------------------- | -| `symbol` | `'☸ '` | クラスター名の前に表示されるシンボルを表すフォーマット文字列。 | -| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | module のフォーマットです。 | -| `style` | `'cyan bold'` | モジュールのスタイルです。 | -| `context_aliases` | `{}` | コンテキストの表示エイリアスを定義するテーブル。 | -| `user_aliases` | `{}` | Table of user aliases to display. | -| `detect_extensions` | `[]` | どの拡張子がこのモジュールをアクティブにするか | -| `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか | -| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | -| `disabled` | `true` | `kubernetes` モジュールを無効にする。 | +| オプション | デフォルト | 説明 | +| ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | +| `symbol` | `'☸ '` | A format string representing the symbol displayed before the Cluster. | +| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | module のフォーマットです。 | +| `style` | `'cyan bold'` | モジュールのスタイルです。 | +| `context_aliases` | `{}` | Table of context aliases to display. | +| `user_aliases` | `{}` | Table of user aliases to display. | +| `detect_extensions` | `[]` | どの拡張子がこのモジュールをアクティブにするか | +| `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか | +| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | +| `disabled` | `true` | Disables the `kubernetes` module. | ### 変数 -| 変数 | 設定例 | 説明 | -| --------- | -------------------- | -------------------------------------- | -| context | `starship-context` | The current kubernetes context name | -| namespace | `starship-namespace` | 設定されている場合、現在の Kubernetes の namespace 名 | -| user | `starship-user` | If set, the current kubernetes user | -| cluster | `starship-cluster` | If set, the current kubernetes cluster | -| symbol | | オプション `symbol` の値をミラーする | -| style\* | | オプション `style` の値をミラーする | +| 変数 | 設定例 | 説明 | +| --------- | -------------------- | ---------------------------------------- | +| context | `starship-context` | The current kubernetes context name | +| namespace | `starship-namespace` | If set, the current kubernetes namespace | +| user | `starship-user` | If set, the current kubernetes user | +| cluster | `starship-cluster` | If set, the current kubernetes cluster | +| symbol | | オプション `symbol` の値をミラーする | +| style\* | | オプション `style` の値をミラーする | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -2261,13 +2382,13 @@ Long and automatically generated cluster names can be identified and shortened u ## Line Break -`line_break` モジュールは、プロンプトを2行に分割します。 +The `line_break` module separates the prompt into two lines. ### オプション -| オプション | デフォルト | 説明 | -| ---------- | ------- | -------------------------------------- | -| `disabled` | `false` | `line_break` モジュールを無効にして、プロンプトを1行にします。 | +| オプション | デフォルト | 説明 | +| ---------- | ------- | ------------------------------------------------------------------ | +| `disabled` | `false` | Disables the `line_break` module, making the prompt a single line. | ### 設定例 @@ -2278,25 +2399,25 @@ Long and automatically generated cluster names can be identified and shortened u disabled = true ``` -## ローカルIP +## Local IP -`localip`モジュールは、プライマリネットワークインターフェイスのIPv4アドレスを表示します。 +The `localip` module shows the IPv4 address of the primary network interface. ### オプション -| オプション | デフォルト | 説明 | -| ---------- | ------------------------- | ----------------------------------- | -| `ssh_only` | `true` | SSHセッションに接続されている場合にのみ、IPアドレスを表示します。 | -| `format` | `'[$localipv4]($style) '` | module のフォーマットです。 | -| `style` | `'bold yellow'` | モジュールのスタイルです。 | -| `disabled` | `true` | `localip`モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| ---------- | ------------------------- | ------------------------------------------------------ | +| `ssh_only` | `true` | Only show IP address when connected to an SSH session. | +| `format` | `'[$localipv4]($style) '` | module のフォーマットです。 | +| `style` | `'bold yellow'` | モジュールのスタイルです。 | +| `disabled` | `true` | Disables the `localip` module. | ### 変数 -| 変数 | 設定例 | 説明 | -| --------- | ------------ | ---------------------- | -| localipv4 | 192.168.1.13 | プライマリIPv4アドレスが含まれています | -| style\* | | オプション `style` の値をミラーする | +| 変数 | 設定例 | 説明 | +| --------- | ------------ | --------------------------------- | +| localipv4 | 192.168.1.13 | Contains the primary IPv4 address | +| style\* | | オプション `style` の値をミラーする | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -2313,7 +2434,7 @@ disabled = false ## Lua -`lua`モジュールは、現在インストールされている[Lua](http://www.lua.org/) のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +The `lua` module shows the currently installed version of [Lua](http://www.lua.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - カレントディレクトリに`.lua-version`ファイルが含まれている - カレントディレクトリに`lua`ディレクトリが含まれている @@ -2321,23 +2442,23 @@ disabled = false ### オプション -| オプション | デフォルト | 説明 | -| ------------------- | ------------------------------------ | ------------------------------------------------------ | -| `format` | `'via [$symbol($version )]($style)'` | module のフォーマットです。 | -| `version_format` | `'v${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | -| `symbol` | `'🌙 '` | Luaのシンボルを表すフォーマット文字列 | -| `detect_extensions` | `['lua']` | どの拡張子がこのモジュールをアクティブにするか | -| `detect_files` | `['.lua-version']` | どのファイル名がこのモジュールをアクティブにするか | -| `detect_folders` | `['lua']` | どのフォルダーがこのモジュールをアクティブにするか | -| `style` | `'bold blue'` | モジュールのスタイルです。 | -| `lua_binary` | `'lua'` | Starshipがバージョンを取得するときに実行するLuaバイナリを設定します。 | -| `disabled` | `false` | `lua`モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| ------------------- | ------------------------------------ | -------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | module のフォーマットです。 | +| `version_format` | `'v${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | +| `symbol` | `'🌙 '` | A format string representing the symbol of Lua. | +| `detect_extensions` | `['lua']` | どの拡張子がこのモジュールをアクティブにするか | +| `detect_files` | `['.lua-version']` | どのファイル名がこのモジュールをアクティブにするか | +| `detect_folders` | `['lua']` | どのフォルダーがこのモジュールをアクティブにするか | +| `style` | `'bold blue'` | モジュールのスタイルです。 | +| `lua_binary` | `'lua'` | Configures the lua binary that Starship executes when getting the version. | +| `disabled` | `false` | Disables the `lua` module. | ### 変数 | 変数 | 設定例 | 説明 | | --------- | -------- | ----------------------- | -| version | `v5.4.0` | `lua` のバージョン | +| version | `v5.4.0` | The version of `lua` | | symbol | | オプション `symbol` の値をミラーする | | style\* | | オプション `style` の値をミラーする | @@ -2352,27 +2473,27 @@ disabled = false format = 'via [🌕 $version](bold blue) ' ``` -## メモリ使用量 +## Memory Usage -`memory_usage` モジュールは、現在のシステムメモリとスワップ使用量を示します。 +The `memory_usage` module shows current system memory and swap usage. -デフォルトでは、システムスワップの合計がゼロ以外の場合、スワップ使用量が表示されます。 +By default the swap usage is displayed if the total system swap is non-zero. ::: tip -このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで `disabled` を `false` に設定します。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### オプション -| オプション | デフォルト | 説明 | -| ----------- | ----------------------------------------------- | --------------------------- | -| `threshold` | `75` | この閾値を超えない限り、メモリ使用率は表示されません。 | -| `format` | `'via $symbol [${ram}( \| ${swap})]($style) '` | module のフォーマットです。 | -| `symbol` | `'🐏'` | メモリ使用率を表示する前に使用される記号です。 | -| `style` | `'bold dimmed white'` | モジュールのスタイルです。 | -| `disabled` | `true` | `memory_usage`モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| ----------- | ----------------------------------------------- | -------------------------------------------------------- | +| `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. | +| `format` | `'via $symbol [${ram}( \| ${swap})]($style) '` | module のフォーマットです。 | +| `symbol` | `'🐏'` | The symbol used before displaying the memory usage. | +| `style` | `'bold dimmed white'` | モジュールのスタイルです。 | +| `disabled` | `true` | Disables the `memory_usage` module. | ### 変数 @@ -2440,26 +2561,27 @@ style = 'bold dimmed green' ## Mercurial Branch -` hg_branch `モジュールは、現在のディレクトリにあるリポジトリのアクティブなブランチを示します。 +The `hg_branch` module shows the active branch and topic 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'` | モジュールのスタイルです。 | -| `format` | `'on [$symbol$branch]($style) '` | module のフォーマットです。 | -| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to `N` graphemes | -| `truncation_symbol` | `'…'` | ブランチ名切り捨てられていることを示すための記号です。 | -| `disabled` | `true` | Disables the `hg_branch` module. | +| オプション | デフォルト | 説明 | +| ------------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------- | +| `symbol` | `' '` | The symbol used before the hg bookmark or branch name of the repo in your current directory. | +| `style` | `'bold purple'` | モジュールのスタイルです。 | +| `format` | `'on [$symbol$branch(:$topic)]($style) '` | module のフォーマットです。 | +| `truncation_length` | `2^63 - 1` | Truncates the hg branch / topic name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. | +| `disabled` | `true` | Disables the `hg_branch` module. | ### 変数 -| 変数 | 設定例 | 説明 | -| --------- | -------- | --------------------------- | -| branch | `master` | The active mercurial branch | -| symbol | | オプション `symbol` の値をミラーする | -| style\* | | オプション `style` の値をミラーする | +| 変数 | 設定例 | 説明 | +| --------- | --------- | --------------------------- | +| branch | `master` | The active mercurial branch | +| topic | `feature` | The active mercurial topic | +| symbol | | オプション `symbol` の値をミラーする | +| style\* | | オプション `style` の値をミラーする | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -2476,7 +2598,7 @@ truncation_symbol = '' ## Nim -`nim`モジュールは、現在インストールされている[Nim](https://nim-lang.org/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +The `nim` module shows the currently installed version of [Nim](https://nim-lang.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - カレントディレクトリに`nim.cfg`ファイルが含まれている - カレントディレクトリに拡張子が`.nim`のファイルが含まれている @@ -2518,18 +2640,20 @@ symbol = '🎣 ' ## Nix-shell -`nix_shell`モジュールは[nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html)環境を表示します。 このモジュールは、nixシェル環境内にあるときに表示されます。 +The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html) environment. The module will be shown when inside a nix-shell environment. ### オプション -| オプション | デフォルト | 説明 | -| ------------ | ---------------------------------------------- | ----------------------------------------------------- | -| `format` | `'via [$symbol$state( \($name\))]($style) '` | module のフォーマットです。 | -| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | -| `style` | `'bold blue'` | モジュールのスタイルです。 | -| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | -| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | -| `disabled` | `false` | `nix_shell`モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| ------------- | ---------------------------------------------- | --------------------------------------------------------------------- | +| `format` | `'via [$symbol$state( \($name\))]($style) '` | module のフォーマットです。 | +| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | +| `style` | `'bold blue'` | モジュールのスタイルです。 | +| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | +| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | +| `unknown_msg` | `''` | A format string shown when it is unknown if the shell is pure/impure. | +| `disabled` | `false` | Disables the `nix_shell` module. | +| `heuristic` | `false` | Attempts to detect new `nix shell`-style shells with a heuristic. | ### 変数 @@ -2551,12 +2675,13 @@ symbol = '🎣 ' disabled = true impure_msg = '[impure shell](bold red)' pure_msg = '[pure shell](bold green)' +unknown_msg = '[unknown shell](bold yellow)' format = 'via [☃️ $state( \($name\))](bold blue) ' ``` ## Node.js -`nodejs`モジュールは、現在インストールされている[Node.js](https://nodejs.org/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +The `nodejs` module shows the currently installed version of [Node.js](https://nodejs.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - カレントディレクトリに`package.json`ファイルが含まれている - カレントディレクトリに`.node-version`ファイルが含まれている @@ -2576,7 +2701,7 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' | `detect_files` | `['package.json', '.node-version']` | どのファイル名がこのモジュールをアクティブにするか | | `detect_folders` | `['node_modules']` | どのフォルダーがこのモジュールをアクティブにするか | | `style` | `'bold green'` | モジュールのスタイルです。 | -| `disabled` | `false` | `nodejs`モジュールを無効にします。 | +| `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. | ### 変数 @@ -2600,7 +2725,7 @@ format = 'via [🤖 $version](bold green) ' ## OCaml -`ocaml`モジュールは、現在インストールされている[OCaml](https://ocaml.org/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +The `ocaml` module shows the currently installed version of [OCaml](https://ocaml.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - カレントディレクトリに拡張子`.opam`のファイルまたは`_opam`ディレクトリが含まれている - カレントディレクトリに`esy.lock`ディレクトリが含まれている @@ -2728,7 +2853,7 @@ The [os_info](https://lib.rs/crates/os_info) crate used by this module is known ::: tip -このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで `disabled` を `false` に設定します。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -2813,9 +2938,9 @@ Windows = " " Arch = "Arch is the best! " ``` -## パッケージのバージョン +## Package Version -`package` モジュールは、現在のディレクトリがパッケージのリポジトリである場合に表示され、現在のバージョンが表示されます。 The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages. +The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages. - [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory - [**Cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory @@ -2839,14 +2964,14 @@ Arch = "Arch is the best! " ### オプション -| オプション | デフォルト | 説明 | -| ----------------- | --------------------------------- | --------------------------------------------------------- | -| `format` | `'is [$symbol$version]($style) '` | module のフォーマットです。 | -| `symbol` | `'📦 '` | パッケージのバージョンを表示する前に使用される記号です。 | -| `version_format` | `'v${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | -| `style` | `'bold 208'` | モジュールのスタイルです。 | -| `display_private` | `false` | Enable displaying version for packages marked as private. | -| `disabled` | `false` | `package` モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| ----------------- | --------------------------------- | ---------------------------------------------------------- | +| `format` | `'is [$symbol$version]($style) '` | module のフォーマットです。 | +| `symbol` | `'📦 '` | The symbol used before displaying the version the package. | +| `version_format` | `'v${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | +| `style` | `'bold 208'` | モジュールのスタイルです。 | +| `display_private` | `false` | Enable displaying version for packages marked as private. | +| `disabled` | `false` | Disables the `package` module. | ### 変数 @@ -2869,7 +2994,7 @@ format = 'via [🎁 $version](208 bold) ' ## Perl -`perl`モジュールは、現在インストールされている[Perl](https://www.perl.org/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +The `perl` module shows the currently installed version of [Perl](https://www.perl.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - カレントディレクトリに`Makefile.PL`または`Build.PL`ファイルが含まれている - カレントディレクトリに`cpanfile`または`cpanfile.snapshot`ファイルが含まれている @@ -2909,9 +3034,9 @@ format = 'via [🦪 $version]($style) ' ## PHP -`php`モジュールは、現在インストールされている[PHP](https://www.php.net/) のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +The `php` module shows the currently installed version of [PHP](https://www.php.net/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 -- The current directory contains a `composer.json` file +- カレントディレクトリに`composer.json`ファイルが含まれている - カレントディレクトリに`.php-version`ファイルが含まれている - カレントディレクトリに拡張子が`.php`のファイルが含まれている @@ -2921,12 +3046,12 @@ format = 'via [🦪 $version]($style) ' | ------------------- | ------------------------------------ | ------------------------------------------------------ | | `format` | `'via [$symbol($version )]($style)'` | module のフォーマットです。 | | `version_format` | `'v${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | -| `symbol` | `'🐘 '` | PHPのバージョンを表示する前に使用される記号です。 | +| `symbol` | `'🐘 '` | The symbol used before displaying the version of PHP. | | `detect_extensions` | `['php']` | どの拡張子がこのモジュールをアクティブにするか | | `detect_files` | `['composer.json', '.php-version']` | どのファイル名がこのモジュールをアクティブにするか | | `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | | `style` | `'147 bold'` | モジュールのスタイルです。 | -| `disabled` | `false` | `php`モジュールを無効にします。 | +| `disabled` | `false` | Disables the `php` module. | ### 変数 @@ -2947,13 +3072,28 @@ format = 'via [🦪 $version]($style) ' format = 'via [🔹 $version](147 bold) ' ``` +## Pijul Channel + +The `pijul_channel` module shows the active channel of the repo in your current directory. + +### オプション + +| オプション | デフォルト | 説明 | +| ------------------- | --------------------------------- | ------------------------------------------------------------------------------------ | +| `symbol` | `' '` | The symbol used before the pijul channel name of the repo in your current directory. | +| `style` | `'bold purple'` | モジュールのスタイルです。 | +| `format` | `'on [$symbol$channel]($style) '` | module のフォーマットです。 | +| `truncation_length` | `2^63 - 1` | Truncates the pijul channel name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. | +| `disabled` | `true` | Disables the `pijul` module. | + ## Pulumi The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. ::: tip -By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). それでも有効にしたい場合は、 [以下の例に従ってください](#with-pulumi-version). +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). ::: @@ -3007,7 +3147,7 @@ format = '[$symbol$stack]($style) ' ## PureScript -`purescript`モジュールは、現在インストールされている[PureScript](https://www.purescript.org/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - カレントディレクトリに`spago.dhall`ファイルが含まれている - カレントディレクトリに拡張子が`.purs`のファイルが含まれている @@ -3048,7 +3188,7 @@ format = 'via [$symbol$version](bold white)' The `python` module shows the currently installed version of [Python](https://www.python.org/) and the current [Python virtual environment](https://docs.python.org/tutorial/venv.html) if one is activated. -`pyenvversionname` が `true` に設定されている場合 、pyenv でのバージョン名が表示されます 。 そうでなければ、`python --version` を元にバージョン番号を表示します。 +If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 @@ -3070,13 +3210,13 @@ The `python` module shows the currently installed version of [Python](https://ww | `version_format` | `'v${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | | `symbol` | `'🐍 '` | A format string representing the symbol of Python | | `style` | `'yellow bold'` | モジュールのスタイルです。 | -| `pyenv_version_name` | `false` | pyenvを使用してPythonバージョンを取得します | +| `pyenv_version_name` | `false` | Use pyenv to get Python version | | `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `python_binary` | `['python', 'python3', 'python2']` | Configures the python binaries that Starship should executes when getting the version. | | `detect_extensions` | `['py']` | どの拡張子がこのモジュールをアクティブにするか | | `detect_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` | どのファイル名がこのモジュールをアクティブにするか | | `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | -| `disabled` | `false` | `python`モジュールを無効にします。 | +| `disabled` | `false` | Disables the `python` module. | ::: tip @@ -3135,7 +3275,7 @@ python_binary = ['./venv/bin/python', 'python', 'python3', 'python2'] ## R -`rlang`モジュールは、現在インストールされている[R](https://www.r-project.org/)のバージョンを表示します。 次の条件のいずれかが満たされると、モジュールが表示されます。 +The `rlang` module shows the currently installed version of [R](https://www.r-project.org/). The module will be shown if any of the following conditions are met: - カレントディレクトリに拡張子が`.R`のファイルが含まれている - カレントディレクトリに拡張子が`.Rd`のファイルが含まれている @@ -3215,7 +3355,7 @@ format = 'via [🦪 $version]($style) ' ## Red -デフォルトでは`red`モジュールは、現在インストールされている[Red](https://www.red-lang.org/)のバージョンを表示します。 次の条件のいずれかが満たされると、モジュールが表示されます: +By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met: - カレントディレクトリに拡張子が`.red` or `.reds`のファイルが含まれている @@ -3253,7 +3393,7 @@ symbol = '🔴 ' ## Ruby -デフォルトでは`ruby`モジュールは現在インストールされている[Ruby](https://www.ruby-lang.org/)のバージョンを表示します。 次の条件のいずれかが満たされると、モジュールが表示されます: +By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). The module will be shown if any of the following conditions are met: - カレントディレクトリに`Gemfile`ファイルが含まれている - カレントディレクトリに `.ruby-version` ファイルが含まれている @@ -3268,13 +3408,13 @@ Starship gets the current Ruby version by running `ruby -v`. | ------------------- | ------------------------------------ | ------------------------------------------------------- | | `format` | `'via [$symbol($version )]($style)'` | module のフォーマットです。 | | `version_format` | `'v${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | -| `symbol` | `'💎 '` | Rubyのシンボルを表すフォーマット文字列. | +| `symbol` | `'💎 '` | A format string representing the symbol of Ruby. | | `detect_extensions` | `['rb']` | どの拡張子がこのモジュールをアクティブにするか | | `detect_files` | `['Gemfile', '.ruby-version']` | どのファイル名がこのモジュールをアクティブにするか | | `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | | `detect_variables` | `['RUBY_VERSION', 'RBENV_VERSION']` | Which environment variables should trigger this module. | | `style` | `'bold red'` | モジュールのスタイルです。 | -| `disabled` | `false` | `ruby`モジュールを無効にします。 | +| `disabled` | `false` | Disables the `ruby` module. | ### 変数 @@ -3297,7 +3437,7 @@ symbol = '🔺 ' ## Rust -デフォルトでは`rust`モジュールは現在インストールされている[Rust](https://www.rust-lang.org/)のバージョンを表示します。 次の条件のいずれかが満たされると、モジュールが表示されます: +By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). The module will be shown if any of the following conditions are met: - カレントディレクトリに`Cargo.toml`ファイルが含まれている - カレントディレクトリに`.rs`の拡張子のファイルが含まれている @@ -3308,18 +3448,18 @@ symbol = '🔺 ' | ------------------- | ------------------------------------ | ------------------------------------------------------ | | `format` | `'via [$symbol($version )]($style)'` | module のフォーマットです。 | | `version_format` | `'v${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | -| `symbol` | `'🦀 '` | Rustのシンボルを表すフォーマット文字列 | +| `symbol` | `'🦀 '` | A format string representing the symbol of Rust | | `detect_extensions` | `['rs']` | どの拡張子がこのモジュールをアクティブにするか | | `detect_files` | `['Cargo.toml']` | どのファイル名がこのモジュールをアクティブにするか | | `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | | `style` | `'bold red'` | モジュールのスタイルです。 | -| `disabled` | `false` | `rust`モジュールを無効にします。 | +| `disabled` | `false` | Disables the `rust` module. | ### 変数 | 変数 | 設定例 | 説明 | | --------- | ----------------- | -------------------------------------------- | -| version | `v1.43.0-nightly` | `rustc`のバージョン | +| version | `v1.43.0-nightly` | The version of `rustc` | | numver | `1.51.0` | The numeric component of the `rustc` version | | toolchain | `beta` | The toolchain version | | symbol | | オプション `symbol` の値をミラーする | @@ -3338,7 +3478,7 @@ format = 'via [⚙️ $version](red bold)' ## Scala -`scala` モジュールは、現在インストールされている[Scala](https://www.scala-lang.org/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - カレントディレクトリに`build.sbt`、`.scalaenv`または`.sbtenv`ファイルが含まれている - カレントディレクトリに拡張子が`.scala`または`.sbt`のファイルが含まれている @@ -3382,7 +3522,7 @@ The `shell` module shows an indicator for currently used shell. ::: tip -このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで `disabled` を `false` に設定します。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -3410,7 +3550,7 @@ The `shell` module shows an indicator for currently used shell. | 変数 | デフォルト | 説明 | | --------- | ----- | ---------------------------------------------------------- | | indicator | | Mirrors the value of `indicator` for currently used shell. | -| style\* | | オプション `style` の値をミラーする. | +| style\* | | Mirrors the value of option `style`. | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -3534,7 +3674,7 @@ The `status` module displays the exit code of the previous command. If $success_ ::: tip -このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで `disabled` を `false` に設定します。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -3595,7 +3735,7 @@ The `sudo` module displays if sudo credentials are currently cached. The module ::: tip -このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで `disabled` を `false` に設定します。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -3640,7 +3780,7 @@ disabled = false ## Swift -デフォルトでは`swift` モジュールは、現在インストールされている[Swift](https://swift.org/)のバージョンを表示します。 次の条件のいずれかが満たされると、モジュールが表示されます: +By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). The module will be shown if any of the following conditions are met: - カレントディレクトリに`Package.swift`ファイルが含まれている - カレントディレクトリに拡張子が`.swift`のファイルが含まれている @@ -3679,11 +3819,11 @@ format = 'via [🏎 $version](red bold)' ## Terraform -`terraform` モジュールは、現在選択されている[Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) とバージョンを表示します。 +The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. ::: tip -Terraformのバージョンはデフォルトでは表示されません。多くのプラグインが使用されている場合、現在のTerraformのバージョンでは遅くなるからです。 それでも有効にしたい場合は、 [以下の例に従ってください](#with-terraform-version). +By default the Terraform version is not shown, since this is slow for current versions of Terraform when a lot of plugins are in use. If you still want to enable it, [follow the example shown below](#with-terraform-version). ::: @@ -3698,21 +3838,21 @@ Terraformのバージョンはデフォルトでは表示されません。多 | ------------------- | ------------------------------------ | ------------------------------------------------------ | | `format` | `'via [$symbol$workspace]($style) '` | モジュールのフォーマット文字列。 | | `version_format` | `'v${raw}'` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | -| `symbol` | `'💠'` | ワークスペースの前に表示されるフォーマット文字列。 | +| `symbol` | `'💠'` | A format string shown before the terraform workspace. | | `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | どの拡張子がこのモジュールをアクティブにするか | | `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか | | `detect_folders` | `['.terraform']` | どのフォルダーがこのモジュールをアクティブにするか | | `style` | `'bold 105'` | モジュールのスタイルです。 | -| `disabled` | `false` | `terraform` モジュールを無効にします。 | +| `disabled` | `false` | Disables the `terraform` module. | ### 変数 -| 変数 | 設定例 | 説明 | -| --------- | ---------- | ----------------------- | -| version | `v0.12.24` | `terraform` のバージョン | -| workspace | `default` | 現在のTerraformワークスペース | -| symbol | | オプション `symbol` の値をミラーする | -| style\* | | オプション `style` の値をミラーする | +| 変数 | 設定例 | 説明 | +| --------- | ---------- | ------------------------------- | +| version | `v0.12.24` | The version of `terraform` | +| workspace | `default` | The current Terraform workspace | +| symbol | | オプション `symbol` の値をミラーする | +| style\* | | オプション `style` の値をミラーする | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -3736,27 +3876,27 @@ format = '[🏎💨 $version$workspace]($style) ' format = '[🏎💨 $workspace]($style) ' ``` -## Time +## 時刻 -`time`モジュールは、現在の**現地**時間を示します。 `format`設定は、時間の表示方法を制御するために[`chrono`](https://crates.io/crates/chrono)クレートによって使用されます。 使用可能なオプションを確認するには、[chrono strftimeのドキュメント](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html)をご覧ください。 +The `time` module shows the current **local** time. The `format` configuration value is used by the [`chrono`](https://crates.io/crates/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) to see what options are available. ::: tip -このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで `disabled` を `false` に設定します。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### オプション -| オプション | デフォルト | 説明 | -| ----------------- | ----------------------- | ----------------------------------------------------------------------------------------------------- | -| `format` | `'at [$time]($style) '` | モジュールのフォーマット文字列。 | -| `use_12hr` | `false` | 12時間のフォーマットを有効にします。 | -| `time_format` | この表の下を参照してください | 時刻のフォーマットに使用される[クロノフォーマット文字列](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) です。 | -| `style` | `'bold yellow'` | モジュールのスタイルです。 | -| `utc_time_offset` | `'local'` | 使用するUTCオフセットを設定します。 Range from -24 < x < 24. フロートが30/45分のタイムゾーンオフセットに対応できるようにします。 | -| `disabled` | `true` | `time`モジュールを無効にします。 | -| `time_range` | `'-'` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | +| オプション | デフォルト | 説明 | +| ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | +| `format` | `'at [$time]($style) '` | モジュールのフォーマット文字列。 | +| `use_12hr` | `false` | Enables 12 hour formatting | +| `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. | +| `style` | `'bold yellow'` | The style for the module time | +| `utc_time_offset` | `'local'` | Sets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. | +| `disabled` | `true` | Disables the `time` module. | +| `time_range` | `'-'` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | If `use_12hr` is `true`, then `time_format` defaults to `'%r'`. Otherwise, it defaults to `'%T'`. Manually setting `time_format` will override the `use_12hr` setting. @@ -3782,9 +3922,9 @@ utc_time_offset = '-5' time_range = '10:00:00-14:00:00' ``` -## ユーザー名 +## Username -`username`モジュールはアクティブなユーザーのユーザー名を表示します。 次の条件のいずれかが満たされると、モジュールが表示されます: +The `username` module shows active user's username. The module will be shown if any of the following conditions are met: - The current user is root/admin - カレントユーザーが、ログインしているユーザーとは異なる @@ -3802,10 +3942,10 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, ` | オプション | デフォルト | 説明 | | ------------- | ----------------------- | ------------------------------------------- | | `style_root` | `'bold red'` | The style used when the user is root/admin. | -| `style_user` | `'bold yellow'` | 非rootユーザーに使用されるスタイルです。 | +| `style_user` | `'bold yellow'` | The style used for non-root users. | | `format` | `'[$user]($style) in '` | module のフォーマットです。 | -| `show_always` | `false` | `username` モジュールを常に表示します。 | -| `disabled` | `false` | `username` モジュールを無効にします。 | +| `show_always` | `false` | Always shows the `username` module. | +| `disabled` | `false` | Disables the `username` module. | ### 変数 @@ -3829,7 +3969,7 @@ show_always = true ## Vagrant -`vagrant`モジュールは、現在インストールされている[Vagrant](https://www.vagrantup.com/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +The `vagrant` module shows the currently installed version of [Vagrant](https://www.vagrantup.com/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - カレントディレクトリに`Vagrantfile`ファイルが含まれている @@ -3867,7 +4007,7 @@ format = 'via [⍱ $version](bold white) ' ## V -`vlang`モジュールは、現在インストールされている[V](https://vlang.io/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +The `vlang` module shows you your currently installed version of [V](https://vlang.io/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - カレントディレクトリに拡張子が`.v`のファイルが含まれている - カレントディレクトリに`v.mod`、`vpkg.json`または`.vpkg-lock.json`ファイルが含まれている @@ -3935,7 +4075,7 @@ format = '[🆅 $repo](bold blue) ' ## Zig -デフォルトでは`zig`モジュールは、現在インストールされている[Zig](https://ziglang.org/)のバージョンを表示します。 次の条件のいずれかが満たされると、モジュールが表示されます: +By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met: - カレントディレクトリに拡張子が`.zig`のファイルが含まれている @@ -4015,8 +4155,8 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt | ------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `command` | `''` | The command whose output should be printed. The command will be passed on stdin to the shell. | | `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. | -| `shell` | | [この表の下を参照してください](#custom-command-shell) | -| `説明` | `''` | The description of the module that is shown when running `starship explain`. | +| `shell` | | [See below](#custom-command-shell) | +| `description` | `''` | The description of the module that is shown when running `starship explain`. | | `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_extensions` | `[]` | The extensions that will be searched in the working directory for a match. | diff --git a/docs/ja-JP/guide/README.md b/docs/ja-JP/guide/README.md index 95c60c0e..e396cee3 100644 --- a/docs/ja-JP/guide/README.md +++ b/docs/ja-JP/guide/README.md @@ -9,7 +9,7 @@

GitHub Actions workflow status @@ -423,6 +423,7 @@ Support this project by [becoming a sponsor](https://github.com/sponsors/starshi **Supporter Tier** - [Dimension](https://dimension.dev/) +- [Appwrite](https://appwrite.io/)


diff --git a/docs/ja-JP/presets/README.md b/docs/ja-JP/presets/README.md index 76603374..37cdd724 100644 --- a/docs/ja-JP/presets/README.md +++ b/docs/ja-JP/presets/README.md @@ -14,7 +14,11 @@ This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt. -::: tip This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). ::: +::: tip + +This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). + +::: [Click to view No Nerd Font preset](./no-nerd-font) diff --git a/docs/ko-KR/README.md b/docs/ko-KR/README.md index 16ed63ad..d7c096da 100644 --- a/docs/ko-KR/README.md +++ b/docs/ko-KR/README.md @@ -149,14 +149,14 @@ description: Starship is the minimal, blazing fast, and extremely customizable p ::: warning - This will change in the future. Only Nushell v0.61+ is supported. + This will change in the future. Only Nushell v0.73+ is supported. ::: - Add the following to to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell): + Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell): ```sh mkdir ~/.cache/starship - starship init nu | save ~/.cache/starship/init.nu + starship init nu | save -f ~/.cache/starship/init.nu ``` And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`): diff --git a/docs/ko-KR/advanced-config/README.md b/docs/ko-KR/advanced-config/README.md index a3719eb2..d5183288 100644 --- a/docs/ko-KR/advanced-config/README.md +++ b/docs/ko-KR/advanced-config/README.md @@ -207,8 +207,6 @@ Note: The right prompt is a single line following the input location. To right a `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell. -Note: Nushell 0.71.0 or later is required - ### Example ```toml @@ -231,7 +229,7 @@ Produces a prompt like the following: Some shells support a continuation prompt along with the normal prompt. This prompt is rendered instead of the normal prompt when the user has entered an incomplete statement (such as a single left parenthesis or quote). -Starship can set the continuation prompt using the `continuation_prompt` option. The default prompt is `"[∙](bright-black) "`. +Starship can set the continuation prompt using the `continuation_prompt` option. The default prompt is `'[∙](bright-black) '`. Note: `continuation_prompt` should be set to a literal string without any variables. @@ -247,7 +245,7 @@ Note: Continuation prompts are only available in the following shells: # ~/.config/starship.toml # A continuation prompt that displays two filled in arrows -continuation_prompt = "▶▶" +continuation_prompt = '▶▶ ' ``` ## Style Strings diff --git a/docs/ko-KR/config/README.md b/docs/ko-KR/config/README.md index 95bd8201..64db4cb0 100644 --- a/docs/ko-KR/config/README.md +++ b/docs/ko-KR/config/README.md @@ -252,12 +252,14 @@ $singularity\ $kubernetes\ $directory\ $vcsh\ +$fossil_branch\ $git_branch\ $git_commit\ $git_state\ $git_metrics\ $git_status\ $hg_branch\ +$pijul_channel\ $docker_context\ $package\ $c\ @@ -270,6 +272,7 @@ $dotnet\ $elixir\ $elm\ $erlang\ +$fennel\ $golang\ $guix_shell\ $haskell\ @@ -278,6 +281,7 @@ $helm\ $java\ $julia\ $kotlin\ +$gradle\ $lua\ $nim\ $nodejs\ @@ -1305,6 +1309,12 @@ The `env_var` module displays the current value of a selected environment variab ::: tip +The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. + +::: + +::: 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 @@ -1320,13 +1330,14 @@ default = 'unknown user' ### Options -| Option | Default | Description | -| ---------- | ------------------------------ | ---------------------------------------------------------------------------- | -| `symbol` | `''` | The symbol used before displaying the variable value. | -| `variable` | | The environment variable to be displayed. | -| `default` | | The default value to be displayed when the selected variable is not defined. | -| `format` | `'with [$env_value]($style) '` | The format for the module. | -| `disabled` | `false` | Disables the `env_var` module. | +| Option | Default | Description | +| ------------- | ------------------------------ | ---------------------------------------------------------------------------- | +| `symbol` | `""` | The symbol used before displaying the variable value. | +| `variable` | | The environment variable to be displayed. | +| `default` | | The default value to be displayed when the selected variable is not defined. | +| `format` | `"with [$env_value]($style) "` | The format for the module. | +| `description` | `""` | The description of the module that is shown when running `starship explain`. | +| `disabled` | `false` | Disables the `env_var` module. | ### Variables @@ -1399,6 +1410,44 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https: format = 'via [e $version](bold red) ' ``` +## Fennel + +The `fennel` module shows the currently installed version of [Fennel](https://fennel-lang.org). By default the module will be shown if any of the following conditions are met: + +- The current directory contains a file with the `.fnl` extension + +### Options + +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. | +| `style` | `'bold green'` | The style for the module. | +| `detect_extensions` | `[fnl]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `disabled` | `false` | Disables the `fennel` module. | + +### Variables + +| Variable | Example | Description | +| --------- | -------- | ------------------------------------ | +| version | `v1.2.1` | The version of `fennel` | +| symbol | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | + +*: This variable can only be used as a part of a style string + +### Example + +```toml +# ~/.config/starship.toml + +[fennel] +symbol = '⫰ ' +``` + ## Fill The `fill` module fills any extra space on the line with a symbol. If multiple `fill` modules are present in a line they will split the space evenly between them. This is useful for aligning other modules. @@ -1428,6 +1477,42 @@ Produces a prompt that looks like: AA -------------------------------------------- BB -------------------------------------------- CC ``` +## Fossil Branch + +The `fossil_branch` module shows the name of the active branch of the check-out in your current directory. + +### Options + +| Option | Default | Description | +| ------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | +| `format` | `'on [$symbol$branch]($style) '` | The format for the module. Use `'$branch'` to refer to the current branch name. | +| `symbol` | `' '` | The symbol used before the branch name of the check-out in your current directory. | +| `style` | `'bold purple'` | The style for the module. | +| `truncation_length` | `2^63 - 1` | Truncates a Fossil branch name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. | +| `disabled` | `true` | Disables the `fossil_branch` module. | + +### Variables + +| Variable | Example | Description | +| --------- | ------- | ------------------------------------ | +| branch | `trunk` | The active Fossil branch | +| symbol | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | + +*: This variable can only be used as a part of a style string + +### Example + +```toml +# ~/.config/starship.toml + +[fossil_branch] +symbol = '🦎 ' +truncation_length = 4 +truncation_symbol = '' +``` + ## Google Cloud (`gcloud`) The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var. @@ -1562,10 +1647,11 @@ The `git_commit` module shows the current commit hash and also the tag (if any) ### Variables -| Variable | Example | Description | -| --------- | --------- | ----------------------------------- | -| hash | `b703eb3` | The current git commit hash | -| style\* | | Mirrors the value of option `style` | +| Variable | Example | Description | +| --------- | --------- | -------------------------------------------- | +| hash | `b703eb3` | The current git commit hash | +| tag | `v1.0.0` | The tag name if showing tag info is enabled. | +| style\* | | Mirrors the value of option `style` | *: This variable can only be used as a part of a style string @@ -1840,6 +1926,41 @@ disabled = true format = 'via [🐂](yellow bold) ' ``` +## Gradle + +The `gradle` module shows the version of the [Gradle Wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html) currently used in the project directory. + +By default the module will be shown if any of the following conditions are met: + +- The current directory contains a `gradle/wrapper/gradle-wrapper.properties` directory. +- The current directory contains a file ending with `.gradle` or `.gradle.kts`. + +The `gradle` module is only able to read your Gradle Wrapper version from your config file, we don't execute your wrapper, because of the security concerns. + +### Options + +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🅶 "` | A format string representing the symbol of Gradle. | +| `detect_extensions` | `["gradle", "gradle.kts"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `["gradle"]` | Which folders should trigger this module. | +| `style` | `"bold bright-cyan"` | The style for the module. | +| `disabled` | `false` | Disables the `gradle` module. | +| `recursive` | `false` | Enables recursive finding for the `gradle` directory. | + +### Variables + +| Variable | Example | Description | +| -------- | -------- | ------------------------------------ | +| version | `v7.5.1` | The version of `gradle` | +| 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 + ## Haskell The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot. @@ -2440,26 +2561,27 @@ style = 'bold dimmed green' ## Mercurial Branch -The `hg_branch` module shows the active branch of the repo in your current directory. +The `hg_branch` module shows the active branch and topic of the repo in your current directory. ### Options -| Option | Default | Description | -| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------- | -| `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. | -| `format` | `'on [$symbol$branch]($style) '` | The format for the module. | -| `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. | -| `disabled` | `true` | Disables the `hg_branch` module. | +| Option | Default | Description | +| ------------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------- | +| `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. | +| `format` | `'on [$symbol$branch(:$topic)]($style) '` | The format for the module. | +| `truncation_length` | `2^63 - 1` | Truncates the hg branch / topic name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. | +| `disabled` | `true` | Disables the `hg_branch` module. | ### Variables -| Variable | Example | Description | -| --------- | -------- | ------------------------------------ | -| branch | `master` | The active mercurial branch | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| Variable | Example | Description | +| --------- | --------- | ------------------------------------ | +| branch | `master` | The active mercurial branch | +| topic | `feature` | The active mercurial topic | +| 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 @@ -2522,14 +2644,16 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/ ### Options -| Option | Default | Description | -| ------------ | ---------------------------------------------- | ----------------------------------------------------- | -| `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. | -| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | -| `style` | `'bold blue'` | The style for the module. | -| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | -| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | -| `disabled` | `false` | Disables the `nix_shell` module. | +| Option | Default | Description | +| ------------- | ---------------------------------------------- | --------------------------------------------------------------------- | +| `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. | +| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | +| `style` | `'bold blue'` | The style for the module. | +| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | +| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | +| `unknown_msg` | `''` | A format string shown when it is unknown if the shell is pure/impure. | +| `disabled` | `false` | Disables the `nix_shell` module. | +| `heuristic` | `false` | Attempts to detect new `nix shell`-style shells with a heuristic. | ### Variables @@ -2551,6 +2675,7 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/ disabled = true impure_msg = '[impure shell](bold red)' pure_msg = '[pure shell](bold green)' +unknown_msg = '[unknown shell](bold yellow)' format = 'via [☃️ $state( \($name\))](bold blue) ' ``` @@ -2947,6 +3072,21 @@ The `php` module shows the currently installed version of [PHP](https://www.php. format = 'via [🔹 $version](147 bold) ' ``` +## Pijul Channel + +The `pijul_channel` module shows the active channel of the repo in your current directory. + +### Options + +| Option | Default | Description | +| ------------------- | --------------------------------- | ------------------------------------------------------------------------------------ | +| `symbol` | `' '` | The symbol used before the pijul channel name of the repo in your current directory. | +| `style` | `'bold purple'` | The style for the module. | +| `format` | `'on [$symbol$channel]($style) '` | The format for the module. | +| `truncation_length` | `2^63 - 1` | Truncates the pijul channel name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. | +| `disabled` | `true` | Disables the `pijul` module. | + ## Pulumi The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. diff --git a/docs/ko-KR/guide/README.md b/docs/ko-KR/guide/README.md index c8231e69..3c4467fd 100644 --- a/docs/ko-KR/guide/README.md +++ b/docs/ko-KR/guide/README.md @@ -9,8 +9,8 @@

깃헙 액션 워크풀로 상태 디스코드에 채팅을 하세요 @@ -423,6 +423,7 @@ Support this project by [becoming a sponsor](https://github.com/sponsors/starshi **Supporter Tier** - [Dimension](https://dimension.dev/) +- [Appwrite](https://appwrite.io/)


diff --git a/docs/ko-KR/installing/README.md b/docs/ko-KR/installing/README.md index d9b34f54..bf2e01ba 100644 --- a/docs/ko-KR/installing/README.md +++ b/docs/ko-KR/installing/README.md @@ -1,8 +1,8 @@ -# Advanced Installation +# 고급 설치 -To install starship, you need to do two things: +Starship을 설치하려면 다음 두 가지를 수행해주세요 -1. Get the **starship** binary onto your computer +1. **Starship** 바이너리를 당신의 컴퓨터에 받으세요 1. Tell your shell to use the starship binary as its prompt by modifying its init scripts For most users, the instructions on [the main page](/guide/#🚀-installation) will work great. However, for some more specialized platforms, different instructions are needed. @@ -15,7 +15,7 @@ There are so many platforms out there that they didn't fit into the main README. Head over to the [Chocolatey installation page](https://chocolatey.org/install) and follow the instructions to install Chocolatey. -### Installation +### 설치 ```powershell choco install starship @@ -29,7 +29,7 @@ choco install starship pkg install getconf ``` -### Installation +### 설치 ```sh curl -sS https://starship.rs/install.sh | sh -s -- --bin-dir /data/data/com.termux/files/usr/bin @@ -37,7 +37,7 @@ curl -sS https://starship.rs/install.sh | sh -s -- --bin-dir /data/data/com.term ## [Funtoo Linux](https://www.funtoo.org/Welcome) -### Installation +### 설치 On Funtoo Linux, starship can be installed from [core-kit](https://github.com/funtoo/core-kit/tree/1.4-release/app-shells/starship) via Portage: diff --git a/docs/ko-KR/presets/README.md b/docs/ko-KR/presets/README.md index cb3dcf1b..3903bc17 100644 --- a/docs/ko-KR/presets/README.md +++ b/docs/ko-KR/presets/README.md @@ -14,7 +14,11 @@ This preset changes the symbols for each module to use Nerd Font symbols. This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt. -::: tip This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). ::: +::: tip + +This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). + +::: [Click to view No Nerd Font preset](./no-nerd-font) diff --git a/docs/nl-NL/README.md b/docs/nl-NL/README.md index c094b57b..71c5e908 100644 --- a/docs/nl-NL/README.md +++ b/docs/nl-NL/README.md @@ -149,14 +149,14 @@ description: Starship is the minimal, blazing fast, and extremely customizable p ::: warning - This will change in the future. Only Nushell v0.61+ is supported. + This will change in the future. Only Nushell v0.73+ is supported. ::: - Add the following to to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell): + Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell): ```sh mkdir ~/.cache/starship - starship init nu | save ~/.cache/starship/init.nu + starship init nu | save -f ~/.cache/starship/init.nu ``` And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`): diff --git a/docs/nl-NL/advanced-config/README.md b/docs/nl-NL/advanced-config/README.md index 9a8b0fff..2ea7915d 100644 --- a/docs/nl-NL/advanced-config/README.md +++ b/docs/nl-NL/advanced-config/README.md @@ -207,8 +207,6 @@ Note: The right prompt is a single line following the input location. To right a `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell. -Note: Nushell 0.71.0 or later is required - ### Example ```toml @@ -231,7 +229,7 @@ Produces a prompt like the following: Some shells support a continuation prompt along with the normal prompt. This prompt is rendered instead of the normal prompt when the user has entered an incomplete statement (such as a single left parenthesis or quote). -Starship can set the continuation prompt using the `continuation_prompt` option. The default prompt is `"[∙](bright-black) "`. +Starship can set the continuation prompt using the `continuation_prompt` option. The default prompt is `'[∙](bright-black) '`. Note: `continuation_prompt` should be set to a literal string without any variables. @@ -247,7 +245,7 @@ Note: Continuation prompts are only available in the following shells: # ~/.config/starship.toml # A continuation prompt that displays two filled in arrows -continuation_prompt = "▶▶" +continuation_prompt = '▶▶ ' ``` ## Style Strings diff --git a/docs/nl-NL/config/README.md b/docs/nl-NL/config/README.md index 95bd8201..64db4cb0 100644 --- a/docs/nl-NL/config/README.md +++ b/docs/nl-NL/config/README.md @@ -252,12 +252,14 @@ $singularity\ $kubernetes\ $directory\ $vcsh\ +$fossil_branch\ $git_branch\ $git_commit\ $git_state\ $git_metrics\ $git_status\ $hg_branch\ +$pijul_channel\ $docker_context\ $package\ $c\ @@ -270,6 +272,7 @@ $dotnet\ $elixir\ $elm\ $erlang\ +$fennel\ $golang\ $guix_shell\ $haskell\ @@ -278,6 +281,7 @@ $helm\ $java\ $julia\ $kotlin\ +$gradle\ $lua\ $nim\ $nodejs\ @@ -1305,6 +1309,12 @@ The `env_var` module displays the current value of a selected environment variab ::: tip +The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. + +::: + +::: 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 @@ -1320,13 +1330,14 @@ default = 'unknown user' ### Options -| Option | Default | Description | -| ---------- | ------------------------------ | ---------------------------------------------------------------------------- | -| `symbol` | `''` | The symbol used before displaying the variable value. | -| `variable` | | The environment variable to be displayed. | -| `default` | | The default value to be displayed when the selected variable is not defined. | -| `format` | `'with [$env_value]($style) '` | The format for the module. | -| `disabled` | `false` | Disables the `env_var` module. | +| Option | Default | Description | +| ------------- | ------------------------------ | ---------------------------------------------------------------------------- | +| `symbol` | `""` | The symbol used before displaying the variable value. | +| `variable` | | The environment variable to be displayed. | +| `default` | | The default value to be displayed when the selected variable is not defined. | +| `format` | `"with [$env_value]($style) "` | The format for the module. | +| `description` | `""` | The description of the module that is shown when running `starship explain`. | +| `disabled` | `false` | Disables the `env_var` module. | ### Variables @@ -1399,6 +1410,44 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https: format = 'via [e $version](bold red) ' ``` +## Fennel + +The `fennel` module shows the currently installed version of [Fennel](https://fennel-lang.org). By default the module will be shown if any of the following conditions are met: + +- The current directory contains a file with the `.fnl` extension + +### Options + +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. | +| `style` | `'bold green'` | The style for the module. | +| `detect_extensions` | `[fnl]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `disabled` | `false` | Disables the `fennel` module. | + +### Variables + +| Variable | Example | Description | +| --------- | -------- | ------------------------------------ | +| version | `v1.2.1` | The version of `fennel` | +| symbol | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | + +*: This variable can only be used as a part of a style string + +### Example + +```toml +# ~/.config/starship.toml + +[fennel] +symbol = '⫰ ' +``` + ## Fill The `fill` module fills any extra space on the line with a symbol. If multiple `fill` modules are present in a line they will split the space evenly between them. This is useful for aligning other modules. @@ -1428,6 +1477,42 @@ Produces a prompt that looks like: AA -------------------------------------------- BB -------------------------------------------- CC ``` +## Fossil Branch + +The `fossil_branch` module shows the name of the active branch of the check-out in your current directory. + +### Options + +| Option | Default | Description | +| ------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | +| `format` | `'on [$symbol$branch]($style) '` | The format for the module. Use `'$branch'` to refer to the current branch name. | +| `symbol` | `' '` | The symbol used before the branch name of the check-out in your current directory. | +| `style` | `'bold purple'` | The style for the module. | +| `truncation_length` | `2^63 - 1` | Truncates a Fossil branch name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. | +| `disabled` | `true` | Disables the `fossil_branch` module. | + +### Variables + +| Variable | Example | Description | +| --------- | ------- | ------------------------------------ | +| branch | `trunk` | The active Fossil branch | +| symbol | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | + +*: This variable can only be used as a part of a style string + +### Example + +```toml +# ~/.config/starship.toml + +[fossil_branch] +symbol = '🦎 ' +truncation_length = 4 +truncation_symbol = '' +``` + ## Google Cloud (`gcloud`) The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var. @@ -1562,10 +1647,11 @@ The `git_commit` module shows the current commit hash and also the tag (if any) ### Variables -| Variable | Example | Description | -| --------- | --------- | ----------------------------------- | -| hash | `b703eb3` | The current git commit hash | -| style\* | | Mirrors the value of option `style` | +| Variable | Example | Description | +| --------- | --------- | -------------------------------------------- | +| hash | `b703eb3` | The current git commit hash | +| tag | `v1.0.0` | The tag name if showing tag info is enabled. | +| style\* | | Mirrors the value of option `style` | *: This variable can only be used as a part of a style string @@ -1840,6 +1926,41 @@ disabled = true format = 'via [🐂](yellow bold) ' ``` +## Gradle + +The `gradle` module shows the version of the [Gradle Wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html) currently used in the project directory. + +By default the module will be shown if any of the following conditions are met: + +- The current directory contains a `gradle/wrapper/gradle-wrapper.properties` directory. +- The current directory contains a file ending with `.gradle` or `.gradle.kts`. + +The `gradle` module is only able to read your Gradle Wrapper version from your config file, we don't execute your wrapper, because of the security concerns. + +### Options + +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🅶 "` | A format string representing the symbol of Gradle. | +| `detect_extensions` | `["gradle", "gradle.kts"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `["gradle"]` | Which folders should trigger this module. | +| `style` | `"bold bright-cyan"` | The style for the module. | +| `disabled` | `false` | Disables the `gradle` module. | +| `recursive` | `false` | Enables recursive finding for the `gradle` directory. | + +### Variables + +| Variable | Example | Description | +| -------- | -------- | ------------------------------------ | +| version | `v7.5.1` | The version of `gradle` | +| 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 + ## Haskell The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot. @@ -2440,26 +2561,27 @@ style = 'bold dimmed green' ## Mercurial Branch -The `hg_branch` module shows the active branch of the repo in your current directory. +The `hg_branch` module shows the active branch and topic of the repo in your current directory. ### Options -| Option | Default | Description | -| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------- | -| `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. | -| `format` | `'on [$symbol$branch]($style) '` | The format for the module. | -| `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. | -| `disabled` | `true` | Disables the `hg_branch` module. | +| Option | Default | Description | +| ------------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------- | +| `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. | +| `format` | `'on [$symbol$branch(:$topic)]($style) '` | The format for the module. | +| `truncation_length` | `2^63 - 1` | Truncates the hg branch / topic name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. | +| `disabled` | `true` | Disables the `hg_branch` module. | ### Variables -| Variable | Example | Description | -| --------- | -------- | ------------------------------------ | -| branch | `master` | The active mercurial branch | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| Variable | Example | Description | +| --------- | --------- | ------------------------------------ | +| branch | `master` | The active mercurial branch | +| topic | `feature` | The active mercurial topic | +| 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 @@ -2522,14 +2644,16 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/ ### Options -| Option | Default | Description | -| ------------ | ---------------------------------------------- | ----------------------------------------------------- | -| `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. | -| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | -| `style` | `'bold blue'` | The style for the module. | -| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | -| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | -| `disabled` | `false` | Disables the `nix_shell` module. | +| Option | Default | Description | +| ------------- | ---------------------------------------------- | --------------------------------------------------------------------- | +| `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. | +| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | +| `style` | `'bold blue'` | The style for the module. | +| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | +| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | +| `unknown_msg` | `''` | A format string shown when it is unknown if the shell is pure/impure. | +| `disabled` | `false` | Disables the `nix_shell` module. | +| `heuristic` | `false` | Attempts to detect new `nix shell`-style shells with a heuristic. | ### Variables @@ -2551,6 +2675,7 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/ disabled = true impure_msg = '[impure shell](bold red)' pure_msg = '[pure shell](bold green)' +unknown_msg = '[unknown shell](bold yellow)' format = 'via [☃️ $state( \($name\))](bold blue) ' ``` @@ -2947,6 +3072,21 @@ The `php` module shows the currently installed version of [PHP](https://www.php. format = 'via [🔹 $version](147 bold) ' ``` +## Pijul Channel + +The `pijul_channel` module shows the active channel of the repo in your current directory. + +### Options + +| Option | Default | Description | +| ------------------- | --------------------------------- | ------------------------------------------------------------------------------------ | +| `symbol` | `' '` | The symbol used before the pijul channel name of the repo in your current directory. | +| `style` | `'bold purple'` | The style for the module. | +| `format` | `'on [$symbol$channel]($style) '` | The format for the module. | +| `truncation_length` | `2^63 - 1` | Truncates the pijul channel name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. | +| `disabled` | `true` | Disables the `pijul` module. | + ## Pulumi The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. diff --git a/docs/nl-NL/guide/README.md b/docs/nl-NL/guide/README.md index 35f7ce2d..7188a648 100644 --- a/docs/nl-NL/guide/README.md +++ b/docs/nl-NL/guide/README.md @@ -9,7 +9,7 @@

GitHub Actions-werkwijze status Website + · Installatie + · Configuratie

@@ -150,12 +152,12 @@ **De minimalistische, razend snelle en oneindig aanpasbare prompt voor elke shell!** -- **Snel:** het is snel -_echt heel erg_ snel! 🚀 -- **Aanpasbaar:** configureer elk aspect van je prompt. +- **Snel:** het is snel -_ echt heel_ snel! 🚀 +- **Aanpasbaar:** configureer elk onderdeel van je prompt. - **Universeel:** werkt op elke shell, op elk besturingssysteem. - **Intelligent:** toont relevante informatie in een oogopslag. - **Rijk aan functies:** ondersteuning voor al je favoriete tools. -- **Makkelijk:** snel te installeren - begin in een handomdraai met het te gebruiken. +- **Makkelijk:** snel te installeren – gebruik het binnen enkele minuten.

Verken de Starship-documentatie  ▶ @@ -167,18 +169,18 @@ ### Benodigdheden -- Een [Nerd Font](https://www.nerdfonts.com/) is geïnstalleerd en ingeschakeld in je terminal (bijvoorbeeld probeer het [Fira Code Nerd Font](https://www.nerdfonts.com/font-downloads)). +- Een [Nerd Font](https://www.nerdfonts.com/) is geïnstalleerd en ingeschakeld in je terminal (probeer bijvoorbeeld het [Fira Code Nerd Font](https://www.nerdfonts.com/font-downloads)). -### Step 1. Install Starship +### Stap 1. Installeer Starship -Select your operating system from the list below to view installation instructions: +Selecteer je besturingssysteem in de onderstaande lijst en bekijk de installatie-instructies:

Android -Install Starship using any of the following package managers: +Installeer Starship met één van de volgende pakketbeheerders: -| Repository | Instructions | +| Repository | Instructies | | --------------------------------------------------------------------------------- | ---------------------- | | [Termux](https://github.com/termux/termux-packages/tree/master/packages/starship) | `pkg install starship` | @@ -187,9 +189,9 @@ Install Starship using any of the following package managers:
BSD -Install Starship using any of the following package managers: +Installeer Starship met één van de volgende pakketbeheerders: -| Distribution | Repository | Instructions | +| Distribution | Repository | Instructies | | ------------ | -------------------------------------------------------- | --------------------------------- | | **_Any_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | | FreeBSD | [FreshPorts](https://www.freshports.org/shells/starship) | `pkg install starship` | @@ -208,7 +210,7 @@ curl -sS https://starship.rs/install.sh | sh Alternatively, install Starship using any of the following package managers: -| Distribution | Repository | Instructions | +| Distribution | Repository | Instructies | | ------------------ | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | | **_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` | @@ -235,7 +237,7 @@ curl -sS https://starship.rs/install.sh | sh Alternatively, install Starship using any of the following package managers: -| Repository | Instructions | +| Repository | Instructies | | -------------------------------------------------------- | --------------------------------------- | | **[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` | @@ -249,9 +251,9 @@ Alternatively, install Starship using any of the following package managers: Install the latest version for your system with the MSI-installers from the [releases section](https://github.com/starship/starship/releases/latest). -Install Starship using any of the following package managers: +Installeer Starship met één van de volgende pakketbeheerders: -| Repository | Instructions | +| Repository | Instructies | | -------------------------------------------------------------------------------------------- | --------------------------------------- | | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | | [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` | @@ -261,7 +263,7 @@ Install Starship using any of the following package managers:
-### Step 2. Setup your shell to use Starship +### Stap 2. Setup your shell to use Starship Configure your shell to initialize starship. Select yours from the list below: @@ -329,7 +331,7 @@ Add the following to the end of your Nushell env file (find it by running `$nu.e ```sh mkdir ~/.cache/starship -starship init nu | save ~/.cache/starship/init.nu +starship init nu | save -f ~/.cache/starship/init.nu ``` And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`): @@ -338,7 +340,7 @@ And add the following to the end of your Nushell configuration (find it by runni source ~/.cache/starship/init.nu ``` -Note: Only Nushell v0.61+ is supported +Note: Only Nushell v0.73+ is supported
@@ -386,7 +388,7 @@ eval "$(starship init zsh)" -### Step 3. Configure Starship +### Stap 3. Configure Starship Start a new shell instance, and you should see your beautiful new shell prompt. If you're happy with the defaults, enjoy! @@ -421,6 +423,7 @@ Support this project by [becoming a sponsor](https://github.com/sponsors/starshi **Supporter Tier** - [Dimension](https://dimension.dev/) +- [Appwrite](https://appwrite.io/)


diff --git a/docs/nl-NL/installing/README.md b/docs/nl-NL/installing/README.md index fc1e90a3..a674a441 100644 --- a/docs/nl-NL/installing/README.md +++ b/docs/nl-NL/installing/README.md @@ -15,7 +15,7 @@ There are so many platforms out there that they didn't fit into the main README. Head over to the [Chocolatey installation page](https://chocolatey.org/install) and follow the instructions to install Chocolatey. -### Installation +### Installatie ```powershell choco install starship @@ -29,7 +29,7 @@ choco install starship pkg install getconf ``` -### Installation +### Installatie ```sh curl -sS https://starship.rs/install.sh | sh -s -- --bin-dir /data/data/com.termux/files/usr/bin @@ -37,7 +37,7 @@ curl -sS https://starship.rs/install.sh | sh -s -- --bin-dir /data/data/com.term ## [Funtoo Linux](https://www.funtoo.org/Welcome) -### Installation +### Installatie On Funtoo Linux, starship can be installed from [core-kit](https://github.com/funtoo/core-kit/tree/1.4-release/app-shells/starship) via Portage: diff --git a/docs/nl-NL/presets/README.md b/docs/nl-NL/presets/README.md index cb3dcf1b..3903bc17 100644 --- a/docs/nl-NL/presets/README.md +++ b/docs/nl-NL/presets/README.md @@ -14,7 +14,11 @@ This preset changes the symbols for each module to use Nerd Font symbols. This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt. -::: tip This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). ::: +::: tip + +This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). + +::: [Click to view No Nerd Font preset](./no-nerd-font) diff --git a/docs/no-NO/README.md b/docs/no-NO/README.md index c6ecdcd0..6095b368 100644 --- a/docs/no-NO/README.md +++ b/docs/no-NO/README.md @@ -2,7 +2,7 @@ home: true heroImage: /logo.svg heroText: -tagline: The minimal, blazing-fast, and infinitely customizable prompt for any shell! +tagline: Minimal, blendende rask og uendelig tilpasningsdyktig ledetekst for alle skall! actionText: Get Started → actionLink: ./guide/ features: @@ -28,7 +28,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p -### Prerequisites +### Nødvendig forutsetninger - A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal. @@ -66,7 +66,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p #### Bash - Add the following to the end of `~/.bashrc`: + Legg til følgende på slutten av `~/.bashrc`: ```sh # ~/.bashrc @@ -77,7 +77,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p #### Fish - Add the following to the end of `~/.config/fish/config.fish`: + Legg til følgende i slutten av `~/.config/fish/config.fish`: ```sh # ~/.config/fish/config.fish @@ -108,7 +108,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p #### Ion - Add the following to the end of `~/.config/ion/initrc`: + Legg til følgende i slutten av `~/.config/ion/initrc`: ```sh # ~/.config/ion/initrc @@ -117,7 +117,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p ``` - #### Elvish + #### Elvisk ::: warning @@ -125,7 +125,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p ::: - Add the following to the end of `~/.elvish/rc.elv`: + Legg til følgende i slutten av `~/.elvish/rc.elv`: ```sh # ~/.elvish/rc.elv @@ -136,7 +136,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p #### Tcsh - Add the following to the end of `~/.tcshrc`: + Legg til følgende i slutten av `~/.tcshrc`: ```sh # ~/.tcshrc @@ -149,17 +149,17 @@ description: Starship is the minimal, blazing fast, and extremely customizable p ::: warning - This will change in the future. Only Nushell v0.61+ is supported. + This will change in the future. Only Nushell v0.73+ is supported. ::: - Add the following to to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell): + Legg til følgende i slutten av Nushell env filen (finn den ved å kjøre `$nu.env-path` i Nushell): ```sh mkdir ~/.cache/starship - starship init nu | save ~/.cache/starship/init.nu + starship init nu | save -f ~/.cache/starship/init.nu ``` - And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`): + Og legg følgende til slutten av Nushell konfigurasjonen (finn det ved å kjøre `$nu.config-path`): ```sh source ~/.cache/starship/init.nu @@ -178,7 +178,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p #### 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: + Du må bruke [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) med Cmd. Add the following to a file `starship.lua` and place this file in Clink scripts directory: ```lua -- starship.lua diff --git a/docs/no-NO/advanced-config/README.md b/docs/no-NO/advanced-config/README.md index 9a8b0fff..2ea7915d 100644 --- a/docs/no-NO/advanced-config/README.md +++ b/docs/no-NO/advanced-config/README.md @@ -207,8 +207,6 @@ Note: The right prompt is a single line following the input location. To right a `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell. -Note: Nushell 0.71.0 or later is required - ### Example ```toml @@ -231,7 +229,7 @@ Produces a prompt like the following: Some shells support a continuation prompt along with the normal prompt. This prompt is rendered instead of the normal prompt when the user has entered an incomplete statement (such as a single left parenthesis or quote). -Starship can set the continuation prompt using the `continuation_prompt` option. The default prompt is `"[∙](bright-black) "`. +Starship can set the continuation prompt using the `continuation_prompt` option. The default prompt is `'[∙](bright-black) '`. Note: `continuation_prompt` should be set to a literal string without any variables. @@ -247,7 +245,7 @@ Note: Continuation prompts are only available in the following shells: # ~/.config/starship.toml # A continuation prompt that displays two filled in arrows -continuation_prompt = "▶▶" +continuation_prompt = '▶▶ ' ``` ## Style Strings diff --git a/docs/no-NO/config/README.md b/docs/no-NO/config/README.md index 95bd8201..64db4cb0 100644 --- a/docs/no-NO/config/README.md +++ b/docs/no-NO/config/README.md @@ -252,12 +252,14 @@ $singularity\ $kubernetes\ $directory\ $vcsh\ +$fossil_branch\ $git_branch\ $git_commit\ $git_state\ $git_metrics\ $git_status\ $hg_branch\ +$pijul_channel\ $docker_context\ $package\ $c\ @@ -270,6 +272,7 @@ $dotnet\ $elixir\ $elm\ $erlang\ +$fennel\ $golang\ $guix_shell\ $haskell\ @@ -278,6 +281,7 @@ $helm\ $java\ $julia\ $kotlin\ +$gradle\ $lua\ $nim\ $nodejs\ @@ -1305,6 +1309,12 @@ The `env_var` module displays the current value of a selected environment variab ::: tip +The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. + +::: + +::: 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 @@ -1320,13 +1330,14 @@ default = 'unknown user' ### Options -| Option | Default | Description | -| ---------- | ------------------------------ | ---------------------------------------------------------------------------- | -| `symbol` | `''` | The symbol used before displaying the variable value. | -| `variable` | | The environment variable to be displayed. | -| `default` | | The default value to be displayed when the selected variable is not defined. | -| `format` | `'with [$env_value]($style) '` | The format for the module. | -| `disabled` | `false` | Disables the `env_var` module. | +| Option | Default | Description | +| ------------- | ------------------------------ | ---------------------------------------------------------------------------- | +| `symbol` | `""` | The symbol used before displaying the variable value. | +| `variable` | | The environment variable to be displayed. | +| `default` | | The default value to be displayed when the selected variable is not defined. | +| `format` | `"with [$env_value]($style) "` | The format for the module. | +| `description` | `""` | The description of the module that is shown when running `starship explain`. | +| `disabled` | `false` | Disables the `env_var` module. | ### Variables @@ -1399,6 +1410,44 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https: format = 'via [e $version](bold red) ' ``` +## Fennel + +The `fennel` module shows the currently installed version of [Fennel](https://fennel-lang.org). By default the module will be shown if any of the following conditions are met: + +- The current directory contains a file with the `.fnl` extension + +### Options + +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. | +| `style` | `'bold green'` | The style for the module. | +| `detect_extensions` | `[fnl]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `disabled` | `false` | Disables the `fennel` module. | + +### Variables + +| Variable | Example | Description | +| --------- | -------- | ------------------------------------ | +| version | `v1.2.1` | The version of `fennel` | +| symbol | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | + +*: This variable can only be used as a part of a style string + +### Example + +```toml +# ~/.config/starship.toml + +[fennel] +symbol = '⫰ ' +``` + ## Fill The `fill` module fills any extra space on the line with a symbol. If multiple `fill` modules are present in a line they will split the space evenly between them. This is useful for aligning other modules. @@ -1428,6 +1477,42 @@ Produces a prompt that looks like: AA -------------------------------------------- BB -------------------------------------------- CC ``` +## Fossil Branch + +The `fossil_branch` module shows the name of the active branch of the check-out in your current directory. + +### Options + +| Option | Default | Description | +| ------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | +| `format` | `'on [$symbol$branch]($style) '` | The format for the module. Use `'$branch'` to refer to the current branch name. | +| `symbol` | `' '` | The symbol used before the branch name of the check-out in your current directory. | +| `style` | `'bold purple'` | The style for the module. | +| `truncation_length` | `2^63 - 1` | Truncates a Fossil branch name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. | +| `disabled` | `true` | Disables the `fossil_branch` module. | + +### Variables + +| Variable | Example | Description | +| --------- | ------- | ------------------------------------ | +| branch | `trunk` | The active Fossil branch | +| symbol | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | + +*: This variable can only be used as a part of a style string + +### Example + +```toml +# ~/.config/starship.toml + +[fossil_branch] +symbol = '🦎 ' +truncation_length = 4 +truncation_symbol = '' +``` + ## Google Cloud (`gcloud`) The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var. @@ -1562,10 +1647,11 @@ The `git_commit` module shows the current commit hash and also the tag (if any) ### Variables -| Variable | Example | Description | -| --------- | --------- | ----------------------------------- | -| hash | `b703eb3` | The current git commit hash | -| style\* | | Mirrors the value of option `style` | +| Variable | Example | Description | +| --------- | --------- | -------------------------------------------- | +| hash | `b703eb3` | The current git commit hash | +| tag | `v1.0.0` | The tag name if showing tag info is enabled. | +| style\* | | Mirrors the value of option `style` | *: This variable can only be used as a part of a style string @@ -1840,6 +1926,41 @@ disabled = true format = 'via [🐂](yellow bold) ' ``` +## Gradle + +The `gradle` module shows the version of the [Gradle Wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html) currently used in the project directory. + +By default the module will be shown if any of the following conditions are met: + +- The current directory contains a `gradle/wrapper/gradle-wrapper.properties` directory. +- The current directory contains a file ending with `.gradle` or `.gradle.kts`. + +The `gradle` module is only able to read your Gradle Wrapper version from your config file, we don't execute your wrapper, because of the security concerns. + +### Options + +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🅶 "` | A format string representing the symbol of Gradle. | +| `detect_extensions` | `["gradle", "gradle.kts"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `["gradle"]` | Which folders should trigger this module. | +| `style` | `"bold bright-cyan"` | The style for the module. | +| `disabled` | `false` | Disables the `gradle` module. | +| `recursive` | `false` | Enables recursive finding for the `gradle` directory. | + +### Variables + +| Variable | Example | Description | +| -------- | -------- | ------------------------------------ | +| version | `v7.5.1` | The version of `gradle` | +| 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 + ## Haskell The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot. @@ -2440,26 +2561,27 @@ style = 'bold dimmed green' ## Mercurial Branch -The `hg_branch` module shows the active branch of the repo in your current directory. +The `hg_branch` module shows the active branch and topic of the repo in your current directory. ### Options -| Option | Default | Description | -| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------- | -| `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. | -| `format` | `'on [$symbol$branch]($style) '` | The format for the module. | -| `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. | -| `disabled` | `true` | Disables the `hg_branch` module. | +| Option | Default | Description | +| ------------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------- | +| `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. | +| `format` | `'on [$symbol$branch(:$topic)]($style) '` | The format for the module. | +| `truncation_length` | `2^63 - 1` | Truncates the hg branch / topic name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. | +| `disabled` | `true` | Disables the `hg_branch` module. | ### Variables -| Variable | Example | Description | -| --------- | -------- | ------------------------------------ | -| branch | `master` | The active mercurial branch | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| Variable | Example | Description | +| --------- | --------- | ------------------------------------ | +| branch | `master` | The active mercurial branch | +| topic | `feature` | The active mercurial topic | +| 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 @@ -2522,14 +2644,16 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/ ### Options -| Option | Default | Description | -| ------------ | ---------------------------------------------- | ----------------------------------------------------- | -| `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. | -| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | -| `style` | `'bold blue'` | The style for the module. | -| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | -| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | -| `disabled` | `false` | Disables the `nix_shell` module. | +| Option | Default | Description | +| ------------- | ---------------------------------------------- | --------------------------------------------------------------------- | +| `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. | +| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | +| `style` | `'bold blue'` | The style for the module. | +| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | +| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | +| `unknown_msg` | `''` | A format string shown when it is unknown if the shell is pure/impure. | +| `disabled` | `false` | Disables the `nix_shell` module. | +| `heuristic` | `false` | Attempts to detect new `nix shell`-style shells with a heuristic. | ### Variables @@ -2551,6 +2675,7 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/ disabled = true impure_msg = '[impure shell](bold red)' pure_msg = '[pure shell](bold green)' +unknown_msg = '[unknown shell](bold yellow)' format = 'via [☃️ $state( \($name\))](bold blue) ' ``` @@ -2947,6 +3072,21 @@ The `php` module shows the currently installed version of [PHP](https://www.php. format = 'via [🔹 $version](147 bold) ' ``` +## Pijul Channel + +The `pijul_channel` module shows the active channel of the repo in your current directory. + +### Options + +| Option | Default | Description | +| ------------------- | --------------------------------- | ------------------------------------------------------------------------------------ | +| `symbol` | `' '` | The symbol used before the pijul channel name of the repo in your current directory. | +| `style` | `'bold purple'` | The style for the module. | +| `format` | `'on [$symbol$channel]($style) '` | The format for the module. | +| `truncation_length` | `2^63 - 1` | Truncates the pijul channel name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. | +| `disabled` | `true` | Disables the `pijul` module. | + ## Pulumi The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. diff --git a/docs/no-NO/guide/README.md b/docs/no-NO/guide/README.md index 055ba601..8c6043b8 100644 --- a/docs/no-NO/guide/README.md +++ b/docs/no-NO/guide/README.md @@ -2,44 +2,44 @@ Starship – Cross-shell prompt

GitHub Actions workflow status Crates.io version Packaging status
Chat on Discord Follow @StarshipPrompt on Twitter

- Website + Nettside · - Installation + Installasjon · - Configuration + Konfigurasjon

@@ -47,7 +47,7 @@ >English   Deutsch   Español   Français   Bahasa Indonesia   Italiano   日本語   Português do Brasil   Русский   Tiếng Việt   简体中文   繁體中文

@@ -145,42 +145,42 @@ Starship with iTerm2 and the Snazzy theme -**The minimal, blazing-fast, and infinitely customizable prompt for any shell!** +**Minimal, blendende rask og uendelig tilpasningsdyktig ledetekst for alle skall! ** -- **Fast:** it's fast – _really really_ fast! 🚀 -- **Customizable:** configure every aspect of your prompt. -- **Universal:** works on any shell, on any operating system. -- **Intelligent:** shows relevant information at a glance. -- **Feature rich:** support for all your favorite tools. -- **Easy:** quick to install – start using it in minutes. +- **Fast:** Det er kjapt - _virkelig_ kjapt! 🚀 +- **Tilpassbart:** konfigurer hvert aspekt av din ledetekst. +- **Universelt:** fungerer med ethvert skall uansett operativsystem. +- **Intelligent:** viser relevant informasjon øyeblikkelig. +- **Funksjonsrikt:** støtter alle dine favorittverktøy. +- **Lett:** raskt å installere - start å bruke det på minutter.

-Explore the Starship docs  ▶ +Utforsk Starship dokumentasjon  ▶

-## 🚀 Installation +## 🚀 Installasjon -### Prerequisites +### Nødvendig forutsetninger -- 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)). +- En [Nerd Font](https://www.nerdfonts.com/) installert og aktivert i terminalen (for eksempel [Fira Code Nerd Font](https://www.nerdfonts.com/font-downloads)). -### Step 1. Install Starship +### Steg 1. Installer Starship -Select your operating system from the list below to view installation instructions: +Velg operativsystemet ditt fra listen nedenfor for å se installasjonsinstrukser:
Android -Install Starship using any of the following package managers: +Installer Starship ved å bruke en av følgende installasjonsprogrammene: -| Repository | Instructions | +| Repository | Instruksjoner | | --------------------------------------------------------------------------------- | ---------------------- | | [Termux](https://github.com/termux/termux-packages/tree/master/packages/starship) | `pkg install starship` | @@ -189,13 +189,13 @@ Install Starship using any of the following package managers:
BSD -Install Starship using any of the following package managers: +Installer Starship ved å bruke en av følgende installasjonsprogrammene: -| Distribution | Repository | Instructions | -| ------------ | -------------------------------------------------------- | --------------------------------- | -| **_Any_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | -| FreeBSD | [FreshPorts](https://www.freshports.org/shells/starship) | `pkg install starship` | -| NetBSD | [pkgsrc](https://pkgsrc.se/shells/starship) | `pkgin install starship` | +| Distribusjonen | Repository | Instruksjoner | +| -------------- | -------------------------------------------------------- | --------------------------------- | +| **_Noen_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | +| FreeBSD | [FreshPorts](https://www.freshports.org/shells/starship) | `pkg install starship` | +| NetBSD | [pkgsrc](https://pkgsrc.se/shells/starship) | `pkgin install starship` |
@@ -210,12 +210,12 @@ curl -sS https://starship.rs/install.sh | sh Alternatively, install Starship using any of the following package managers: -| Distribution | Repository | Instructions | +| Distribusjonen | Repository | Instruksjoner | | ------------------ | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | -| **_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_ | [Linuxbrew](https://formulae.brew.sh/formula/starship) | `brew install starship` | -| _Any_ | [Snapcraft](https://snapcraft.io/starship) | `snap install starship` | +| **_Noen_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | +| _Noen_ | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` | +| _Noen_ | [Linuxbrew](https://formulae.brew.sh/formula/starship) | `brew install starship` | +| _Noen_ | [Snapcraft](https://snapcraft.io/starship) | `snap install starship` | | Alpine Linux 3.13+ | [Alpine Linux Packages](https://pkgs.alpinelinux.org/packages?name=starship) | `apk add starship` | | Arch Linux | [Arch Linux Community](https://archlinux.org/packages/community/x86_64/starship) | `pacman -S starship` | | CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship`
`dnf install starship` | @@ -237,7 +237,7 @@ curl -sS https://starship.rs/install.sh | sh Alternatively, install Starship using any of the following package managers: -| Repository | Instructions | +| Repository | Instruksjoner | | -------------------------------------------------------- | --------------------------------------- | | **[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` | @@ -251,9 +251,9 @@ Alternatively, install Starship using any of the following package managers: Install the latest version for your system with the MSI-installers from the [releases section](https://github.com/starship/starship/releases/latest). -Install Starship using any of the following package managers: +Installer Starship ved å bruke en av følgende installasjonsprogrammene: -| Repository | Instructions | +| Repository | Instruksjoner | | -------------------------------------------------------------------------------------------- | --------------------------------------- | | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | | [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` | @@ -263,14 +263,14 @@ Install Starship using any of the following package managers:
-### Step 2. Setup your shell to use Starship +### Steg 2. Sett opp skallet ditt for å bruke Starship -Configure your shell to initialize starship. Select yours from the list below: +Konfigurer skallet ditt til å initialisere starship. Velg din fra listen nedenfor:
Bash -Add the following to the end of `~/.bashrc`: +Legg til følgende på slutten av `~/.bashrc`: ```sh eval "$(starship init bash)" @@ -281,7 +281,7 @@ eval "$(starship init bash)"
Cmd -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: +Du må bruke [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) med Cmd. Lag en fil på følgende lokasjonen `%LocalAppData%\clink\starship.lua` med dette innholdet: ```lua load(io.popen('starship init cmd'):read("*a"))() @@ -290,22 +290,22 @@ load(io.popen('starship init cmd'):read("*a"))()
-Elvish +Elvisk -Add the following to the end of `~/.elvish/rc.elv`: +Legg til følgende i slutten av `~/.elvish/rc.elv`: ```sh eval (starship init elvish) ``` -Note: Only Elvish v0.18+ is supported +Merk: Bare Alvisk v0.18+ støttes
Fish -Add the following to the end of `~/.config/fish/config.fish`: +Legg til følgende i slutten av `~/.config/fish/config.fish`: ```fish starship init fish | source @@ -316,7 +316,7 @@ starship init fish | source
Ion -Add the following to the end of `~/.config/ion/initrc`: +Legg til følgende i slutten av `~/.config/ion/initrc`: ```sh eval $(starship init ion) @@ -327,27 +327,27 @@ eval $(starship init ion)
Nushell -Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell): +Legg til følgende i slutten av Nushell env filen (finn den ved å kjøre `$nu.env-path` i Nushell): ```sh mkdir ~/.cache/starship -starship init nu | save ~/.cache/starship/init.nu +starship init nu | save -f ~/.cache/starship/init.nu ``` -And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`): +Og legg følgende til slutten av Nushell konfigurasjonen (finn det ved å kjøre `$nu.config-path`): ```sh source ~/.cache/starship/init.nu ``` -Note: Only Nushell v0.61+ is supported +Merk: Bare Nushell v0.73+ støttes
PowerShell -Add the following to the end of your PowerShell configuration (find it by running `$PROFILE`): +Legg til følgende i slutten av PowerShell-konfigurasjonen (finn den ved å kjøre `$PROFILE`): ```powershell Invoke-Expression (&starship init powershell) @@ -358,7 +358,7 @@ Invoke-Expression (&starship init powershell)
Tcsh -Add the following to the end of `~/.tcshrc`: +Legg til følgende i slutten av `~/.tcshrc`: ```sh eval `starship init tcsh` @@ -388,7 +388,7 @@ eval "$(starship init zsh)"
-### Step 3. Configure Starship +### Steg 3. Configure Starship Start a new shell instance, and you should see your beautiful new shell prompt. If you're happy with the defaults, enjoy! @@ -423,6 +423,7 @@ Support this project by [becoming a sponsor](https://github.com/sponsors/starshi **Supporter Tier** - [Dimension](https://dimension.dev/) +- [Appwrite](https://appwrite.io/)


diff --git a/docs/no-NO/installing/README.md b/docs/no-NO/installing/README.md index 0ae67ad1..fe6a4003 100644 --- a/docs/no-NO/installing/README.md +++ b/docs/no-NO/installing/README.md @@ -11,11 +11,11 @@ There are so many platforms out there that they didn't fit into the main README. ## [Chocolatey](https://chocolatey.org) -### Prerequisites +### Nødvendig forutsetninger Head over to the [Chocolatey installation page](https://chocolatey.org/install) and follow the instructions to install Chocolatey. -### Installation +### Installasjon ```powershell choco install starship @@ -23,13 +23,13 @@ choco install starship ## [termux](https://termux.com) -### Prerequisites +### Nødvendig forutsetninger ```sh pkg install getconf ``` -### Installation +### Installasjon ```sh curl -sS https://starship.rs/install.sh | sh -s -- --bin-dir /data/data/com.termux/files/usr/bin @@ -37,7 +37,7 @@ curl -sS https://starship.rs/install.sh | sh -s -- --bin-dir /data/data/com.term ## [Funtoo Linux](https://www.funtoo.org/Welcome) -### Installation +### Installasjon On Funtoo Linux, starship can be installed from [core-kit](https://github.com/funtoo/core-kit/tree/1.4-release/app-shells/starship) via Portage: diff --git a/docs/no-NO/presets/README.md b/docs/no-NO/presets/README.md index cb3dcf1b..3903bc17 100644 --- a/docs/no-NO/presets/README.md +++ b/docs/no-NO/presets/README.md @@ -14,7 +14,11 @@ This preset changes the symbols for each module to use Nerd Font symbols. This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt. -::: tip This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). ::: +::: tip + +This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). + +::: [Click to view No Nerd Font preset](./no-nerd-font) diff --git a/docs/no-NO/presets/nerd-font.md b/docs/no-NO/presets/nerd-font.md index f523d01c..bd8ce071 100644 --- a/docs/no-NO/presets/nerd-font.md +++ b/docs/no-NO/presets/nerd-font.md @@ -6,7 +6,7 @@ This preset changes the symbols for each module to use Nerd Font symbols. ![Screenshot of Nerd Font Symbols preset](/presets/img/nerd-font-symbols.png) -### Prerequisites +### Nødvendig forutsetninger - A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (the example uses Fira Code Nerd Font) diff --git a/docs/no-NO/presets/pastel-powerline.md b/docs/no-NO/presets/pastel-powerline.md index 808cc731..66fc9b19 100644 --- a/docs/no-NO/presets/pastel-powerline.md +++ b/docs/no-NO/presets/pastel-powerline.md @@ -6,7 +6,7 @@ This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-m ![Screenshot of Pastel Powerline preset](/presets/img/pastel-powerline.png) -### Prerequisites +### Nødvendig forutsetninger - A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (the example uses Caskaydia Cove Nerd Font) diff --git a/docs/no-NO/presets/tokyo-night.md b/docs/no-NO/presets/tokyo-night.md index 33f51749..268b2d70 100644 --- a/docs/no-NO/presets/tokyo-night.md +++ b/docs/no-NO/presets/tokyo-night.md @@ -6,7 +6,7 @@ This preset is inspired by [tokyo-night-vscode-theme](https://github.com/enkia/t ![Screenshot of Tokyo Night preset](/presets/img/tokyo-night.png) -### Prerequisites +### Nødvendig forutsetninger - A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal diff --git a/docs/pl-PL/README.md b/docs/pl-PL/README.md index 5db7eda1..9cd8bd06 100644 --- a/docs/pl-PL/README.md +++ b/docs/pl-PL/README.md @@ -149,14 +149,14 @@ description: Starship to minimalny, szybki i ekstremalnie konfigurowalny wiersz ::: warning - Ten sposób zmieni się w przyszłości. Działa tylko na Nushell v0.61+. + Ten sposób zmieni się w przyszłości. Działa tylko na Nushell v0.73+. ::: - Dodaj następujący kod na koniec Twojego pliku Nushell env (możesz go znaleźć uruchamiając `$nu.env-path` w Nushell): + Dodaj następujący kod na koniec twojego pliku env Nushell (możesz go znaleść za pomocą `$nu.env-path` w Nushell): ```sh mkdir ~/.cache/starship - starship init nu | save ~/.cache/starship/init.nu + starship init nu | save -f ~/.cache/starship/init.nu ``` Dodaj następujący kod na koniec Twojego pliku konfiguracyjnego Nushell (możesz go znaleźć uruchamiając `$nu.config-path`): diff --git a/docs/pl-PL/advanced-config/README.md b/docs/pl-PL/advanced-config/README.md index 4bb70ff3..f1fdf66d 100644 --- a/docs/pl-PL/advanced-config/README.md +++ b/docs/pl-PL/advanced-config/README.md @@ -207,8 +207,6 @@ Note: The right prompt is a single line following the input location. To right a `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell. -Note: Nushell 0.71.0 or later is required - ### Example ```toml @@ -231,7 +229,7 @@ Produces a prompt like the following: Some shells support a continuation prompt along with the normal prompt. This prompt is rendered instead of the normal prompt when the user has entered an incomplete statement (such as a single left parenthesis or quote). -Starship can set the continuation prompt using the `continuation_prompt` option. The default prompt is `"[∙](bright-black) "`. +Starship can set the continuation prompt using the `continuation_prompt` option. The default prompt is `'[∙](bright-black) '`. Note: `continuation_prompt` should be set to a literal string without any variables. @@ -247,7 +245,7 @@ Note: Continuation prompts are only available in the following shells: # ~/.config/starship.toml # A continuation prompt that displays two filled in arrows -continuation_prompt = "▶▶" +continuation_prompt = '▶▶ ' ``` ## Style Strings diff --git a/docs/pl-PL/config/README.md b/docs/pl-PL/config/README.md index 04f3c7f0..4312736e 100644 --- a/docs/pl-PL/config/README.md +++ b/docs/pl-PL/config/README.md @@ -252,12 +252,14 @@ $singularity\ $kubernetes\ $directory\ $vcsh\ +$fossil_branch\ $git_branch\ $git_commit\ $git_state\ $git_metrics\ $git_status\ $hg_branch\ +$pijul_channel\ $docker_context\ $package\ $c\ @@ -270,6 +272,7 @@ $dotnet\ $elixir\ $elm\ $erlang\ +$fennel\ $golang\ $guix_shell\ $haskell\ @@ -278,6 +281,7 @@ $helm\ $java\ $julia\ $kotlin\ +$gradle\ $lua\ $nim\ $nodejs\ @@ -1305,6 +1309,12 @@ The `env_var` module displays the current value of a selected environment variab ::: tip +The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. + +::: + +::: 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 @@ -1320,13 +1330,14 @@ default = 'unknown user' ### Options -| Option | Default | Description | -| ---------- | ------------------------------ | ---------------------------------------------------------------------------- | -| `symbol` | `''` | The symbol used before displaying the variable value. | -| `zmienne` | | The environment variable to be displayed. | -| `default` | | The default value to be displayed when the selected variable is not defined. | -| `format` | `'with [$env_value]($style) '` | The format for the module. | -| `disabled` | `false` | Disables the `env_var` module. | +| Option | Default | Description | +| ------------- | ------------------------------ | ---------------------------------------------------------------------------- | +| `symbol` | `""` | The symbol used before displaying the variable value. | +| `zmienne` | | The environment variable to be displayed. | +| `default` | | The default value to be displayed when the selected variable is not defined. | +| `format` | `"with [$env_value]($style) "` | The format for the module. | +| `description` | `""` | The description of the module that is shown when running `starship explain`. | +| `disabled` | `false` | Disables the `env_var` module. | ### Variables @@ -1399,6 +1410,44 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https: format = 'via [e $version](bold red) ' ``` +## Fennel + +The `fennel` module shows the currently installed version of [Fennel](https://fennel-lang.org). By default the module will be shown if any of the following conditions are met: + +- The current directory contains a file with the `.fnl` extension + +### Options + +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. | +| `style` | `'bold green'` | The style for the module. | +| `detect_extensions` | `[fnl]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `disabled` | `false` | Disables the `fennel` module. | + +### Variables + +| Zmienne | Example | Description | +| --------- | -------- | ------------------------------------ | +| version | `v1.2.1` | The version of `fennel` | +| symbol | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | + +*: This variable can only be used as a part of a style string + +### Example + +```toml +# ~/.config/starship.toml + +[fennel] +symbol = '⫰ ' +``` + ## Fill The `fill` module fills any extra space on the line with a symbol. If multiple `fill` modules are present in a line they will split the space evenly between them. This is useful for aligning other modules. @@ -1428,6 +1477,42 @@ Produces a prompt that looks like: AA -------------------------------------------- BB -------------------------------------------- CC ``` +## Fossil Branch + +The `fossil_branch` module shows the name of the active branch of the check-out in your current directory. + +### Options + +| Option | Default | Description | +| ------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | +| `format` | `'on [$symbol$branch]($style) '` | The format for the module. Use `'$branch'` to refer to the current branch name. | +| `symbol` | `' '` | The symbol used before the branch name of the check-out in your current directory. | +| `style` | `'bold purple'` | The style for the module. | +| `truncation_length` | `2^63 - 1` | Truncates a Fossil branch name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. | +| `disabled` | `true` | Disables the `fossil_branch` module. | + +### Variables + +| Zmienne | Example | Description | +| --------- | ------- | ------------------------------------ | +| branch | `trunk` | The active Fossil branch | +| symbol | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | + +*: This variable can only be used as a part of a style string + +### Example + +```toml +# ~/.config/starship.toml + +[fossil_branch] +symbol = '🦎 ' +truncation_length = 4 +truncation_symbol = '' +``` + ## Google Cloud (`gcloud`) The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var. @@ -1562,10 +1647,11 @@ The `git_commit` module shows the current commit hash and also the tag (if any) ### Variables -| Zmienne | Example | Description | -| --------- | --------- | ----------------------------------- | -| hash | `b703eb3` | The current git commit hash | -| style\* | | Mirrors the value of option `style` | +| Zmienne | Example | Description | +| --------- | --------- | -------------------------------------------- | +| hash | `b703eb3` | The current git commit hash | +| tag | `v1.0.0` | The tag name if showing tag info is enabled. | +| style\* | | Mirrors the value of option `style` | *: This variable can only be used as a part of a style string @@ -1840,6 +1926,41 @@ disabled = true format = 'via [🐂](yellow bold) ' ``` +## Gradle + +The `gradle` module shows the version of the [Gradle Wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html) currently used in the project directory. + +By default the module will be shown if any of the following conditions are met: + +- The current directory contains a `gradle/wrapper/gradle-wrapper.properties` directory. +- The current directory contains a file ending with `.gradle` or `.gradle.kts`. + +The `gradle` module is only able to read your Gradle Wrapper version from your config file, we don't execute your wrapper, because of the security concerns. + +### Options + +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🅶 "` | A format string representing the symbol of Gradle. | +| `detect_extensions` | `["gradle", "gradle.kts"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `["gradle"]` | Which folders should trigger this module. | +| `style` | `"bold bright-cyan"` | The style for the module. | +| `disabled` | `false` | Disables the `gradle` module. | +| `recursive` | `false` | Enables recursive finding for the `gradle` directory. | + +### Variables + +| Zmienne | Example | Description | +| ------- | -------- | ------------------------------------ | +| version | `v7.5.1` | The version of `gradle` | +| 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 + ## Haskell The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot. @@ -2440,26 +2561,27 @@ style = 'bold dimmed green' ## Mercurial Branch -The `hg_branch` module shows the active branch of the repo in your current directory. +The `hg_branch` module shows the active branch and topic of the repo in your current directory. ### Options -| Option | Default | Description | -| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------- | -| `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. | -| `format` | `'on [$symbol$branch]($style) '` | The format for the module. | -| `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. | -| `disabled` | `true` | Disables the `hg_branch` module. | +| Option | Default | Description | +| ------------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------- | +| `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. | +| `format` | `'on [$symbol$branch(:$topic)]($style) '` | The format for the module. | +| `truncation_length` | `2^63 - 1` | Truncates the hg branch / topic name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. | +| `disabled` | `true` | Disables the `hg_branch` module. | ### Variables -| Zmienne | Example | Description | -| --------- | -------- | ------------------------------------ | -| branch | `master` | The active mercurial branch | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| Zmienne | Example | Description | +| --------- | --------- | ------------------------------------ | +| branch | `master` | The active mercurial branch | +| topic | `feature` | The active mercurial topic | +| 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 @@ -2522,14 +2644,16 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/ ### Options -| Option | Default | Description | -| ------------ | ---------------------------------------------- | ----------------------------------------------------- | -| `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. | -| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | -| `style` | `'bold blue'` | The style for the module. | -| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | -| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | -| `disabled` | `false` | Disables the `nix_shell` module. | +| Option | Default | Description | +| ------------- | ---------------------------------------------- | --------------------------------------------------------------------- | +| `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. | +| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | +| `style` | `'bold blue'` | The style for the module. | +| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | +| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | +| `unknown_msg` | `''` | A format string shown when it is unknown if the shell is pure/impure. | +| `disabled` | `false` | Disables the `nix_shell` module. | +| `heuristic` | `false` | Attempts to detect new `nix shell`-style shells with a heuristic. | ### Variables @@ -2551,6 +2675,7 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/ disabled = true impure_msg = '[impure shell](bold red)' pure_msg = '[pure shell](bold green)' +unknown_msg = '[unknown shell](bold yellow)' format = 'via [☃️ $state( \($name\))](bold blue) ' ``` @@ -2947,6 +3072,21 @@ The `php` module shows the currently installed version of [PHP](https://www.php. format = 'via [🔹 $version](147 bold) ' ``` +## Pijul Channel + +The `pijul_channel` module shows the active channel of the repo in your current directory. + +### Options + +| Option | Default | Description | +| ------------------- | --------------------------------- | ------------------------------------------------------------------------------------ | +| `symbol` | `' '` | The symbol used before the pijul channel name of the repo in your current directory. | +| `style` | `'bold purple'` | The style for the module. | +| `format` | `'on [$symbol$channel]($style) '` | The format for the module. | +| `truncation_length` | `2^63 - 1` | Truncates the pijul channel name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. | +| `disabled` | `true` | Disables the `pijul` module. | + ## Pulumi The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. diff --git a/docs/pl-PL/guide/README.md b/docs/pl-PL/guide/README.md index de464da5..21b835bd 100644 --- a/docs/pl-PL/guide/README.md +++ b/docs/pl-PL/guide/README.md @@ -9,7 +9,7 @@

Status Github Actions

-[![SWUbanner](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg)](https://vshymanskyy.github.io/StandWithUkraine) +[![SWUbaner](https://raw.githubusercontent.com/vshymanskyy/StandWithUkraine/main/banner2-direct.svg)](https://vshymanskyy.github.io/StandWithUkraine)

@@ -171,16 +171,16 @@ - Czcionka typu [Nerd Font](https://www.nerdfonts.com/) zainstalowana i ustawiona w twoim terminalu (wypróbuj na przykład [Fira Code Nerd Font](https://www.nerdfonts.com/font-downloads)). -### Krok 1. Install Starship +### Krok 1. Zainstaluj Starship -Select your operating system from the list below to view installation instructions: +Wybierz system operacyjny z poniższej listy, aby wyświetlić odpowiednie instrukcje instalacji:
Android -Install Starship using any of the following package managers: +Zainstaluj Starship używając dowolnego z następujących menedżerów pakietów: -| Repository | Instructions | +| Repozytorium | Instrukcje | | --------------------------------------------------------------------------------- | ---------------------- | | [Termux](https://github.com/termux/termux-packages/tree/master/packages/starship) | `pkg install starship` | @@ -189,34 +189,34 @@ Install Starship using any of the following package managers:
BSD -Install Starship using any of the following package managers: +Zainstaluj Starship używając dowolnego z następujących menedżerów pakietów: -| Distribution | Repository | Instructions | -| ------------ | -------------------------------------------------------- | --------------------------------- | -| **_Any_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | -| FreeBSD | [FreshPorts](https://www.freshports.org/shells/starship) | `pkg install starship` | -| NetBSD | [pkgsrc](https://pkgsrc.se/shells/starship) | `pkgin install starship` | +| Dystrybucja | Repozytorium | Instrukcje | +| ------------- | -------------------------------------------------------- | --------------------------------- | +| **_Dowolna_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | +| FreeBSD | [FreshPorts](https://www.freshports.org/shells/starship) | `pkg install starship` | +| NetBSD | [pkgsrc](https://pkgsrc.se/shells/starship) | `pkgin install starship` |
Linux -Install the latest version for your system: +Zainstaluj najnowszą wersję dla swojego systemu: ```sh curl -sS https://starship.rs/install.sh | sh ``` -Alternatively, install Starship using any of the following package managers: +Alternatywnie, zainstaluj Starship używając dowolnego z następujących menedżerów pakietów: -| Distribution | Repository | Instructions | +| Dystrybucja | Repozytorium | Instrukcje | | ------------------ | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | -| **_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_ | [Linuxbrew](https://formulae.brew.sh/formula/starship) | `brew install starship` | -| _Any_ | [Snapcraft](https://snapcraft.io/starship) | `snap install starship` | -| Alpine Linux 3.13+ | [Alpine Linux Packages](https://pkgs.alpinelinux.org/packages?name=starship) | `apk add starship` | +| **_Dowolna_** | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | +| _Dowolna_ | [conda-forge](https://anaconda.org/conda-forge/starship) | `conda install -c conda-forge starship` | +| _Dowolna_ | [Linuxbrew](https://formulae.brew.sh/formula/starship) | `brew install starship` | +| _Dowolna_ | [Snapcraft](https://snapcraft.io/starship) | `snap install starship` | +| Alpine Linux 3.13+ | [Alpine Linux Packages](https://pkgs.alpinelinux.org/packages?name=starship) | `apk dodaj starship` | | Arch Linux | [Arch Linux Community](https://archlinux.org/packages/community/x86_64/starship) | `pacman -S starship` | | CentOS 7+ | [Copr](https://copr.fedorainfracloud.org/coprs/atim/starship) | `dnf copr enable atim/starship`
`dnf install starship` | | Gentoo | [Gentoo Packages](https://packages.gentoo.org/packages/app-shells/starship) | `emerge app-shells/starship` | @@ -229,15 +229,15 @@ Alternatively, install Starship using any of the following package managers:
macOS -Install the latest version for your system: +Zainstaluj najnowszą wersję dla swojego systemu: ```sh curl -sS https://starship.rs/install.sh | sh ``` -Alternatively, install Starship using any of the following package managers: +Alternatywnie, zainstaluj Starship używając dowolnego z następujących menedżerów pakietów: -| Repository | Instructions | +| Repozytorium | Instrukcje | | -------------------------------------------------------- | --------------------------------------- | | **[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` | @@ -249,11 +249,11 @@ Alternatively, install Starship using any of the following package managers:
Windows -Install the latest version for your system with the MSI-installers from the [releases section](https://github.com/starship/starship/releases/latest). +Zainstaluj najnowszą wersję dla swojego systemu używając instalatorów MSI z [sekcji Releases](https://github.com/starship/starship/releases/latest). -Install Starship using any of the following package managers: +Zainstaluj Starship używając dowolnego z następujących menedżerów pakietów: -| Repository | Instructions | +| Repozytorium | Instrukcje | | -------------------------------------------------------------------------------------------- | --------------------------------------- | | **[crates.io](https://crates.io/crates/starship)** | `cargo install starship --locked` | | [Chocolatey](https://community.chocolatey.org/packages/starship) | `choco install starship` | @@ -263,9 +263,9 @@ Install Starship using any of the following package managers:
-### Krok 2. Setup your shell to use Starship +### Krok 2. Skonfiguruj swoją powłokę, aby używała Starship -Configure your shell to initialize starship. Select yours from the list below: +Skonfiguruj swoją powłokę, aby inicjowała Starship. Wybierz swoją z poniższej listy:
Bash @@ -281,7 +281,7 @@ eval "$(starship init bash)"
Cmd -Musisz użyć [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) z Cmd. Create a file at this path `%LocalAppData%\clink\starship.lua` with the following contents: +Musisz użyć [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) z Cmd. Utwórz plik na tej ścieżce `%LocalAppData%\clink\starship.lua` z następującą zawartością: ```lua load(io.popen('starship init cmd'):read("*a"))() @@ -298,7 +298,7 @@ Dodaj na koniec pliku `~/.elvish/rc.elv`: eval (starship init elvish) ``` -Note: Only Elvish v0.18+ is supported +Uwaga: Obsługiwany jest tylko Elvish w wersji v0.18 wzwyż
@@ -327,11 +327,11 @@ eval $(starship init ion)
Nushell -Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell): +Dodaj następujący kod na koniec twojego pliku env Nushell (możesz go znaleść za pomocą `$nu.env-path` w Nushell): ```sh mkdir ~/.cache/starship -starship init nu | save ~/.cache/starship/init.nu +starship init nu | save -f ~/.cache/starship/init.nu ``` Dodaj następujący kod na koniec Twojego pliku konfiguracyjnego Nushell (możesz go znaleźć uruchamiając `$nu.config-path`): @@ -340,14 +340,14 @@ Dodaj następujący kod na koniec Twojego pliku konfiguracyjnego Nushell (możes source ~/.cache/starship/init.nu ``` -Note: Only Nushell v0.61+ is supported +Uwaga: Obsługiwany jest tylko Nushell w wersji v0.73 wzwyż
PowerShell -Add the following to the end of your PowerShell configuration (find it by running `$PROFILE`): +Dodaj następujący kod na końcu swojego pliku konfiguracyjnego PowerShell (możesz go znaleźć uruchamiając `$PROFILE`): ```powershell Invoke-Expression (&starship init powershell) @@ -388,41 +388,42 @@ eval "$(starship init zsh)"
-### Krok 3. Configure Starship +### Krok 3. Skonfiguruj Starship -Start a new shell instance, and you should see your beautiful new shell prompt. If you're happy with the defaults, enjoy! +Uruchom nową instancję powłoki, żeby zobaczyć swój nowy, piękny wiersz poleceń. Jeśli wartości domyślne są dla Ciebie satysfakcjonujące, to życzymy miłej zabawy! -If you're looking to further customize Starship: +Lecz jeśli chcesz nieco dostosować Starship: -- **[Configuration](https://starship.rs/config/)** – learn how to configure Starship to tweak your prompt to your liking +- **[Konfiguracja](https://starship.rs/config/)** – Naucz się konfigurować Starship, by móc dostosować swój wiersz poleceń wedle uznania -- **[Presets](https://starship.rs/presets/)** – get inspired by the pre-built configuration of others +- **[Gotowe konfiguracje](https://starship.rs/presets/)** – zainspiruj się konfiguracjami stworzonymi przez innych ## 🤝Wspomóż nas Zawsze szukamy pomocy od osób **na każdym poziomie zaawansowania**! Jeśli potrzebujesz łatwiejszego wdrożenia w projekt, wypróbuj [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). -Jeśli płynnie władasz językiem innym niż angielski, bardzo doceniamy każdą pomoc w tłumaczeniu dokumentacji. Jeśli chcesz pomóc, tłumaczenia można dodawać na [Starship Crowdin](https://translate.starship.rs/). +Jeśli płynnie władasz językiem innym niż angielski, bardzo doceniamy każdą pomoc w tłumaczeniu dokumentacji. Jeśli chcesz pomóc, tłumaczenia można dodawać na [Crowdin Starship](https://translate.starship.rs/). Jeżeli chcesz wspomóc tworzenie starship, zapoznaj się z naszym [Poradnikiem Współpracy](https://github.com/starship/starship/blob/master/CONTRIBUTING.md). Ponadto możesz wejść na nasz [serwer Discord](https://discord.gg/8Jzqu3T) i się przywitać. 👋 ## 💭Inspiracje -Zapoznaj się z wcześniejszymi projektami które zainspirowały nas do stworzenia starship. 🙏 +Zapoznaj się z wcześniejszymi projektami, które zainspirowały nas do stworzenia starship. 🙏 -- **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** – A ZSH prompt for astronauts. +- **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** – Wiersz poleceń ZSH dla astronautów. -- **[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)** - Motyw robyrussell dla wielu powłok, napisany w JavaScript. -- **[reujab/silver](https://github.com/reujab/silver)** – A cross-shell customizable powerline-like prompt with icons. +- **[reujab/silver](https://github.com/reujab/silver)** - Wiersz polecenia typu Powerline z ikonami, działa na wielu różnych powłokach. -## ❤️ Sponsors +## ❤️ Sponsorzy -Support this project by [becoming a sponsor](https://github.com/sponsors/starship). Your name or logo will show up here with a link to your website. +Wspomóż ten projekt [stając się sponsorem](https://github.com/sponsors/starship). Twoja nazwa bądź logo pojawi się tutaj wraz z linkiem do Twojej witryny. -**Supporter Tier** +**Poziom Supporter** - [Dimension](https://dimension.dev/) +- [Appwrite](https://appwrite.io/)


diff --git a/docs/pl-PL/presets/README.md b/docs/pl-PL/presets/README.md index 660dbff3..21c7893c 100644 --- a/docs/pl-PL/presets/README.md +++ b/docs/pl-PL/presets/README.md @@ -14,7 +14,11 @@ This preset changes the symbols for each module to use Nerd Font symbols. This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt. -::: tip This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). ::: +::: tip + +This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). + +::: [Click to view No Nerd Font preset](./no-nerd-font) diff --git a/docs/pt-BR/README.md b/docs/pt-BR/README.md index 58a6666c..c975f221 100644 --- a/docs/pt-BR/README.md +++ b/docs/pt-BR/README.md @@ -149,14 +149,14 @@ description: O Starship é o prompt minimalista, extremamente rápido e extremam ::: warning - Isto irá mudar no futuro. Somente Nushell v0.61+ é suportado. + Isto irá mudar no futuro. Somente Nushell v0.73+ é suportado. ::: - Adicione o seguinte ao final do seu arquivo env do Nushell (encontre-o executando `$nu.env-path` no Nushell): + Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell): ```sh mkdir ~/.cache/starship - starship init nu | save ~/.cache/starship/init.nu + starship init nu | save -f ~/.cache/starship/init.nu ``` E adicione o seguinte ao final da sua configuração do Nushell (encontre-o executando `$nu.config-path`): diff --git a/docs/pt-BR/advanced-config/README.md b/docs/pt-BR/advanced-config/README.md index f6f3437e..809701fa 100644 --- a/docs/pt-BR/advanced-config/README.md +++ b/docs/pt-BR/advanced-config/README.md @@ -207,8 +207,6 @@ Nota: O prompt direito é uma única linha após o local de entrada. Para alinha `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell. -Note: Nushell 0.71.0 or later is required - ### Exemplo ```toml @@ -231,7 +229,7 @@ Produz um prompt como o seguinte: Alguns shells suportam um prompt de continuação junto com o prompt normal. Esse prompt é renderizado em vez do prompt normal quando o usuário insere uma instrução incompleta (como um único parêntese esquerdo ou aspas). -Starship pode definir o prompt de continuação usando a opção `continuation_prompt`. O prompt padrão é `"[∙](bright-black) "`. +Starship pode definir o prompt de continuação usando a opção `continuation_prompt`. The default prompt is `'[∙](bright-black) '`. Nota: `continuation_prompt` deve ser definido como uma string literal sem nenhuma variável. @@ -247,7 +245,7 @@ Nota: os prompts de continuação estão disponíveis apenas nos seguintes shell # ~/.config/starship.toml # Um prompt de continuação que exibe duas setas preenchidas -continuation_prompt = "▶▶" +continuation_prompt = '▶▶ ' ``` ## Estilo dos textos diff --git a/docs/pt-BR/config/README.md b/docs/pt-BR/config/README.md index 70800406..7986705e 100644 --- a/docs/pt-BR/config/README.md +++ b/docs/pt-BR/config/README.md @@ -252,12 +252,14 @@ $singularity\ $kubernetes\ $directory\ $vcsh\ +$fossil_branch\ $git_branch\ $git_commit\ $git_state\ $git_metrics\ $git_status\ $hg_branch\ +$pijul_channel\ $docker_context\ $package\ $c\ @@ -270,6 +272,7 @@ $dotnet\ $elixir\ $elm\ $erlang\ +$fennel\ $golang\ $guix_shell\ $haskell\ @@ -278,6 +281,7 @@ $helm\ $java\ $julia\ $kotlin\ +$gradle\ $lua\ $nim\ $nodejs\ @@ -1305,6 +1309,12 @@ O módulo `env_var` exibe o valor atual de uma variável de ambiente selecionada ::: tip +The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. + +::: + +::: 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 @@ -1320,13 +1330,14 @@ default = 'unknown user' ### Opções -| Opções | Padrão | Descrição | -| ---------- | ------------------------------ | ---------------------------------------------------------------------------- | -| `symbol` | `''` | O símbolo usado antes de exibir o valor da variável. | -| `variable` | | A variável de ambiente a ser exibida. | -| `default` | | O valor padrão a ser exibido quando a variável selecionada não for definida. | -| `format` | `'with [$env_value]($style) '` | O formato do módulo. | -| `disabled` | `false` | Desabilita o módulo `env_var`. | +| Opções | Padrão | Descrição | +| ------------- | ------------------------------ | ---------------------------------------------------------------------------- | +| `symbol` | `""` | O símbolo usado antes de exibir o valor da variável. | +| `variable` | | A variável de ambiente a ser exibida. | +| `default` | | O valor padrão a ser exibido quando a variável selecionada não for definida. | +| `format` | `"with [$env_value]($style) "` | O formato do módulo. | +| `description` | `""` | The description of the module that is shown when running `starship explain`. | +| `disabled` | `false` | Desabilita o módulo `env_var`. | ### Variáveis @@ -1399,6 +1410,44 @@ O módulo `erlang` mostra a versão atualmente instalada do [Erlang/OTP](https:/ format = 'via [e $version](bold red) ' ``` +## Fennel + +The `fennel` module shows the currently installed version of [Fennel](https://fennel-lang.org). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: + +- The current directory contains a file with the `.fnl` extension + +### Opções + +| Opções | Padrão | Descrição | +| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | +| `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. | +| `style` | `'bold green'` | O estilo do módulo. | +| `detect_extensions` | `[fnl]` | Quais extensões 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. | +| `disabled` | `false` | Disables the `fennel` module. | + +### Variáveis + +| Variável | Exemplo | Descrição | +| --------- | -------- | --------------------------------- | +| version | `v1.2.1` | The version of `fennel` | +| symbol | | Espelha o valor da opção `symbol` | +| style\* | | Espelha o valor da opção `style` | + +*: Esta variável só pode ser usada como parte de uma string de estilo + +### Exemplo + +```toml +# ~/.config/starship.toml + +[fennel] +symbol = '⫰ ' +``` + ## Fill O módulo `fill` preenche qualquer espaço vazio da linha com um simbolo. Se múltiplos módulos `fill` estiverem presentes em uma linha, eles irão dividir o espaço entre eles. Isto é útil para alinhar outros módulos. @@ -1428,30 +1477,66 @@ Produz um prompt parecido com: AA -------------------------------------------- BB -------------------------------------------- CC ``` -## Google Cloud (`gcloud`) +## Fossil Branch -O módulo `gcloud` exibe a configuração atual para a CLI do [`gcloud`](https://cloud.google.com/sdk/gcloud). Isto é baseadp mp arquivo `~/.config/gcloud/active_config` e no arquivo`~/.config/gcloud/configurations/config_{CONFIG NAME}` e a env var `CLOUDSDK_CONFIG`. +The `fossil_branch` module shows the name of the active branch of the check-out in your current directory. ### Opções -| Opções | Padrão | Descrição | -| ----------------- | ---------------------------------------------------------- | ------------------------------------------------------------------- | -| `format` | `'on [$symbol$account(@$domain)(\($region\))]($style) '` | O formato do módulo. | -| `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. | -| `project_aliases` | `{}` | Tabela de apelidos do projeto a serem exibidos além do nome do GCP. | -| `style` | `'bold blue'` | O estilo do módulo. | -| `disabled` | `false` | Desabilita o módulo `gcloud`. | +| Opções | Padrão | Descrição | +| ------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | +| `format` | `'on [$symbol$branch]($style) '` | O formato do módulo. Use `'$branch'` to refer to the current branch name. | +| `symbol` | `' '` | The symbol used before the branch name of the check-out in your current directory. | +| `style` | `'bold purple'` | O estilo do módulo. | +| `truncation_length` | `2^63 - 1` | Truncates a Fossil branch name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. | +| `disabled` | `true` | Disables the `fossil_branch` module. | + +### Variáveis + +| Variável | Exemplo | Descrição | +| --------- | ------- | --------------------------------- | +| branch | `trunk` | The active Fossil branch | +| symbol | | Espelha o valor da opção `symbol` | +| style\* | | Espelha o valor da opção `style` | + +*: Esta variável só pode ser usada como parte de uma string de estilo + +### Exemplo + +```toml +# ~/.config/starship.toml + +[fossil_branch] +symbol = '🦎 ' +truncation_length = 4 +truncation_symbol = '' +``` + +## Google Cloud (`gcloud`) + +The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var. + +### Opções + +| Opções | Padrão | Descrição | +| ----------------- | ---------------------------------------------------------- | ---------------------------------------------------------------- | +| `format` | `'on [$symbol$account(@$domain)(\($region\))]($style) '` | O formato do módulo. | +| `symbol` | `'☁️ '` | The symbol used before displaying the current GCP profile. | +| `region_aliases` | `{}` | Table of region aliases to display in addition to the GCP name. | +| `project_aliases` | `{}` | Table of project aliases to display in addition to the GCP name. | +| `style` | `'bold blue'` | O estilo do módulo. | +| `disabled` | `false` | Disables the `gcloud` module. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | ------------- | ------------------------------------------------------------------ | -| region | `us-central1` | A região atual do GCP | -| account | `foo` | O perfil atual do GCP | -| domain | `example.com` | O perfil de domínio atual do GCP | -| project | | O projeto atual do GCP | -| active | `default` | O nome da configuração escrita em `~/.config/gcloud/active_config` | +| region | `us-central1` | The current GCP region | +| account | `foo` | The current GCP profile | +| domain | `example.com` | The current GCP profile domain | +| project | | The current GCP project | +| active | `default` | The active config name written in `~/.config/gcloud/active_config` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -1465,7 +1550,7 @@ O módulo `gcloud` exibe a configuração atual para a CLI do [`gcloud`](https:/ # ~/.config/starship.toml [gcloud] -format = 'em [$symbol$account(@$domain)(\($project\))]($style) ' +format = 'on [$symbol$account(@$domain)(\($project\))]($style) ' ``` #### Exibe apenas o nome da configuração ativa @@ -1503,31 +1588,31 @@ very-long-project-name = 'vlpn' ## Git Branch -O módulo `git_branch` exibe o branch ativo do repositório no diretório atual. +The `git_branch` module shows the active branch of the repo in your current directory. ### Opções -| 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. | -| `format` | `'on [$symbol$branch(:$remote_branch)]($style) '` | O formato do módulo. Use `'$branch'` to refer to the current branch name. | -| `symbol` | `' '` | Um formato de string que representa o simbolo do git branch. | -| `style` | `'bold purple'` | O estilo do módulo. | -| `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. You can use `''` for no symbol. | -| `only_attached` | `false` | Apenas exibe o nome do braço quando o estado não for detached `HEAD`. | -| `ignore_branches` | `[]` | Uma lista de nomes para evitar a exibição. Useful for 'master' or 'main'. | -| `disabled` | `false` | Desabilita o módulo `git_branch`. | +| Opções | Padrão | Descrição | +| -------------------- | ------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | +| `format` | `'on [$symbol$branch(:$remote_branch)]($style) '` | O formato do módulo. Use `'$branch'` to refer to the current branch name. | +| `symbol` | `' '` | A format string representing the symbol of git branch. | +| `style` | `'bold purple'` | O estilo do módulo. | +| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. | +| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | +| `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. | +| `disabled` | `false` | Disables the `git_branch` module. | ### Variáveis -| Variável | Exemplo | Descrição | -| ------------- | -------- | ------------------------------------------------------------------------------------------------- | -| branch | `master` | O nome do braço atual, retornará para `HEAD` se não tiver braço atual (e.x: git detached `HEAD`). | -| remote_name | `origin` | O nome do remoto. | -| remote_branch | `master` | O nome do braço rastreado no `remote_name`. | -| symbol | | Espelha o valor da opção `symbol` | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| ------------- | -------- | ------------------------------------------------------------------------------------------------------ | +| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached `HEAD`). | +| remote_name | `origin` | The remote name. | +| remote_branch | `master` | The name of the branch tracked on `remote_name`. | +| 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 @@ -1545,27 +1630,28 @@ ignore_branches = ['master', 'main'] ## Git commit -O módulo `git_commit` exibe o hash do comiit atual e também a tag (se existir) do repositório no diretório atual. +The `git_commit` module shows the current commit hash and also the tag (if any) of the repo in your current directory. ### Opções | Opções | Padrão | Descrição | | -------------------- | ------------------------------ | ------------------------------------------------------------------------------------ | -| `commit_hash_length` | `7` | O tamanho do git commit hash para ser exibido. | +| `commit_hash_length` | `7` | The length of the displayed git commit hash. | | `format` | `'[\($hash$tag\)]($style) '` | O formato do módulo. | | `style` | `'bold green'` | O estilo do módulo. | -| `only_detached` | `true` | Apenas exibe o git commit hash quando o estado for detached `HEAD` | -| `tag_disabled` | `true` | Desabilita a exibição da informação da tag no módulo `git_commit`. | +| `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_max_candidates` | `0` | How many commits to consider for tag display. The default only allows exact matches. | -| `tag_symbol` | `' 🏷 '` | Simbolo da tag prefixado na informação a ser exibida | -| `disabled` | `false` | Desabilita o módulo `git_commit`. | +| `tag_symbol` | `' 🏷 '` | Tag symbol prefixing the info shown | +| `disabled` | `false` | Disables the `git_commit` module. | ### Variáveis -| Variável | Exemplo | Descrição | -| --------- | --------- | -------------------------------- | -| hash | `b703eb3` | A hash atual do git commit | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| --------- | --------- | -------------------------------------------- | +| hash | `b703eb3` | The current git commit hash | +| tag | `v1.0.0` | The tag name if showing tag info is enabled. | +| style\* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo @@ -1581,31 +1667,31 @@ tag_symbol = '🔖 ' ## Git State -O módulo `git_state` vai exibir nos diretorios que fazem parte de um repositorio git e onde existe uma operação em progresso, como: _REBASING_, _BISECTING_, etc. Se houver informação de progresso (e.x: REBASING 3/10). esta informação será exibida também. +The `git_state` module will show in directories which are part of a git repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. If there is progress information (e.g., REBASING 3/10), that information will be shown too. ### Opções -| Opções | Padrão | Descrição | -| -------------- | --------------------------------------------------------------- | ------------------------------------------------------------------------------------ | -| `rebase` | `'REBASING'` | O formato de string exibida quando um `rebase` esta em progresso. | -| `merge` | `'MERGING'` | O formato de string exibida quando um `merge` esta em progresso. | -| `revert` | `'REVERTING'` | O formato de string exibida quando um `revert` esta em progresso. | -| `cherry_pick` | `'CHERRY-PICKING'` | O formato de string exibida quando um `cherry-pick` esta em progresso. | -| `bisect` | `'BISECTING'` | O formato de string exibida quando um `bisect` esta em progresso. | -| `am` | `'AM'` | O formato de string exibida quando um `apply-mailbox` (`git am`) esta em progresso. | -| `am_or_rebase` | `'AM/REBASE'` | O formato de string exibida quando um `apply-mailbox` or `rebase` esta em progresso. | -| `style` | `'bold yellow'` | O estilo do módulo. | -| `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | O formato do módulo. | -| `disabled` | `false` | Desabilita o módulo `git_state`. | +| Opções | Padrão | Descrição | +| -------------- | --------------------------------------------------------------- | --------------------------------------------------------------------------------------- | +| `rebase` | `'REBASING'` | A format string displayed when a `rebase` is in progress. | +| `merge` | `'MERGING'` | A format string displayed when a `merge` is in progress. | +| `revert` | `'REVERTING'` | A format string displayed when a `revert` is in progress. | +| `cherry_pick` | `'CHERRY-PICKING'` | A format string displayed when a `cherry-pick` is in progress. | +| `bisect` | `'BISECTING'` | A format string displayed when a `bisect` is in progress. | +| `am` | `'AM'` | A format string displayed when an `apply-mailbox` (`git am`) is in progress. | +| `am_or_rebase` | `'AM/REBASE'` | A format string displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. | +| `style` | `'bold yellow'` | O estilo do módulo. | +| `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | O formato do módulo. | +| `disabled` | `false` | Disables the `git_state` module. | ### Variáveis -| Variável | Exemplo | Descrição | -| ---------------- | ---------- | -------------------------------------- | -| state | `REBASING` | O estado atual do repo | -| progress_current | `1` | O progresso da operação atual | -| progress_total | `2` | O total do progresso da operação atual | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| ---------------- | ---------- | -------------------------------- | +| state | `REBASING` | The current state of the repo | +| progress_current | `1` | The current operation progress | +| progress_total | `2` | The total operation progress | +| style\* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo @@ -1621,32 +1707,32 @@ cherry_pick = '[🍒 PICKING](bold red)' ## Git Metrics -O módulo `git_metrics` vai exibir o número de adições e exclusões de linhas no repositório git atual. +The `git_metrics` module will show the number of added and deleted lines in the current git repository. ::: tip -Este módulo é desabilitado por padrão. Para habilitar, defina `disabled` para `false` no seu arquivo de configuração. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### Opções -| Opções | Padrão | Descrição | -| -------------------- | ------------------------------------------------------------ | ------------------------------------------- | -| `added_style` | `'bold green'` | O estilo para a contagem de adições. | -| `deleted_style` | `'bold red'` | O estilo para a contagem de exclusões. | -| `only_nonzero_diffs` | `true` | Exibe apenas o status para itens alterados. | -| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | O formato do módulo. | -| `disabled` | `true` | Desabilita o módulo `git_metrics`. | +| Opções | Padrão | Descrição | +| -------------------- | ------------------------------------------------------------ | ------------------------------------- | +| `added_style` | `'bold green'` | The style for the added count. | +| `deleted_style` | `'bold red'` | The style for the deleted count. | +| `only_nonzero_diffs` | `true` | Render status only for changed items. | +| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | O formato do módulo. | +| `disabled` | `true` | Disables the `git_metrics` module. | ### Variáveis -| Variável | Exemplo | Descrição | -| ----------------- | ------- | --------------------------------------- | -| added | `1` | O número atual de linhas adicionadas | -| deleted | `2` | O número atual de linhas excluidas | -| added_style\* | | Espelha o valor da opção `added_style` | -| deleted_style\* | | Espelha o valor da opção`deleted_style` | +| Variável | Exemplo | Descrição | +| ----------------- | ------- | ------------------------------------------- | +| added | `1` | The current number of added lines | +| deleted | `2` | The current number of deleted lines | +| added_style\* | | Mirrors the value of option `added_style` | +| deleted_style\* | | Mirrors the value of option `deleted_style` | *: Esta variável só pode ser usada como parte de uma string de estilo @@ -1662,66 +1748,66 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) ' ## Git Status -O módulo `git_status` exibe o simbolo que representa o estado do repositório no diretório atual. +The `git_status` module shows symbols representing the state of the repo in your current directory. ::: tip -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. +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. ::: ### Opções -| Opções | Padrão | Descrição | -| ------------------- | ----------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------- | -| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | O formato padrão para `git_status` | -| `conflicted` | `'='` | Este braço tem conflitos. | -| `ahead` | `'⇡'` | O formato do `ahead` | -| `behind` | `'⇣'` | O formato do `behind` | -| `diverged` | `'⇕'` | O formato do `diverged` | -| `up_to_date` | `''` | O formato do `up_to_date` | -| `untracked` | `'?'` | O formato do `untracked` | -| `stashed` | `'$'` | O formato do `stashed` | -| `modified` | `'!'` | O formato do `modified` | -| `staged` | `'+'` | O formato do `staged` | -| `renamed` | `'»'` | O formato do `renamed` | -| `deleted` | `'✘'` | O formato do `deleted` | -| `style` | `'bold red'` | O estilo do módulo. | -| `ignore_submodules` | `false` | Ignora as alterações de submódulos. | -| `disabled` | `false` | Desabilita o módulo `git_status`. | -| `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. | +| Opções | Padrão | Descrição | +| ------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | +| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | The default format for `git_status` | +| `conflicted` | `'='` | This branch has merge conflicts. | +| `ahead` | `'⇡'` | The format of `ahead` | +| `behind` | `'⇣'` | The format of `behind` | +| `diverged` | `'⇕'` | The format of `diverged` | +| `up_to_date` | `''` | The format of `up_to_date` | +| `untracked` | `'?'` | The format of `untracked` | +| `stashed` | `'$'` | The format of `stashed` | +| `modified` | `'!'` | The format of `modified` | +| `staged` | `'+'` | The format of `staged` | +| `renamed` | `'»'` | The format of `renamed` | +| `deleted` | `'✘'` | The format of `deleted` | +| `style` | `'bold red'` | O estilo do módulo. | +| `ignore_submodules` | `false` | Ignore changes to submodules. | +| `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. | ### Variáveis -As variáveis a seguir podem ser usadas no `format`: +The following variables can be used in `format`: -| Variável | Descrição | -| -------------- | ---------------------------------------------------------------------------------------------------------- | -| `all_status` | Atalhos para `$conflicted$stashed$deleted$renamed$modified$staged$untracked` | -| `ahead_behind` | Exibe `diverged`, `ahead`, `behind` or `up_to_date` conforme o formato da string do status do repositório. | -| `conflicted` | Exibe `conflicted` quando este braço tenha conflitos no merge. | -| `untracked` | Exibe `untracked` quando há arquivos não rastreados no diretório atual. | -| `stashed` | Exibe `stashed` quando um stash existe para o repositório local. | -| `modified` | Exibe `modified` quando um arquivo tenha modificações for adicionado na área de staging. | -| `staged` | Exibe `staged` quando um arquivo novo for adicionado na área de staging. | -| `renamed` | Exibe `renamed` quando um arquivo renomeado for adicionado na área de staging. | -| `deleted` | Exibe `deleted` quando um arquivo deletado for adicionado na área de staging. | -| style\* | Espelha o valor da opção `style` | +| Variável | Descrição | +| -------------- | ------------------------------------------------------------------------------------------------------------- | +| `all_status` | Shortcut for`$conflicted$stashed$deleted$renamed$modified$staged$untracked` | +| `ahead_behind` | Displays `diverged`, `ahead`, `behind` or `up_to_date` format string based on the current status of the repo. | +| `conflicted` | Displays `conflicted` when this branch has merge conflicts. | +| `untracked` | Displays `untracked` when there are untracked files in the working directory. | +| `stashed` | Displays `stashed` when a stash exists for the local repository. | +| `modified` | Displays `modified` when there are file modifications in the working directory. | +| `staged` | Displays `staged` when a new file has been added to the staging area. | +| `renamed` | Displays `renamed` when a renamed file has been added to the staging area. | +| `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. | +| style\* | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo -As variáveis a seguir podem ser usadas em `diverged`: +The following variables can be used in `diverged`: -| Variável | Descrição | -| -------------- | --------------------------------------------------- | -| `ahead_count` | Número de commits a frente do braço de rastreamento | -| `behind_count` | Número de commits atrás do braço de rastreamento | +| Variável | Descrição | +| -------------- | ---------------------------------------------- | +| `ahead_count` | Number of commits ahead of the tracking branch | +| `behind_count` | Number of commits behind the tracking branch | -As variaveis a seguir podem ser usadas em `conflicted`, `ahead`, `behind`, `untracked`, `stashed`, `modified`, `staged`, `renamed` e `deleted`: +The following variables can be used in `conflicted`, `ahead`, `behind`, `untracked`, `stashed`, `modified`, `staged`, `renamed` and `deleted`: -| Variável | Descrição | -| -------- | -------------------------- | -| `count` | Exibe o número de arquivos | +| Variável | Descrição | +| -------- | ------------------------ | +| `count` | Show the number of files | ### Exemplo @@ -1742,7 +1828,7 @@ renamed = '👅' deleted = '🗑' ``` -Exibe o count a frente/atrás do braço que esta sendo rastreado +Show ahead/behind count of the branch being tracked ```toml # ~/.config/starship.toml @@ -1753,18 +1839,18 @@ diverged = '⇕⇡${ahead_count}⇣${behind_count}' behind = '⇣${count}' ``` -Use o executável do Windows Starship em caminhos do Windows em WSL +Use Windows Starship executable on Windows paths in WSL ```toml # ~/.config/starship.toml [git_status] -windows_starship = '/mnt/c/Users/nomedousuario/scoop/apps/starship/current/starship.exe' +windows_starship = '/mnt/c/Users/username/scoop/apps/starship/current/starship.exe' ``` ## Go -O módulo `golang` exibe a versão instalada atual do [Go](https://golang.org/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: +The `golang` module shows the currently installed version of [Go](https://golang.org/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: - O diretório atual conter um arquivo `go.mod` - O diretório atual conter um arquivo `go.sum` @@ -1778,22 +1864,22 @@ O módulo `golang` exibe a versão instalada atual do [Go](https://golang.org/). ### Opções -| Opções | Padrão | Descrição | -| ------------------- | ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | -| `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | -| `version_format` | `'v${raw}'` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'🐹 '` | O formato da string que representa o simbolo do Go. | -| `detect_extensions` | `['go']` | Quais extensões 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. | -| `style` | `'bold cyan'` | O estilo do módulo. | -| `disabled` | `false` | Desabilita o módulo `golang`. | +| Opções | Padrão | Descrição | +| ------------------- | ----------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | +| `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'🐹 '` | A format string representing the symbol of Go. | +| `detect_extensions` | `['go']` | Quais extensões 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. | +| `style` | `'bold cyan'` | O estilo do módulo. | +| `disabled` | `false` | Disables the `golang` module. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | --------- | --------------------------------- | -| version | `v1.12.1` | A versão do `go` | +| version | `v1.12.1` | The version of `go` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -1840,9 +1926,44 @@ disabled = true format = 'via [🐂](yellow bold) ' ``` +## Gradle + +The `gradle` module shows the version of the [Gradle Wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html) currently used in the project directory. + +Por padrão o módulo vai exibir se uma das condições a seguir for atendida: + +- The current directory contains a `gradle/wrapper/gradle-wrapper.properties` directory. +- The current directory contains a file ending with `.gradle` or `.gradle.kts`. + +The `gradle` module is only able to read your Gradle Wrapper version from your config file, we don't execute your wrapper, because of the security concerns. + +### Opções + +| Opções | Padrão | Descrição | +| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | +| `version_format` | `"v${raw}"` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🅶 "` | A format string representing the symbol of Gradle. | +| `detect_extensions` | `["gradle", "gradle.kts"]` | Quais extensões devem ativar este módulo. | +| `detect_files` | `[]` | Quais nomes de arquivos devem ativar este módulo. | +| `detect_folders` | `["gradle"]` | Quais pastas devem ativar este módulo. | +| `style` | `"bold bright-cyan"` | O estilo do módulo. | +| `disabled` | `false` | Disables the `gradle` module. | +| `recursive` | `false` | Enables recursive finding for the `gradle` directory. | + +### Variáveis + +| Variável | Exemplo | Descrição | +| -------- | -------- | --------------------------------- | +| version | `v7.5.1` | The version of `gradle` | +| 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 + ## Haskell -O módulo `haskell` encontra a versão atual do GHC selecionada e/ou o snapshot do Stack selecionado. +The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot. Por padrão o módulo vai exibir se uma das condições a seguir for atendida: @@ -1851,25 +1972,25 @@ Por padrão o módulo vai exibir se uma das condições a seguir for atendida: ### Opções -| Opções | Padrão | Descrição | -| ------------------- | ------------------------------------ | --------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | -| `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_files` | `['stack.yaml', 'cabal.project']` | Quais nomes de arquivos devem ativar este módulo. | -| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | -| `style` | `'bold purple'` | O estilo do módulo. | -| `disabled` | `false` | Desativa o módulo `haskell`. | +| Opções | Padrão | Descrição | +| ------------------- | ------------------------------------ | -------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | +| `symbol` | `'λ '` | A format string representing the symbol of Haskell | +| `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_folders` | `[]` | Quais pastas devem ativar este módulo. | +| `style` | `'bold purple'` | O estilo do módulo. | +| `disabled` | `false` | Disables the `haskell` module. | ### Variáveis -| Variável | Exemplo | Descrição | -| -------------- | ----------- | ------------------------------------------------------------------------------ | -| version | | `ghc_version` ou o `snapshot` dependendo se o projeto atual é um projeto Stack | -| snapshot | `lts-18.12` | Snapshot do Stack selecionado | -| ghc\_version | `9.2.1` | Versão do GHC instalada | -| symbol | | Espelha o valor da opção `symbol` | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| -------------- | ----------- | --------------------------------------------------------------------------------------- | +| version | | `ghc_version` or `snapshot` depending on whether the current project is a Stack project | +| snapshot | `lts-18.12` | Currently selected Stack snapshot | +| ghc\_version | `9.2.1` | Currently installed GHC version | +| 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 @@ -1883,16 +2004,16 @@ The `haxe` module shows the currently installed version of [Haxe](https://haxe.o ### Opções -| Opções | Padrão | Descrição | -| ------------------- | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | -| `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `detect_extensions` | `["hx", "hxml"]` | Quais extensões devem ativar este módulo. | -| `detect_files` | `["project.xml", "Project.xml", "application.xml", "haxelib.json", "hxformat.json", ".haxerc"]` | Quais nomes de arquivos devem ativar este módulo. | -| `detect_folders` | `[".haxelib", "haxe_libraries"]` | Quais pastas devem ativar este módulo. | -| `symbol` | `"⌘ "` | O formato de string que representa o simbolo do Helm. | -| `style` | `"bold fg:202"` | O estilo do módulo. | -| `disabled` | `false` | Disables the `haxe` module. | +| Opções | Padrão | Descrição | +| ------------------- | ----------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | +| `version_format` | `"v${raw}"` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | +| `detect_extensions` | `["hx", "hxml"]` | Quais extensões devem ativar este módulo. | +| `detect_files` | `["project.xml", "Project.xml", "application.xml", "haxelib.json", "hxformat.json", ".haxerc"]` | Quais nomes de arquivos devem ativar este módulo. | +| `detect_folders` | `[".haxelib", "haxe_libraries"]` | Quais pastas devem ativar este módulo. | +| `symbol` | `"⌘ "` | A format string representing the symbol of Helm. | +| `style` | `"bold fg:202"` | O estilo do módulo. | +| `disabled` | `false` | Disables the `haxe` module. | ### Variáveis @@ -1915,7 +2036,7 @@ format = "via [⌘ $version](bold fg:202) " ## Helm -O módulo `helm` exibe a versão atual instalada do [Helm](https://helm.sh/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: +The `helm` module shows the currently installed version of [Helm](https://helm.sh/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: - O diretório atual conter um arquivo `helmfile.yaml` - O diretório atual contem um arquivo `Chart.yaml` @@ -1929,15 +2050,15 @@ O módulo `helm` exibe a versão atual instalada do [Helm](https://helm.sh/). Po | `detect_extensions` | `[]` | Quais extensões devem ativar este módulo. | | `detect_files` | `['helmfile.yaml', 'Chart.yaml']` | Quais nomes de arquivos devem ativar este módulo. | | `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | -| `symbol` | `'⎈ '` | O formato de string que representa o simbolo do Helm. | +| `symbol` | `'⎈ '` | A format string representing the symbol of Helm. | | `style` | `'bold white'` | O estilo do módulo. | -| `disabled` | `false` | Desabilita o módulo `helm`. | +| `disabled` | `false` | Disables the `helm` module. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | -------- | --------------------------------- | -| version | `v3.1.1` | A versão do `helm` | +| version | `v3.1.1` | The version of `helm` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -1954,26 +2075,26 @@ format = 'via [⎈ $version](bold white) ' ## Hostname -O módulo `hostname` exibe o nome do hostname. +The `hostname` module shows the system hostname. ### Opções -| Opções | Padrão | Descrição | -| ------------ | -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `ssh_only` | `true` | Apenas exibe o hostname quando conectado em uma sessão SSH. | -| `ssh_symbol` | `'🌐 '` | Uma formatação de string que representa o símbolo quando conectado à sessão SSH. | -| `trim_at` | `'.'` | String na qual vai truncar o hostname, após a primeira correspondência. `'.'` will stop after the first dot. `''` will disable any truncation | -| `format` | `'[$ssh_symbol$hostname]($style) in '` | O formato do módulo. | -| `style` | `'bold dimmed green'` | O estilo do módulo. | -| `disabled` | `false` | Desabilita o módulo `hostname`. | +| Opções | Padrão | Descrição | +| ------------ | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | +| `ssh_only` | `true` | Only show hostname when connected to an SSH session. | +| `ssh_symbol` | `'🌐 '` | A format string representing the symbol when connected to SSH session. | +| `trim_at` | `'.'` | String that the hostname is cut off at, after the first match. `'.'` will stop after the first dot. `''` will disable any truncation | +| `format` | `'[$ssh_symbol$hostname]($style) in '` | O formato do módulo. | +| `style` | `'bold dimmed green'` | O estilo do módulo. | +| `disabled` | `false` | Disables the `hostname` module. | ### Variáveis -| Variável | Exemplo | Descrição | -| ---------- | ---------- | -------------------------------------------------------------- | -| hostname | `computer` | O hostname do computador | -| style\* | | Espelha o valor da opção `style` | -| ssh_symbol | `'🌏 '` | O símbolo a ser representado quando conectado à uma sessão SSH | +| Variável | Exemplo | Descrição | +| ---------- | ---------- | ----------------------------------------------------- | +| hostname | `computer` | The hostname of the computer | +| style\* | | Espelha o valor da opção `style` | +| ssh_symbol | `'🌏 '` | The symbol to represent when connected to SSH session | *: Esta variável só pode ser usada como parte de uma string de estilo @@ -1991,7 +2112,7 @@ disabled = false ## Java -O módulo `java` exibe o versão atual instalada do [Java](https://www.oracle.com/java/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: +The `java` module shows the currently installed version of [Java](https://www.oracle.com/java/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: - The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `deps.edn`, `project.clj`, or `build.boot` file - O diretório atual contenha arquivos com as extensões `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` @@ -2005,15 +2126,15 @@ O módulo `java` exibe o versão atual instalada do [Java](https://www.oracle.co | `detect_extensions` | `['java', 'class', 'gradle', 'jar', 'cljs', 'cljc']` | Quais extensões devem ativar este módulo. | | `detect_files` | `['pom.xml', 'build.gradle.kts', 'build.sbt', '.java-version', 'deps.edn', 'project.clj', 'build.boot']` | Quais nomes de arquivos devem ativar este módulo. | | `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | -| `symbol` | `'☕ '` | Um formato de string que representa o simbolo do Java | +| `symbol` | `'☕ '` | A format string representing the symbol of Java | | `style` | `'red dimmed'` | O estilo do módulo. | -| `disabled` | `false` | Desabilita o módulo `java`. | +| `disabled` | `false` | Disables the `java` module. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | ------- | --------------------------------- | -| version | `v14` | A versão do `java` | +| version | `v14` | The version of `java` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -2030,45 +2151,45 @@ symbol = '🌟 ' ## Jobs -O módulo `jobs` exibe o número atual de jobs rodando. O módulo vai ser exibido apenas se existir jobs em segundo plano sendo executados. O módulo vai exibir o número de jobs rodando se ao menos tiver 2 jobs ou mais que o valor da configuração `number_threshold`, se existir. O módulo vai exibir um simbolo se tiver ao menos 1 job ou mais, se o valor da configuração `symbol_threshold` existir. Você pode setar os dois valores para 0 para _sempre_ exibir o simbolo e número de jobs, mesmo que seja 0 os jobs em execução. +The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to _always_ show the symbol and number of jobs, even if there are 0 jobs running. -A funcionalidade padrão é: +The default functionality is: - 0 jobs -> Nada é exibido. - 1 job -> `symbol` é exibido. - 2 jobs or more -> `symbol` + `number` é exibido. -::: warning +::: atenção -Este módulo não é suportado em tcsh e nu. +This module is not supported on tcsh and nu. ::: -::: warning +::: atenção -A opção `threshold` está obsoleta, mas se você quiser usa-la, o módulo vai exibir o numero de jobs rodando se for maior que 1 ou maior que o valor configurado na `threshold`, se ele existir. Se o valor `threshold` for definido como 0, então o módulo vai exibir quando tiver 0 jobs rodando. +The `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. ::: ### Opções -| Opções | Padrão | Descrição | -| ------------------ | ----------------------------- | ------------------------------------------------------------------------- | -| `threshold`* | `1` | Exibe o número de jobs se excedido. | -| `symbol_threshold` | `1` | Exibe `symbol` se o número de jobs for ao menos `symbol_threshold`. | -| `number_threshold` | `2` | Exibe o número de jobs se o número de jobs é ao menos `number_threshold`. | -| `format` | `'[$symbol$number]($style) '` | O formato do módulo. | -| `symbol` | `'✦'` | A string usada para representar a variável `symbol`. | -| `style` | `'bold blue'` | O estilo do módulo. | -| `disabled` | `false` | Desabilita o módulo `jobs`. | +| Opções | Padrão | Descrição | +| ------------------ | ----------------------------- | ------------------------------------------------------------------------ | +| `threshold`* | `1` | Show number of jobs if exceeded. | +| `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. | +| `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. | +| `format` | `'[$symbol$number]($style) '` | O formato do módulo. | +| `symbol` | `'✦'` | The string used to represent the `symbol` variable. | +| `style` | `'bold blue'` | O estilo do módulo. | +| `disabled` | `false` | Disables the `jobs` module. | -*: Esta opção está obsoleta, por favor use o `number_threshold` e `symbol_threshold` em vez disso. +*: This option is deprecated, please use the `number_threshold` and `symbol_threshold` options instead. ### Variáveis | Variável | Exemplo | Descrição | | --------- | ------- | --------------------------------- | -| number | `1` | O número de jobs | +| number | `1` | The number of jobs | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -2087,7 +2208,7 @@ symbol_threshold = 0 ## Julia -O módulo `julia` exibe a versão atual instalada do [Julia](https://julialang.org/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: +The `julia` module shows the currently installed version of [Julia](https://julialang.org/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: - O diretório atual contem um arquivo `Project.toml` - O diretório atual contem um arquivo `Manifest.toml` @@ -2095,22 +2216,22 @@ O módulo `julia` exibe a versão atual instalada do [Julia](https://julialang.o ### Opções -| Opções | Padrão | Descrição | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ | -| `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | -| `version_format` | `'v${raw}'` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `detect_extensions` | `['jl']` | Quais extensões devem ativar este módulo. | -| `detect_files` | `['Project.toml', 'Manifest.toml']` | Quais nomes de arquivos devem ativar este módulo. | -| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | -| `symbol` | `'ஃ '` | O formato de string que representa o simbolo do Julia. | -| `style` | `'bold purple'` | O estilo do módulo. | -| `disabled` | `false` | Desabilita o módulo `julia`. | +| Opções | Padrão | Descrição | +| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | +| `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | +| `detect_extensions` | `['jl']` | Quais extensões devem ativar este módulo. | +| `detect_files` | `['Project.toml', 'Manifest.toml']` | Quais nomes de arquivos devem ativar este módulo. | +| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | +| `symbol` | `'ஃ '` | A format string representing the symbol of Julia. | +| `style` | `'bold purple'` | O estilo do módulo. | +| `disabled` | `false` | Disables the `julia` module. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | -------- | --------------------------------- | -| version | `v1.4.0` | A versão do `julia` | +| version | `v1.4.0` | The version of `julia` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -2127,29 +2248,29 @@ symbol = '∴ ' ## Kotlin -O módulo `kotlin` exibie a versão atual instalada do [Kotlin](https://kotlinlang.org/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: +The `kotlin` module shows the currently installed version of [Kotlin](https://kotlinlang.org/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: - O diretório atual contem um arquivo `.kt` ou um arquivo `.kts` ### Opções -| Opções | Padrão | Descrição | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ | -| `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | -| `version_format` | `'v${raw}'` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `detect_extensions` | `['kt', 'kts']` | Quais extensões 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. | -| `symbol` | `'🅺 '` | O formato de string que representa o simbolo do Kotlin. | -| `style` | `'bold blue'` | O estilo do módulo. | -| `kotlin_binary` | `'kotlin'` | Configura o binário do kotlin que o Starship executa para obter a versão. | -| `disabled` | `false` | Desabilita o módulo `kotlin`. | +| Opções | Padrão | Descrição | +| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | +| `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | +| `detect_extensions` | `['kt', 'kts']` | Quais extensões 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. | +| `symbol` | `'🅺 '` | A format string representing the symbol of Kotlin. | +| `style` | `'bold blue'` | O estilo do módulo. | +| `kotlin_binary` | `'kotlin'` | Configures the kotlin binary that Starship executes when getting the version. | +| `disabled` | `false` | Disables the `kotlin` module. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | --------- | --------------------------------- | -| version | `v1.4.21` | A versão do `kotlin` | +| version | `v1.4.21` | The version of `kotlin` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -2174,11 +2295,11 @@ kotlin_binary = 'kotlinc' ## Kubernetes -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`. +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`. If the `$KUBECONFIG` env var is set the module will use that if not it will use the `~/.kube/config`. ::: tip -Este módulo é desabilitado por padrão. Para habilitar, defina `disabled` para `false` no seu arquivo de configuração. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. When the module is enabled it will always be active, unless any of `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions. @@ -2186,28 +2307,28 @@ When the module is enabled it will always be active, unless any of `detect_exten ### Opções -| Opções | Padrão | Descrição | -| ------------------- | ---------------------------------------------------- | ------------------------------------------------------------- | -| `symbol` | `'☸ '` | Uma string que representa o simbolo exibido antes do Cluster. | -| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | O formato do módulo. | -| `style` | `'cyan bold'` | O estilo do módulo. | -| `context_aliases` | `{}` | Tabela de aliases de contexto para exibir. | -| `user_aliases` | `{}` | Table of user aliases to display. | -| `detect_extensions` | `[]` | Quais extensões 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. | -| `disabled` | `true` | Desabilita o módulo `kubernetes`. | +| Opções | Padrão | Descrição | +| ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | +| `symbol` | `'☸ '` | A format string representing the symbol displayed before the Cluster. | +| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | O formato do módulo. | +| `style` | `'cyan bold'` | O estilo do módulo. | +| `context_aliases` | `{}` | Table of context aliases to display. | +| `user_aliases` | `{}` | Table of user aliases to display. | +| `detect_extensions` | `[]` | Quais extensões 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. | +| `disabled` | `true` | Disables the `kubernetes` module. | ### Variáveis -| Variável | Exemplo | Descrição | -| --------- | -------------------- | ------------------------------------------- | -| context | `starship-context` | O nome atual do kubernetes context | -| namespace | `starship-namespace` | Se definido o namespace atual do kubernetes | -| user | `starship-user` | Se definido, o usuário atual do kubernetes | -| cluster | `starship-cluster` | Se definido, o cluster atual do kubernetes | -| symbol | | Espelha o valor da opção `symbol` | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| --------- | -------------------- | ---------------------------------------- | +| context | `starship-context` | The current kubernetes context name | +| namespace | `starship-namespace` | If set, the current kubernetes namespace | +| user | `starship-user` | If set, the current kubernetes user | +| cluster | `starship-cluster` | If set, the current kubernetes cluster | +| 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 @@ -2242,9 +2363,9 @@ detect_files = ['k8s'] Additional to simple aliasing, `context_aliases` and `user_aliases` also supports extended matching and renaming using regular expressions. -A expressão regular deve coincidir com todo o contexto kube, Grupos de captura podem ser referenciados usando `$name` e `$N` na substituição. Isto esta mais explicado na documentação do [regex crate](https://docs.rs/regex/1.5.4/regex/struct.Regex.html#method.replace). +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. -Nomes longos de clusters gerados automaticamente podem ser encurtados usando expressão regular: +Long and automatically generated cluster names can be identified and shortened using regular expressions: ```toml [kubernetes.context_aliases] @@ -2259,15 +2380,15 @@ Nomes longos de clusters gerados automaticamente podem ser encurtados usando exp 'gke_.*_(?P[\\w-]+)' = 'gke-$var_cluster' ``` -## Quebra de Linha +## Line Break -O módulo `line_break` separa o prompt em duas linhas. +The `line_break` module separates the prompt into two lines. ### Opções -| Opções | Padrão | Descrição | -| ---------- | ------- | ----------------------------------------------------------------------------------- | -| `disabled` | `false` | Desabilita o módulo `line_break`, fazendo com que o prompt seja em uma única linha. | +| Opções | Padrão | Descrição | +| ---------- | ------- | ------------------------------------------------------------------ | +| `disabled` | `false` | Disables the `line_break` module, making the prompt a single line. | ### Exemplo @@ -2278,25 +2399,25 @@ O módulo `line_break` separa o prompt em duas linhas. disabled = true ``` -## IP Local +## Local IP -O módulo `localip` mostra o endereço IPv4 da interface primária de rede. +The `localip` module shows the IPv4 address of the primary network interface. ### Opções -| Opções | Padrão | Descrição | -| ---------- | ------------------------- | -------------------------------------------------------------- | -| `ssh_only` | `true` | Apenas mostre o endereço IP quando conectado a uma sessão SSH. | -| `format` | `'[$localipv4]($style) '` | O formato do módulo. | -| `style` | `'bold yellow'` | O estilo do módulo. | -| `disabled` | `true` | Desabilita o módulo `localip`. | +| Opções | Padrão | Descrição | +| ---------- | ------------------------- | ------------------------------------------------------ | +| `ssh_only` | `true` | Only show IP address when connected to an SSH session. | +| `format` | `'[$localipv4]($style) '` | O formato do módulo. | +| `style` | `'bold yellow'` | O estilo do módulo. | +| `disabled` | `true` | Disables the `localip` module. | ### Variáveis -| Variável | Exemplo | Descrição | -| --------- | ------------ | -------------------------------- | -| localipv4 | 192.168.1.13 | Contém o endereço IPv4 principal | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| --------- | ------------ | --------------------------------- | +| localipv4 | 192.168.1.13 | Contains the primary IPv4 address | +| style\* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo @@ -2313,7 +2434,7 @@ disabled = false ## Lua -O módulo `lua` exibe a versão atual instalada do [Lua](http://www.lua.org/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: +The `lua` module shows the currently installed version of [Lua](http://www.lua.org/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: - O diretório atual contém um arquivo `.lua-version` - O diretório atual contém um diretório `lua` @@ -2321,23 +2442,23 @@ O módulo `lua` exibe a versão atual instalada do [Lua](http://www.lua.org/). P ### Opções -| Opções | Padrão | Descrição | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ | -| `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | -| `version_format` | `'v${raw}'` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'🌙 '` | Uma string que representa o simbolo do Lua. | -| `detect_extensions` | `['lua']` | Quais extensões devem ativar este módulo. | -| `detect_files` | `['.lua-version']` | Quais nomes de arquivos devem ativar este módulo. | -| `detect_folders` | `['lua']` | Quais pastas devem ativar este módulo. | -| `style` | `'bold blue'` | O estilo do módulo. | -| `lua_binary` | `'lua'` | Configura o binário lua que o Starship executa para pegar a versão. | -| `disabled` | `false` | Desabilita o módulo `lua`. | +| Opções | Padrão | Descrição | +| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | +| `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'🌙 '` | A format string representing the symbol of Lua. | +| `detect_extensions` | `['lua']` | Quais extensões devem ativar este módulo. | +| `detect_files` | `['.lua-version']` | Quais nomes de arquivos devem ativar este módulo. | +| `detect_folders` | `['lua']` | Quais pastas devem ativar este módulo. | +| `style` | `'bold blue'` | O estilo do módulo. | +| `lua_binary` | `'lua'` | Configures the lua binary that Starship executes when getting the version. | +| `disabled` | `false` | Disables the `lua` module. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | -------- | --------------------------------- | -| version | `v5.4.0` | A versão do `lua` | +| version | `v5.4.0` | The version of `lua` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -2352,40 +2473,40 @@ O módulo `lua` exibe a versão atual instalada do [Lua](http://www.lua.org/). P format = 'via [🌕 $version](bold blue) ' ``` -## Uso de Memória +## Memory Usage -O módulo `memory_usage` mostra a memória atual do sistema e o uso de troca. +The `memory_usage` module shows current system memory and swap usage. -Por padrão o uso do swap é exibido se o total de swap do sistema é diferente de zero. +By default the swap usage is displayed if the total system swap is non-zero. ::: tip -Este módulo é desabilitado por padrão. Para habilitar, defina `disabled` para `false` no seu arquivo de configuração. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### Opções -| Opções | Padrão | Descrição | -| ----------- | ----------------------------------------------- | ------------------------------------------------------------- | -| `threshold` | `75` | Esconde o uso de memoria a menos que exceda esta porcentagem. | -| `format` | `'via $symbol [${ram}( \| ${swap})]($style) '` | O formato do módulo. | -| `symbol` | `'🐏'` | O simbolo usado antes de exibir o uso de memoria. | -| `style` | `'bold dimmed white'` | O estilo do módulo. | -| `disabled` | `true` | Desabilita o módulo `memory_usage`. | +| Opções | Padrão | Descrição | +| ----------- | ----------------------------------------------- | -------------------------------------------------------- | +| `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. | +| `format` | `'via $symbol [${ram}( \| ${swap})]($style) '` | O formato do módulo. | +| `symbol` | `'🐏'` | The symbol used before displaying the memory usage. | +| `style` | `'bold dimmed white'` | O estilo do módulo. | +| `disabled` | `true` | Disables the `memory_usage` module. | ### Variáveis -| Variável | Exemplo | Descrição | -| ---------------- | ------------- | ------------------------------------------------- | -| ram | `31GiB/65GiB` | O uso/total de memoria RAM atual do sistema. | -| ram_pct | `48%` | A porcentagem de uso atual da memoria do sistema. | -| swap\*\* | `1GiB/4GiB` | O tamanho atual do swap do sistema. | -| swap_pct\*\* | `77%` | A porcentagem atual de uso do swap. | -| symbol | `🐏` | Espelha o valor da opção `symbol` | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| ---------------- | ------------- | ------------------------------------------------------------------ | +| ram | `31GiB/65GiB` | The usage/total RAM of the current system memory. | +| ram_pct | `48%` | The percentage of the current system memory. | +| swap\*\* | `1GiB/4GiB` | The swap memory size of the current system swap memory file. | +| swap_pct\*\* | `77%` | The swap memory percentage of the current system swap memory file. | +| symbol | `🐏` | 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 *\*: As informações do arquivo SWAP são exibidas apenas se detectadas no sistema atual +*: This variable can only be used as a part of a style string *\*: The SWAP file information is only displayed if detected on the current system ### Exemplo @@ -2440,26 +2561,27 @@ style = 'bold dimmed green' ## Mercurial Branch -O módulo `hg_branch` exibe o braço atual do repositório no diretório atual. +The `hg_branch` module shows the active branch and topic of the repo in your current directory. ### Opções -| Opções | Padrão | Descrição | -| ------------------- | -------------------------------- | --------------------------------------------------------------------------------------- | -| `symbol` | `' '` | O simbolo usado ante do marcador hg ou nome do braço do repositório no diretório atual. | -| `style` | `'bold purple'` | O estilo do módulo. | -| `format` | `'on [$symbol$branch]($style) '` | O formato do módulo. | -| `truncation_length` | `2^63 - 1` | Trunca o nome do braço hg para `N` caracteres | -| `truncation_symbol` | `'…'` | O simbolo usado para indicar que o nome braço foi truncado. | -| `disabled` | `true` | Desabilita o módulo `hg_branch`. | +| Opções | Padrão | Descrição | +| ------------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------- | +| `symbol` | `' '` | The symbol used before the hg bookmark or branch name of the repo in your current directory. | +| `style` | `'bold purple'` | O estilo do módulo. | +| `format` | `'on [$symbol$branch(:$topic)]($style) '` | O formato do módulo. | +| `truncation_length` | `2^63 - 1` | Truncates the hg branch / topic name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. | +| `disabled` | `true` | Disables the `hg_branch` module. | ### Variáveis -| Variável | Exemplo | Descrição | -| --------- | -------- | --------------------------------- | -| branch | `master` | O braço mercurial ativo | -| symbol | | Espelha o valor da opção `symbol` | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| --------- | --------- | --------------------------------- | +| branch | `master` | The active mercurial branch | +| topic | `feature` | The active mercurial topic | +| 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 @@ -2476,7 +2598,7 @@ truncation_symbol = '' ## Nim -O módulo `nim` exibe a versão atual instalada do [Nim](https://nim-lang.org/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: +The `nim` module shows the currently installed version of [Nim](https://nim-lang.org/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: - O diretório atual conter um arquivo `nim.cfg` - O diretório atual tenha um arquivo com a extensão `.nim` @@ -2487,20 +2609,20 @@ O módulo `nim` exibe a versão atual instalada do [Nim](https://nim-lang.org/). | Opções | Padrão | Descrição | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | O formato do módulo | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module | | `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'👑 '` | O símbolo usado antes de exibir a versão do Nim. | +| `symbol` | `'👑 '` | The symbol used before displaying the version of Nim. | | `detect_extensions` | `['nim', 'nims', 'nimble']` | Quais extensões devem ativar este módulo. | | `detect_files` | `['nim.cfg']` | Quais nomes de arquivos devem ativar este módulo. | | `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | | `style` | `'bold yellow'` | O estilo do módulo. | -| `disabled` | `false` | Desabilita o módulo `nim`. | +| `disabled` | `false` | Disables the `nim` module. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | -------- | --------------------------------- | -| version | `v1.2.0` | A versão do `nimc` | +| version | `v1.2.0` | The version of `nimc` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -2518,25 +2640,27 @@ symbol = '🎣 ' ## Nix-shell -O módulo `nix_shell` exibe o ambiente [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html). O módulo vai exibir quando estiver dentro de um ambiente nix-shell. +The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html) environment. The module will be shown when inside a nix-shell environment. ### Opções -| Opções | Padrão | Descrição | -| ------------ | ---------------------------------------------- | ------------------------------------------------- | -| `format` | `'via [$symbol$state( \($name\))]($style) '` | O formato do módulo. | -| `symbol` | `'❄️ '` | Uma string que representa o simbolo do nix-shell. | -| `style` | `'bold blue'` | O estilo do módulo. | -| `impure_msg` | `'impure'` | Uma string que exibe quando o shell é impuro. | -| `pure_msg` | `'pure'` | Uma string que exibe quando o shell é puro. | -| `disabled` | `false` | Desabilita o módulo `nix_shell`. | +| Opções | Padrão | Descrição | +| ------------- | ---------------------------------------------- | --------------------------------------------------------------------- | +| `format` | `'via [$symbol$state( \($name\))]($style) '` | O formato do módulo. | +| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | +| `style` | `'bold blue'` | O estilo do módulo. | +| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | +| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | +| `unknown_msg` | `''` | A format string shown when it is unknown if the shell is pure/impure. | +| `disabled` | `false` | Disables the `nix_shell` module. | +| `heuristic` | `false` | Attempts to detect new `nix shell`-style shells with a heuristic. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | ------- | --------------------------------- | -| state | `pure` | O estado do nix-shell | -| name | `lorri` | O nome do nix-shell | +| state | `pure` | The state of the nix-shell | +| name | `lorri` | The name of the nix-shell | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -2551,12 +2675,13 @@ O módulo `nix_shell` exibe o ambiente [nix-shell](https://nixos.org/guides/nix- disabled = true impure_msg = '[impure shell](bold red)' pure_msg = '[pure shell](bold green)' +unknown_msg = '[unknown shell](bold yellow)' format = 'via [☃️ $state( \($name\))](bold blue) ' ``` ## Node.js -O módulo `nodejs` exibe a versão atual instalada do [Node.js](https://nodejs.org/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: +The `nodejs` module shows the currently installed version of [Node.js](https://nodejs.org/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: - O diretório atual conter um arquivo `package.json` - O diretório atual tenha um arquivo `.node-version` @@ -2567,23 +2692,23 @@ O módulo `nodejs` exibe a versão atual instalada do [Node.js](https://nodejs.o ### Opções -| Opções | Padrão | Descrição | -| ------------------- | ------------------------------------------ | -------------------------------------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | -| `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `' '` | Uma string que representa o simbolo do Node.js. | -| `detect_extensions` | `['js', 'mjs', 'cjs', 'ts', 'mts', 'cts']` | Quais extensões devem ativar este módulo. | -| `detect_files` | `['package.json', '.node-version']` | Quais nomes de arquivos devem ativar este módulo. | -| `detect_folders` | `['node_modules']` | Quais pastas devem ativar este módulo. | -| `style` | `'bold green'` | O estilo do módulo. | -| `disabled` | `false` | Desabilita o módulo `nodejs`. | -| `not_capable_style` | `bold red` | O estilo para o módulo quando a propriedade engine no package.json não coincide com a versão do Node.js. | +| Opções | Padrão | Descrição | +| ------------------- | ------------------------------------------ | ----------------------------------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | +| `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | +| `symbol` | `' '` | A format string representing the symbol of Node.js. | +| `detect_extensions` | `['js', 'mjs', 'cjs', 'ts', 'mts', 'cts']` | Quais extensões devem ativar este módulo. | +| `detect_files` | `['package.json', '.node-version']` | Quais nomes de arquivos devem ativar este módulo. | +| `detect_folders` | `['node_modules']` | Quais pastas devem ativar este módulo. | +| `style` | `'bold green'` | O estilo do módulo. | +| `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. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | ---------- | --------------------------------- | -| version | `v13.12.0` | A versão do `node` | +| version | `v13.12.0` | The version of `node` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -2600,7 +2725,7 @@ format = 'via [🤖 $version](bold green) ' ## OCaml -O módulo `ocaml` exibe a versão atual instalada do [OCaml](https://ocaml.org/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: +The `ocaml` module shows the currently installed version of [OCaml](https://ocaml.org/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: - O diretório atual contenha um arquivo com a extensão`.opam` ou um diretório `_opam` - O diretório atual tenha um diretório `esy.lock` @@ -2615,24 +2740,24 @@ O módulo `ocaml` exibe a versão atual instalada do [OCaml](https://ocaml.org/) | ------------------------- | -------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | | `format` | `'via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)'` | A string de formato do módulo. | | `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'🐫 '` | O símbolo usado antes de exibir a versão do OCaml. | -| `global_switch_indicator` | `''` | A string usada para representar a mudança global OPAM. | -| `local_switch_indicator` | `'*'` | A string usada para representar as mudanças locais do OPAM. | +| `symbol` | `'🐫 '` | The symbol used before displaying the version of OCaml. | +| `global_switch_indicator` | `''` | The format string used to represent global OPAM switch. | +| `local_switch_indicator` | `'*'` | The format string used to represent local OPAM switch. | | `detect_extensions` | `['opam', 'ml', 'mli', 're', 'rei']` | Quais extensões devem ativar este módulo. | | `detect_files` | `['dune', 'dune-project', 'jbuild', 'jbuild-ignore', '.merlin']` | Quais nomes de arquivos devem ativar este módulo. | | `detect_folders` | `['_opam', 'esy.lock']` | Quais pastas devem ativar este módulo. | | `style` | `'bold yellow'` | O estilo do módulo. | -| `disabled` | `false` | Desabilita o módulo `ocaml`. | +| `disabled` | `false` | Disables the `ocaml` module. | ### Variáveis -| Variável | Exemplo | Descrição | -| ---------------- | ------------ | ---------------------------------------------------------------- | -| version | `v4.10.0` | A versão do `ocaml` | -| switch_name | `my-project` | O switch OPAM ativo | -| switch_indicator | | Espelha o valor do `indicator` para o switch ativo atual do OPAM | -| symbol | | Espelha o valor da opção `symbol` | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| ---------------- | ------------ | ----------------------------------------------------------------- | +| version | `v4.10.0` | The version of `ocaml` | +| switch_name | `my-project` | The active OPAM switch | +| switch_indicator | | Mirrors the value of `indicator` for currently active OPAM switch | +| 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 @@ -2683,23 +2808,23 @@ format = 'via [⛑️ $version](bold red) ' ## OpenStack -O módulo `openstack` exibe o OpenStack cloud e projeto atual. O módulo apenas ativa quando a env var `OS_CLOUD` esta definida, neste caso ele vai ler o arquivo `clouds.yaml` de qualquer um dos [default locations](https://docs.openstack.org/python-openstackclient/latest/configuration/index.html#configuration-files). para buscar o projeto atual em uso. +The `openstack` module shows the current OpenStack cloud and project. The module only active when the `OS_CLOUD` env var is set, in which case it will read `clouds.yaml` file from any of the [default locations](https://docs.openstack.org/python-openstackclient/latest/configuration/index.html#configuration-files). to fetch the current project in use. ### Opções -| Opções | Padrão | Descrição | -| ---------- | ----------------------------------------------- | ---------------------------------------------------- | -| `format` | `'on [$symbol$cloud(\($project\))]($style) '` | O formato do módulo. | -| `symbol` | `'☁️ '` | O simbolo usado para exibir o OpenStack cloud atual. | -| `style` | `'bold yellow'` | O estilo do módulo. | -| `disabled` | `false` | Desabilita o módulo `openstack`. | +| Opções | Padrão | Descrição | +| ---------- | ----------------------------------------------- | -------------------------------------------------------------- | +| `format` | `'on [$symbol$cloud(\($project\))]($style) '` | O formato do módulo. | +| `symbol` | `'☁️ '` | The symbol used before displaying the current OpenStack cloud. | +| `style` | `'bold yellow'` | O estilo do módulo. | +| `disabled` | `false` | Disables the `openstack` module. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | ------- | --------------------------------- | -| cloud | `corp` | O OpenStack cloud atual | -| project | `dev` | O projeto OpenStack atual | +| cloud | `corp` | The current OpenStack cloud | +| project | `dev` | The current OpenStack project | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -2720,7 +2845,7 @@ symbol = '☁️ ' The `os` module shows the current operating system. OS information is detected via the [os_info](https://lib.rs/crates/os_info) crate. -::: warning +::: atenção The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. @@ -2728,7 +2853,7 @@ The [os_info](https://lib.rs/crates/os_info) crate used by this module is known ::: tip -Este módulo é desabilitado por padrão. Para habilitar, defina `disabled` para `false` no seu arquivo de configuração. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -2813,9 +2938,9 @@ Windows = " " Arch = "Arch is the best! " ``` -## Versionamento de Pacotes +## Package Version -O módulo `package` é mostrado quando o diretório atual é o repositório de um pacote e mostra sua versão atual. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages. +The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages. - [**npm**](https://docs.npmjs.com/cli/commands/npm) – 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 @@ -2842,17 +2967,17 @@ O módulo `package` é mostrado quando o diretório atual é o repositório de u | Opções | Padrão | Descrição | | ----------------- | --------------------------------- | ----------------------------------------------------------------------------------- | | `format` | `'is [$symbol$version]($style) '` | O formato do módulo. | -| `symbol` | `'📦 '` | O símbolo usado antes de exibir a versão do pacote. | +| `symbol` | `'📦 '` | The symbol used before displaying the version the package. | | `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | | `style` | `'bold 208'` | O estilo do módulo. | -| `display_private` | `false` | Habilita a exibição da versão para os pacotes marcados como privado. | -| `disabled` | `false` | Desabilita o módulo `package`. | +| `display_private` | `false` | Enable displaying version for packages marked as private. | +| `disabled` | `false` | Disables the `package` module. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | -------- | --------------------------------- | -| version | `v1.0.0` | A versão do seu pacote | +| version | `v1.0.0` | The version of your package | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -2869,7 +2994,7 @@ format = 'via [🎁 $version](208 bold) ' ## Perl -O módulo `perl` exibe a versão atual instalada do [Perl](https://www.perl.org/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: +The `perl` module shows the currently installed version of [Perl](https://www.perl.org/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: - O diretório atual tanha um aquivo `Makefile.PL` ou `Build.PL` - O diretório atual tenha um arquivo `cpanfile` ou `cpanfile.snapshot` @@ -2883,18 +3008,18 @@ O módulo `perl` exibe a versão atual instalada do [Perl](https://www.perl.org/ | ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | | `format` | `'via [$symbol($version )]($style)'` | A string de formato do módulo. | | `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'🐪 '` | O símbolo usado antes de exibir a versão do Perl. | +| `symbol` | `'🐪 '` | The symbol used before displaying the version of Perl | | `detect_extensions` | `['pl', 'pm', 'pod']` | Quais extensões devem ativar este módulo. | | `detect_files` | `['Makefile.PL', 'Build.PL', 'cpanfile', 'cpanfile.snapshot', 'META.json', 'META.yml', '.perl-version']` | Quais nomes de arquivos devem ativar este módulo. | | `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | | `style` | `'bold 149'` | O estilo do módulo. | -| `disabled` | `false` | Desabilita o módulo `perl`. | +| `disabled` | `false` | Disables the `perl` module. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | --------- | --------------------------------- | -| version | `v5.26.1` | A versão do `perl` | +| version | `v5.26.1` | The version of `perl` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -2909,9 +3034,9 @@ format = 'via [🦪 $version]($style) ' ## PHP -O módulo `php` mostra a versão atualmente instalada do [PHP](https://www.php.net/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: +The `php` module shows the currently installed version of [PHP](https://www.php.net/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: -- The current directory contains a `composer.json` file +- O diretório atual conter um arquivo `composer.json` - O diretório atual tenha um arquivo `.php-version` - O diretório atual tenha um arquivo com extensão `.php` @@ -2926,13 +3051,13 @@ O módulo `php` mostra a versão atualmente instalada do [PHP](https://www.php.n | `detect_files` | `['composer.json', '.php-version']` | Quais nomes de arquivos devem ativar este módulo. | | `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | | `style` | `'147 bold'` | O estilo do módulo. | -| `disabled` | `false` | Desabilita o módulo `php`. | +| `disabled` | `false` | Disables the `php` module. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | -------- | --------------------------------- | -| version | `v7.3.8` | A versão do `php` | +| version | `v7.3.8` | The version of `php` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -2947,13 +3072,28 @@ O módulo `php` mostra a versão atualmente instalada do [PHP](https://www.php.n format = 'via [🔹 $version](147 bold) ' ``` +## Pijul Channel + +The `pijul_channel` module shows the active channel of the repo in your current directory. + +### Opções + +| Opções | Padrão | Descrição | +| ------------------- | --------------------------------- | ------------------------------------------------------------------------------------ | +| `symbol` | `' '` | The symbol used before the pijul channel name of the repo in your current directory. | +| `style` | `'bold purple'` | O estilo do módulo. | +| `format` | `'on [$symbol$channel]($style) '` | O formato do módulo. | +| `truncation_length` | `2^63 - 1` | Truncates the pijul channel name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. | +| `disabled` | `true` | Disables the `pijul` module. | + ## Pulumi -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. +The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. ::: tip -Por padrão a versão do Pulumi não é exibida, pois leva um tempo maior para ser carregada. Em média a maioria dos plugins leva (~70ms). Se você ainda deseja ativa-la, [siga o exemplo abaixo](#with-pulumi-version). +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). ::: @@ -2968,20 +3108,20 @@ Por padrão o módulo vai exibir se uma das condições a seguir for atendida: | ---------------- | -------------------------------------------- | ----------------------------------------------------------------------------------- | | `format` | `'via [$symbol($username@)$stack]($style) '` | A string de formato do módulo. | | `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `' '` | Uma string que é exibida antes do Pulumi stack. | +| `symbol` | `' '` | A format string shown before the Pulumi stack. | | `style` | `'bold 5'` | O estilo do módulo. | | `search_upwards` | `true` | Enable discovery of pulumi config files in parent directories. | -| `disabled` | `false` | Desabilita o módulo `pulumi`. | +| `disabled` | `false` | Disables the `pulumi` module. | ### Variáveis -| Variável | Exemplo | Descrição | -| --------------- | ---------- | --------------------------------- | -| version | `v0.12.24` | A versão do `pulumi` | -| stack | `dev` | A stack Pulumi atual | -| nome do usuário | `alice` | O nome de usuário Pulumi atual | -| symbol | | Espelha o valor da opção `symbol` | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| --------- | ---------- | --------------------------------- | +| version | `v0.12.24` | The version of `pulumi` | +| stack | `dev` | The current Pulumi stack | +| username | `alice` | The current Pulumi username | +| 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 @@ -3007,7 +3147,7 @@ format = '[$symbol$stack]($style) ' ## PureScript -O módulo `purescript` exibe a versão atual instalada do [PureScript](https://www.purescript.org/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: +The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. Por padrão o módulo vai exibir se uma das condições a seguir for atendida: - O diretório atual conter um arquivo `spago.dhall` - O diretório atual tenha um arquivo com a extensão `.purs` @@ -3018,18 +3158,18 @@ O módulo `purescript` exibe a versão atual instalada do [PureScript](https://w | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | | `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | | `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'<=> '` | O símbolo usado antes de exibir a versão do PureScript. | +| `symbol` | `'<=> '` | The symbol used before displaying the version of PureScript. | | `detect_extensions` | `['purs']` | Quais extensões devem ativar este módulo. | | `detect_files` | `['spago.dhall']` | Quais nomes de arquivos devem ativar este módulo. | | `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | | `style` | `'bold white'` | O estilo do módulo. | -| `disabled` | `false` | Desabilita o módulo `purescript`. | +| `disabled` | `false` | Disables the `purescript` module. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | -------- | --------------------------------- | -| version | `0.13.5` | A versão do `purescript` | +| version | `0.13.5` | The version of `purescript` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -3046,9 +3186,9 @@ format = 'via [$symbol$version](bold white)' ## Python -O módulo `python` exibe a versão atual instalada do [Python](https://www.python.org/) e o [Python virtual environment](https://docs.python.org/tutorial/venv.html) se algum estiver ativo. +The `python` module shows the currently installed version of [Python](https://www.python.org/) and the current [Python virtual environment](https://docs.python.org/tutorial/venv.html) if one is activated. -Se o `pyenv_version_name` estiver definido como `true`, será exibido o nome da versão do pyenv. Caso contrario, ele exibirá o número da versão do `python --version`. +If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. Por padrão o módulo vai exibir se uma das condições a seguir for atendida: @@ -3064,37 +3204,37 @@ Por padrão o módulo vai exibir se uma das condições a seguir for atendida: ### Opções -| Opções | Padrão | Descrição | -| -------------------- | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | O formato do módulo. | -| `version_format` | `'v${raw}'` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'🐍 '` | Uma string que representa o simbolo do Python | -| `style` | `'yellow bold'` | O estilo do módulo. | -| `pyenv_version_name` | `false` | Usa pyenv para pegar a versão do Python | -| `pyenv_prefix` | `pyenv` | Prefixo antes da versão do pyenv, apenas usado se pyenv for usado | -| `python_binary` | `['python', 'python3', 'python2']` | Configura o binário python que o Starship vai executar para obter a versão. | -| `detect_extensions` | `['py']` | Quais extensões devem acionar este módulo | -| `detect_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` | [] | -| `detect_folders` | `[]` | Quais pastas devem ativar este módulo | -| `disabled` | `false` | Desabilita o módulo `python`. | +| Opções | Padrão | Descrição | +| -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- | +| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | O formato do módulo. | +| `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'🐍 '` | A format string representing the symbol of Python | +| `style` | `'yellow bold'` | O estilo do módulo. | +| `pyenv_version_name` | `false` | Use pyenv to get Python version | +| `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | +| `python_binary` | `['python', 'python3', 'python2']` | Configures the python binaries that Starship should executes when getting the version. | +| `detect_extensions` | `['py']` | Quais extensões devem acionar este módulo | +| `detect_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` | [] | +| `detect_folders` | `[]` | Quais pastas devem ativar este módulo | +| `disabled` | `false` | Disables the `python` module. | ::: tip -A variável `python_binary` aceita uma string ou uma lista de strings. O Starship vai tentar executar cada binário até obter um resultado. Note que você pode apenas alterar o binário em que o Starship executa para pegar a versão do Python não os argumentos que são utilizados. +The `python_binary` variable accepts either a string or a list of strings. Starship will try executing each binary until it gets a result. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used. -O valor padrão e a ordem para o `python_binary` foram escolhidos para identificar primeiro uma versão do Python em um ambiente virtualenv/conda (que atualmente adiciona um `python`, não importa se ele aponta pro `python3` ou `python2`). Este tem efeito de lado, se você tenha um sistema com Python 2 instalado, pode ser usado antes de qualquer Python 3 (pelo menos nas Distros Linux que sempre fazem um symlink `/usr/bin/python` para Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below. +The default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `/usr/bin/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `'python3'` will hide any Python version 2, see example below. ::: ### Variáveis -| Variável | Exemplo | Descrição | -| ------------ | --------------- | --------------------------------------- | -| version | `'v3.8.1'` | A versão do `python` | -| symbol | `'🐍 '` | Espelha o valor da opção `symbol` | -| style | `'yellow bold'` | Espelha o valor da opção `style` | -| pyenv_prefix | `'pyenv '` | Espelha o valor da opção `pyenv_prefix` | -| virtualenv | `'venv'` | O nome atual do `virtualenv` | +| Variável | Exemplo | Descrição | +| ------------ | --------------- | ------------------------------------------ | +| version | `'v3.8.1'` | The version of `python` | +| symbol | `'🐍 '` | Espelha o valor da opção `symbol` | +| style | `'yellow bold'` | Espelha o valor da opção `style` | +| pyenv_prefix | `'pyenv '` | Mirrors the value of option `pyenv_prefix` | +| virtualenv | `'venv'` | The current `virtualenv` name | ### Exemplo @@ -3110,7 +3250,7 @@ pyenv_version_name = true # ~/.config/starship.toml [python] -# Use apenas o binário `python3` para obter a versão. +# Only use the `python3` binary to get the version. python_binary = 'python3' ``` @@ -3118,7 +3258,7 @@ python_binary = 'python3' # ~/.config/starship.toml [python] -# Não acione para arquivos com a extensão py +# Don't trigger for files with the py extension detect_extensions = [] ``` @@ -3126,16 +3266,16 @@ detect_extensions = [] # ~/.config/starship.toml [python] -# Exibe a versão do python de dentro de um venv local. +# Display the version of python from inside a local venv. # -# Note que isso só funcionará quando o venv estiver dentro do projeto e só -# funcionará apenas no diretório que contém o diretório venv, mas talvez isso seja ok? +# Note this will only work when the venv is inside the project and it will only +# work in the directory that contains the venv dir but maybe this is ok? python_binary = ['./venv/bin/python', 'python', 'python3', 'python2'] ``` ## R -O módulo `rlang` mostra a versão atualmente instalada do [R](https://www.r-project.org/). O módulo será mostrado se qualquer uma das seguintes condições for atendida: +The `rlang` module shows the currently installed version of [R](https://www.r-project.org/). The module will be shown if any of the following conditions are met: - O diretório atual tenha um arquivo com a extensão `.R`. - O diretório atual tenha um arquivo com a extensão `.Rd`. @@ -3147,22 +3287,22 @@ O módulo `rlang` mostra a versão atualmente instalada do [R](https://www.r-pro ### Opções -| Opções | Padrão | Descrição | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ | -| `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | -| `version_format` | `'v${raw}'` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'📐'` | Uma string que representa o simbolo do R. | -| `style` | `'blue bold'` | O estilo do módulo. | -| `detect_extensions` | `['R', 'Rd', 'Rmd', 'Rproj', 'Rsx']` | Quais extensões devem acionar este módulo | -| `detect_files` | `['.Rprofile']` | [] | -| `detect_folders` | `['.Rproj.user']` | Quais pastas devem ativar este módulo | -| `disabled` | `false` | Desabilita o módulo `r`. | +| Opções | Padrão | Descrição | +| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | +| `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'📐'` | A format string representing the symbol of R. | +| `style` | `'blue bold'` | O estilo do módulo. | +| `detect_extensions` | `['R', 'Rd', 'Rmd', 'Rproj', 'Rsx']` | Quais extensões devem acionar este módulo | +| `detect_files` | `['.Rprofile']` | [] | +| `detect_folders` | `['.Rproj.user']` | Quais pastas devem ativar este módulo | +| `disabled` | `false` | Disables the `r` module. | ### Variáveis | Variável | Exemplo | Descrição | | -------- | ------------- | --------------------------------- | -| version | `v4.0.5` | A versão do `R` | +| version | `v4.0.5` | The version of `R` | | symbol | | Espelha o valor da opção `symbol` | | style | `'blue bold'` | Espelha o valor da opção `style` | @@ -3184,16 +3324,16 @@ The `raku` module shows the currently installed version of [Raku](https://www.ra ### Opções -| Opções | Padrão | Descrição | -| ------------------- | ------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `format` | `'via [$symbol($version-$vm_version )]($style)'` | A string de formato do módulo. | -| `version_format` | `'v${raw}'` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'🦋 '` | The symbol used before displaying the version of Raku | -| `detect_extensions` | `['p6', 'pm6', 'pod6', 'raku', 'rakumod']` | Quais extensões devem ativar este módulo. | -| `detect_files` | `['META6.json']` | Quais nomes de arquivos devem ativar este módulo. | -| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | -| `style` | `'bold 149'` | O estilo do módulo. | -| `disabled` | `false` | Disables the `raku` module. | +| Opções | Padrão | Descrição | +| ------------------- | ------------------------------------------------ | ----------------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version-$vm_version )]($style)'` | A string de formato do módulo. | +| `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'🦋 '` | The symbol used before displaying the version of Raku | +| `detect_extensions` | `['p6', 'pm6', 'pod6', 'raku', 'rakumod']` | Quais extensões devem ativar este módulo. | +| `detect_files` | `['META6.json']` | Quais nomes de arquivos devem ativar este módulo. | +| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | +| `style` | `'bold 149'` | O estilo do módulo. | +| `disabled` | `false` | Disables the `raku` module. | ### Variáveis @@ -3215,28 +3355,28 @@ format = 'via [🦪 $version]($style) ' ## 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: +By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met: - O diretório atual contenha um arquivo com a extensão `.red` or `.reds` ### Opções -| Opções | Padrão | Descrição | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ | -| `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | -| `version_format` | `'v${raw}'` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'🔺 '` | Uma string que representa o simbolo do Red. | -| `detect_extensions` | `['red']` | Quais extensões 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. | -| `style` | `'red bold'` | O estilo do módulo. | -| `disabled` | `false` | Desabilita o módulo `red`. | +| Opções | Padrão | Descrição | +| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | +| `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'🔺 '` | A format string representing the symbol of Red. | +| `detect_extensions` | `['red']` | Quais extensões 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. | +| `style` | `'red bold'` | O estilo do módulo. | +| `disabled` | `false` | Disables the `red` module. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | -------- | --------------------------------- | -| version | `v2.5.1` | A versão do `red` | +| version | `v2.5.1` | The version of `red` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -3253,34 +3393,34 @@ symbol = '🔴 ' ## 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: +By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). The module will be shown if any of the following conditions are met: - O diretório atual tenha um arquivo `Gemfile` - O diretório atual contém um arquivo `.ruby-version` - O diretório atual contem um arquivo `.rb` - As variáveis de ambiente `RUBY_VERSION` ou `RBENV_VERSION` estão definidas -O Starship pega a versão atual do Ruby rodando `ruby -v`. +Starship gets the current Ruby version by running `ruby -v`. ### Opções -| Opções | Padrão | Descrição | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ | -| `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | -| `version_format` | `'v${raw}'` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'💎 '` | Uma string que representa o simbolo do Ruby. | -| `detect_extensions` | `['rb']` | Quais extensões devem ativar este módulo. | -| `detect_files` | `['Gemfile', '.ruby-version']` | Quais nomes de arquivos devem ativar este módulo. | -| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | -| `detect_variables` | `['RUBY_VERSION', 'RBENV_VERSION']` | Quais variáveis de ambiente devem ativar este módulo. | -| `style` | `'bold red'` | O estilo do módulo. | -| `disabled` | `false` | Desabilita o módulo `ruby`. | +| Opções | Padrão | Descrição | +| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | +| `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'💎 '` | A format string representing the symbol of Ruby. | +| `detect_extensions` | `['rb']` | Quais extensões devem ativar este módulo. | +| `detect_files` | `['Gemfile', '.ruby-version']` | Quais nomes de arquivos devem ativar este módulo. | +| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | +| `detect_variables` | `['RUBY_VERSION', 'RBENV_VERSION']` | Which environment variables should trigger this module. | +| `style` | `'bold red'` | O estilo do módulo. | +| `disabled` | `false` | Disables the `ruby` module. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | -------- | --------------------------------- | -| version | `v2.5.1` | A versão do `ruby` | +| version | `v2.5.1` | The version of `ruby` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -3297,33 +3437,33 @@ symbol = '🔺 ' ## 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: +By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). The module will be shown if any of the following conditions are met: - O diretório atual contem um arquivo `Cargo.toml` - O diretório atual tenha um arquivo com a extensão `.rs` ### Opções -| Opções | Padrão | Descrição | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ | -| `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | -| `version_format` | `'v${raw}'` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'🦀 '` | Uma string que representa o simbolo do Rust | -| `detect_extensions` | `['rs']` | Quais extensões devem ativar este módulo. | -| `detect_files` | `['Cargo.toml']` | Quais nomes de arquivos devem ativar este módulo. | -| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | -| `style` | `'bold red'` | O estilo do módulo. | -| `disabled` | `false` | Desabilita o módulo `rust`. | +| Opções | Padrão | Descrição | +| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | +| `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'🦀 '` | A format string representing the symbol of Rust | +| `detect_extensions` | `['rs']` | Quais extensões devem ativar este módulo. | +| `detect_files` | `['Cargo.toml']` | Quais nomes de arquivos devem ativar este módulo. | +| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | +| `style` | `'bold red'` | O estilo do módulo. | +| `disabled` | `false` | Disables the `rust` module. | ### Variáveis -| Variável | Exemplo | Descrição | -| --------- | ----------------- | --------------------------------------- | -| version | `v1.43.0-nightly` | A versão do `rustc` | -| numver | `1.51.0` | O componente numérico da versão `rustc` | -| toolchain | `beta` | A versão do toolchain | -| symbol | | Espelha o valor da opção `symbol` | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| --------- | ----------------- | -------------------------------------------- | +| version | `v1.43.0-nightly` | The version of `rustc` | +| numver | `1.51.0` | The numeric component of the `rustc` version | +| toolchain | `beta` | The toolchain version | +| 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 @@ -3338,7 +3478,7 @@ format = 'via [⚙️ $version](red bold)' ## Scala -O módulo `scala` exibe a versão atual instalada do [Scala](https://www.scala-lang.org/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: +The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: - O diretório atual contem um arquivo `build.sbt`, `.scalaenv` ou `.sbtenv` - O diretório atual tenha um arquivo com a extensão `.scala` ou `.sbt` @@ -3346,22 +3486,22 @@ O módulo `scala` exibe a versão atual instalada do [Scala](https://www.scala-l ### Opções -| Opções | Padrão | Descrição | -| ------------------- | ---------------------------------------- | ------------------------------------------------------------------------------------ | -| `format` | `'via [${symbol}(${version} )]($style)'` | O formato do módulo. | -| `version_format` | `'v${raw}'` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `detect_extensions` | `['sbt', 'scala']` | Quais extensões devem ativar este módulo. | -| `detect_files` | `['.scalaenv', '.sbtenv', 'build.sbt']` | Quais nomes de arquivos devem ativar este módulo. | -| `detect_folders` | `['.metals']` | Quais pastas devem ativar este módulo. | -| `symbol` | `'🆂 '` | Uma string que representa o simbolo do Scala. | -| `style` | `'red dimmed'` | O estilo do módulo. | -| `disabled` | `false` | Desabilita o módulo `scala`. | +| Opções | Padrão | Descrição | +| ------------------- | ---------------------------------------- | ----------------------------------------------------------------------------------- | +| `format` | `'via [${symbol}(${version} )]($style)'` | O formato do módulo. | +| `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | +| `detect_extensions` | `['sbt', 'scala']` | Quais extensões devem ativar este módulo. | +| `detect_files` | `['.scalaenv', '.sbtenv', 'build.sbt']` | Quais nomes de arquivos devem ativar este módulo. | +| `detect_folders` | `['.metals']` | Quais pastas devem ativar este módulo. | +| `symbol` | `'🆂 '` | A format string representing the symbol of Scala. | +| `style` | `'red dimmed'` | O estilo do módulo. | +| `disabled` | `false` | Disables the `scala` module. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | -------- | --------------------------------- | -| version | `2.13.5` | A versão do `scala` | +| version | `2.13.5` | The version of `scala` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -3378,39 +3518,39 @@ symbol = '🌟 ' ## Shell -O módulo de `shell` exibe um indicador para o shell que esta sendo usado. +The `shell` module shows an indicator for currently used shell. ::: tip -Este módulo é desabilitado por padrão. Para habilitar, defina `disabled` para `false` no seu arquivo de configuração. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### Opções -| Opções | Padrão | Descrição | -| ---------------------- | ------------------------- | ------------------------------------------------------- | -| `bash_indicator` | `'bsh'` | Uma string para representar o bash. | -| `fish_indicator` | `'fsh'` | Uma string usada para representar o fish. | -| `zsh_indicator` | `'zsh'` | Uma string usada para representar o zsh. | -| `powershell_indicator` | `'psh'` | Uma string usada para representar o powershell. | -| `ion_indicator` | `'ion'` | Uma string usada para representar o ion. | -| `elvish_indicator` | `'esh'` | Uma string usada para representar o elvish. | -| `tcsh_indicator` | `'tsh'` | Uma string usada para representar o tcsh. | -| `xonsh_indicator` | `'xsh'` | Uma string usada para representar o xonsh. | -| `cmd_indicator` | `'cmd'` | Uma string usada para representar o cmd. | -| `nu_indicator` | `'nu'` | Uma string usada para representar o nu. | -| `unknown_indicator` | `''` | Valor padrão para exibir quando o shell é desconhecido. | -| `format` | `'[$indicator]($style) '` | O formato do módulo. | -| `style` | `'white bold'` | O estilo do módulo. | -| `disabled` | `true` | Desabilita o módulo `shell`. | +| Opções | Padrão | Descrição | +| ---------------------- | ------------------------- | ------------------------------------------------------------ | +| `bash_indicator` | `'bsh'` | A format string used to represent bash. | +| `fish_indicator` | `'fsh'` | A format string used to represent fish. | +| `zsh_indicator` | `'zsh'` | A format string used to represent zsh. | +| `powershell_indicator` | `'psh'` | A format string used to represent powershell. | +| `ion_indicator` | `'ion'` | A format string used to represent ion. | +| `elvish_indicator` | `'esh'` | A format string used to represent elvish. | +| `tcsh_indicator` | `'tsh'` | A format string used to represent tcsh. | +| `xonsh_indicator` | `'xsh'` | A format string used to represent xonsh. | +| `cmd_indicator` | `'cmd'` | A format string used to represent cmd. | +| `nu_indicator` | `'nu'` | A format string used to represent nu. | +| `unknown_indicator` | `''` | The default value to be displayed when the shell is unknown. | +| `format` | `'[$indicator]($style) '` | O formato do módulo. | +| `style` | `'white bold'` | O estilo do módulo. | +| `disabled` | `true` | Disables the `shell` module. | ### Variáveis -| Variável | Padrão | Descrição | -| --------- | ------ | ------------------------------------------------------------- | -| indicator | | Espelha o valor do `indicator` para o shell usado atualmente. | -| style\* | | Espelha o valor da opção `style`. | +| Variável | Padrão | Descrição | +| --------- | ------ | ---------------------------------------------------------- | +| indicator | | Mirrors the value of `indicator` for currently used shell. | +| style\* | | Mirrors the value of option `style`. | *: Esta variável só pode ser usada como parte de uma string de estilo @@ -3433,20 +3573,20 @@ The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/int ### Opções -| Opções | Padrão | Descrição | -| ----------- | ---------------------------- | ----------------------------------------------------------------- | -| `threshold` | `2` | Limite de exibição. | -| `format` | `'[$symbol$shlvl]($style) '` | O formato do módulo. | -| `symbol` | `'↕️ '` | O simbolo usado para representar o `SHLVL`. | -| `repeat` | `false` | Caso o `symbol` deva se repetir de acordo com o total do `SHLVL`. | -| `style` | `'bold yellow'` | O estilo do módulo. | -| `disabled` | `true` | Desabilita o módulo `shlvl`. | +| Opções | Padrão | Descrição | +| ----------- | ---------------------------- | ------------------------------------------------------------- | +| `threshold` | `2` | Display threshold. | +| `format` | `'[$symbol$shlvl]($style) '` | O formato do módulo. | +| `symbol` | `'↕️ '` | The symbol used to represent the `SHLVL`. | +| `repeat` | `false` | Causes `symbol` to be repeated by the current `SHLVL` amount. | +| `style` | `'bold yellow'` | O estilo do módulo. | +| `disabled` | `true` | Disables the `shlvl` module. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | ------- | --------------------------------- | -| shlvl | `3` | O valor atual do `SHLVL` | +| shlvl | `3` | The current value of `SHLVL` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -3465,22 +3605,22 @@ threshold = 3 ## Singularidade -O módulo `singularity` exibe a imagem atual do [Singularity](https://sylabs.io/singularity/), se dentro de um contêiner e definido `$SINGULARITY_NAME`. +The `singularity` module shows the current [Singularity](https://sylabs.io/singularity/) image, if inside a container and `$SINGULARITY_NAME` is set. ### Opções -| Opções | Padrão | Descrição | -| ---------- | -------------------------------- | ------------------------------------------- | -| `format` | `'[$symbol\[$env\]]($style) '` | O formato do módulo. | -| `symbol` | `''` | Uma string exibida antes do nome da imagem. | -| `style` | `'bold dimmed blue'` | O estilo do módulo. | -| `disabled` | `false` | Desabilita o módulo `singularity`. | +| Opções | Padrão | Descrição | +| ---------- | -------------------------------- | ------------------------------------------------ | +| `format` | `'[$symbol\[$env\]]($style) '` | O formato do módulo. | +| `symbol` | `''` | A format string displayed before the image name. | +| `style` | `'bold dimmed blue'` | O estilo do módulo. | +| `disabled` | `false` | Disables the `singularity` module. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | ------------ | --------------------------------- | -| env | `centos.img` | A imagem atual do Singularity | +| env | `centos.img` | The current Singularity image | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -3497,23 +3637,23 @@ format = '[📦 \[$env\]]($style) ' ## Spack -O módulo `spack` mostra o ambiente [Spack](https://spack.readthedocs.io/en/latest/) atual, se o `$SPACK_ENV` estiver definido. +The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set. ### Opções -| Opções | Padrão | Descrição | -| ------------------- | -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `truncation_length` | `1` | O número de diretórios para os quais o caminho do ambiente deve ser truncado. `0` quer dizer sem truncação. Também consulte o módulo [`directory`](#directory). | -| `symbol` | `'🅢 '` | O simbolo usado antes do nome do environment. | -| `style` | `'bold blue'` | O estilo do módulo. | -| `format` | `'via [$symbol$environment]($style) '` | O formato do módulo. | -| `disabled` | `false` | Desabilita o módulo `spack`. | +| 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). | +| `symbol` | `'🅢 '` | O simbolo usado antes do nome do environment. | +| `style` | `'bold blue'` | O estilo do módulo. | +| `format` | `'via [$symbol$environment]($style) '` | O formato do módulo. | +| `disabled` | `false` | Disables the `spack` module. | ### Variáveis | Variável | Exemplo | Descrição | | ----------- | ------------ | --------------------------------- | -| environment | `astronauts` | O ambiente spack atual | +| environment | `astronauts` | The current spack environment | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -3530,11 +3670,11 @@ format = '[$symbol$environment](dimmed blue) ' ## Status -O módulo `status` exibe o código de saída do comando anterior. Se o $success_symbol estiver vazio (padrão), o módulo será exibido apenas se o código de saída não for `0.`. O código de status será convertido em um inteiro de 32 bits signed. +The `status` module displays the exit code of the previous command. If $success_symbol is empty (default), the module will be shown only if the exit code is not `0`. The status code will cast to a signed 32-bit integer. ::: tip -Este módulo é desabilitado por padrão. Para habilitar, defina `disabled` para `false` no seu arquivo de configuração. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -3542,36 +3682,36 @@ Este módulo é desabilitado por padrão. Para habilitar, defina `disabled` para | Opções | Padrão | Descrição | | --------------------------- | ---------------------------------------------------------------------------------- | --------------------------------------------------------------------- | -| `format` | `'[$symbol$status]($style) '` | O formato do módulo | -| `symbol` | `'❌'` | O simbolo exibido no erro de programa | -| `success_symbol` | `''` | O simbolo exibido no sucesso de programa | -| `not_executable_symbol` | `'🚫'` | O simbolo exibido quando o arquivo não é executável | -| `not_found_symbol` | `'🔍'` | O simbolo exibido quando o comando não é encontrado | -| `sigint_symbol` | `'🧱'` | O simbolo exibido no SIGINT (Ctrl + c) | -| `signal_symbol` | `'⚡'` | O simbolo exibido em qualquer sinal | +| `format` | `'[$symbol$status]($style) '` | The format of the module | +| `symbol` | `'❌'` | The symbol displayed on program error | +| `success_symbol` | `''` | The symbol displayed on program success | +| `not_executable_symbol` | `'🚫'` | The symbol displayed when file isn't executable | +| `not_found_symbol` | `'🔍'` | The symbol displayed when the command can't be found | +| `sigint_symbol` | `'🧱'` | The symbol displayed on SIGINT (Ctrl + c) | +| `signal_symbol` | `'⚡'` | The symbol displayed on any signal | | `style` | `'bold red'` | O estilo do módulo. | -| `recognize_signal_code` | `true` | Habilita o mapeamento de sinais para códigos de saída | -| `map_symbol` | `false` | Habilita o mapeamento de símbolos para códigos de saída | -| `pipestatus` | `false` | Habilita o relatório de pipestatus | +| `recognize_signal_code` | `true` | Enable signal mapping from exit code | +| `map_symbol` | `false` | Enable symbols mapping from exit code | +| `pipestatus` | `false` | Enable pipestatus reporting | | `pipestatus_separator` | | | The symbol used to separate pipestatus segments (supports formatting) | -| `pipestatus_format` | `'\[$pipestatus\] => [$symbol$common_meaning$signal_name$maybe_int]($style)'` | O formato do módulo quando o comando é um pipeline | +| `pipestatus_format` | `'\[$pipestatus\] => [$symbol$common_meaning$signal_name$maybe_int]($style)'` | The format of the module when the command is a pipeline | | `pipestatus_segment_format` | | When specified, replaces `format` when formatting pipestatus segments | -| `disabled` | `true` | Desabilita o módulo `status`. | +| `disabled` | `true` | Disables the `status` module. | ### Variáveis -| Variável | Exemplo | Descrição | -| -------------- | ------- | -------------------------------------------------------------------------------------------------------- | -| status | `127` | O codígo de saída do último comando | -| hex_status | `0x7F` | O codígo de saída do último comando em hex | -| int | `127` | O codígo de saída do último comando | -| common_meaning | `ERROR` | Significa que o código não é um sinal | -| signal_number | `9` | Número do sinal correspondente ao código de saída, apenas se sinalizado | -| signal_name | `KILL` | Nome do sinal correspondente ao código de saída, apenas se for sinalizado | -| maybe_int | `7` | Contém o código de saída quando nenhum significado for encontrado | -| pipestatus | | Exibição do pipeline de programas com os códigos de saída, este é apenas disponível no pipestatus_format | -| symbol | | Espelha o valor da opção `symbol` | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| -------------- | ------- | ------------------------------------------------------------------------------------------- | +| status | `127` | The exit code of the last command | +| hex_status | `0x7F` | The exit code of the last command in hex | +| int | `127` | The exit code of the last command | +| common_meaning | `ERROR` | Meaning of the code if not a signal | +| signal_number | `9` | Signal number corresponding to the exit code, only if signalled | +| signal_name | `KILL` | Name of the signal corresponding to the exit code, only if signalled | +| maybe_int | `7` | Contains the exit code number when no meaning has been found | +| pipestatus | | Rendering of in pipeline programs's exit codes, this is only available in pipestatus_format | +| 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 @@ -3591,23 +3731,23 @@ disabled = false ## Sudo -O módulo `sudo` é exibido se uma credencial sudo estiver em cache. O módulo vai ser exibido somente se as credenciais estiverem em cache. +The `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached. ::: tip -Este módulo é desabilitado por padrão. Para habilitar, defina `disabled` para `false` no seu arquivo de configuração. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### Opções -| Opções | Padrão | Descrição | -| --------------- | ------------------------ | -------------------------------------------------------------------------- | -| `format` | `'[as $symbol]($style)'` | O formato do módulo | -| `symbol` | `'🧙 '` | O simbolo exibido quando as credenciais estão em cache | -| `style` | `'bold blue'` | O estilo do módulo. | -| `allow_windows` | `false` | Desde que o Windows não tem um padrão sudo, o valor padrão é desabilitado. | -| `disabled` | `true` | Desabilita o módulo `sudo`. | +| Opções | Padrão | Descrição | +| --------------- | ------------------------ | ------------------------------------------------------- | +| `format` | `'[as $symbol]($style)'` | The format of the module | +| `symbol` | `'🧙 '` | The symbol displayed when credentials are cached | +| `style` | `'bold blue'` | O estilo do módulo. | +| `allow_windows` | `false` | Since windows has no default sudo, default is disabled. | +| `disabled` | `true` | Disables the `sudo` module. | ### Variáveis @@ -3630,7 +3770,7 @@ disabled = false ``` ```toml -# No windows +# On windows # $HOME\.starship\config.toml [sudo] @@ -3640,29 +3780,29 @@ disabled = false ## 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: +By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). The module will be shown if any of the following conditions are met: - O diretório atual tenha um arquivo `Package.swift` - O diretório atual tenha um arquivo com a extensão `.swift` ### Opções -| Opções | Padrão | Descrição | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ | -| `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | -| `version_format` | `'v${raw}'` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'🐦 '` | Uma string que representa o simbolo do Swift | -| `detect_extensions` | `['swift']` | Quais extensões devem ativar este módulo. | -| `detect_files` | `['Package.swift']` | Quais nomes de arquivos devem ativar este módulo. | -| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | -| `style` | `'bold 202'` | O estilo do módulo. | -| `disabled` | `false` | Desabilita o módulo `swift`. | +| Opções | Padrão | Descrição | +| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | +| `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'🐦 '` | A format string representing the symbol of Swift | +| `detect_extensions` | `['swift']` | Quais extensões devem ativar este módulo. | +| `detect_files` | `['Package.swift']` | Quais nomes de arquivos devem ativar este módulo. | +| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | +| `style` | `'bold 202'` | O estilo do módulo. | +| `disabled` | `false` | Disables the `swift` module. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | -------- | --------------------------------- | -| version | `v5.2.4` | A versão do `swift` | +| version | `v5.2.4` | The version of `swift` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -3679,11 +3819,11 @@ format = 'via [🏎 $version](red bold)' ## Terraform -O módulo `terraform` exibe o [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) selecionado e sua versão. +The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. ::: tip -Por padrão a versão do Terraform não é exibida, desde que é lento recuperar a versão atual quando muitos plugins estão em uso. Se você deseja habilitar,, [Siga o exemplo abaixo](#with-terraform-version). +By default the Terraform version is not shown, since this is slow for current versions of Terraform when a lot of plugins are in use. If you still want to enable it, [follow the example shown below](#with-terraform-version). ::: @@ -3698,19 +3838,19 @@ Por padrão o módulo vai exibir se uma das condições a seguir for atendida: | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | | `format` | `'via [$symbol$workspace]($style) '` | A string de formato do módulo. | | `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'💠'` | Uma string que é exibida antes do workspace terraform. | +| `symbol` | `'💠'` | A format string shown before the terraform workspace. | | `detect_extensions` | `['tf', 'tfplan', 'tfstate']` | Quais extensões devem ativar este módulo. | | `detect_files` | `[]` | Quais nomes de arquivos devem ativar este módulo. | | `detect_folders` | `['.terraform']` | Quais pastas devem ativar este módulo. | | `style` | `'bold 105'` | O estilo do módulo. | -| `disabled` | `false` | Desabilita o módulo `terraform`. | +| `disabled` | `false` | Disables the `terraform` module. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | ---------- | --------------------------------- | -| version | `v0.12.24` | A versão do `terraform` | -| workspace | `default` | O workspace atual do Terraform | +| version | `v0.12.24` | The version of `terraform` | +| workspace | `default` | The current Terraform workspace | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -3738,33 +3878,33 @@ format = '[🏎💨 $workspace]($style) ' ## Horário -O módulo `time` exibe a hora **local** atual. A configuração de `format` é usada pelo [`chrono`](https://crates.io/crates/chrono) para controlar qual hora é exibida. Dê uma olhada na [documentação do chrono strftime](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) para ver quais opções estão disponíveis. +The `time` module shows the current **local** time. The `format` configuration value is used by the [`chrono`](https://crates.io/crates/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) to see what options are available. ::: tip -Este módulo é desabilitado por padrão. Para habilitar, defina `disabled` para `false` no seu arquivo de configuração. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### Opções -| Opções | Padrão | Descrição | -| ----------------- | ----------------------- | --------------------------------------------------------------------------------------------------------------------------- | -| `format` | `'at [$time]($style) '` | A string de formato do módulo. | -| `use_12hr` | `false` | Habilita a formatação de 12 horas | -| `time_format` | veja abaixo | A string [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) usada para formatar a hora. | -| `style` | `'bold yellow'` | O estilo do módulo time | -| `utc_time_offset` | `'local'` | Define o UTC a ser usado. Intervalo de -24 < x < 24. Aceita floats para acomodar timezones 30/45. | -| `disabled` | `true` | Desabilita o módulo `time`. | -| `time_range` | `'-'` | Define o intervalo de tempo o qual o módulo será exibido. O horário deve ser especificado no formato de 24-hours | +| Opções | Padrão | Descrição | +| ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | +| `format` | `'at [$time]($style) '` | A string de formato do módulo. | +| `use_12hr` | `false` | Enables 12 hour formatting | +| `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. | +| `style` | `'bold yellow'` | The style for the module time | +| `utc_time_offset` | `'local'` | Sets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. | +| `disabled` | `true` | Disables the `time` module. | +| `time_range` | `'-'` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | -If `use_12hr` is `true`, then `time_format` defaults to `'%r'`. Otherwise, it defaults to `'%T'`. Ajustes manuais no `time_format` irão sobrescrever a configuração `use_12hr`. +If `use_12hr` is `true`, then `time_format` defaults to `'%r'`. Otherwise, it defaults to `'%T'`. Manually setting `time_format` will override the `use_12hr` setting. ### Variáveis | Variável | Exemplo | Descrição | | --------- | ---------- | -------------------------------- | -| time | `13:08:10` | A hora atual. | +| time | `13:08:10` | The current time. | | style\* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo @@ -3782,9 +3922,9 @@ utc_time_offset = '-5' time_range = '10:00:00-14:00:00' ``` -## Nome do usuário +## Username -O módulo `username` mostra o nome de usuário do usuário ativo. O módulo será mostrado se alguma das seguintes condições for atendida: +The `username` module shows active user's username. The module will be shown if any of the following conditions are met: - O usuário atual é root/admin - O usuário atual não é o mesmo que está logado @@ -3793,26 +3933,26 @@ O módulo `username` mostra o nome de usuário do usuário ativo. O módulo ser ::: tip -Conexões SSH são detectadas checando as variáveis de ambiente `SSH_CONNECTION`, `SSH_CLIENT`, and `SSH_TTY`. Se seu host SSH não tem estas variáveis configuradas, uma alternativa é definir uma delas com valor burro. +SSH connection is detected by checking environment variables `SSH_CONNECTION`, `SSH_CLIENT`, and `SSH_TTY`. If your SSH host does not set up these variables, one workaround is to set one of them with a dummy value. ::: ### Opções -| Opções | Padrão | Descrição | -| ------------- | ----------------------- | --------------------------------------------- | -| `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. | -| `format` | `'[$user]($style) in '` | O formato do módulo. | -| `show_always` | `false` | Sempre exibe o módulo `username`. | -| `disabled` | `false` | Desabilita o módulo `username`. | +| Opções | Padrão | Descrição | +| ------------- | ----------------------- | ------------------------------------------- | +| `style_root` | `'bold red'` | The style used when the user is root/admin. | +| `style_user` | `'bold yellow'` | The style used for non-root users. | +| `format` | `'[$user]($style) in '` | O formato do módulo. | +| `show_always` | `false` | Always shows the `username` module. | +| `disabled` | `false` | Disables the `username` module. | ### Variáveis -| Variável | Exemplo | Descrição | -| -------- | ------------ | -------------------------------------------------------------------------------------- | -| `style` | `'red bold'` | Espelha o valor da opção `style_root` quando o root esta logado e `style_user` se não. | -| `user` | `'fulano'` | O ID do usuário logado atualmente. | +| Variável | Exemplo | Descrição | +| -------- | ------------ | ------------------------------------------------------------------------------------------- | +| `style` | `'red bold'` | Mirrors the value of option `style_root` when root is logged in and `style_user` otherwise. | +| `user` | `'matchai'` | The currently logged-in user ID. | ### Exemplo @@ -3829,28 +3969,28 @@ show_always = true ## Vagrant -O módulo `vagrant` exibe a versão atual instalada do [Vagrant](https://www.vagrantup.com/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: +The `vagrant` module shows the currently installed version of [Vagrant](https://www.vagrantup.com/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: - O diretório atual contem um arquivo `Vagrantfile` ### Opções -| Opções | Padrão | Descrição | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ | -| `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | -| `version_format` | `'v${raw}'` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'⍱ '` | Um formato de string que representa o simbolo do Vagrant. | -| `detect_extensions` | `[]` | Quais extensões devem ativar este módulo. | -| `detect_files` | `['Vagrantfile']` | Quais nomes de arquivos devem ativar este módulo. | -| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | -| `style` | `'cyan bold'` | O estilo do módulo. | -| `disabled` | `false` | Desabilita o módulo `vagrant`. | +| Opções | Padrão | Descrição | +| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | +| `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'⍱ '` | A format string representing the symbol of Vagrant. | +| `detect_extensions` | `[]` | Quais extensões devem ativar este módulo. | +| `detect_files` | `['Vagrantfile']` | Quais nomes de arquivos devem ativar este módulo. | +| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | +| `style` | `'cyan bold'` | O estilo do módulo. | +| `disabled` | `false` | Disables the `vagrant` module. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | ---------------- | --------------------------------- | -| version | `Vagrant 2.2.10` | A versão do `Vagrant` | +| version | `Vagrant 2.2.10` | The version of `Vagrant` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -3867,7 +4007,7 @@ format = 'via [⍱ $version](bold white) ' ## V -O módulo `vlang` exibe a versão atual instalada do [V](https://vlang.io/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: +The `vlang` module shows you your currently installed version of [V](https://vlang.io/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: - O diretório atual cotem qualquer arquivo com a extensão `.v` - O diretório atual contem um arquivo `v.mod`, `vpkg.json` ou `.vpkg-lock.json` @@ -3878,18 +4018,18 @@ O módulo `vlang` exibe a versão atual instalada do [V](https://vlang.io/). Por | ------------------- | -------------------------------------------- | ----------------------------------------------------------------------------------- | | `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | | `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'V '` | Um formato de string que representa o simbolo do V | +| `symbol` | `'V '` | A format string representing the symbol of V | | `detect_extensions` | `['v']` | Quais extensões devem ativar este módulo. | | `detect_files` | `['v.mod', 'vpkg.json', '.vpkg-lock.json' ]` | Quais nomes de arquivos devem ativar este módulo. | | `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | | `style` | `'blue bold'` | O estilo do módulo. | -| `disabled` | `false` | Desabilita o módulo `vlang`. | +| `disabled` | `false` | Disables the `vlang` module. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | ------- | --------------------------------- | -| version | `v0.2` | A versão do `v` | +| version | `v0.2` | The version of `v` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -3903,22 +4043,22 @@ format = 'via [V $version](blue bold) ' ## VCSH -O módulo `vcsh` exibe o repositório [VCSH](https://github.com/RichiH/vcsh) atual ativo. O módulo vai ser exibido apenas se um repositório estiver em uso. +The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. The module will be shown only if a repository is currently in use. ### Opções | Opções | Padrão | Descrição | | ---------- | -------------------------------- | ------------------------------------------------------ | -| `symbol` | `''` | O simbolo usado antes de exibir o nome do repositório. | +| `symbol` | `''` | The symbol used before displaying the repository name. | | `style` | `'bold yellow'` | O estilo do módulo. | | `format` | `'vcsh [$symbol$repo]($style) '` | O formato do módulo. | -| `disabled` | `false` | Desabilita o módulo `vcsh`. | +| `disabled` | `false` | Disables the `vcsh` module. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | ------------------------------------------- | --------------------------------- | -| repo | `dotfiles` if in a VCSH repo named dotfiles | O nome do repositório ativo | +| repo | `dotfiles` if in a VCSH repo named dotfiles | The active repository name | | symbol | | Espelha o valor da opção `symbol` | | style\* | `black bold dimmed` | Espelha o valor da opção `style` | @@ -3935,7 +4075,7 @@ format = '[🆅 $repo](bold blue) ' ## Zig -Por padrão, o módulo `zig` mostra a versão atualmente instalada do [Zig](https://ziglang.org/). O módulo será mostrado se alguma das seguintes condições for atendida: +By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met: - O diretório atual contém arquivo com a extensão `.zig` @@ -3945,9 +4085,9 @@ Por padrão, o módulo `zig` mostra a versão atualmente instalada do [Zig](http | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | | `format` | `'via [$symbol($version )]($style)'` | O formato do módulo. | | `version_format` | `'v${raw}'` | A versão formatada. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'↯ '` | O símbolo usado antes de exibir a versão do Zig. | +| `symbol` | `'↯ '` | The symbol used before displaying the version of Zig. | | `style` | `'bold yellow'` | O estilo do módulo. | -| `disabled` | `false` | Desabilita o módulo `zig`. | +| `disabled` | `false` | Disables the `zig` module. | | `detect_extensions` | `['zig']` | Quais extensões devem ativar este módulo. | | `detect_files` | `[]` | Quais nomes de arquivos devem ativar este módulo. | | `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | @@ -3956,7 +4096,7 @@ Por padrão, o módulo `zig` mostra a versão atualmente instalada do [Zig](http | Variável | Exemplo | Descrição | | --------- | -------- | --------------------------------- | -| version | `v0.6.0` | A versão do `zig` | +| version | `v0.6.0` | The version of `zig` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -3971,11 +4111,11 @@ Por padrão, o módulo `zig` mostra a versão atualmente instalada do [Zig](http symbol = '⚡️ ' ``` -## Comandos Personalizados +## Custom commands -Os módulos `custom` mostram a saída de alguns comandos arbitrários. +The `custom` modules show the output of some arbitrary commands. -Esses módulos serão mostrados se alguma das seguintes condições for atendida: +These modules will be shown if any of the following conditions are met: - O diretório atual contém um arquivo cujo nome está em `detect_files` - O diretório atual contém um diretório cujo nome está em `detect_folders` @@ -3985,85 +4125,85 @@ Esses módulos serão mostrados se alguma das seguintes condições for atendida ::: tip -Vários módulos personalizados podem ser definidos usando um `.`. +Multiple custom modules can be defined by using a `.`. ::: ::: tip -A ordem na qual os módulos personalizados são mostrados pode ser definida individualmente incluindo `${custom.foo}` no `format` de nível superior (como inclui um ponto, você precisa usar `${...}`). Por padrão, o módulo `custom` mostrará todos os módulos personalizados na ordem em que eles foram definidos. +The order in which custom modules are shown can be individually set by including `${custom.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `custom` module will simply show all custom modules in the order they were defined. ::: ::: tip -A [Issue #1252](https://github.com/starship/starship/discussions/1252) contém exemplos de módulos personalizados. Se você tem um exemplo interessante que não esta coberto lá, sinta-se livre para compartilha-lo! +[Issue #1252](https://github.com/starship/starship/discussions/1252) contains examples of custom modules. If you have an interesting example not covered there, feel free to share it there! ::: -::: warning A saída do comando é exibido unescaped no prompt +::: warning Command output is printed unescaped to the prompt -Seja qual for a saída o comando irá gerar uma saída sem modificações no prompt. Isto siguinifica que a saída tenha sequencias especiais estas serão interpretadas pelo seu shell, elas serão expandidas quando exibidas. Estas sequencias especiais são especificas da shell, ex: você pode escrever um módulo de comando que escreve uma sequencia de bash, ex:. `\h`, mas este módulo não irá funcionar no shell fish ou zsh. +Whatever output the command generates is printed unmodified in the prompt. This means if the output contains special sequences that are interpreted by your shell they will be expanded when displayed. These special sequences are shell specific, e.g. you can write a command module that writes bash sequences, e.g. `\h`, but this module will not work in a fish or zsh shell. -Strings de formatação também podem conter sequencias de prompt especificas de shell, ex: [Bash](https://www.gnu.org/software/bash/manual/html_node/Controlling-the-Prompt.html), [Zsh](https://zsh.sourceforge.io/Doc/Release/Prompt-Expansion.html). +Format strings can also contain shell specific prompt sequences, e.g. [Bash](https://www.gnu.org/software/bash/manual/html_node/Controlling-the-Prompt.html), [Zsh](https://zsh.sourceforge.io/Doc/Release/Prompt-Expansion.html). ::: ### Opções -| Opções | Padrão | Descrição | -| ------------------- | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `command` | `''` | O comando cuja a saída deve ser exibida. O comando será passado no stdin para o shell. | -| `when` | `false` | Ou um valor booleano (`true` ou `false`, sem aspas) ou um comando shell de string usado como condição para mostrar o módulo. No caso de uma string, o módulo será mostrado se o comando retornar um código de status `0`. | -| `shell` | | [Veja abaixo](#custom-command-shell) | -| `description` | `''` | 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_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. | -| `symbol` | `''` | O simbolo usado antes de exibir a saída do comando. | -| `style` | `'bold green'` | O estilo do módulo. | -| `format` | `'[$symbol($output )]($style)'` | O formato do módulo. | -| `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). | -| `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` | Ignora a configuração global do `command_timeout` e continua executando comandos externos, não importa quanto tempo eles demorem. | +| Opções | Padrão | Descrição | +| ------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `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. | +| `shell` | | [See below](#custom-command-shell) | +| `description` | `''` | The description of the module that is shown when running `starship explain`. | +| `detect_files` | `[]` | The files that will be searched in the working directory for a match. | +| `detect_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. | +| `symbol` | `''` | The symbol used before displaying the command output. | +| `style` | `'bold green'` | O estilo do módulo. | +| `format` | `'[$symbol($output )]($style)'` | O formato do módulo. | +| `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). | +| `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. | ### Variáveis -| Variável | Descrição | -| --------- | --------------------------------- | -| output | A saída do comando no `shell` | -| symbol | Espelha o valor da opção `symbol` | -| style\* | Espelha o valor da opção `style` | +| Variável | Descrição | +| --------- | -------------------------------------- | +| output | The output of shell command in `shell` | +| 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 #### Comandos personalizados de shell -`shell` aceita uma lista não vazia de string, onde: +`shell` accepts a non-empty list of strings, where: - A primeira string é o caminho para o shell que executará o comando. - Outros argumentos que serão passados para o shell. If unset, it will fallback to STARSHIP_SHELL and then to 'sh' on Linux, and 'cmd /C' on Windows. -O `command` será passado no stdin. +The `command` will be passed in on stdin. -Se o `shell` não for dado ou apenas conter um elemento e o Starship detectar PowerShell ele será usado, os seguintes argumentos serão automaticamente adicionados: `-NoProfile -Command -`. Se `shell` não for fornecido ou contiver apenas um elemento e o Starship detectar que o Cmd será usado, o seguinte argumento será adicionado automaticamente: `/C` e `stdin` serão definidos como `false`. Se `shell` não for fornecido ou contiver apenas um elemento e o Starship detectar que o Nushell será usado, os seguintes argumentos serão adicionados automaticamente: `-c` e `stdin` serão definidos como `false`. Este comportamento pode ser evitado passando explicitamente argumento para o shell, ex. +If `shell` is not given or only contains one element and Starship detects PowerShell will be used, the following arguments will automatically be added: `-NoProfile -Command -`. If `shell` is not given or only contains one element and Starship detects Cmd will be used, the following argument will automatically be added: `/C` and `stdin` will be set to `false`. If `shell` is not given or only contains one element and Starship detects Nushell will be used, the following arguments will automatically be added: `-c` and `stdin` will be set to `false`. This behavior can be avoided by explicitly passing arguments to the shell, e.g. ```toml shell = ['pwsh', '-Command', '-'] ``` -::: warning Tenha certeza que tenha uma configuração de shell +::: warning Make sure your custom shell configuration exits gracefully -Se você definir um comando personalizado, tenha certeza que o shell padrão usado pelo starship execute este comando com uma saída graciosa (via the `shell` option). +If you set a custom command, make sure that the default Shell used by starship will properly execute the command with a graceful exit (via the `shell` option). -Por exemplo, PowerShell requer o parâmetro `-Command` para executar um liner. Omitindo este parâmetro pode ser que o starship entre em um loop recursivo, onde o shell tente carrega um ambiente completo de perfil com o próprio starship novamente e portanto execute novamente o comando, entrando em um loop sem fim. +For example, PowerShell requires the `-Command` parameter to execute a one liner. Omitting this parameter might throw starship into a recursive loop where the shell might try to load a full profile environment with starship itself again and hence re-execute the custom command, getting into a never ending loop. -Parâmetros similares ao `-NoProfile` no PowerShell são recomendados para outras shells, bem como para evitar um tempo de carregamento maior toda vez que o starship for chamado. +Parameters similar to `-NoProfile` in PowerShell are recommended for other shells as well to avoid extra loading time of a custom profile on every starship invocation. -Detecção automática de shell e adição de parâmetros estão sendo implementados atualmente, mas é possível que nem todas as shells sejam cobertas. [Por favor abra uma issue](https://github.com/starship/starship/issues/new/choose) com detalhes do shell e configurações do starship se você acertar algum cenário. +Automatic detection of shells and proper parameters addition are currently implemented, but it's possible that not all shells are covered. [Please open an issue](https://github.com/starship/starship/issues/new/choose) with shell details and starship configuration if you hit such scenario. ::: diff --git a/docs/pt-BR/guide/README.md b/docs/pt-BR/guide/README.md index 8a179924..436fc80a 100644 --- a/docs/pt-BR/guide/README.md +++ b/docs/pt-BR/guide/README.md @@ -9,7 +9,7 @@

Status do workflow Actions do GitHub @@ -423,6 +423,7 @@ Apoie este projeto [tornando-se um patrocinador](https://github.com/sponsors/sta **Supporter Tier** - [Dimension](https://dimension.dev/) +- [Appwrite](https://appwrite.io/)


diff --git a/docs/pt-BR/presets/README.md b/docs/pt-BR/presets/README.md index 92013941..8a7d9d82 100644 --- a/docs/pt-BR/presets/README.md +++ b/docs/pt-BR/presets/README.md @@ -14,7 +14,11 @@ Essa predefinição altera os símbolos para cada módulo usar símbolos com Ner This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt. -::: tip This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). ::: +::: tip + +This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). + +::: [Click to view No Nerd Font preset](./no-nerd-font) @@ -34,7 +38,7 @@ Essa personalização converte os símbolos para cada módulo em texto simples. Esta predefinição oculta a versão do runtime da linguagem. Se você trabalha com containers ou ambientes virtualizados, esta aqui é para você! -[![Captura da tela de predefinição Ocultar Versões de Runtime](/presets/img/no-runtime-versions.png "Clique para ver as personalizações para remover a versão do runtime")](./no-runtimes) +[![Captura de tela de uma personalização ocultando a versão do runtime](/presets/img/no-runtime-versions.png "Clique para ver as personalizações para remover a versão do runtime")](./no-runtimes) ## [No Empty Icons](./no-empty-icons.md) @@ -44,7 +48,7 @@ This preset does not show icons if the toolset is not found. ## [Prompt do Terminal com Pure](./pure-preset.md) -Essa configuração simula a aparência e o comportamento do [Pure](https://github.com/sindresorhus/pure). +Essa personalização simula a aparência e o comportamento do [Pure](https://github.com/sindresorhus/pure). [![Captura de tela da personalização do prompt do terminal usando Pure](/presets/img/pure-preset.png "Clique para ver as personalização para usar no prompt do terminal com Pure")](./pure-preset) diff --git a/docs/pt-PT/README.md b/docs/pt-PT/README.md index c6ecdcd0..f222b780 100644 --- a/docs/pt-PT/README.md +++ b/docs/pt-PT/README.md @@ -149,14 +149,14 @@ description: Starship is the minimal, blazing fast, and extremely customizable p ::: warning - This will change in the future. Only Nushell v0.61+ is supported. + This will change in the future. Only Nushell v0.73+ is supported. ::: - Add the following to to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell): + Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell): ```sh mkdir ~/.cache/starship - starship init nu | save ~/.cache/starship/init.nu + starship init nu | save -f ~/.cache/starship/init.nu ``` And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`): diff --git a/docs/pt-PT/advanced-config/README.md b/docs/pt-PT/advanced-config/README.md index 9a8b0fff..2ea7915d 100644 --- a/docs/pt-PT/advanced-config/README.md +++ b/docs/pt-PT/advanced-config/README.md @@ -207,8 +207,6 @@ Note: The right prompt is a single line following the input location. To right a `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell. -Note: Nushell 0.71.0 or later is required - ### Example ```toml @@ -231,7 +229,7 @@ Produces a prompt like the following: Some shells support a continuation prompt along with the normal prompt. This prompt is rendered instead of the normal prompt when the user has entered an incomplete statement (such as a single left parenthesis or quote). -Starship can set the continuation prompt using the `continuation_prompt` option. The default prompt is `"[∙](bright-black) "`. +Starship can set the continuation prompt using the `continuation_prompt` option. The default prompt is `'[∙](bright-black) '`. Note: `continuation_prompt` should be set to a literal string without any variables. @@ -247,7 +245,7 @@ Note: Continuation prompts are only available in the following shells: # ~/.config/starship.toml # A continuation prompt that displays two filled in arrows -continuation_prompt = "▶▶" +continuation_prompt = '▶▶ ' ``` ## Style Strings diff --git a/docs/pt-PT/config/README.md b/docs/pt-PT/config/README.md index 95bd8201..64db4cb0 100644 --- a/docs/pt-PT/config/README.md +++ b/docs/pt-PT/config/README.md @@ -252,12 +252,14 @@ $singularity\ $kubernetes\ $directory\ $vcsh\ +$fossil_branch\ $git_branch\ $git_commit\ $git_state\ $git_metrics\ $git_status\ $hg_branch\ +$pijul_channel\ $docker_context\ $package\ $c\ @@ -270,6 +272,7 @@ $dotnet\ $elixir\ $elm\ $erlang\ +$fennel\ $golang\ $guix_shell\ $haskell\ @@ -278,6 +281,7 @@ $helm\ $java\ $julia\ $kotlin\ +$gradle\ $lua\ $nim\ $nodejs\ @@ -1305,6 +1309,12 @@ The `env_var` module displays the current value of a selected environment variab ::: tip +The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. + +::: + +::: 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 @@ -1320,13 +1330,14 @@ default = 'unknown user' ### Options -| Option | Default | Description | -| ---------- | ------------------------------ | ---------------------------------------------------------------------------- | -| `symbol` | `''` | The symbol used before displaying the variable value. | -| `variable` | | The environment variable to be displayed. | -| `default` | | The default value to be displayed when the selected variable is not defined. | -| `format` | `'with [$env_value]($style) '` | The format for the module. | -| `disabled` | `false` | Disables the `env_var` module. | +| Option | Default | Description | +| ------------- | ------------------------------ | ---------------------------------------------------------------------------- | +| `symbol` | `""` | The symbol used before displaying the variable value. | +| `variable` | | The environment variable to be displayed. | +| `default` | | The default value to be displayed when the selected variable is not defined. | +| `format` | `"with [$env_value]($style) "` | The format for the module. | +| `description` | `""` | The description of the module that is shown when running `starship explain`. | +| `disabled` | `false` | Disables the `env_var` module. | ### Variables @@ -1399,6 +1410,44 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https: format = 'via [e $version](bold red) ' ``` +## Fennel + +The `fennel` module shows the currently installed version of [Fennel](https://fennel-lang.org). By default the module will be shown if any of the following conditions are met: + +- The current directory contains a file with the `.fnl` extension + +### Options + +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. | +| `style` | `'bold green'` | The style for the module. | +| `detect_extensions` | `[fnl]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `disabled` | `false` | Disables the `fennel` module. | + +### Variables + +| Variable | Example | Description | +| --------- | -------- | ------------------------------------ | +| version | `v1.2.1` | The version of `fennel` | +| symbol | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | + +*: This variable can only be used as a part of a style string + +### Example + +```toml +# ~/.config/starship.toml + +[fennel] +symbol = '⫰ ' +``` + ## Fill The `fill` module fills any extra space on the line with a symbol. If multiple `fill` modules are present in a line they will split the space evenly between them. This is useful for aligning other modules. @@ -1428,6 +1477,42 @@ Produces a prompt that looks like: AA -------------------------------------------- BB -------------------------------------------- CC ``` +## Fossil Branch + +The `fossil_branch` module shows the name of the active branch of the check-out in your current directory. + +### Options + +| Option | Default | Description | +| ------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | +| `format` | `'on [$symbol$branch]($style) '` | The format for the module. Use `'$branch'` to refer to the current branch name. | +| `symbol` | `' '` | The symbol used before the branch name of the check-out in your current directory. | +| `style` | `'bold purple'` | The style for the module. | +| `truncation_length` | `2^63 - 1` | Truncates a Fossil branch name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. | +| `disabled` | `true` | Disables the `fossil_branch` module. | + +### Variables + +| Variable | Example | Description | +| --------- | ------- | ------------------------------------ | +| branch | `trunk` | The active Fossil branch | +| symbol | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | + +*: This variable can only be used as a part of a style string + +### Example + +```toml +# ~/.config/starship.toml + +[fossil_branch] +symbol = '🦎 ' +truncation_length = 4 +truncation_symbol = '' +``` + ## Google Cloud (`gcloud`) The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var. @@ -1562,10 +1647,11 @@ The `git_commit` module shows the current commit hash and also the tag (if any) ### Variables -| Variable | Example | Description | -| --------- | --------- | ----------------------------------- | -| hash | `b703eb3` | The current git commit hash | -| style\* | | Mirrors the value of option `style` | +| Variable | Example | Description | +| --------- | --------- | -------------------------------------------- | +| hash | `b703eb3` | The current git commit hash | +| tag | `v1.0.0` | The tag name if showing tag info is enabled. | +| style\* | | Mirrors the value of option `style` | *: This variable can only be used as a part of a style string @@ -1840,6 +1926,41 @@ disabled = true format = 'via [🐂](yellow bold) ' ``` +## Gradle + +The `gradle` module shows the version of the [Gradle Wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html) currently used in the project directory. + +By default the module will be shown if any of the following conditions are met: + +- The current directory contains a `gradle/wrapper/gradle-wrapper.properties` directory. +- The current directory contains a file ending with `.gradle` or `.gradle.kts`. + +The `gradle` module is only able to read your Gradle Wrapper version from your config file, we don't execute your wrapper, because of the security concerns. + +### Options + +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🅶 "` | A format string representing the symbol of Gradle. | +| `detect_extensions` | `["gradle", "gradle.kts"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `["gradle"]` | Which folders should trigger this module. | +| `style` | `"bold bright-cyan"` | The style for the module. | +| `disabled` | `false` | Disables the `gradle` module. | +| `recursive` | `false` | Enables recursive finding for the `gradle` directory. | + +### Variables + +| Variable | Example | Description | +| -------- | -------- | ------------------------------------ | +| version | `v7.5.1` | The version of `gradle` | +| 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 + ## Haskell The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot. @@ -2440,26 +2561,27 @@ style = 'bold dimmed green' ## Mercurial Branch -The `hg_branch` module shows the active branch of the repo in your current directory. +The `hg_branch` module shows the active branch and topic of the repo in your current directory. ### Options -| Option | Default | Description | -| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------- | -| `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. | -| `format` | `'on [$symbol$branch]($style) '` | The format for the module. | -| `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. | -| `disabled` | `true` | Disables the `hg_branch` module. | +| Option | Default | Description | +| ------------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------- | +| `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. | +| `format` | `'on [$symbol$branch(:$topic)]($style) '` | The format for the module. | +| `truncation_length` | `2^63 - 1` | Truncates the hg branch / topic name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. | +| `disabled` | `true` | Disables the `hg_branch` module. | ### Variables -| Variable | Example | Description | -| --------- | -------- | ------------------------------------ | -| branch | `master` | The active mercurial branch | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| Variable | Example | Description | +| --------- | --------- | ------------------------------------ | +| branch | `master` | The active mercurial branch | +| topic | `feature` | The active mercurial topic | +| 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 @@ -2522,14 +2644,16 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/ ### Options -| Option | Default | Description | -| ------------ | ---------------------------------------------- | ----------------------------------------------------- | -| `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. | -| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | -| `style` | `'bold blue'` | The style for the module. | -| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | -| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | -| `disabled` | `false` | Disables the `nix_shell` module. | +| Option | Default | Description | +| ------------- | ---------------------------------------------- | --------------------------------------------------------------------- | +| `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. | +| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | +| `style` | `'bold blue'` | The style for the module. | +| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | +| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | +| `unknown_msg` | `''` | A format string shown when it is unknown if the shell is pure/impure. | +| `disabled` | `false` | Disables the `nix_shell` module. | +| `heuristic` | `false` | Attempts to detect new `nix shell`-style shells with a heuristic. | ### Variables @@ -2551,6 +2675,7 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/ disabled = true impure_msg = '[impure shell](bold red)' pure_msg = '[pure shell](bold green)' +unknown_msg = '[unknown shell](bold yellow)' format = 'via [☃️ $state( \($name\))](bold blue) ' ``` @@ -2947,6 +3072,21 @@ The `php` module shows the currently installed version of [PHP](https://www.php. format = 'via [🔹 $version](147 bold) ' ``` +## Pijul Channel + +The `pijul_channel` module shows the active channel of the repo in your current directory. + +### Options + +| Option | Default | Description | +| ------------------- | --------------------------------- | ------------------------------------------------------------------------------------ | +| `symbol` | `' '` | The symbol used before the pijul channel name of the repo in your current directory. | +| `style` | `'bold purple'` | The style for the module. | +| `format` | `'on [$symbol$channel]($style) '` | The format for the module. | +| `truncation_length` | `2^63 - 1` | Truncates the pijul channel name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. | +| `disabled` | `true` | Disables the `pijul` module. | + ## Pulumi The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. diff --git a/docs/pt-PT/guide/README.md b/docs/pt-PT/guide/README.md index 055ba601..8b73fa92 100644 --- a/docs/pt-PT/guide/README.md +++ b/docs/pt-PT/guide/README.md @@ -9,7 +9,7 @@

GitHub Actions workflow status @@ -423,6 +423,7 @@ Support this project by [becoming a sponsor](https://github.com/sponsors/starshi **Supporter Tier** - [Dimension](https://dimension.dev/) +- [Appwrite](https://appwrite.io/)


diff --git a/docs/pt-PT/presets/README.md b/docs/pt-PT/presets/README.md index cb3dcf1b..3903bc17 100644 --- a/docs/pt-PT/presets/README.md +++ b/docs/pt-PT/presets/README.md @@ -14,7 +14,11 @@ This preset changes the symbols for each module to use Nerd Font symbols. This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt. -::: tip This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). ::: +::: tip + +This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). + +::: [Click to view No Nerd Font preset](./no-nerd-font) diff --git a/docs/ru-RU/README.md b/docs/ru-RU/README.md index 8d9f4c28..c8ca9016 100644 --- a/docs/ru-RU/README.md +++ b/docs/ru-RU/README.md @@ -149,14 +149,14 @@ description: Starship - минимальная, быстрая и бесконе ::: warning - This will change in the future. Only Nushell v0.61+ is supported. + This will change in the future. Only Nushell v0.73+ is supported. ::: - Add the following to to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell): + Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell): ```sh mkdir ~/.cache/starship - starship init nu | save ~/.cache/starship/init.nu + starship init nu | save -f ~/.cache/starship/init.nu ``` And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`): diff --git a/docs/ru-RU/advanced-config/README.md b/docs/ru-RU/advanced-config/README.md index a7a3011d..4c627fcd 100644 --- a/docs/ru-RU/advanced-config/README.md +++ b/docs/ru-RU/advanced-config/README.md @@ -207,8 +207,6 @@ Note: The right prompt is a single line following the input location. To right a `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell. -Note: Nushell 0.71.0 or later is required - ### Пример ```toml @@ -231,7 +229,7 @@ Produces a prompt like the following: Some shells support a continuation prompt along with the normal prompt. This prompt is rendered instead of the normal prompt when the user has entered an incomplete statement (such as a single left parenthesis or quote). -Starship can set the continuation prompt using the `continuation_prompt` option. The default prompt is `"[∙](bright-black) "`. +Starship can set the continuation prompt using the `continuation_prompt` option. The default prompt is `'[∙](bright-black) '`. Note: `continuation_prompt` should be set to a literal string without any variables. @@ -247,7 +245,7 @@ Note: Continuation prompts are only available in the following shells: # ~/.config/starship.toml # A continuation prompt that displays two filled in arrows -continuation_prompt = "▶▶" +continuation_prompt = '▶▶ ' ``` ## Строки стиля diff --git a/docs/ru-RU/config/README.md b/docs/ru-RU/config/README.md index 34f59d2b..4d4ac44f 100644 --- a/docs/ru-RU/config/README.md +++ b/docs/ru-RU/config/README.md @@ -252,12 +252,14 @@ $singularity\ $kubernetes\ $directory\ $vcsh\ +$fossil_branch\ $git_branch\ $git_commit\ $git_state\ $git_metrics\ $git_status\ $hg_branch\ +$pijul_channel\ $docker_context\ $package\ $c\ @@ -270,6 +272,7 @@ $dotnet\ $elixir\ $elm\ $erlang\ +$fennel\ $golang\ $guix_shell\ $haskell\ @@ -278,6 +281,7 @@ $helm\ $java\ $julia\ $kotlin\ +$gradle\ $lua\ $nim\ $nodejs\ @@ -1305,6 +1309,12 @@ The `env_var` module displays the current value of a selected environment variab ::: tip +The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. + +::: + +::: 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 @@ -1320,13 +1330,14 @@ default = 'unknown user' ### Опции -| Параметр | По умолчанию | Описание | -| ---------- | ------------------------------ | ---------------------------------------------------------------- | -| `symbol` | `''` | Символ, используемый перед отображением значения переменной. | -| `variable` | | Отображаемая переменная окружения. | -| `default` | | Значение отображаемое, когда выбранная переменная не определена. | -| `format` | `'with [$env_value]($style) '` | Формат модуля. | -| `disabled` | `false` | Отключает модуль `env_var`. | +| Параметр | По умолчанию | Описание | +| ------------- | ------------------------------ | ---------------------------------------------------------------------------- | +| `symbol` | `""` | Символ, используемый перед отображением значения переменной. | +| `variable` | | Отображаемая переменная окружения. | +| `default` | | Значение отображаемое, когда выбранная переменная не определена. | +| `format` | `"with [$env_value]($style) "` | Формат модуля. | +| `description` | `""` | The description of the module that is shown when running `starship explain`. | +| `disabled` | `false` | Отключает модуль `env_var`. | ### Переменные @@ -1388,7 +1399,7 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https: | symbol | | Отражает значение параметра `symbol` | | style\* | | Отражает значение параметра `style` | -*: Эта переменная может использоваться только в качестве части строки style +*: This variable can only be used as a part of a style string ### Пример @@ -1399,6 +1410,44 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https: format = 'via [e $version](bold red) ' ``` +## Fennel + +The `fennel` module shows the currently installed version of [Fennel](https://fennel-lang.org). By default the module will be shown if any of the following conditions are met: + +- The current directory contains a file with the `.fnl` extension + +### Опции + +| Параметр | По умолчанию | Описание | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | Формат модуля. | +| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. | +| `style` | `'bold green'` | Стиль модуля. | +| `detect_extensions` | `[fnl]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `disabled` | `false` | Disables the `fennel` module. | + +### Переменные + +| Переменная | Пример | Описание | +| ---------- | -------- | ------------------------------------ | +| version | `v1.2.1` | The version of `fennel` | +| symbol | | Отражает значение параметра `symbol` | +| style\* | | Отражает значение параметра `style` | + +*: Эта переменная может использоваться только в качестве части строки style + +### Пример + +```toml +# ~/.config/starship.toml + +[fennel] +symbol = '⫰ ' +``` + ## Fill The `fill` module fills any extra space on the line with a symbol. If multiple `fill` modules are present in a line they will split the space evenly between them. This is useful for aligning other modules. @@ -1428,6 +1477,42 @@ Produces a prompt that looks like: AA -------------------------------------------- BB -------------------------------------------- CC ``` +## Fossil Branch + +The `fossil_branch` module shows the name of the active branch of the check-out in your current directory. + +### Опции + +| Параметр | По умолчанию | Описание | +| ------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | +| `format` | `'on [$symbol$branch]($style) '` | Формат модуля. Use `'$branch'` to refer to the current branch name. | +| `symbol` | `' '` | The symbol used before the branch name of the check-out in your current directory. | +| `style` | `'bold purple'` | Стиль модуля. | +| `truncation_length` | `2^63 - 1` | Truncates a Fossil branch name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. | +| `disabled` | `true` | Disables the `fossil_branch` module. | + +### Переменные + +| Переменная | Пример | Описание | +| ---------- | ------- | ------------------------------------ | +| branch | `trunk` | The active Fossil branch | +| symbol | | Отражает значение параметра `symbol` | +| style\* | | Отражает значение параметра `style` | + +*: Эта переменная может использоваться только в качестве части строки style + +### Пример + +```toml +# ~/.config/starship.toml + +[fossil_branch] +symbol = '🦎 ' +truncation_length = 4 +truncation_symbol = '' +``` + ## Google Cloud (`gcloud`) The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var. @@ -1501,23 +1586,23 @@ format = 'on [$symbol$account(@$domain)(\($project\))]($style) ' very-long-project-name = 'vlpn' ``` -## Ветвь Git +## Git Branch -Модуль `git_branch` показывает активную ветку репозитория в вашем текущей директории. +The `git_branch` module shows the active branch of the repo in your current directory. ### Опции -| Параметр | По умолчанию | Описание | -| -------------------- | ------------------------------------------------- | --------------------------------------------------------------------------------------------- | -| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | -| `format` | `'on [$symbol$branch(:$remote_branch)]($style) '` | Формат модуля. Use `'$branch'` to refer to the current branch name. | -| `symbol` | `' '` | A format string representing the symbol of git branch. | -| `style` | `'bold purple'` | Стиль модуля. | -| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | -| `truncation_symbol` | `'…'` | Символ, используемый для обозначения усечения названия ветки. You can use `''` for no symbol. | -| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | -| `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. | -| `disabled` | `false` | Отключает модуль `git_branch`. | +| Параметр | По умолчанию | Описание | +| -------------------- | ------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local 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. | +| `style` | `'bold purple'` | Стиль модуля. | +| `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. | +| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | +| `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. | +| `disabled` | `false` | Disables the `git_branch` module. | ### Переменные @@ -1551,21 +1636,22 @@ The `git_commit` module shows the current commit hash and also the tag (if any) | Параметр | По умолчанию | Описание | | -------------------- | ------------------------------ | ------------------------------------------------------------------------------------ | -| `commit_hash_length` | `7` | Длина отображаемого хэша коммита git. | +| `commit_hash_length` | `7` | The length of the displayed git commit hash. | | `format` | `'[\($hash$tag\)]($style) '` | Формат модуля. | | `style` | `'bold green'` | Стиль модуля. | | `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state | | `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. | | `tag_max_candidates` | `0` | How many commits to consider for tag display. The default only allows exact matches. | | `tag_symbol` | `' 🏷 '` | Tag symbol prefixing the info shown | -| `disabled` | `false` | Отключает модуль `git_commit`. | +| `disabled` | `false` | Disables the `git_commit` module. | ### Переменные -| Переменная | Пример | Описание | -| ---------- | --------- | ----------------------------------- | -| hash | `b703eb3` | The current git commit hash | -| style\* | | Отражает значение параметра `style` | +| Переменная | Пример | Описание | +| ---------- | --------- | -------------------------------------------- | +| hash | `b703eb3` | The current git commit hash | +| tag | `v1.0.0` | The tag name if showing tag info is enabled. | +| style\* | | Отражает значение параметра `style` | *: Эта переменная может использоваться только в качестве части строки style @@ -1579,9 +1665,9 @@ commit_hash_length = 4 tag_symbol = '🔖 ' ``` -## Состояние Git +## Git State -Модуль `git_state` будет отображаться в директориях, являющимися частью репозитория git, и там, где выполняется операция, такие как: _REBASING_, _BISECTING_, и т. д. Если есть информация о прогрессе (например, REBASING 3/10), эта информация также будет показана. +The `git_state` module will show in directories which are part of a git repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. If there is progress information (e.g., REBASING 3/10), that information will be shown too. ### Опции @@ -1596,7 +1682,7 @@ tag_symbol = '🔖 ' | `am_or_rebase` | `'AM/REBASE'` | A format string displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. | | `style` | `'bold yellow'` | Стиль модуля. | | `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | Формат модуля. | -| `disabled` | `false` | Отключает модуль `git_state`. | +| `disabled` | `false` | Disables the `git_state` module. | ### Переменные @@ -1607,7 +1693,7 @@ tag_symbol = '🔖 ' | progress_total | `2` | The total operation progress | | style\* | | Отражает значение параметра `style` | -*: Эта переменная может использоваться только в качестве части строки style +*: This variable can only be used as a part of a style string ### Пример @@ -1625,7 +1711,7 @@ The `git_metrics` module will show the number of added and deleted lines in the ::: tip -По умолчанию этот модуль отключен. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -1648,7 +1734,7 @@ The `git_metrics` module will show the number of added and deleted lines in the | added_style\* | | Mirrors the value of option `added_style` | | deleted_style\* | | Mirrors the value of option `deleted_style` | -*: Эта переменная может использоваться только в качестве части строки style +*: This variable can only be used as a part of a style string ### Пример @@ -1662,7 +1748,7 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) ' ## Статус Git -Модуль `git_status` отображает символы, представляющие состояние репозитория в вашей текущей директории. +The `git_status` module shows symbols representing the state of the repo in your current directory. ::: tip @@ -1675,7 +1761,7 @@ The Git Status module is very slow in Windows directories (for example under `/m | Параметр | По умолчанию | Описание | | ------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | | `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | The default format for `git_status` | -| `conflicted` | `'='` | Эта ветка имеет конфликты слияния. | +| `conflicted` | `'='` | This branch has merge conflicts. | | `ahead` | `'⇡'` | The format of `ahead` | | `behind` | `'⇣'` | The format of `behind` | | `diverged` | `'⇕'` | The format of `diverged` | @@ -1688,7 +1774,7 @@ The Git Status module is very slow in Windows directories (for example under `/m | `deleted` | `'✘'` | The format of `deleted` | | `style` | `'bold red'` | Стиль модуля. | | `ignore_submodules` | `false` | Ignore changes to submodules. | -| `disabled` | `false` | Отключает модуль `git_status`. | +| `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. | ### Переменные @@ -1708,7 +1794,7 @@ The following variables can be used in `format`: | `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. | | style\* | Отражает значение параметра `style` | -*: Эта переменная может использоваться только в качестве части строки style +*: This variable can only be used as a part of a style string The following variables can be used in `diverged`: @@ -1719,9 +1805,9 @@ The following variables can be used in `diverged`: The following variables can be used in `conflicted`, `ahead`, `behind`, `untracked`, `stashed`, `modified`, `staged`, `renamed` and `deleted`: -| Переменная | Описание | -| ---------- | -------------------------- | -| `count` | Показать количество файлов | +| Переменная | Описание | +| ---------- | ------------------------ | +| `count` | Show the number of files | ### Пример @@ -1742,7 +1828,7 @@ renamed = '👅' deleted = '🗑' ``` -Показывать счетчик впереди/позади для отслеживаемой ветки +Show ahead/behind count of the branch being tracked ```toml # ~/.config/starship.toml @@ -1787,7 +1873,7 @@ The `golang` module shows the currently installed version of [Go](https://golang | `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. | | `style` | `'bold cyan'` | Стиль модуля. | -| `disabled` | `false` | Отключает модуль `golang`. | +| `disabled` | `false` | Disables the `golang` module. | ### Переменные @@ -1828,7 +1914,7 @@ The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel | symbol | | Отражает значение параметра `symbol` | | style\* | | Отражает значение параметра `style` | -*: Эта переменная может использоваться только в качестве части строки style +*: This variable can only be used as a part of a style string ### Пример @@ -1840,6 +1926,41 @@ disabled = true format = 'via [🐂](yellow bold) ' ``` +## Gradle + +The `gradle` module shows the version of the [Gradle Wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html) currently used in the project directory. + +By default the module will be shown if any of the following conditions are met: + +- The current directory contains a `gradle/wrapper/gradle-wrapper.properties` directory. +- The current directory contains a file ending with `.gradle` or `.gradle.kts`. + +The `gradle` module is only able to read your Gradle Wrapper version from your config file, we don't execute your wrapper, because of the security concerns. + +### Опции + +| Параметр | По умолчанию | Описание | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🅶 "` | A format string representing the symbol of Gradle. | +| `detect_extensions` | `["gradle", "gradle.kts"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `["gradle"]` | Which folders should trigger this module. | +| `style` | `"bold bright-cyan"` | Стиль модуля. | +| `disabled` | `false` | Disables the `gradle` module. | +| `recursive` | `false` | Enables recursive finding for the `gradle` directory. | + +### Переменные + +| Переменная | Пример | Описание | +| ---------- | -------- | ------------------------------------ | +| version | `v7.5.1` | The version of `gradle` | +| symbol | | Отражает значение параметра `symbol` | +| style* | | Отражает значение параметра `style` | + +*: This variable can only be used as a part of a style string + ## Haskell The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot. @@ -1859,7 +1980,7 @@ By default the module will be shown if any of the following conditions are met: | `detect_files` | `['stack.yaml', 'cabal.project']` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `'bold purple'` | Стиль модуля. | -| `disabled` | `false` | Отключает модуль `haskell`. | +| `disabled` | `false` | Disables the `haskell` module. | ### Переменные @@ -1954,24 +2075,24 @@ format = 'via [⎈ $version](bold white) ' ## Имя хоста -Модуль `hostname` отображает имя системы (хоста). +The `hostname` module shows the system hostname. ### Опции -| Параметр | По умолчанию | Описание | -| ------------ | -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | -| `ssh_only` | `true` | Показывать имя хоста только при подключении через SSH. | -| `ssh_symbol` | `'🌐 '` | A format string representing the symbol when connected to SSH session. | -| `trim_at` | `'.'` | Символы, по которую имя хоста будет сокращено после первого совпадения. `'.'` will stop after the first dot. `''` will disable any truncation | -| `format` | `'[$ssh_symbol$hostname]($style) in '` | Формат модуля. | -| `style` | `'bold dimmed green'` | Стиль модуля. | -| `disabled` | `false` | Отключает модуль `hostname`. | +| Параметр | По умолчанию | Описание | +| ------------ | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | +| `ssh_only` | `true` | Only show hostname when connected to an SSH session. | +| `ssh_symbol` | `'🌐 '` | A format string representing the symbol when connected to SSH session. | +| `trim_at` | `'.'` | String that the hostname is cut off at, after the first match. `'.'` will stop after the first dot. `''` will disable any truncation | +| `format` | `'[$ssh_symbol$hostname]($style) in '` | Формат модуля. | +| `style` | `'bold dimmed green'` | Стиль модуля. | +| `disabled` | `false` | Disables the `hostname` module. | ### Переменные | Переменная | Пример | Описание | | ---------- | ---------- | ----------------------------------------------------- | -| имя хоста | `computer` | The hostname of the computer | +| hostname | `computer` | The hostname of the computer | | style\* | | Отражает значение параметра `style` | | ssh_symbol | `'🌏 '` | The symbol to represent when connected to SSH session | @@ -2007,7 +2128,7 @@ The `java` module shows the currently installed version of [Java](https://www.or | `detect_folders` | `[]` | Which folders should trigger this modules. | | `symbol` | `'☕ '` | A format string representing the symbol of Java | | `style` | `'red dimmed'` | Стиль модуля. | -| `disabled` | `false` | Отключает модуль `java`. | +| `disabled` | `false` | Disables the `java` module. | ### Переменные @@ -2017,7 +2138,7 @@ The `java` module shows the currently installed version of [Java](https://www.or | symbol | | Отражает значение параметра `symbol` | | style\* | | Отражает значение параметра `style` | -*: Эта переменная может использоваться только в качестве части строки style +*: This variable can only be used as a part of a style string ### Пример @@ -2028,9 +2149,9 @@ The `java` module shows the currently installed version of [Java](https://www.or symbol = '🌟 ' ``` -## Работы +## Jobs -Модуль `jobs` отображает текущее количество запущенных работ. Модуль будет показан только если работы выполняются в фоне. The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to _always_ show the symbol and number of jobs, even if there are 0 jobs running. +The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to _always_ show the symbol and number of jobs, even if there are 0 jobs running. The default functionality is: @@ -2054,13 +2175,13 @@ The `threshold` option is deprecated, but if you want to use it, the module will | Параметр | По умолчанию | Описание | | ------------------ | ----------------------------- | ------------------------------------------------------------------------ | -| `threshold`* | `1` | Показывать количество работ, если превышено. | +| `threshold`* | `1` | Show number of jobs if exceeded. | | `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. | | `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. | | `format` | `'[$symbol$number]($style) '` | Формат модуля. | | `symbol` | `'✦'` | The string used to represent the `symbol` variable. | | `style` | `'bold blue'` | Стиль модуля. | -| `disabled` | `false` | Отключает модуль `jobs`. | +| `disabled` | `false` | Disables the `jobs` module. | *: This option is deprecated, please use the `number_threshold` and `symbol_threshold` options instead. @@ -2153,7 +2274,7 @@ The `kotlin` module shows the currently installed version of [Kotlin](https://ko | symbol | | Отражает значение параметра `symbol` | | style\* | | Отражает значение параметра `style` | -*: Эта переменная может использоваться только в качестве части строки style +*: This variable can only be used as a part of a style string ### Пример @@ -2178,7 +2299,7 @@ Displays the current [Kubernetes context](https://kubernetes.io/docs/concepts/co ::: tip -По умолчанию этот модуль отключен. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. When the module is enabled it will always be active, unless any of `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions. @@ -2196,7 +2317,7 @@ When the module is enabled it will always be active, unless any of `detect_exten | `detect_extensions` | `[]` | Which extensions should trigger this module. | | `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this modules. | -| `disabled` | `true` | Отключает модуль `kubernetes`. | +| `disabled` | `true` | Disables the `kubernetes` module. | ### Переменные @@ -2209,7 +2330,7 @@ When the module is enabled it will always be active, unless any of `detect_exten | symbol | | Отражает значение параметра `symbol` | | style\* | | Отражает значение параметра `style` | -*: Эта переменная может использоваться только в качестве части строки style +*: This variable can only be used as a part of a style string ### Пример @@ -2259,15 +2380,15 @@ Long and automatically generated cluster names can be identified and shortened u 'gke_.*_(?P[\\w-]+)' = 'gke-$var_cluster' ``` -## Разрыв Строки +## Line Break -Модуль `line_break` разделяет командную строку на две строки. +The `line_break` module separates the prompt into two lines. ### Опции -| Параметр | По умолчанию | Описание | -| ---------- | ------------ | ------------------------------------------------------------------------ | -| `disabled` | `false` | Отключает модуль `line_break`, отображая командную строку в одну строку. | +| Параметр | По умолчанию | Описание | +| ---------- | ------------ | ------------------------------------------------------------------ | +| `disabled` | `false` | Disables the `line_break` module, making the prompt a single line. | ### Пример @@ -2341,7 +2462,7 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o | symbol | | Отражает значение параметра `symbol` | | style\* | | Отражает значение параметра `style` | -*: Эта переменная может использоваться только в качестве части строки style +*: This variable can only be used as a part of a style string ### Пример @@ -2352,27 +2473,27 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o format = 'via [🌕 $version](bold blue) ' ``` -## Использование памяти +## Memory Usage -Модуль `memory_usage` отображает текущую системную память и использование подкачки. +The `memory_usage` module shows current system memory and swap usage. -По умолчанию использование подкачки отображается, если общая сумма подкачки системы не равна нулю. +By default the swap usage is displayed if the total system swap is non-zero. ::: tip -По умолчанию этот модуль отключен. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### Опции -| Параметр | По умолчанию | Описание | -| ----------- | ----------------------------------------------- | ------------------------------------------------------------------ | -| `threshold` | `75` | Скрывать использование памяти, если она не превышает этот процент. | -| `format` | `'via $symbol [${ram}( \| ${swap})]($style) '` | Формат модуля. | -| `symbol` | `'🐏'` | Символ, используемый перед отображением использования памяти. | -| `style` | `'bold dimmed white'` | Стиль модуля. | -| `disabled` | `true` | Отключает модуль `memory_usage`. | +| Параметр | По умолчанию | Описание | +| ----------- | ----------------------------------------------- | -------------------------------------------------------- | +| `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. | +| `format` | `'via $symbol [${ram}( \| ${swap})]($style) '` | Формат модуля. | +| `symbol` | `'🐏'` | The symbol used before displaying the memory usage. | +| `style` | `'bold dimmed white'` | Стиль модуля. | +| `disabled` | `true` | Disables the `memory_usage` module. | ### Переменные @@ -2438,28 +2559,29 @@ symbol = ' ' style = 'bold dimmed green' ``` -## Ветвь Mercurial +## Mercurial Branch -Модуль `hg_branch` показывает активную ветку репозитория в вашей текущей директории. +The `hg_branch` module shows the active branch and topic of the repo in your current directory. ### Опции -| Параметр | По умолчанию | Описание | -| ------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | -| `symbol` | `' '` | Символ, используемый перед закладкой hg или именем ветви репозитория в текущем каталоге. | -| `style` | `'bold purple'` | Стиль модуля. | -| `format` | `'on [$symbol$branch]($style) '` | Формат модуля. | -| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to `N` graphemes | -| `truncation_symbol` | `'…'` | Символ, используемый для обозначения усечения названия ветки. | -| `disabled` | `true` | Отключает модуль `hg_branch`. | +| Параметр | По умолчанию | Описание | +| ------------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------- | +| `symbol` | `' '` | The symbol used before the hg bookmark or branch name of the repo in your current directory. | +| `style` | `'bold purple'` | Стиль модуля. | +| `format` | `'on [$symbol$branch(:$topic)]($style) '` | Формат модуля. | +| `truncation_length` | `2^63 - 1` | Truncates the hg branch / topic name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. | +| `disabled` | `true` | Disables the `hg_branch` module. | ### Переменные -| Переменная | Пример | Описание | -| ---------- | -------- | ------------------------------------ | -| branch | `master` | The active mercurial branch | -| symbol | | Отражает значение параметра `symbol` | -| style\* | | Отражает значение параметра `style` | +| Переменная | Пример | Описание | +| ---------- | --------- | ------------------------------------ | +| branch | `master` | The active mercurial branch | +| topic | `feature` | The active mercurial topic | +| symbol | | Отражает значение параметра `symbol` | +| style\* | | Отражает значение параметра `style` | *: Эта переменная может использоваться только в качестве части строки style @@ -2487,7 +2609,7 @@ The `nim` module shows the currently installed version of [Nim](https://nim-lang | Параметр | По умолчанию | Описание | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | Формат модуля | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `symbol` | `'👑 '` | The symbol used before displaying the version of Nim. | | `detect_extensions` | `['nim', 'nims', 'nimble']` | Which extensions should trigger this module. | @@ -2518,18 +2640,20 @@ symbol = '🎣 ' ## Nix-shell -The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html) environment. Модуль будет показываться внутри среды nix-shell. +The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html) environment. The module will be shown when inside a nix-shell environment. ### Опции -| Параметр | По умолчанию | Описание | -| ------------ | ---------------------------------------------- | ----------------------------------------------------- | -| `format` | `'via [$symbol$state( \($name\))]($style) '` | Формат модуля. | -| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | -| `style` | `'bold blue'` | Стиль модуля. | -| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | -| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | -| `disabled` | `false` | Отключает модуль `nix_shell`. | +| Параметр | По умолчанию | Описание | +| ------------- | ---------------------------------------------- | --------------------------------------------------------------------- | +| `format` | `'via [$symbol$state( \($name\))]($style) '` | Формат модуля. | +| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | +| `style` | `'bold blue'` | Стиль модуля. | +| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | +| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | +| `unknown_msg` | `''` | A format string shown when it is unknown if the shell is pure/impure. | +| `disabled` | `false` | Disables the `nix_shell` module. | +| `heuristic` | `false` | Attempts to detect new `nix shell`-style shells with a heuristic. | ### Переменные @@ -2551,6 +2675,7 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/ disabled = true impure_msg = '[impure shell](bold red)' pure_msg = '[pure shell](bold green)' +unknown_msg = '[unknown shell](bold yellow)' format = 'via [☃️ $state( \($name\))](bold blue) ' ``` @@ -2576,7 +2701,7 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n | `detect_files` | `['package.json', '.node-version']` | Which filenames should trigger this module. | | `detect_folders` | `['node_modules']` | Which folders should trigger this module. | | `style` | `'bold green'` | Стиль модуля. | -| `disabled` | `false` | Отключает модуль `nodejs`. | +| `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. | ### Переменные @@ -2703,7 +2828,7 @@ The `openstack` module shows the current OpenStack cloud and project. The module | symbol | | Отражает значение параметра `symbol` | | style\* | | Отражает значение параметра `style` | -*: Эта переменная может использоваться только в качестве части строки style +*: This variable can only be used as a part of a style string ### Пример @@ -2728,7 +2853,7 @@ The [os_info](https://lib.rs/crates/os_info) crate used by this module is known ::: tip -По умолчанию этот модуль отключен. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -2813,9 +2938,9 @@ Windows = " " Arch = "Arch is the best! " ``` -## Версия пакета +## Package Version -Модуль `package` отображается, когда текущий каталог является репозиторием для пакета и показывает его текущую версию. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages. +The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages. - [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory - [**Cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory @@ -2842,11 +2967,11 @@ Arch = "Arch is the best! " | Параметр | По умолчанию | Описание | | ----------------- | --------------------------------- | ------------------------------------------------------------------------- | | `format` | `'is [$symbol$version]($style) '` | Формат модуля. | -| `symbol` | `'📦 '` | Символ, используемый перед отображением версии пакета. | +| `symbol` | `'📦 '` | The symbol used before displaying the version the package. | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `style` | `'bold 208'` | Стиль модуля. | | `display_private` | `false` | Enable displaying version for packages marked as private. | -| `disabled` | `false` | Отключает модуль `package`. | +| `disabled` | `false` | Disables the `package` module. | ### Переменные @@ -2856,7 +2981,7 @@ Arch = "Arch is the best! " | symbol | | Отражает значение параметра `symbol` | | style\* | | Отражает значение параметра `style` | -*: Эта переменная может использоваться только в качестве части строки style +*: This variable can only be used as a part of a style string ### Пример @@ -2921,12 +3046,12 @@ The `php` module shows the currently installed version of [PHP](https://www.php. | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | | `format` | `'via [$symbol($version )]($style)'` | Формат модуля. | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'🐘 '` | Символ, используемый перед отображением версии PHP. | +| `symbol` | `'🐘 '` | The symbol used before displaying the version of PHP. | | `detect_extensions` | `['php']` | Which extensions should trigger this module. | | `detect_files` | `['composer.json', '.php-version']` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `'147 bold'` | Стиль модуля. | -| `disabled` | `false` | Отключает модуль `php`. | +| `disabled` | `false` | Disables the `php` module. | ### Переменные @@ -2936,7 +3061,7 @@ The `php` module shows the currently installed version of [PHP](https://www.php. | symbol | | Отражает значение параметра `symbol` | | style\* | | Отражает значение параметра `style` | -*: Эта переменная может использоваться только в качестве части строки style +*: This variable can only be used as a part of a style string ### Пример @@ -2947,6 +3072,21 @@ The `php` module shows the currently installed version of [PHP](https://www.php. format = 'via [🔹 $version](147 bold) ' ``` +## Pijul Channel + +The `pijul_channel` module shows the active channel of the repo in your current directory. + +### Опции + +| Параметр | По умолчанию | Описание | +| ------------------- | --------------------------------- | ------------------------------------------------------------------------------------ | +| `symbol` | `' '` | The symbol used before the pijul channel name of the repo in your current directory. | +| `style` | `'bold purple'` | Стиль модуля. | +| `format` | `'on [$symbol$channel]($style) '` | Формат модуля. | +| `truncation_length` | `2^63 - 1` | Truncates the pijul channel name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. | +| `disabled` | `true` | Disables the `pijul` module. | + ## Pulumi The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. @@ -2975,13 +3115,13 @@ By default the module will be shown if any of the following conditions are met: ### Переменные -| Переменная | Пример | Описание | -| ---------------- | ---------- | ------------------------------------ | -| version | `v0.12.24` | The version of `pulumi` | -| stack | `dev` | The current Pulumi stack | -| имя пользователя | `alice` | The current Pulumi username | -| symbol | | Отражает значение параметра `symbol` | -| style\* | | Отражает значение параметра `style` | +| Переменная | Пример | Описание | +| ---------- | ---------- | ------------------------------------ | +| version | `v0.12.24` | The version of `pulumi` | +| stack | `dev` | The current Pulumi stack | +| username | `alice` | The current Pulumi username | +| symbol | | Отражает значение параметра `symbol` | +| style\* | | Отражает значение параметра `style` | *: Эта переменная может использоваться только в качестве части строки style @@ -3033,7 +3173,7 @@ The `purescript` module shows the currently installed version of [PureScript](ht | symbol | | Отражает значение параметра `symbol` | | style\* | | Отражает значение параметра `style` | -*: Эта переменная может использоваться только в качестве части строки style +*: This variable can only be used as a part of a style string ### Пример @@ -3070,7 +3210,7 @@ By default the module will be shown if any of the following conditions are met: | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `symbol` | `'🐍 '` | A format string representing the symbol of Python | | `style` | `'yellow bold'` | Стиль модуля. | -| `pyenv_version_name` | `false` | Использовать pyenv для получения версии Python | +| `pyenv_version_name` | `false` | Use pyenv to get Python version | | `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `python_binary` | `['python', 'python3', 'python2']` | Configures the python binaries that Starship should executes when getting the version. | | `detect_extensions` | `['py']` | Which extensions should trigger this module | @@ -3215,7 +3355,7 @@ format = 'via [🦪 $version]($style) ' ## Red -By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). Модуль будет показан, если любое из следующих условий соблюдено: +By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a file with `.red` or `.reds` extension @@ -3240,7 +3380,7 @@ By default the `red` module shows the currently installed version of [Red](https | symbol | | Отражает значение параметра `symbol` | | style\* | | Отражает значение параметра `style` | -*: Эта переменная может использоваться только в качестве части строки style +*: This variable can only be used as a part of a style string ### Пример @@ -3253,7 +3393,7 @@ symbol = '🔴 ' ## Ruby -By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). Модуль будет показан, если любое из следующих условий соблюдено: +By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). The module will be shown if any of the following conditions are met: - Текущий каталог содержит файл `Gemfile` - Текущий каталог содержит файл `.ruby-version` @@ -3274,7 +3414,7 @@ Starship gets the current Ruby version by running `ruby -v`. | `detect_folders` | `[]` | Which folders should trigger this module. | | `detect_variables` | `['RUBY_VERSION', 'RBENV_VERSION']` | Which environment variables should trigger this module. | | `style` | `'bold red'` | Стиль модуля. | -| `disabled` | `false` | Отключает модуль `ruby`. | +| `disabled` | `false` | Disables the `ruby` module. | ### Переменные @@ -3297,7 +3437,7 @@ symbol = '🔺 ' ## Rust -By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). Модуль будет показан, если любое из следующих условий соблюдено: +By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). The module will be shown if any of the following conditions are met: - Текущий каталог содержит файл `Cargo.toml` - Текущий каталог содержит файл с расширением `.rs` @@ -3313,7 +3453,7 @@ By default the `rust` module shows the currently installed version of [Rust](htt | `detect_files` | `['Cargo.toml']` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `'bold red'` | Стиль модуля. | -| `disabled` | `false` | Отключает модуль `rust`. | +| `disabled` | `false` | Disables the `rust` module. | ### Переменные @@ -3365,7 +3505,7 @@ The `scala` module shows the currently installed version of [Scala](https://www. | symbol | | Отражает значение параметра `symbol` | | style\* | | Отражает значение параметра `style` | -*: Эта переменная может использоваться только в качестве части строки style +*: This variable can only be used as a part of a style string ### Пример @@ -3382,7 +3522,7 @@ The `shell` module shows an indicator for currently used shell. ::: tip -По умолчанию этот модуль отключен. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -3410,7 +3550,7 @@ The `shell` module shows an indicator for currently used shell. | Переменная | По умолчанию | Описание | | ---------- | ------------ | ---------------------------------------------------------- | | indicator | | Mirrors the value of `indicator` for currently used shell. | -| style\* | | Отражает значение параметра `style`. | +| style\* | | Mirrors the value of option `style`. | *: Эта переменная может использоваться только в качестве части строки style @@ -3517,7 +3657,7 @@ The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/lat | symbol | | Отражает значение параметра `symbol` | | style\* | | Отражает значение параметра `style` | -*: Эта переменная может использоваться только в качестве части строки style +*: This variable can only be used as a part of a style string ### Пример @@ -3534,7 +3674,7 @@ The `status` module displays the exit code of the previous command. If $success_ ::: tip -По умолчанию этот модуль отключен. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -3573,7 +3713,7 @@ The `status` module displays the exit code of the previous command. If $success_ | symbol | | Отражает значение параметра `symbol` | | style\* | | Отражает значение параметра `style` | -*: Эта переменная может использоваться только в качестве части строки style +*: This variable can only be used as a part of a style string ### Пример @@ -3595,7 +3735,7 @@ The `sudo` module displays if sudo credentials are currently cached. The module ::: tip -По умолчанию этот модуль отключен. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -3640,7 +3780,7 @@ disabled = false ## Swift -By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). Модуль будет показан, если любое из следующих условий соблюдено: +By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `Package.swift` file - The current directory contains a file with the `.swift` extension @@ -3666,7 +3806,7 @@ By default the `swift` module shows the currently installed version of [Swift](h | symbol | | Отражает значение параметра `symbol` | | style\* | | Отражает значение параметра `style` | -*: Эта переменная может использоваться только в качестве части строки style +*: This variable can only be used as a part of a style string ### Пример @@ -3703,7 +3843,7 @@ By default the module will be shown if any of the following conditions are met: | `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_folders` | `['.terraform']` | Which folders should trigger this module. | | `style` | `'bold 105'` | Стиль модуля. | -| `disabled` | `false` | Отключает модуль `terraform`. | +| `disabled` | `false` | Disables the `terraform` module. | ### Переменные @@ -3714,7 +3854,7 @@ By default the module will be shown if any of the following conditions are met: | symbol | | Отражает значение параметра `symbol` | | style\* | | Отражает значение параметра `style` | -*: Эта переменная может использоваться только в качестве части строки style +*: This variable can only be used as a part of a style string ### Пример @@ -3738,25 +3878,25 @@ format = '[🏎💨 $workspace]($style) ' ## Время -Модуль `time` показывает текущее **локальное** время. Значение конфигурации `format` используется пакетом [`chrono`](https://crates.io/crates/chrono) для контроля того, как отображается время. Ознакомьтесь с [документацией chrono strftime](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html), чтобы увидеть доступные параметры. +The `time` module shows the current **local** time. The `format` configuration value is used by the [`chrono`](https://crates.io/crates/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) to see what options are available. ::: tip -По умолчанию этот модуль отключен. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### Опции -| Параметр | По умолчанию | Описание | -| ----------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `format` | `'at [$time]($style) '` | The format string for the module. | -| `use_12hr` | `false` | Включить 12-часовое форматирование | -| `time_format` | см. ниже | [Строка формата chrono](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html), используемая для форматирования времени. | -| `style` | `'bold yellow'` | Стиль модуля времени | -| `utc_time_offset` | `'local'` | Устанавливает смещение UTC. Range from -24 < x < 24. Разрешает числам с плавающей точкой встраивать 30/45-минутное смещение временной зоны. | -| `disabled` | `true` | Отключает модуль `time`. | -| `time_range` | `'-'` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | +| Параметр | По умолчанию | Описание | +| ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | +| `format` | `'at [$time]($style) '` | The format string for the module. | +| `use_12hr` | `false` | Enables 12 hour formatting | +| `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. | +| `style` | `'bold yellow'` | The style for the module time | +| `utc_time_offset` | `'local'` | Sets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. | +| `disabled` | `true` | Disables the `time` module. | +| `time_range` | `'-'` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | If `use_12hr` is `true`, then `time_format` defaults to `'%r'`. Otherwise, it defaults to `'%T'`. Manually setting `time_format` will override the `use_12hr` setting. @@ -3764,10 +3904,10 @@ If `use_12hr` is `true`, then `time_format` defaults to `'%r'`. Otherwise, it de | Переменная | Пример | Описание | | ---------- | ---------- | ----------------------------------- | -| время | `13:08:10` | The current time. | +| time | `13:08:10` | The current time. | | style\* | | Отражает значение параметра `style` | -*: Эта переменная может использоваться только в качестве части строки style +*: This variable can only be used as a part of a style string ### Пример @@ -3782,9 +3922,9 @@ utc_time_offset = '-5' time_range = '10:00:00-14:00:00' ``` -## Имя пользователя +## Username -Модуль `username` показывает имя текущего пользователя. Модуль будет показан, если любое из следующих условий соблюдено: +The `username` module shows active user's username. The module will be shown if any of the following conditions are met: - The current user is root/admin - Текущий пользователь отличается от залогиненного @@ -3799,13 +3939,13 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, ` ### Опции -| Параметр | По умолчанию | Описание | -| ------------- | ----------------------- | ------------------------------------------------------- | -| `style_root` | `'bold red'` | The style used when the user is root/admin. | -| `style_user` | `'bold yellow'` | Стиль, используемый для всех пользователей, кроме root. | -| `format` | `'[$user]($style) in '` | Формат модуля. | -| `show_always` | `false` | Всегда показывать модуль `username`. | -| `disabled` | `false` | Отключает модуль `username`. | +| Параметр | По умолчанию | Описание | +| ------------- | ----------------------- | ------------------------------------------- | +| `style_root` | `'bold red'` | The style used when the user is root/admin. | +| `style_user` | `'bold yellow'` | The style used for non-root users. | +| `format` | `'[$user]($style) in '` | Формат модуля. | +| `show_always` | `false` | Always shows the `username` module. | +| `disabled` | `false` | Disables the `username` module. | ### Переменные @@ -3854,7 +3994,7 @@ The `vagrant` module shows the currently installed version of [Vagrant](https:// | symbol | | Отражает значение параметра `symbol` | | style\* | | Отражает значение параметра `style` | -*: Эта переменная может использоваться только в качестве части строки style +*: This variable can only be used as a part of a style string ### Пример @@ -3935,7 +4075,7 @@ format = '[🆅 $repo](bold blue) ' ## Zig -By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). Модуль будет показан, если любое из следующих условий соблюдено: +By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `.zig` file @@ -3960,7 +4100,7 @@ By default the the `zig` module shows the currently installed version of [Zig](h | symbol | | Отражает значение параметра `symbol` | | style\* | | Отражает значение параметра `style` | -*: Эта переменная может использоваться только в качестве части строки style +*: This variable can only be used as a part of a style string ### Пример @@ -4016,7 +4156,7 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt | `command` | `''` | The command whose output should be printed. The command will be passed on stdin to the shell. | | `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. | | `shell` | | [See below](#custom-command-shell) | -| `описание` | `''` | The description of the module that is shown when running `starship explain`. | +| `description` | `''` | The description of the module that is shown when running `starship explain`. | | `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_extensions` | `[]` | The extensions that will be searched in the working directory for a match. | @@ -4036,7 +4176,7 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt | symbol | Отражает значение параметра `symbol` | | style\* | Отражает значение параметра `style` | -*: Эта переменная может использоваться только в качестве части строки style +*: This variable can only be used as a part of a style string #### Custom command shell diff --git a/docs/ru-RU/guide/README.md b/docs/ru-RU/guide/README.md index 1298f595..e4a89a0e 100644 --- a/docs/ru-RU/guide/README.md +++ b/docs/ru-RU/guide/README.md @@ -9,7 +9,7 @@

GitHub Actions workflow status @@ -423,6 +423,7 @@ Support this project by [becoming a sponsor](https://github.com/sponsors/starshi **Supporter Tier** - [Dimension](https://dimension.dev/) +- [Appwrite](https://appwrite.io/)


diff --git a/docs/ru-RU/installing/README.md b/docs/ru-RU/installing/README.md index 09aabc3a..25615b14 100644 --- a/docs/ru-RU/installing/README.md +++ b/docs/ru-RU/installing/README.md @@ -15,7 +15,7 @@ There are so many platforms out there that they didn't fit into the main README. Head over to the [Chocolatey installation page](https://chocolatey.org/install) and follow the instructions to install Chocolatey. -### Installation +### Установка ```powershell choco install starship @@ -29,7 +29,7 @@ choco install starship pkg install getconf ``` -### Installation +### Установка ```sh curl -sS https://starship.rs/install.sh | sh -s -- --bin-dir /data/data/com.termux/files/usr/bin @@ -37,7 +37,7 @@ curl -sS https://starship.rs/install.sh | sh -s -- --bin-dir /data/data/com.term ## [Funtoo Linux](https://www.funtoo.org/Welcome) -### Installation +### Установка On Funtoo Linux, starship can be installed from [core-kit](https://github.com/funtoo/core-kit/tree/1.4-release/app-shells/starship) via Portage: diff --git a/docs/ru-RU/presets/README.md b/docs/ru-RU/presets/README.md index b34a9c4e..acfaf78f 100644 --- a/docs/ru-RU/presets/README.md +++ b/docs/ru-RU/presets/README.md @@ -14,7 +14,11 @@ This preset changes the symbols for each module to use Nerd Font symbols. This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt. -::: tip This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). ::: +::: tip + +This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). + +::: [Click to view No Nerd Font preset](./no-nerd-font) diff --git a/docs/tr-TR/README.md b/docs/tr-TR/README.md index 09694be2..4740b82a 100644 --- a/docs/tr-TR/README.md +++ b/docs/tr-TR/README.md @@ -149,14 +149,14 @@ description: Starship, her prompt için minimal, son derece hızlı ve son derec ::: warning - This will change in the future. Only Nushell v0.61+ is supported. + This will change in the future. Only Nushell v0.73+ is supported. ::: - Add the following to to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell): + Nushell env dosyanızın sonuna aşağıdakileri ekleyin (Nushell'de `$nu.env-path` komutunu çalıştırarak bulabilirsiniz): ```sh mkdir ~/.cache/starship - starship init nu | save ~/.cache/starship/init.nu + starship init nu | save -f ~/.cache/starship/init.nu ``` Aşağıdaki kodu Nushell ayarlarınızın (`$nu.config-path` komutu ile ulaşabilirsiniz) sonuna ekleyin: diff --git a/docs/tr-TR/advanced-config/README.md b/docs/tr-TR/advanced-config/README.md index f4de2506..eb1df7e8 100644 --- a/docs/tr-TR/advanced-config/README.md +++ b/docs/tr-TR/advanced-config/README.md @@ -206,8 +206,6 @@ Note: The right prompt is a single line following the input location. To right a `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell. -Note: Nushell 0.71.0 or later is required - ### Example ```toml @@ -230,7 +228,7 @@ Produces a prompt like the following: Some shells support a continuation prompt along with the normal prompt. This prompt is rendered instead of the normal prompt when the user has entered an incomplete statement (such as a single left parenthesis or quote). -Starship can set the continuation prompt using the `continuation_prompt` option. The default prompt is `"[∙](bright-black) "`. +Starship can set the continuation prompt using the `continuation_prompt` option. The default prompt is `'[∙](bright-black) '`. Note: `continuation_prompt` should be set to a literal string without any variables. @@ -246,7 +244,7 @@ Note: Continuation prompts are only available in the following shells: # ~/.config/starship.toml # A continuation prompt that displays two filled in arrows -continuation_prompt = "▶▶" +continuation_prompt = '▶▶ ' ``` ## Style Strings diff --git a/docs/tr-TR/config/README.md b/docs/tr-TR/config/README.md index 9d6a29c7..2db83caf 100644 --- a/docs/tr-TR/config/README.md +++ b/docs/tr-TR/config/README.md @@ -252,12 +252,14 @@ $singularity\ $kubernetes\ $directory\ $vcsh\ +$fossil_branch\ $git_branch\ $git_commit\ $git_state\ $git_metrics\ $git_status\ $hg_branch\ +$pijul_channel\ $docker_context\ $package\ $c\ @@ -270,6 +272,7 @@ $dotnet\ $elixir\ $elm\ $erlang\ +$fennel\ $golang\ $guix_shell\ $haskell\ @@ -278,6 +281,7 @@ $helm\ $java\ $julia\ $kotlin\ +$gradle\ $lua\ $nim\ $nodejs\ @@ -1305,6 +1309,12 @@ The `env_var` module displays the current value of a selected environment variab ::: tip +The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. + +::: + +::: 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 @@ -1320,13 +1330,14 @@ default = 'unknown user' ### Options -| Option | Default | Description | -| ---------- | ------------------------------ | ---------------------------------------------------------------------------- | -| `symbol` | `''` | The symbol used before displaying the variable value. | -| `variable` | | The environment variable to be displayed. | -| `default` | | The default value to be displayed when the selected variable is not defined. | -| `format` | `'with [$env_value]($style) '` | The format for the module. | -| `disabled` | `false` | Disables the `env_var` module. | +| Option | Default | Description | +| ------------- | ------------------------------ | ---------------------------------------------------------------------------- | +| `symbol` | `""` | The symbol used before displaying the variable value. | +| `variable` | | The environment variable to be displayed. | +| `default` | | The default value to be displayed when the selected variable is not defined. | +| `format` | `"with [$env_value]($style) "` | The format for the module. | +| `description` | `""` | The description of the module that is shown when running `starship explain`. | +| `disabled` | `false` | Disables the `env_var` module. | ### Variables @@ -1399,6 +1410,44 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https: format = 'via [e $version](bold red) ' ``` +## Fennel + +The `fennel` module shows the currently installed version of [Fennel](https://fennel-lang.org). By default the module will be shown if any of the following conditions are met: + +- The current directory contains a file with the `.fnl` extension + +### Options + +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. | +| `stil` | `'bold green'` | The style for the module. | +| `detect_extensions` | `[fnl]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `disabled` | `false` | Disables the `fennel` module. | + +### Variables + +| Variable | Example | Description | +| --------- | -------- | ------------------------------------ | +| version | `v1.2.1` | The version of `fennel` | +| symbol | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | + +*: This variable can only be used as a part of a style string + +### Example + +```toml +# ~/.config/starship.toml + +[fennel] +symbol = '⫰ ' +``` + ## Fill The `fill` module fills any extra space on the line with a symbol. If multiple `fill` modules are present in a line they will split the space evenly between them. This is useful for aligning other modules. @@ -1428,6 +1477,42 @@ Produces a prompt that looks like: AA -------------------------------------------- BB -------------------------------------------- CC ``` +## Fossil Branch + +The `fossil_branch` module shows the name of the active branch of the check-out in your current directory. + +### Options + +| Option | Default | Description | +| ------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | +| `format` | `'on [$symbol$branch]($style) '` | The format for the module. Use `'$branch'` to refer to the current branch name. | +| `symbol` | `' '` | The symbol used before the branch name of the check-out in your current directory. | +| `stil` | `'bold purple'` | The style for the module. | +| `truncation_length` | `2^63 - 1` | Truncates a Fossil branch name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. | +| `disabled` | `true` | Disables the `fossil_branch` module. | + +### Variables + +| Variable | Example | Description | +| --------- | ------- | ------------------------------------ | +| branch | `trunk` | The active Fossil branch | +| symbol | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | + +*: This variable can only be used as a part of a style string + +### Example + +```toml +# ~/.config/starship.toml + +[fossil_branch] +symbol = '🦎 ' +truncation_length = 4 +truncation_symbol = '' +``` + ## Google Cloud (`gcloud`) The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var. @@ -1562,10 +1647,11 @@ The `git_commit` module shows the current commit hash and also the tag (if any) ### Variables -| Variable | Example | Description | -| --------- | --------- | ----------------------------------- | -| hash | `b703eb3` | The current git commit hash | -| style\* | | Mirrors the value of option `style` | +| Variable | Example | Description | +| --------- | --------- | -------------------------------------------- | +| hash | `b703eb3` | The current git commit hash | +| tag | `v1.0.0` | The tag name if showing tag info is enabled. | +| style\* | | Mirrors the value of option `style` | *: This variable can only be used as a part of a style string @@ -1840,6 +1926,41 @@ disabled = true format = 'via [🐂](yellow bold) ' ``` +## Gradle + +The `gradle` module shows the version of the [Gradle Wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html) currently used in the project directory. + +By default the module will be shown if any of the following conditions are met: + +- The current directory contains a `gradle/wrapper/gradle-wrapper.properties` directory. +- The current directory contains a file ending with `.gradle` or `.gradle.kts`. + +The `gradle` module is only able to read your Gradle Wrapper version from your config file, we don't execute your wrapper, because of the security concerns. + +### Options + +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🅶 "` | A format string representing the symbol of Gradle. | +| `detect_extensions` | `["gradle", "gradle.kts"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `["gradle"]` | Which folders should trigger this module. | +| `stil` | `"bold bright-cyan"` | The style for the module. | +| `disabled` | `false` | Disables the `gradle` module. | +| `recursive` | `false` | Enables recursive finding for the `gradle` directory. | + +### Variables + +| Variable | Example | Description | +| -------- | -------- | ------------------------------------ | +| version | `v7.5.1` | The version of `gradle` | +| 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 + ## Haskell The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot. @@ -2038,13 +2159,13 @@ The default functionality is: - 1 job -> `symbol` is shown. - 2 jobs or more -> `symbol` + `number` are shown. -::: warning +::: uyarı This module is not supported on tcsh and nu. ::: -::: warning +::: uyarı The `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. @@ -2440,26 +2561,27 @@ style = 'bold dimmed green' ## Mercurial Branch -The `hg_branch` module shows the active branch of the repo in your current directory. +The `hg_branch` module shows the active branch and topic of the repo in your current directory. ### Options -| Option | Default | Description | -| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------- | -| `symbol` | `' '` | The symbol used before the hg bookmark or branch name of the repo in your current directory. | -| `stil` | `'bold purple'` | The style 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_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. | -| `disabled` | `true` | Disables the `hg_branch` module. | +| Option | Default | Description | +| ------------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------- | +| `symbol` | `' '` | The symbol used before the hg bookmark or branch name of the repo in your current directory. | +| `stil` | `'bold purple'` | The style for the module. | +| `format` | `'on [$symbol$branch(:$topic)]($style) '` | The format for the module. | +| `truncation_length` | `2^63 - 1` | Truncates the hg branch / topic name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. | +| `disabled` | `true` | Disables the `hg_branch` module. | ### Variables -| Variable | Example | Description | -| --------- | -------- | ------------------------------------ | -| branch | `master` | The active mercurial branch | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| Variable | Example | Description | +| --------- | --------- | ------------------------------------ | +| branch | `master` | The active mercurial branch | +| topic | `feature` | The active mercurial topic | +| 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 @@ -2522,14 +2644,16 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/ ### Options -| Option | Default | Description | -| ------------ | ---------------------------------------------- | ----------------------------------------------------- | -| `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. | -| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | -| `stil` | `'bold blue'` | The style for the module. | -| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | -| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | -| `disabled` | `false` | Disables the `nix_shell` module. | +| Option | Default | Description | +| ------------- | ---------------------------------------------- | --------------------------------------------------------------------- | +| `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. | +| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | +| `stil` | `'bold blue'` | The style for the module. | +| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | +| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | +| `unknown_msg` | `''` | A format string shown when it is unknown if the shell is pure/impure. | +| `disabled` | `false` | Disables the `nix_shell` module. | +| `heuristic` | `false` | Attempts to detect new `nix shell`-style shells with a heuristic. | ### Variables @@ -2551,6 +2675,7 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/ disabled = true impure_msg = '[impure shell](bold red)' pure_msg = '[pure shell](bold green)' +unknown_msg = '[unknown shell](bold yellow)' format = 'via [☃️ $state( \($name\))](bold blue) ' ``` @@ -2720,7 +2845,7 @@ symbol = '☁️ ' The `os` module shows the current operating system. OS information is detected via the [os_info](https://lib.rs/crates/os_info) crate. -::: warning +::: uyarı The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. @@ -2947,6 +3072,21 @@ The `php` module shows the currently installed version of [PHP](https://www.php. format = 'via [🔹 $version](147 bold) ' ``` +## Pijul Channel + +The `pijul_channel` module shows the active channel of the repo in your current directory. + +### Options + +| Option | Default | Description | +| ------------------- | --------------------------------- | ------------------------------------------------------------------------------------ | +| `symbol` | `' '` | The symbol used before the pijul channel name of the repo in your current directory. | +| `stil` | `'bold purple'` | The style for the module. | +| `format` | `'on [$symbol$channel]($style) '` | The format for the module. | +| `truncation_length` | `2^63 - 1` | Truncates the pijul channel name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. | +| `disabled` | `true` | Disables the `pijul` module. | + ## Pulumi The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. diff --git a/docs/tr-TR/guide/README.md b/docs/tr-TR/guide/README.md index 45b9f173..04db9c13 100644 --- a/docs/tr-TR/guide/README.md +++ b/docs/tr-TR/guide/README.md @@ -9,7 +9,7 @@

GitHub Actions workflow status @@ -423,6 +423,7 @@ Support this project by [becoming a sponsor](https://github.com/sponsors/starshi **Supporter Tier** - [Dimension](https://dimension.dev/) +- [Appwrite](https://appwrite.io/)


diff --git a/docs/tr-TR/presets/README.md b/docs/tr-TR/presets/README.md index 1880a133..79d72c95 100644 --- a/docs/tr-TR/presets/README.md +++ b/docs/tr-TR/presets/README.md @@ -14,7 +14,11 @@ This preset changes the symbols for each module to use Nerd Font symbols. This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt. -::: tip This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). ::: +::: tip + +This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). + +::: [Click to view No Nerd Font preset](./no-nerd-font) diff --git a/docs/uk-UA/README.md b/docs/uk-UA/README.md index e5ea61d2..a215ade2 100644 --- a/docs/uk-UA/README.md +++ b/docs/uk-UA/README.md @@ -149,14 +149,14 @@ description: Starship is the minimal, blazing fast, and extremely customizable p ::: warning - This will change in the future. Only Nushell v0.61+ is supported. + This will change in the future. Only Nushell v0.73+ is supported. ::: - Add the following to to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell): + Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell): ```sh mkdir ~/.cache/starship - starship init nu | save ~/.cache/starship/init.nu + starship init nu | save -f ~/.cache/starship/init.nu ``` Додайте наступний рядок наприкінці Вашої конфігурації Nushell (знайдіть її виконавши `$nu.config-path`): diff --git a/docs/uk-UA/advanced-config/README.md b/docs/uk-UA/advanced-config/README.md index 92d4d054..5786aeec 100644 --- a/docs/uk-UA/advanced-config/README.md +++ b/docs/uk-UA/advanced-config/README.md @@ -207,8 +207,6 @@ Note: The right prompt is a single line following the input location. To right a `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell. -Note: Nushell 0.71.0 or later is required - ### Example ```toml @@ -231,7 +229,7 @@ Produces a prompt like the following: Some shells support a continuation prompt along with the normal prompt. This prompt is rendered instead of the normal prompt when the user has entered an incomplete statement (such as a single left parenthesis or quote). -Starship can set the continuation prompt using the `continuation_prompt` option. The default prompt is `"[∙](bright-black) "`. +Starship can set the continuation prompt using the `continuation_prompt` option. The default prompt is `'[∙](bright-black) '`. Note: `continuation_prompt` should be set to a literal string without any variables. @@ -247,7 +245,7 @@ Note: Continuation prompts are only available in the following shells: # ~/.config/starship.toml # A continuation prompt that displays two filled in arrows -continuation_prompt = "▶▶" +continuation_prompt = '▶▶ ' ``` ## Style Strings diff --git a/docs/uk-UA/config/README.md b/docs/uk-UA/config/README.md index 95bd8201..64db4cb0 100644 --- a/docs/uk-UA/config/README.md +++ b/docs/uk-UA/config/README.md @@ -252,12 +252,14 @@ $singularity\ $kubernetes\ $directory\ $vcsh\ +$fossil_branch\ $git_branch\ $git_commit\ $git_state\ $git_metrics\ $git_status\ $hg_branch\ +$pijul_channel\ $docker_context\ $package\ $c\ @@ -270,6 +272,7 @@ $dotnet\ $elixir\ $elm\ $erlang\ +$fennel\ $golang\ $guix_shell\ $haskell\ @@ -278,6 +281,7 @@ $helm\ $java\ $julia\ $kotlin\ +$gradle\ $lua\ $nim\ $nodejs\ @@ -1305,6 +1309,12 @@ The `env_var` module displays the current value of a selected environment variab ::: tip +The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. + +::: + +::: 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 @@ -1320,13 +1330,14 @@ default = 'unknown user' ### Options -| Option | Default | Description | -| ---------- | ------------------------------ | ---------------------------------------------------------------------------- | -| `symbol` | `''` | The symbol used before displaying the variable value. | -| `variable` | | The environment variable to be displayed. | -| `default` | | The default value to be displayed when the selected variable is not defined. | -| `format` | `'with [$env_value]($style) '` | The format for the module. | -| `disabled` | `false` | Disables the `env_var` module. | +| Option | Default | Description | +| ------------- | ------------------------------ | ---------------------------------------------------------------------------- | +| `symbol` | `""` | The symbol used before displaying the variable value. | +| `variable` | | The environment variable to be displayed. | +| `default` | | The default value to be displayed when the selected variable is not defined. | +| `format` | `"with [$env_value]($style) "` | The format for the module. | +| `description` | `""` | The description of the module that is shown when running `starship explain`. | +| `disabled` | `false` | Disables the `env_var` module. | ### Variables @@ -1399,6 +1410,44 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https: format = 'via [e $version](bold red) ' ``` +## Fennel + +The `fennel` module shows the currently installed version of [Fennel](https://fennel-lang.org). By default the module will be shown if any of the following conditions are met: + +- The current directory contains a file with the `.fnl` extension + +### Options + +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. | +| `style` | `'bold green'` | The style for the module. | +| `detect_extensions` | `[fnl]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `disabled` | `false` | Disables the `fennel` module. | + +### Variables + +| Variable | Example | Description | +| --------- | -------- | ------------------------------------ | +| version | `v1.2.1` | The version of `fennel` | +| symbol | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | + +*: This variable can only be used as a part of a style string + +### Example + +```toml +# ~/.config/starship.toml + +[fennel] +symbol = '⫰ ' +``` + ## Fill The `fill` module fills any extra space on the line with a symbol. If multiple `fill` modules are present in a line they will split the space evenly between them. This is useful for aligning other modules. @@ -1428,6 +1477,42 @@ Produces a prompt that looks like: AA -------------------------------------------- BB -------------------------------------------- CC ``` +## Fossil Branch + +The `fossil_branch` module shows the name of the active branch of the check-out in your current directory. + +### Options + +| Option | Default | Description | +| ------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | +| `format` | `'on [$symbol$branch]($style) '` | The format for the module. Use `'$branch'` to refer to the current branch name. | +| `symbol` | `' '` | The symbol used before the branch name of the check-out in your current directory. | +| `style` | `'bold purple'` | The style for the module. | +| `truncation_length` | `2^63 - 1` | Truncates a Fossil branch name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. | +| `disabled` | `true` | Disables the `fossil_branch` module. | + +### Variables + +| Variable | Example | Description | +| --------- | ------- | ------------------------------------ | +| branch | `trunk` | The active Fossil branch | +| symbol | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | + +*: This variable can only be used as a part of a style string + +### Example + +```toml +# ~/.config/starship.toml + +[fossil_branch] +symbol = '🦎 ' +truncation_length = 4 +truncation_symbol = '' +``` + ## Google Cloud (`gcloud`) The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var. @@ -1562,10 +1647,11 @@ The `git_commit` module shows the current commit hash and also the tag (if any) ### Variables -| Variable | Example | Description | -| --------- | --------- | ----------------------------------- | -| hash | `b703eb3` | The current git commit hash | -| style\* | | Mirrors the value of option `style` | +| Variable | Example | Description | +| --------- | --------- | -------------------------------------------- | +| hash | `b703eb3` | The current git commit hash | +| tag | `v1.0.0` | The tag name if showing tag info is enabled. | +| style\* | | Mirrors the value of option `style` | *: This variable can only be used as a part of a style string @@ -1840,6 +1926,41 @@ disabled = true format = 'via [🐂](yellow bold) ' ``` +## Gradle + +The `gradle` module shows the version of the [Gradle Wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html) currently used in the project directory. + +By default the module will be shown if any of the following conditions are met: + +- The current directory contains a `gradle/wrapper/gradle-wrapper.properties` directory. +- The current directory contains a file ending with `.gradle` or `.gradle.kts`. + +The `gradle` module is only able to read your Gradle Wrapper version from your config file, we don't execute your wrapper, because of the security concerns. + +### Options + +| Option | Default | Description | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🅶 "` | A format string representing the symbol of Gradle. | +| `detect_extensions` | `["gradle", "gradle.kts"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `["gradle"]` | Which folders should trigger this module. | +| `style` | `"bold bright-cyan"` | The style for the module. | +| `disabled` | `false` | Disables the `gradle` module. | +| `recursive` | `false` | Enables recursive finding for the `gradle` directory. | + +### Variables + +| Variable | Example | Description | +| -------- | -------- | ------------------------------------ | +| version | `v7.5.1` | The version of `gradle` | +| 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 + ## Haskell The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot. @@ -2440,26 +2561,27 @@ style = 'bold dimmed green' ## Mercurial Branch -The `hg_branch` module shows the active branch of the repo in your current directory. +The `hg_branch` module shows the active branch and topic of the repo in your current directory. ### Options -| Option | Default | Description | -| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------- | -| `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. | -| `format` | `'on [$symbol$branch]($style) '` | The format for the module. | -| `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. | -| `disabled` | `true` | Disables the `hg_branch` module. | +| Option | Default | Description | +| ------------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------- | +| `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. | +| `format` | `'on [$symbol$branch(:$topic)]($style) '` | The format for the module. | +| `truncation_length` | `2^63 - 1` | Truncates the hg branch / topic name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. | +| `disabled` | `true` | Disables the `hg_branch` module. | ### Variables -| Variable | Example | Description | -| --------- | -------- | ------------------------------------ | -| branch | `master` | The active mercurial branch | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| Variable | Example | Description | +| --------- | --------- | ------------------------------------ | +| branch | `master` | The active mercurial branch | +| topic | `feature` | The active mercurial topic | +| 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 @@ -2522,14 +2644,16 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/ ### Options -| Option | Default | Description | -| ------------ | ---------------------------------------------- | ----------------------------------------------------- | -| `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. | -| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | -| `style` | `'bold blue'` | The style for the module. | -| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | -| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | -| `disabled` | `false` | Disables the `nix_shell` module. | +| Option | Default | Description | +| ------------- | ---------------------------------------------- | --------------------------------------------------------------------- | +| `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. | +| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | +| `style` | `'bold blue'` | The style for the module. | +| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | +| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | +| `unknown_msg` | `''` | A format string shown when it is unknown if the shell is pure/impure. | +| `disabled` | `false` | Disables the `nix_shell` module. | +| `heuristic` | `false` | Attempts to detect new `nix shell`-style shells with a heuristic. | ### Variables @@ -2551,6 +2675,7 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/ disabled = true impure_msg = '[impure shell](bold red)' pure_msg = '[pure shell](bold green)' +unknown_msg = '[unknown shell](bold yellow)' format = 'via [☃️ $state( \($name\))](bold blue) ' ``` @@ -2947,6 +3072,21 @@ The `php` module shows the currently installed version of [PHP](https://www.php. format = 'via [🔹 $version](147 bold) ' ``` +## Pijul Channel + +The `pijul_channel` module shows the active channel of the repo in your current directory. + +### Options + +| Option | Default | Description | +| ------------------- | --------------------------------- | ------------------------------------------------------------------------------------ | +| `symbol` | `' '` | The symbol used before the pijul channel name of the repo in your current directory. | +| `style` | `'bold purple'` | The style for the module. | +| `format` | `'on [$symbol$channel]($style) '` | The format for the module. | +| `truncation_length` | `2^63 - 1` | Truncates the pijul channel name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. | +| `disabled` | `true` | Disables the `pijul` module. | + ## Pulumi The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. diff --git a/docs/uk-UA/guide/README.md b/docs/uk-UA/guide/README.md index bd98f8db..b9032634 100644 --- a/docs/uk-UA/guide/README.md +++ b/docs/uk-UA/guide/README.md @@ -9,7 +9,7 @@

GitHub Actions workflow status @@ -423,6 +423,7 @@ Support this project by [becoming a sponsor](https://github.com/sponsors/starshi **Supporter Tier** - [Dimension](https://dimension.dev/) +- [Appwrite](https://appwrite.io/)


diff --git a/docs/uk-UA/presets/README.md b/docs/uk-UA/presets/README.md index cb3dcf1b..3903bc17 100644 --- a/docs/uk-UA/presets/README.md +++ b/docs/uk-UA/presets/README.md @@ -14,7 +14,11 @@ This preset changes the symbols for each module to use Nerd Font symbols. This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt. -::: tip This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). ::: +::: tip + +This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). + +::: [Click to view No Nerd Font preset](./no-nerd-font) diff --git a/docs/vi-VN/README.md b/docs/vi-VN/README.md index 4b30d3ad..4222ec04 100644 --- a/docs/vi-VN/README.md +++ b/docs/vi-VN/README.md @@ -149,14 +149,14 @@ description: Starship là prompt nhỏ, cực nhanh, và khả năng tuỳ biế ::: warning - This will change in the future. Only Nushell v0.61+ is supported. + This will change in the future. Only Nushell v0.73+ is supported. ::: - Add the following to to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell): + Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell): ```sh mkdir ~/.cache/starship - starship init nu | save ~/.cache/starship/init.nu + starship init nu | save -f ~/.cache/starship/init.nu ``` And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`): diff --git a/docs/vi-VN/advanced-config/README.md b/docs/vi-VN/advanced-config/README.md index b7c6cb51..9148982b 100644 --- a/docs/vi-VN/advanced-config/README.md +++ b/docs/vi-VN/advanced-config/README.md @@ -207,8 +207,6 @@ Note: The right prompt is a single line following the input location. To right a `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell. -Note: Nushell 0.71.0 or later is required - ### Ví dụ ```toml @@ -231,7 +229,7 @@ Produces a prompt like the following: Some shells support a continuation prompt along with the normal prompt. This prompt is rendered instead of the normal prompt when the user has entered an incomplete statement (such as a single left parenthesis or quote). -Starship can set the continuation prompt using the `continuation_prompt` option. The default prompt is `"[∙](bright-black) "`. +Starship can set the continuation prompt using the `continuation_prompt` option. The default prompt is `'[∙](bright-black) '`. Note: `continuation_prompt` should be set to a literal string without any variables. @@ -247,7 +245,7 @@ Note: Continuation prompts are only available in the following shells: # ~/.config/starship.toml # A continuation prompt that displays two filled in arrows -continuation_prompt = "▶▶" +continuation_prompt = '▶▶ ' ``` ## Các chuỗi kiểu diff --git a/docs/vi-VN/config/README.md b/docs/vi-VN/config/README.md index 9a635a70..6ac4654a 100644 --- a/docs/vi-VN/config/README.md +++ b/docs/vi-VN/config/README.md @@ -252,12 +252,14 @@ $singularity\ $kubernetes\ $directory\ $vcsh\ +$fossil_branch\ $git_branch\ $git_commit\ $git_state\ $git_metrics\ $git_status\ $hg_branch\ +$pijul_channel\ $docker_context\ $package\ $c\ @@ -270,6 +272,7 @@ $dotnet\ $elixir\ $elm\ $erlang\ +$fennel\ $golang\ $guix_shell\ $haskell\ @@ -278,6 +281,7 @@ $helm\ $java\ $julia\ $kotlin\ +$gradle\ $lua\ $nim\ $nodejs\ @@ -1305,6 +1309,12 @@ The `env_var` module displays the current value of a selected environment variab ::: tip +The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. + +::: + +::: 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 @@ -1320,13 +1330,14 @@ default = 'unknown user' ### Options -| Tuỳ chọn | Mặc định | Mô tả | -| ---------- | ------------------------------ | ------------------------------------------------------------------------ | -| `symbol` | `''` | Biểu tượng sử dụng để hiển thị trước giá trị của biến. | -| `variable` | | Biến môi trường được hiển thị. | -| `default` | | Giá trị mặc định được hiển thị khi biến được chọn không được định nghĩa. | -| `format` | `'with [$env_value]($style) '` | Định dạng cho module. | -| `disabled` | `false` | Vô hiệu `env_var`. | +| Tuỳ chọn | Mặc định | Mô tả | +| ------------- | ------------------------------ | ---------------------------------------------------------------------------- | +| `symbol` | `""` | Biểu tượng sử dụng để hiển thị trước giá trị của biến. | +| `variable` | | Biến môi trường được hiển thị. | +| `default` | | Giá trị mặc định được hiển thị khi biến được chọn không được định nghĩa. | +| `format` | `"with [$env_value]($style) "` | Định dạng cho module. | +| `description` | `""` | The description of the module that is shown when running `starship explain`. | +| `disabled` | `false` | Vô hiệu `env_var`. | ### Các biến @@ -1388,7 +1399,7 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https: | 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 +*: This variable can only be used as a part of a style string ### Ví dụ @@ -1399,11 +1410,49 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https: format = 'via [e $version](bold red) ' ``` +## Fennel + +The `fennel` module shows the currently installed version of [Fennel](https://fennel-lang.org). Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn: + +- The current directory contains a file with the `.fnl` extension + +### Options + +| Tuỳ chọn | Mặc định | Mô tả | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | Định dạng cho module. | +| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. | +| `style` | `'bold green'` | Kiểu cho module. | +| `detect_extensions` | `[fnl]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | +| `detect_files` | `[]` | Những tên tệp nào sẽ kích hoạt mô-đun này. | +| `detect_folders` | `[]` | Những thư mục nào nên kích hoạt các mô đun này. | +| `disabled` | `false` | Disables the `fennel` module. | + +### Các biến + +| Biến | Ví dụ | Mô tả | +| --------- | -------- | -------------------------------- | +| version | `v1.2.1` | The version of `fennel` | +| symbol | | Giá trị ghi đè tuỳ chọn `symbol` | +| style\* | | Giá trị ghi đè của `style` | + +*: Biến này có thể chỉ được sử dụng như một phần của style string + +### Ví dụ + +```toml +# ~/.config/starship.toml + +[fennel] +symbol = '⫰ ' +``` + ## Fill The `fill` module fills any extra space on the line with a symbol. If multiple `fill` modules are present in a line they will split the space evenly between them. This is useful for aligning other modules. -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ---------- | -------------- | --------------------------------- | @@ -1428,32 +1477,68 @@ Produces a prompt that looks like: AA -------------------------------------------- BB -------------------------------------------- CC ``` -## Google Cloud (`gcloud`) +## Fossil Branch -Mô đun `gcloud` hiển thị cấu hình hiện tại của [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. Cái này dựa trên tập tin `~/.config/gcloud/active_config`, `~/.config/gcloud/configurations/config_{CONFIG NAME}` và biến môi trường `CLOUDSDK_CONFIG`. +The `fossil_branch` module shows the name of the active branch of the check-out in your current directory. ### Options -| Tuỳ chọn | Mặc định | Mô tả | -| ----------------- | ---------------------------------------------------------- | ----------------------------------------------------------------- | -| `format` | `'on [$symbol$account(@$domain)(\($region\))]($style) '` | Định dạng cho module. | -| `symbol` | `'☁️ '` | Kí hiệu sử dụng hiển thị trước profile GCP hiện tại. | -| `region_aliases` | `{}` | Bảng ánh xạ của các bí danh của region để hiển thị ngoài tên GCP. | -| `project_aliases` | `{}` | Table of project aliases to display in addition to the GCP name. | -| `style` | `'bold blue'` | Kiểu cho module. | -| `disabled` | `false` | Vô hiệu mô đun `gcloud`. | +| Tuỳ chọn | Mặc định | Mô tả | +| ------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | +| `format` | `'on [$symbol$branch]($style) '` | Định dạng cho module. Use `'$branch'` to refer to the current branch name. | +| `symbol` | `' '` | The symbol used before the branch name of the check-out in your current directory. | +| `style` | `'bold purple'` | Kiểu cho module. | +| `truncation_length` | `2^63 - 1` | Truncates a Fossil branch name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. | +| `disabled` | `true` | Disables the `fossil_branch` module. | ### Các biến -| Biến | Ví dụ | Mô tả | -| --------- | ------------- | -------------------------------------------------------------------- | -| region | `us-central1` | Region GCP hiện tại | -| account | `foo` | Profile hiện tại của GCP | -| domain | `example.com` | The current GCP profile domain | -| project | | Dự án hiện tại của GCP | -| active | `default` | Tên cấu hình có hiệu lực viết trong `~/.config/gcloud/active_config` | -| symbol | | Giá trị ghi đè tuỳ chọn `symbol` | -| style\* | | Giá trị ghi đè của `style` | +| Biến | Ví dụ | Mô tả | +| --------- | ------- | -------------------------------- | +| branch | `trunk` | The active Fossil branch | +| symbol | | Giá trị ghi đè tuỳ chọn `symbol` | +| style\* | | Giá trị ghi đè của `style` | + +*: Biến này có thể chỉ được sử dụng như một phần của style string + +### Ví dụ + +```toml +# ~/.config/starship.toml + +[fossil_branch] +symbol = '🦎 ' +truncation_length = 4 +truncation_symbol = '' +``` + +## Google Cloud (`gcloud`) + +The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var. + +### Options + +| Tuỳ chọn | Mặc định | Mô tả | +| ----------------- | ---------------------------------------------------------- | ---------------------------------------------------------------- | +| `format` | `'on [$symbol$account(@$domain)(\($region\))]($style) '` | Định dạng cho module. | +| `symbol` | `'☁️ '` | The symbol used before displaying the current GCP profile. | +| `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. | +| `style` | `'bold blue'` | Kiểu cho module. | +| `disabled` | `false` | Disables the `gcloud` module. | + +### Các biến + +| Biến | Ví dụ | Mô tả | +| --------- | ------------- | ------------------------------------------------------------------ | +| region | `us-central1` | The current GCP region | +| account | `foo` | The current GCP profile | +| domain | `example.com` | The current GCP profile domain | +| project | | The current GCP project | +| active | `default` | The active config name written in `~/.config/gcloud/active_config` | +| 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 @@ -1503,29 +1588,29 @@ very-long-project-name = 'vlpn' ## Git Branch -Mô đun `git_branch` hiển thị nhánh hiệu lực của repo trong thư mục hiện tại của bạn. +The `git_branch` module shows the active branch of the repo in your current directory. ### Options -| 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. | -| `format` | `'on [$symbol$branch(:$remote_branch)]($style) '` | Định dạng cho module. Use `'$branch'` to refer to the current branch name. | -| `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. | -| `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. You can use `''` for no symbol. | -| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | -| `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. | -| `disabled` | `false` | Vô hiệu mô đun `git_branch`. | +| Tuỳ chọn | Mặc định | Mô tả | +| -------------------- | ------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | +| `format` | `'on [$symbol$branch(:$remote_branch)]($style) '` | Định dạng cho module. Use `'$branch'` to refer to the current branch name. | +| `symbol` | `' '` | A format string representing the symbol of git branch. | +| `style` | `'bold purple'` | Kiểu cho module. | +| `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. | +| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | +| `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. | +| `disabled` | `false` | Disables the `git_branch` module. | ### Các biến | Biến | Ví dụ | Mô tả | | ------------- | -------- | ------------------------------------------------------------------------------------------------------ | | branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached `HEAD`). | -| remote_name | `origin` | Tên remote. | -| remote_branch | `master` | Tên của nhánh đã theo dõi trên `remote_name`. | +| remote_name | `origin` | The remote name. | +| remote_branch | `master` | The name of the branch tracked on `remote_name`. | | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | @@ -1545,27 +1630,28 @@ ignore_branches = ['master', 'main'] ## Git Commit -Mô đun `git_commit` hiển thị hash commit hiện tại và tag (nếu có) của repo trong thư mục hiện tại của bạn. +The `git_commit` module shows the current commit hash and also the tag (if any) of the repo in your current directory. ### Options | Tuỳ chọn | Mặc định | Mô tả | | -------------------- | ------------------------------ | ------------------------------------------------------------------------------------ | -| `commit_hash_length` | `7` | Độ dài của git commit hash được hiển thị. | +| `commit_hash_length` | `7` | The length of the displayed git commit hash. | | `format` | `'[\($hash$tag\)]($style) '` | Định dạng cho module. | | `style` | `'bold green'` | Kiểu cho module. | | `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state | -| `tag_disabled` | `true` | Vô hiệu hiển thị thông tin tag trong mô đun `git_commit`. | +| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. | | `tag_max_candidates` | `0` | How many commits to consider for tag display. The default only allows exact matches. | -| `tag_symbol` | `' 🏷 '` | Biểu tượng tag trước thông tin được hiển thị | -| `disabled` | `false` | Vô hiệu mô đun `git_commit`. | +| `tag_symbol` | `' 🏷 '` | Tag symbol prefixing the info shown | +| `disabled` | `false` | Disables the `git_commit` module. | ### Các biến -| Biến | Ví dụ | Mô tả | -| --------- | --------- | -------------------------- | -| hash | `b703eb3` | Git commit hash hiện tại | -| style\* | | Giá trị ghi đè của `style` | +| Biến | Ví dụ | Mô tả | +| --------- | --------- | -------------------------------------------- | +| hash | `b703eb3` | The current git commit hash | +| tag | `v1.0.0` | The tag name if showing tag info is enabled. | +| 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 @@ -1581,33 +1667,33 @@ tag_symbol = '🔖 ' ## Git State -Mô đun `git_state` sẽ hiển hiển thị trong các thư mục là một phần của gt repository và những nơi tồn tại một hoạt động trong tiến trình như _REBASING_, _BISECTING_. Nếu có thông tin tiến trình (ví dụ, REBASING 3/10), thông tin đó cũng sẽ được hiển thị. +The `git_state` module will show in directories which are part of a git repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. If there is progress information (e.g., REBASING 3/10), that information will be shown too. ### Options -| Tuỳ chọn | Mặc định | Mô tả | -| -------------- | --------------------------------------------------------------- | ---------------------------------------------------------------------------------- | -| `rebase` | `'REBASING'` | Một format sring hiển thị khi một `rebase` đang trong quá trình. | -| `merge` | `'MERGING'` | Một format sring hiển thị khi một `merge` đang trong quá trình. | -| `revert` | `'REVERTING'` | Một format sring hiển thị khi một `revert` đang trong quá trình. | -| `cherry_pick` | `'CHERRY-PICKING'` | Một format sring hiển thị khi một `cherry-pick` đang trong quá trình. | -| `bisect` | `'BISECTING'` | Một format sring hiển thị khi một `bisect` đang trong quá trình. | -| `am` | `'AM'` | Một format sring hiển thị khi một `apply-mailbox` (`git am`) đang trong quá trình. | -| `am_or_rebase` | `'AM/REBASE'` | Một format sring hiển thị khi một `apply-mailbox` (`rebase`) đang trong quá trình. | -| `style` | `'bold yellow'` | Kiểu cho module. | -| `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | Định dạng cho module. | -| `disabled` | `false` | Vô hiệu `git_state` module. | +| Tuỳ chọn | Mặc định | Mô tả | +| -------------- | --------------------------------------------------------------- | --------------------------------------------------------------------------------------- | +| `rebase` | `'REBASING'` | A format string displayed when a `rebase` is in progress. | +| `merge` | `'MERGING'` | A format string displayed when a `merge` is in progress. | +| `revert` | `'REVERTING'` | A format string displayed when a `revert` is in progress. | +| `cherry_pick` | `'CHERRY-PICKING'` | A format string displayed when a `cherry-pick` is in progress. | +| `bisect` | `'BISECTING'` | A format string displayed when a `bisect` is in progress. | +| `am` | `'AM'` | A format string displayed when an `apply-mailbox` (`git am`) is in progress. | +| `am_or_rebase` | `'AM/REBASE'` | A format string displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. | +| `style` | `'bold yellow'` | Kiểu cho module. | +| `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | Định dạng cho module. | +| `disabled` | `false` | Disables the `git_state` module. | ### Các biến -| Biến | Ví dụ | Mô tả | -| ---------------- | ---------- | --------------------------------- | -| state | `REBASING` | Trạng thái của repo hiện tại | -| progress_current | `1` | Trạng thái của quá trình hiện tại | -| progress_total | `2` | Tổng số các quá trình | -| style\* | | Giá trị ghi đè của `style` | +| Biến | Ví dụ | Mô tả | +| ---------------- | ---------- | ------------------------------ | +| state | `REBASING` | The current state of the repo | +| progress_current | `1` | The current operation progress | +| progress_total | `2` | The total operation progress | +| 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 +*: This variable can only be used as a part of a style string ### Ví dụ @@ -1625,7 +1711,7 @@ The `git_metrics` module will show the number of added and deleted lines in the ::: tip -Mặc định, mô đun này được vô hiệu. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -1648,7 +1734,7 @@ Mặc định, mô đun này được vô hiệu. Để kích hoạt nó, thiế | added_style\* | | Mirrors the value of option `added_style` | | deleted_style\* | | Mirrors the value of option `deleted_style` | -*: Biến này có thể chỉ được sử dụng như một phần của style string +*: This variable can only be used as a part of a style string ### Ví dụ @@ -1662,7 +1748,7 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) ' ## Git Status -Mô đun `git_status` hiển thị các biểu tượng đại diện cho trạng thái của repo trong thư mục hiện tại của bạn. +The `git_status` module shows symbols representing the state of the repo in your current directory. ::: tip @@ -1674,54 +1760,54 @@ The Git Status module is very slow in Windows directories (for example under `/m | Tuỳ chọn | Mặc định | Mô tả | | ------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | Định dạng mặc định cho `git_status` | -| `conflicted` | `'='` | Nhánh này có nhiều merge conflicts. | -| `ahead` | `'⇡'` | Định dạng của `ahead` | -| `behind` | `'⇣'` | Định dạng của `behind` | -| `diverged` | `'⇕'` | Định dạng của `diverged` | +| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | The default format for `git_status` | +| `conflicted` | `'='` | This branch has merge conflicts. | +| `ahead` | `'⇡'` | The format of `ahead` | +| `behind` | `'⇣'` | The format of `behind` | +| `diverged` | `'⇕'` | The format of `diverged` | | `up_to_date` | `''` | The format of `up_to_date` | -| `untracked` | `'?'` | Định dạng của `untracked` | -| `stashed` | `'$'` | Định dạng của `stashed` | -| `modified` | `'!'` | Định dạng của `modified` | -| `staged` | `'+'` | Định dạng của `modified` | -| `renamed` | `'»'` | Định dạng của `renamed` | -| `deleted` | `'✘'` | Định dạng của `deleted` | +| `untracked` | `'?'` | The format of `untracked` | +| `stashed` | `'$'` | The format of `stashed` | +| `modified` | `'!'` | The format of `modified` | +| `staged` | `'+'` | The format of `staged` | +| `renamed` | `'»'` | The format of `renamed` | +| `deleted` | `'✘'` | The format of `deleted` | | `style` | `'bold red'` | Kiểu cho module. | | `ignore_submodules` | `false` | Ignore changes to submodules. | -| `disabled` | `false` | Vô hiệu `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. | ### Các biến -Các biến dưới đây có thể được sử dụng trong `format`: +The following variables can be used in `format`: | Biến | Mô tả | | -------------- | ------------------------------------------------------------------------------------------------------------- | -| `all_status` | Shortcut cho `$conflicted$stashed$deleted$renamed$modified$staged$untracked` | +| `all_status` | Shortcut for`$conflicted$stashed$deleted$renamed$modified$staged$untracked` | | `ahead_behind` | Displays `diverged`, `ahead`, `behind` or `up_to_date` format string based on the current status of the repo. | -| `conflicted` | Hiển thị `conflicted` khi nhánh này có merge conflicts. | -| `untracked` | Hiển thị `untracked` khi có tệp tin untracked trong thư mục làm việc. | -| `stashed` | Hiển thị `stashed` khi một stash tồn tại trong local repository. | -| `modified` | Hiển thị `modified` khi có tệp tin được chỉnh sửa trong thư mục làm việc. | -| `staged` | Hiển thị `staged` khi một tệp tin mới được thêm vào staging area. | -| `renamed` | Hiển thị `renamed` khi một tệp tin đổi tên đã được thêm vào staging area. | -| `deleted` | Hiển thị `deleted` khi một tệp tin bị xóa đã được thêm vào staging area. | +| `conflicted` | Displays `conflicted` when this branch has merge conflicts. | +| `untracked` | Displays `untracked` when there are untracked files in the working directory. | +| `stashed` | Displays `stashed` when a stash exists for the local repository. | +| `modified` | Displays `modified` when there are file modifications in the working directory. | +| `staged` | Displays `staged` when a new file has been added to the staging area. | +| `renamed` | Displays `renamed` when a renamed file has been added to the staging area. | +| `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. | | style\* | 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 +*: This variable can only be used as a part of a style string -Các biến sau có thể được sử dụng trong `diverged`: +The following variables can be used in `diverged`: -| Biến | Mô tả | -| -------------- | --------------------------------------------- | -| `ahead_count` | Số lượng commit phía trước của nhánh tracking | -| `behind_count` | Số lượng commit phía sau nhánh tracking | +| Biến | Mô tả | +| -------------- | ---------------------------------------------- | +| `ahead_count` | Number of commits ahead of the tracking branch | +| `behind_count` | Number of commits behind the tracking branch | -Các biến sau có thể được sử dụng trong `conflicted`, `ahead`, `behind`, `untracked`, `stashed`, `modified`, `staged`, `renamed` and `deleted`: +The following variables can be used in `conflicted`, `ahead`, `behind`, `untracked`, `stashed`, `modified`, `staged`, `renamed` and `deleted`: -| Biến | Mô tả | -| ------- | ----------------------------- | -| `count` | Hiển thị số lượng các tệp tin | +| Biến | Mô tả | +| ------- | ------------------------ | +| `count` | Show the number of files | ### Ví dụ @@ -1742,7 +1828,7 @@ renamed = '👅' deleted = '🗑' ``` -Hiển thị tổng số nhánh phía trước/phía sau của nhánh được track +Show ahead/behind count of the branch being tracked ```toml # ~/.config/starship.toml @@ -1782,18 +1868,18 @@ The `golang` module shows the currently installed version of [Go](https://golang | ------------------- | ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | | `format` | `'via [$symbol($version )]($style)'` | Định dạng cho module. | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'🐹 '` | Một format string đại diện cho biểu tượng của Go. | +| `symbol` | `'🐹 '` | A format string representing the symbol of Go. | | `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', '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. | | `style` | `'bold cyan'` | Kiểu cho module. | -| `disabled` | `false` | Vô hiệu `golang` module. | +| `disabled` | `false` | Disables the `golang` module. | ### Các biến | Biến | Ví dụ | Mô tả | | --------- | --------- | -------------------------------- | -| version | `v1.12.1` | Phiên bản của `go` | +| version | `v1.12.1` | The version of `go` | | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | @@ -1812,7 +1898,7 @@ format = 'via [🏎💨 $version](bold cyan) ' The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel/en/html_node/Invoking-guix-shell.html) environment. The module will be shown when inside a guix-shell environment. -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ---------- | -------------------------- | ------------------------------------------------------ | @@ -1828,7 +1914,7 @@ The `guix_shell` module shows the [guix-shell](https://guix.gnu.org/manual/devel | 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 +*: This variable can only be used as a part of a style string ### Ví dụ @@ -1840,6 +1926,41 @@ disabled = true format = 'via [🐂](yellow bold) ' ``` +## Gradle + +The `gradle` module shows the version of the [Gradle Wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html) currently used in the project directory. + +Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn: + +- The current directory contains a `gradle/wrapper/gradle-wrapper.properties` directory. +- The current directory contains a file ending with `.gradle` or `.gradle.kts`. + +The `gradle` module is only able to read your Gradle Wrapper version from your config file, we don't execute your wrapper, because of the security concerns. + +### Các tuỳ chọn + +| Tuỳ chọn | Mặc định | Mô tả | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🅶 "` | A format string representing the symbol of Gradle. | +| `detect_extensions` | `["gradle", "gradle.kts"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | +| `detect_files` | `[]` | Những tên tệp nào sẽ kích hoạt mô-đun này. | +| `detect_folders` | `["gradle"]` | Những thư mục nào sẽ kích hoạt mô-đun này. | +| `style` | `"bold bright-cyan"` | Kiểu cho module. | +| `disabled` | `false` | Disables the `gradle` module. | +| `recursive` | `false` | Enables recursive finding for the `gradle` directory. | + +### Các biến + +| Biến | Ví dụ | Mô tả | +| ------- | -------- | -------------------------------- | +| version | `v7.5.1` | The version of `gradle` | +| symbol | | Giá trị ghi đè tuỳ chọn `symbol` | +| style* | | Giá trị ghi đè của `style` | + +*: This variable can only be used as a part of a style string + ## Haskell The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot. @@ -1849,7 +1970,7 @@ Mặc định module sẽ được hiển thị nếu có bất kì điều ki - Thư mục hiện tại chứa một tập tin `stack.yaml` - The current directory contains any `.hs`, `.cabal`, or `.hs-boot` file -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ------------------- | ------------------------------------ | --------------------------------------------------- | @@ -1881,7 +2002,7 @@ The `haxe` module shows the currently installed version of [Haxe](https://haxe.o - The current directory contains a `.haxelib` or a `haxe_libraries` directory - The current directory contains a file with the `.hx` or `.hxml` extension -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ------------------- | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | @@ -1890,7 +2011,7 @@ The `haxe` module shows the currently installed version of [Haxe](https://haxe.o | `detect_extensions` | `["hx", "hxml"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | | `detect_files` | `["project.xml", "Project.xml", "application.xml", "haxelib.json", "hxformat.json", ".haxerc"]` | Những tên tệp nào sẽ kích hoạt mô-đun này. | | `detect_folders` | `[".haxelib", "haxe_libraries"]` | Những thư mục nào nên kích hoạt các mô đun này. | -| `symbol` | `"⌘ "` | Một format string đại diện cho biểu tượng của Helm. | +| `symbol` | `"⌘ "` | A format string representing the symbol of Helm. | | `style` | `"bold fg:202"` | Kiểu cho module. | | `disabled` | `false` | Disables the `haxe` module. | @@ -1920,7 +2041,7 @@ The `helm` module shows the currently installed version of [Helm](https://helm.s - Thư mục hiện tại chứa một tập tin `helmfile.yaml` - Thư mục hiện tại chứa một tập tin `Chart.yaml` -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | @@ -1929,15 +2050,15 @@ The `helm` module shows the currently installed version of [Helm](https://helm.s | `detect_extensions` | `[]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | | `detect_files` | `['helmfile.yaml', 'Chart.yaml']` | Những tên tệp nào sẽ kích hoạt mô-đun này. | | `detect_folders` | `[]` | Những thư mục nào nên kích hoạt các mô đun này. | -| `symbol` | `'⎈ '` | Một format string đại diện cho biểu tượng của Helm. | +| `symbol` | `'⎈ '` | A format string representing the symbol of Helm. | | `style` | `'bold white'` | Kiểu cho module. | -| `disabled` | `false` | Vô hiệu `helm` module. | +| `disabled` | `false` | Disables the `helm` module. | ### Các biến | Biến | Ví dụ | Mô tả | | --------- | -------- | -------------------------------- | -| version | `v3.1.1` | Phiên bản của `helm` | +| version | `v3.1.1` | The version of `helm` | | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | @@ -1954,18 +2075,18 @@ format = 'via [⎈ $version](bold white) ' ## Hostname -Mô đun `hostname` hiển thị hostnam hệ thống. +The `hostname` module shows the system hostname. -### Options +### Các tuỳ chọn -| 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_symbol` | `'🌐 '` | A format string representing the symbol when connected to SSH session. | -| `trim_at` | `'.'` | Chuỗi mà hostname được cắt ngắn, sau khi khớp lần đầu tiên. `'.'` will stop after the first dot. `''` will disable any truncation | -| `format` | `'[$ssh_symbol$hostname]($style) in '` | Định dạng cho module. | -| `style` | `'bold dimmed green'` | Kiểu cho module. | -| `disabled` | `false` | Vô hiệu `hastname` module. | +| Tuỳ chọn | Mặc định | Mô tả | +| ------------ | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | +| `ssh_only` | `true` | Only show hostname when connected to an SSH session. | +| `ssh_symbol` | `'🌐 '` | A format string representing the symbol when connected to SSH session. | +| `trim_at` | `'.'` | String that the hostname is cut off at, after the first match. `'.'` will stop after the first dot. `''` will disable any truncation | +| `format` | `'[$ssh_symbol$hostname]($style) in '` | Định dạng cho module. | +| `style` | `'bold dimmed green'` | Kiểu cho module. | +| `disabled` | `false` | Disables the `hostname` module. | ### Các biến @@ -1996,7 +2117,7 @@ The `java` module shows the currently installed version of [Java](https://www.or - The current directory contains a `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `deps.edn`, `project.clj`, or `build.boot` file - Thư mục hiện tại chứa một tệp tin với phần mở rộng `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | @@ -2005,19 +2126,19 @@ The `java` module shows the currently installed version of [Java](https://www.or | `detect_extensions` | `['java', 'class', 'gradle', 'jar', 'cljs', 'cljc']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | | `detect_files` | `['pom.xml', 'build.gradle.kts', 'build.sbt', '.java-version', 'deps.edn', 'project.clj', 'build.boot']` | Những tên tệp nào sẽ kích hoạt mô-đun này. | | `detect_folders` | `[]` | Những thư mục nào nên kích hoạt các mô đun này. | -| `symbol` | `'☕ '` | Một format string đại diện cho biểu tượng Java | +| `symbol` | `'☕ '` | A format string representing the symbol of Java | | `style` | `'red dimmed'` | Kiểu cho module. | -| `disabled` | `false` | Vô hiệu `java` module. | +| `disabled` | `false` | Disables the `java` module. | ### Các biến | Biến | Ví dụ | Mô tả | | --------- | ----- | -------------------------------- | -| version | `v14` | Phiên bản của `java` | +| version | `v14` | The version of `java` | | 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 +*: This variable can only be used as a part of a style string ### Ví dụ @@ -2030,7 +2151,7 @@ symbol = '🌟 ' ## Jobs -`jobs` module cho biết số lượng các jobs đang chạy. Mô đun sẽ được hiển thị chỉ khi có background jobs đang chạy. The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to _always_ show the symbol and number of jobs, even if there are 0 jobs running. +The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to _always_ show the symbol and number of jobs, even if there are 0 jobs running. The default functionality is: @@ -2038,29 +2159,29 @@ The default functionality is: - 1 job -> `symbol` is shown. - 2 jobs or more -> `symbol` + `number` are shown. -::: warning +::: cảnh báo This module is not supported on tcsh and nu. ::: -::: warning +::: cảnh báo The `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. ::: -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ------------------ | ----------------------------- | ------------------------------------------------------------------------ | -| `threshold`* | `1` | Cho biết số lượng jobs nếu nó vượt quá. | +| `threshold`* | `1` | Show number of jobs if exceeded. | | `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. | | `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. | | `format` | `'[$symbol$number]($style) '` | Định dạng cho module. | | `symbol` | `'✦'` | The string used to represent the `symbol` variable. | | `style` | `'bold blue'` | Kiểu cho module. | -| `disabled` | `false` | Vô hiệu `jobs` module. | +| `disabled` | `false` | Disables the `jobs` module. | *: This option is deprecated, please use the `number_threshold` and `symbol_threshold` options instead. @@ -2068,7 +2189,7 @@ The `threshold` option is deprecated, but if you want to use it, the module will | Biến | Ví dụ | Mô tả | | --------- | ----- | -------------------------------- | -| number | `1` | Số lượng job | +| number | `1` | The number of jobs | | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | @@ -2093,7 +2214,7 @@ The `julia` module shows the currently installed version of [Julia](https://juli - Thư mục hiện tại chứa một tập tin `Manifest.toml` - Thư mục hiện tại chứa một tệp tin với phần mở rộng `.jl` -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | @@ -2102,15 +2223,15 @@ The `julia` module shows the currently installed version of [Julia](https://juli | `detect_extensions` | `['jl']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | | `detect_files` | `['Project.toml', 'Manifest.toml']` | Những tên tệp nào sẽ kích hoạt mô-đun này. | | `detect_folders` | `[]` | Những thư mục nào nên kích hoạt các mô đun này. | -| `symbol` | `'ஃ '` | Một format string đại diện cho biếu tượng của Julia. | +| `symbol` | `'ஃ '` | A format string representing the symbol of Julia. | | `style` | `'bold purple'` | Kiểu cho module. | -| `disabled` | `false` | Vô hiệu `julia` module. | +| `disabled` | `false` | Disables the `julia` module. | ### Các biến | Biến | Ví dụ | Mô tả | | --------- | -------- | -------------------------------- | -| version | `v1.4.0` | Phiên bản của `julia` | +| version | `v1.4.0` | The version of `julia` | | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | @@ -2133,27 +2254,27 @@ The `kotlin` module shows the currently installed version of [Kotlin](https://ko ### Options -| Tuỳ chọn | Mặc định | Mô tả | -| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | Định dạng cho module. | -| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `detect_extensions` | `['kt', 'kts']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | -| `detect_files` | `[]` | Những tên tệp nào sẽ kích hoạt mô-đun này. | -| `detect_folders` | `[]` | Những thư mục nào nên kích hoạt các mô đun này. | -| `symbol` | `'🅺 '` | Một format string đại diện cho biết tượng của Kotllin. | -| `style` | `'bold blue'` | Kiểu cho module. | -| `kotlin_binary` | `'kotlin'` | Cấu hình kotlin nhị phân mà Starship thực thi khi lấy phiên bản. | -| `disabled` | `false` | Vô hiệu `kotlin` module. | +| Tuỳ chọn | Mặc định | Mô tả | +| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | Định dạng cho module. | +| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `detect_extensions` | `['kt', 'kts']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | +| `detect_files` | `[]` | Những tên tệp nào sẽ kích hoạt mô-đun này. | +| `detect_folders` | `[]` | Những thư mục nào nên kích hoạt các mô đun này. | +| `symbol` | `'🅺 '` | A format string representing the symbol of Kotlin. | +| `style` | `'bold blue'` | Kiểu cho module. | +| `kotlin_binary` | `'kotlin'` | Configures the kotlin binary that Starship executes when getting the version. | +| `disabled` | `false` | Disables the `kotlin` module. | ### Các biến | Biến | Ví dụ | Mô tả | | --------- | --------- | -------------------------------- | -| version | `v1.4.21` | Phiên bản của `kotlin` | +| version | `v1.4.21` | The version of `kotlin` | | 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 +*: This variable can only be used as a part of a style string ### Ví dụ @@ -2174,17 +2295,17 @@ kotlin_binary = 'kotlinc' ## 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`. Nếu biến môi trường `$KUBECONFIG` được thiết lập, mô đun sẽ sử dụng cái đó nếu nó không sử dụng `~/.kube/config`. +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`. If the `$KUBECONFIG` env var is set the module will use that if not it will use the `~/.kube/config`. ::: tip -Mặc định, mô đun này được vô hiệu. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. When the module is enabled it will always be active, unless any of `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions. ::: -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ------------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | @@ -2209,7 +2330,7 @@ When the module is enabled it will always be active, unless any of `detect_exten | 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 +*: This variable can only be used as a part of a style string ### Ví dụ @@ -2263,7 +2384,7 @@ Long and automatically generated cluster names can be identified and shortened u The `line_break` module separates the prompt into two lines. -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ---------- | -------- | ------------------------------------------------------------------ | @@ -2282,7 +2403,7 @@ disabled = true The `localip` module shows the IPv4 address of the primary network interface. -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ---------- | ------------------------- | ------------------------------------------------------ | @@ -2319,7 +2440,7 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o - The current directory contains a `lua` directory - The current directory contains a file with the `.lua` extension -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ------------------- | ------------------------------------ | -------------------------------------------------------------------------- | @@ -2341,7 +2462,7 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o | 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 +*: This variable can only be used as a part of a style string ### Ví dụ @@ -2360,11 +2481,11 @@ By default the swap usage is displayed if the total system swap is non-zero. ::: tip -Mặc định, mô đun này được vô hiệu. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ----------- | ----------------------------------------------- | -------------------------------------------------------- | @@ -2405,7 +2526,7 @@ The `meson` module shows the current Meson developer environment status. By default the Meson project name is displayed, if `$MESON_DEVENV` is set. -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ------------------- | ---------------------------------- | ----------------------------------------------------------------------------------------- | @@ -2440,26 +2561,27 @@ style = 'bold dimmed green' ## Mercurial Branch -The `hg_branch` module shows the active branch of the repo in your current directory. +The `hg_branch` module shows the active branch and topic of the repo in your current directory. -### Options +### Các tuỳ chọn -| Tuỳ chọn | Mặc định | Mô tả | -| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------- | -| `symbol` | `' '` | The symbol used before the hg bookmark or branch name of the repo in your current directory. | -| `style` | `'bold purple'` | Kiểu cho module. | -| `format` | `'on [$symbol$branch]($style) '` | Định dạng cho module. | -| `truncation_length` | `2^63 - 1` | Truncates the hg branch name 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. | -| `disabled` | `true` | Disables the `hg_branch` module. | +| Tuỳ chọn | Mặc định | Mô tả | +| ------------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------- | +| `symbol` | `' '` | The symbol used before the hg bookmark or branch name of the repo in your current directory. | +| `style` | `'bold purple'` | Kiểu cho module. | +| `format` | `'on [$symbol$branch(:$topic)]($style) '` | Định dạng cho module. | +| `truncation_length` | `2^63 - 1` | Truncates the hg branch / topic name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. | +| `disabled` | `true` | Disables the `hg_branch` module. | ### Các biến -| Biến | Ví dụ | Mô tả | -| --------- | -------- | -------------------------------- | -| branch | `master` | The active mercurial branch | -| symbol | | Giá trị ghi đè tuỳ chọn `symbol` | -| style\* | | Giá trị ghi đè của `style` | +| Biến | Ví dụ | Mô tả | +| --------- | --------- | -------------------------------- | +| branch | `master` | The active mercurial branch | +| topic | `feature` | The active mercurial topic | +| 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 @@ -2483,11 +2605,11 @@ The `nim` module shows the currently installed version of [Nim](https://nim-lang - The current directory contains a file with the `.nims` extension - The current directory contains a file with the `.nimble` extension -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version )]($style)'` | Định dạng cho 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` | | `symbol` | `'👑 '` | The symbol used before displaying the version of Nim. | | `detect_extensions` | `['nim', 'nims', 'nimble']` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | @@ -2520,16 +2642,18 @@ symbol = '🎣 ' The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html) environment. The module will be shown when inside a nix-shell environment. -### Options +### Các tuỳ chọn -| Tuỳ chọn | Mặc định | Mô tả | -| ------------ | ---------------------------------------------- | ----------------------------------------------------- | -| `format` | `'via [$symbol$state( \($name\))]($style) '` | Định dạng cho module. | -| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | -| `style` | `'bold blue'` | Kiểu cho module. | -| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | -| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | -| `disabled` | `false` | Disables the `nix_shell` module. | +| Tuỳ chọn | Mặc định | Mô tả | +| ------------- | ---------------------------------------------- | --------------------------------------------------------------------- | +| `format` | `'via [$symbol$state( \($name\))]($style) '` | Định dạng cho module. | +| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | +| `style` | `'bold blue'` | Kiểu cho module. | +| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | +| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | +| `unknown_msg` | `''` | A format string shown when it is unknown if the shell is pure/impure. | +| `disabled` | `false` | Disables the `nix_shell` module. | +| `heuristic` | `false` | Attempts to detect new `nix shell`-style shells with a heuristic. | ### Các biến @@ -2551,6 +2675,7 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/ disabled = true impure_msg = '[impure shell](bold red)' pure_msg = '[pure shell](bold green)' +unknown_msg = '[unknown shell](bold yellow)' format = 'via [☃️ $state( \($name\))](bold blue) ' ``` @@ -2565,7 +2690,7 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n - The current directory contains a file with the `.js`, `.mjs` or `.cjs` extension - The current directory contains a file with the `.ts`, `.mts` or `.cts` extension -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ------------------- | ------------------------------------------ | ----------------------------------------------------------------------------------------------------- | @@ -2609,7 +2734,7 @@ The `ocaml` module shows the currently installed version of [OCaml](https://ocam - The current directory contains a `.merlin` file - The current directory contains a file with `.ml`, `.mli`, `.re` or `.rei` extension -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------- | @@ -2649,7 +2774,7 @@ format = 'via [🐪 $version]($style) ' The `opa` module shows the currently installed version of the OPA tool. By default the module will be shown if the current directory contains a `.rego` file. -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | @@ -2685,7 +2810,7 @@ format = 'via [⛑️ $version](bold red) ' The `openstack` module shows the current OpenStack cloud and project. The module only active when the `OS_CLOUD` env var is set, in which case it will read `clouds.yaml` file from any of the [default locations](https://docs.openstack.org/python-openstackclient/latest/configuration/index.html#configuration-files). to fetch the current project in use. -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ---------- | ----------------------------------------------- | -------------------------------------------------------------- | @@ -2703,7 +2828,7 @@ The `openstack` module shows the current OpenStack cloud and project. The module | 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 +*: This variable can only be used as a part of a style string ### Ví dụ @@ -2720,7 +2845,7 @@ symbol = '☁️ ' The `os` module shows the current operating system. OS information is detected via the [os_info](https://lib.rs/crates/os_info) crate. -::: warning +::: cảnh báo The [os_info](https://lib.rs/crates/os_info) crate used by this module is known to be inaccurate on some systems. @@ -2728,11 +2853,11 @@ The [os_info](https://lib.rs/crates/os_info) crate used by this module is known ::: tip -Mặc định, mô đun này được vô hiệu. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ---------- | --------------------- | ------------------------------------------------------ | @@ -2837,7 +2962,7 @@ The `package` module is shown when the current directory is the repository for a > ⚠️ The version being shown is that of the package whose source code is in your current directory, not your package manager. -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ----------------- | --------------------------------- | ------------------------------------------------------------------------- | @@ -2856,7 +2981,7 @@ The `package` module is shown when the current directory is the repository for a | 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 +*: This variable can only be used as a part of a style string ### Ví dụ @@ -2877,7 +3002,7 @@ The `perl` module shows the currently installed version of [Perl](https://www.pe - The current directory contains a `.perl-version` file - The current directory contains a `.pl`, `.pm` or `.pod` -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | @@ -2911,11 +3036,11 @@ format = 'via [🦪 $version]($style) ' The `php` module shows the currently installed version of [PHP](https://www.php.net/). Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn: -- The current directory contains a `composer.json` file +- Thư mục hiện tại chứa một tập tin `composer.json` - The current directory contains a `.php-version` file - The current directory contains a `.php` extension -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | @@ -2936,7 +3061,7 @@ The `php` module shows the currently installed version of [PHP](https://www.php. | 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 +*: This variable can only be used as a part of a style string ### Ví dụ @@ -2947,6 +3072,21 @@ The `php` module shows the currently installed version of [PHP](https://www.php. format = 'via [🔹 $version](147 bold) ' ``` +## Pijul Channel + +The `pijul_channel` module shows the active channel of the repo in your current directory. + +### Các tuỳ chọn + +| Tuỳ chọn | Mặc định | Mô tả | +| ------------------- | --------------------------------- | ------------------------------------------------------------------------------------ | +| `symbol` | `' '` | The symbol used before the pijul channel name of the repo in your current directory. | +| `style` | `'bold purple'` | Kiểu cho module. | +| `format` | `'on [$symbol$channel]($style) '` | Định dạng cho module. | +| `truncation_length` | `2^63 - 1` | Truncates the pijul channel name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. | +| `disabled` | `true` | Disables the `pijul` module. | + ## Pulumi The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. @@ -2962,7 +3102,7 @@ Mặc định module sẽ được hiển thị nếu có bất kì điều ki - The current directory contains either `Pulumi.yaml` or `Pulumi.yml` - A parent directory contains either `Pulumi.yaml` or `Pulumi.yml` unless `search_upwards` is set to `false` -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ---------------- | -------------------------------------------- | ------------------------------------------------------------------------- | @@ -3012,7 +3152,7 @@ The `purescript` module shows the currently installed version of [PureScript](ht - Thư mục hiện tại chứa một tập tin `spago.dhall` - The current directory contains a file with the `.purs` extension -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | @@ -3033,7 +3173,7 @@ The `purescript` module shows the currently installed version of [PureScript](ht | 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 +*: This variable can only be used as a part of a style string ### Ví dụ @@ -3062,7 +3202,7 @@ Mặc định module sẽ được hiển thị nếu có bất kì điều ki - The current directory contains a file with the `.py` extension. - A virtual environment is currently activated -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- | @@ -3145,7 +3285,7 @@ The `rlang` module shows the currently installed version of [R](https://www.r-pr - The current directory contains a `.Rprofile` file - The current directory contains a `.Rproj.user` folder -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | @@ -3182,7 +3322,7 @@ The `raku` module shows the currently installed version of [Raku](https://www.ra - The current directory contains a `META6.json` file - The current directory contains a `.p6`, `.pm6`, `.raku`, `.rakumod` or `.pod6` -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ------------------- | ------------------------------------------------ | ------------------------------------------------------------------------- | @@ -3215,11 +3355,11 @@ format = 'via [🦪 $version]($style) ' ## Red -By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn: +By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a file with `.red` or `.reds` extension -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | @@ -3240,7 +3380,7 @@ By default the `red` module shows the currently installed version of [Red](https | 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 +*: This variable can only be used as a part of a style string ### Ví dụ @@ -3253,7 +3393,7 @@ symbol = '🔴 ' ## Ruby -By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn: +By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `Gemfile` file - The current directory contains a `.ruby-version` file @@ -3262,7 +3402,7 @@ By default the `ruby` module shows the currently installed version of [Ruby](htt Starship gets the current Ruby version by running `ruby -v`. -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | @@ -3297,12 +3437,12 @@ symbol = '🔺 ' ## Rust -By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn: +By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `Cargo.toml` file - The current directory contains a file with the `.rs` extension -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | @@ -3344,7 +3484,7 @@ The `scala` module shows the currently installed version of [Scala](https://www. - The current directory contains a file with the `.scala` or `.sbt` extension - The current directory contains a directory named `.metals` -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ------------------- | ---------------------------------------- | ------------------------------------------------------------------------- | @@ -3365,7 +3505,7 @@ The `scala` module shows the currently installed version of [Scala](https://www. | 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 +*: This variable can only be used as a part of a style string ### Ví dụ @@ -3382,11 +3522,11 @@ The `shell` module shows an indicator for currently used shell. ::: tip -Mặc định, mô đun này được vô hiệu. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ---------------------- | ------------------------- | ------------------------------------------------------------ | @@ -3410,7 +3550,7 @@ Mặc định, mô đun này được vô hiệu. Để kích hoạt nó, thiế | Biến | Mặc định | Mô tả | | --------- | -------- | ---------------------------------------------------------- | | indicator | | Mirrors the value of `indicator` for currently used shell. | -| style\* | | Giá trị ghi đè của `style`. | +| style\* | | Mirrors the value of option `style`. | *: Biến này có thể chỉ được sử dụng như một phần của style string @@ -3431,7 +3571,7 @@ disabled = false The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ('shell level') environment variable, if it is set to a number and meets or exceeds the specified threshold. -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ----------- | ---------------------------- | ------------------------------------------------------------- | @@ -3467,7 +3607,7 @@ threshold = 3 The `singularity` module shows the current [Singularity](https://sylabs.io/singularity/) image, if inside a container and `$SINGULARITY_NAME` is set. -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ---------- | -------------------------------- | ------------------------------------------------ | @@ -3499,7 +3639,7 @@ format = '[📦 \[$env\]]($style) ' The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set. -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ------------------- | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -3517,7 +3657,7 @@ The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/lat | 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 +*: This variable can only be used as a part of a style string ### Ví dụ @@ -3534,11 +3674,11 @@ The `status` module displays the exit code of the previous command. If $success_ ::: tip -Mặc định, mô đun này được vô hiệu. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | --------------------------- | ---------------------------------------------------------------------------------- | --------------------------------------------------------------------- | @@ -3573,7 +3713,7 @@ Mặc định, mô đun này được vô hiệu. Để kích hoạt nó, thiế | 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 +*: This variable can only be used as a part of a style string ### Ví dụ @@ -3595,11 +3735,11 @@ The `sudo` module displays if sudo credentials are currently cached. The module ::: tip -Mặc định, mô đun này được vô hiệu. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | --------------- | ------------------------ | ------------------------------------------------------- | @@ -3640,12 +3780,12 @@ disabled = false ## Swift -By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn: +By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `Package.swift` file - The current directory contains a file with the `.swift` extension -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | @@ -3666,7 +3806,7 @@ By default the `swift` module shows the currently installed version of [Swift](h | 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 +*: This variable can only be used as a part of a style string ### Ví dụ @@ -3692,7 +3832,7 @@ Mặc định module sẽ được hiển thị nếu có bất kì điều ki - The current directory contains a `.terraform` folder - Current directory contains a file with the `.tf`, `.tfplan` or `.tfstate` extensions -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | @@ -3714,7 +3854,7 @@ Mặc định module sẽ được hiển thị nếu có bất kì điều ki | 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 +*: This variable can only be used as a part of a style string ### Ví dụ @@ -3742,11 +3882,11 @@ The `time` module shows the current **local** time. The `format` configuration v ::: tip -Mặc định, mô đun này được vô hiệu. Để kích hoạt nó, thiết lập `disabled` sang `false` trong tập tin cấu hình của bạn. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | @@ -3764,10 +3904,10 @@ If `use_12hr` is `true`, then `time_format` defaults to `'%r'`. Otherwise, it de | Biến | Ví dụ | Mô tả | | --------- | ---------- | -------------------------- | -| thời gian | `13:08:10` | The current time. | +| time | `13:08:10` | The current time. | | style\* | | Giá trị ghi đè của `style` | -*: Biến này có thể chỉ được sử dụng như một phần của style string +*: This variable can only be used as a part of a style string ### Ví dụ @@ -3784,7 +3924,7 @@ time_range = '10:00:00-14:00:00' ## Username -The `username` module shows active user's username. Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn: +The `username` module shows active user's username. The module will be shown if any of the following conditions are met: - The current user is root/admin - The current user isn't the same as the one that is logged in @@ -3797,7 +3937,7 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, ` ::: -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ------------- | ----------------------- | ------------------------------------------- | @@ -3833,7 +3973,7 @@ The `vagrant` module shows the currently installed version of [Vagrant](https:// - The current directory contains a `Vagrantfile` file -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | @@ -3854,7 +3994,7 @@ The `vagrant` module shows the currently installed version of [Vagrant](https:// | 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 +*: This variable can only be used as a part of a style string ### Ví dụ @@ -3872,7 +4012,7 @@ The `vlang` module shows you your currently installed version of [V](https://vla - The current directory contains a file with `.v` extension - The current directory contains a `v.mod`, `vpkg.json` or `.vpkg-lock.json` file -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ------------------- | -------------------------------------------- | ------------------------------------------------------------------------- | @@ -3905,7 +4045,7 @@ format = 'via [V $version](blue bold) ' The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. The module will be shown only if a repository is currently in use. -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ---------- | -------------------------------- | ------------------------------------------------------ | @@ -3935,11 +4075,11 @@ format = '[🆅 $repo](bold blue) ' ## Zig -By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). Module cho sẽ được hiện nếu bất kì điều kiện nào dưới đây thoả mãn: +By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `.zig` file -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | @@ -3960,7 +4100,7 @@ By default the the `zig` module shows the currently installed version of [Zig](h | 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 +*: This variable can only be used as a part of a style string ### Ví dụ @@ -4009,14 +4149,14 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt ::: -### Options +### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `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. | | `shell` | | [See below](#custom-command-shell) | -| `mô tả` | `''` | The description of the module that is shown when running `starship explain`. | +| `description` | `''` | The description of the module that is shown when running `starship explain`. | | `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_extensions` | `[]` | The extensions that will be searched in the working directory for a match. | @@ -4036,7 +4176,7 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt | 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 +*: This variable can only be used as a part of a style string #### Custom command shell diff --git a/docs/vi-VN/guide/README.md b/docs/vi-VN/guide/README.md index 20cdb81f..5be25359 100644 --- a/docs/vi-VN/guide/README.md +++ b/docs/vi-VN/guide/README.md @@ -9,7 +9,7 @@

Trạng thái GitHub Actions workflow @@ -423,6 +423,7 @@ Support this project by [becoming a sponsor](https://github.com/sponsors/starshi **Supporter Tier** - [Dimension](https://dimension.dev/) +- [Appwrite](https://appwrite.io/)


diff --git a/docs/vi-VN/presets/README.md b/docs/vi-VN/presets/README.md index 8f826758..0e28b2a5 100644 --- a/docs/vi-VN/presets/README.md +++ b/docs/vi-VN/presets/README.md @@ -14,7 +14,11 @@ This preset changes the symbols for each module to use Nerd Font symbols. This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt. -::: tip This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). ::: +::: tip + +This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). + +::: [Click to view No Nerd Font preset](./no-nerd-font) diff --git a/docs/zh-CN/README.md b/docs/zh-CN/README.md index 6959d0f3..1a272642 100644 --- a/docs/zh-CN/README.md +++ b/docs/zh-CN/README.md @@ -149,14 +149,14 @@ description: Starship是一款轻量级、反应迅速、可自定义的高颜 ::: warning - 这部分今后可能会改变。 仅支持 Nushell v0.61+。 + 这部分今后可能会改变。 仅支持 Nushell v0.73+。 ::: - 将以下内容添加到您 Nushell 环境文件的末尾（使用 `$nu.env-path` 来获取它的路径）： + 在您的 Nushell 环境文件的最后（使用 `$nu.env-path` 来获取它的路径），添加以下内容： ```sh mkdir ~/.cache/starship - starship init nu | save ~/.cache/starship/init.nu + starship init nu | save -f ~/.cache/starship/init.nu ``` 然后在您的 Nushell 配置文件的最后（使用 `$nu.config-path` 来获取它的路径），添加以下内容： diff --git a/docs/zh-CN/advanced-config/README.md b/docs/zh-CN/advanced-config/README.md index ea5e334e..f98322a7 100644 --- a/docs/zh-CN/advanced-config/README.md +++ b/docs/zh-CN/advanced-config/README.md @@ -207,8 +207,6 @@ Invoke-Expression (&starship init powershell) `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell. -Note: Nushell 0.71.0 or later is required - ### 示例 ```toml @@ -231,7 +229,7 @@ right_format = """$all""" 一些 Shell 也同时支持多行提示符。 若用户输入了不完整的命令（例如一个左括号或引号），Shell 会渲染多行提示符。 -使用 `continuation_prompt` 选项来设置 Starship 的多行提示符。 它的默认值为 `[∙](bright-black)`。 +使用 `continuation_prompt` 选项来设置 Starship 的多行提示符。 The default prompt is `'[∙](bright-black) '`. 注意：`continuation_prompt` 应设置为没有变量的字符串。 @@ -247,7 +245,7 @@ right_format = """$all""" # ~/.config/starship.toml # A continuation prompt that displays two filled in arrows -continuation_prompt = "▶▶" +continuation_prompt = '▶▶ ' ``` ## 样式字符串 diff --git a/docs/zh-CN/config/README.md b/docs/zh-CN/config/README.md index 3f15d900..8773cc62 100644 --- a/docs/zh-CN/config/README.md +++ b/docs/zh-CN/config/README.md @@ -24,7 +24,7 @@ success_symbol = '[➜](bold green)' # The 'success_symbol' segment is being set disabled = true ``` -### Config File Location +### 配置文件路径 您可以使用 `STARSHIP_CONFIG` 环境变量更改默认配置文件的位置： @@ -72,11 +72,11 @@ os.setenv('STARSHIP_CACHE', 'C:\\Users\\user\\AppData\\Local\\Temp') 依惯例，大多组件都有一个带有默认终端颜色的前缀（例如“nodejs”的 `via`），以及一个空格作为后缀。 -### Strings +### 字符串 In TOML syntax, [text values](https://toml.io/en/v1.0.0#string) are declared with `'`, `"`, `'''`, or `"""`. -The following Starship syntax symbols have special usage in a format string and must be escaped to display as that character: `$ [ ] ( )`. +下列 Starship 语法符号在格式字符串中具有特殊用途，必须转义才能以原字符显示： `$ [ ] ( )`。 | Symbol | Type | Notes | | ------ | ------------------------- | ------------------------------------------------------ | @@ -252,12 +252,14 @@ $singularity\ $kubernetes\ $directory\ $vcsh\ +$fossil_branch\ $git_branch\ $git_commit\ $git_state\ $git_metrics\ $git_status\ $hg_branch\ +$pijul_channel\ $docker_context\ $package\ $c\ @@ -270,6 +272,7 @@ $dotnet\ $elixir\ $elm\ $erlang\ +$fennel\ $golang\ $guix_shell\ $haskell\ @@ -278,6 +281,7 @@ $helm\ $java\ $julia\ $kotlin\ +$gradle\ $lua\ $nim\ $nodejs\ @@ -1305,6 +1309,12 @@ The `env_var` module displays the current value of a selected environment variab ::: tip +The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. + +::: + +::: 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 @@ -1320,13 +1330,14 @@ default = 'unknown user' ### 配置项 -| 选项 | 默认值 | 描述 | -| ---------- | ------------------------------ | ------------------- | -| `symbol` | `''` | 这个字段的内容会显示在环境变量值之前。 | -| `variable` | | 要显示的环境变量。 | -| `default` | | 所选变量未定义时显示的默认值。 | -| `format` | `'with [$env_value]($style) '` | 组件格式化模板。 | -| `disabled` | `false` | 禁用 `env_var` 组件。 | +| 选项 | 默认值 | 描述 | +| ------------- | ------------------------------ | ---------------------------------------------------------------------------- | +| `symbol` | `""` | 这个字段的内容会显示在环境变量值之前。 | +| `variable` | | 要显示的环境变量。 | +| `default` | | 所选变量未定义时显示的默认值。 | +| `format` | `"with [$env_value]($style) "` | 组件格式化模板。 | +| `description` | `""` | The description of the module that is shown when running `starship explain`. | +| `disabled` | `false` | 禁用 `env_var` 组件。 | ### Variables @@ -1399,6 +1410,44 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https: format = 'via [e $version](bold red) ' ``` +## Fennel + +The `fennel` module shows the currently installed version of [Fennel](https://fennel-lang.org). By default the module will be shown if any of the following conditions are met: + +- The current directory contains a file with the `.fnl` extension + +### 配置项 + +| 选项 | 默认值 | 描述 | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | 组件格式化模板。 | +| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. | +| `style` | `'bold green'` | 此组件的样式。 | +| `detect_extensions` | `[fnl]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `disabled` | `false` | Disables the `fennel` module. | + +### Variables + +| 字段 | 示例 | 描述 | +| --------- | -------- | ----------------------- | +| version | `v1.2.1` | The version of `fennel` | +| symbol | | `symbol`对应值 | +| style\* | | `style`对应值 | + +*: This variable can only be used as a part of a style string + +### 示例 + +```toml +# ~/.config/starship.toml + +[fennel] +symbol = '⫰ ' +``` + ## Fill The `fill` module fills any extra space on the line with a symbol. If multiple `fill` modules are present in a line they will split the space evenly between them. This is useful for aligning other modules. @@ -1428,6 +1477,42 @@ Produces a prompt that looks like: AA -------------------------------------------- BB -------------------------------------------- CC ``` +## Fossil Branch + +The `fossil_branch` module shows the name of the active branch of the check-out in your current directory. + +### 配置项 + +| 选项 | 默认值 | 描述 | +| ------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | +| `format` | `'on [$symbol$branch]($style) '` | 组件格式化模板。 Use `'$branch'` to refer to the current branch name. | +| `symbol` | `' '` | The symbol used before the branch name of the check-out in your current directory. | +| `style` | `'bold purple'` | 此组件的样式。 | +| `truncation_length` | `2^63 - 1` | Truncates a Fossil branch name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. | +| `disabled` | `true` | Disables the `fossil_branch` module. | + +### Variables + +| 字段 | 示例 | 描述 | +| --------- | ------- | ------------------------ | +| branch | `trunk` | The active Fossil branch | +| symbol | | `symbol`对应值 | +| style\* | | `style`对应值 | + +*: This variable can only be used as a part of a style string + +### 示例 + +```toml +# ~/.config/starship.toml + +[fossil_branch] +symbol = '🦎 ' +truncation_length = 4 +truncation_symbol = '' +``` + ## Google Cloud (`gcloud`) The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var. @@ -1503,21 +1588,21 @@ very-long-project-name = 'vlpn' ## Git Branch -`git_branch` 组件显示当前目录的 git 仓库的活动分支。 +The `git_branch` module shows the active branch of the repo in your current directory. ### 配置项 -| 选项 | 默认值 | 描述 | -| -------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------ | -| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | -| `format` | `'on [$symbol$branch(:$remote_branch)]($style) '` | 组件格式化模板。 Use `'$branch'` to refer to the current branch name. | -| `symbol` | `' '` | A format string representing the symbol of git branch. | -| `style` | `'bold purple'` | 此组件的样式。 | -| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | -| `truncation_symbol` | `'…'` | 此字段的内容用来表示分支名称被截断。 You can use `''` for no symbol. | -| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | -| `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. | -| `disabled` | `false` | 禁用 `git_branch` 组件。 | +| 选项 | 默认值 | 描述 | +| -------------------- | ------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local 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. | +| `style` | `'bold purple'` | 此组件的样式。 | +| `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. | +| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | +| `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. | +| `disabled` | `false` | Disables the `git_branch` module. | ### Variables @@ -1551,21 +1636,22 @@ The `git_commit` module shows the current commit hash and also the tag (if any) | 选项 | 默认值 | 描述 | | -------------------- | ------------------------------ | ------------------------------------------------------------------------------------ | -| `commit_hash_length` | `7` | 显示的 git 提交哈希值的长度。 | +| `commit_hash_length` | `7` | The length of the displayed git commit hash. | | `format` | `'[\($hash$tag\)]($style) '` | 组件格式化模板。 | | `style` | `'bold green'` | 此组件的样式。 | | `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state | | `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. | | `tag_max_candidates` | `0` | How many commits to consider for tag display. The default only allows exact matches. | | `tag_symbol` | `' 🏷 '` | Tag symbol prefixing the info shown | -| `disabled` | `false` | 禁用 `git_commit` 组件。 | +| `disabled` | `false` | Disables the `git_commit` module. | ### Variables -| 字段 | 示例 | 描述 | -| --------- | --------- | --------------------------- | -| hash | `b703eb3` | The current git commit hash | -| style\* | | `style`对应值 | +| 字段 | 示例 | 描述 | +| --------- | --------- | -------------------------------------------- | +| hash | `b703eb3` | The current git commit hash | +| tag | `v1.0.0` | The tag name if showing tag info is enabled. | +| style\* | | `style`对应值 | *: This variable can only be used as a part of a style string @@ -1581,7 +1667,7 @@ tag_symbol = '🔖 ' ## Git State -`git_state` 组件会显示当前目录在哪个 git 仓库中，以及正在进行的操作，例如：_REBASING_，_BISECTING_ 等。 进度信息（例如 REBASING 3/10）如果存在则也会被显示。 +The `git_state` module will show in directories which are part of a git repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. If there is progress information (e.g., REBASING 3/10), that information will be shown too. ### 配置项 @@ -1596,7 +1682,7 @@ tag_symbol = '🔖 ' | `am_or_rebase` | `'AM/REBASE'` | A format string displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. | | `style` | `'bold yellow'` | 此组件的样式。 | | `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | 组件格式化模板。 | -| `disabled` | `false` | 禁用 `git_state` 模块 | +| `disabled` | `false` | Disables the `git_state` module. | ### Variables @@ -1625,7 +1711,7 @@ The `git_metrics` module will show the number of added and deleted lines in the ::: tip -此组件默认被禁用。 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -1662,7 +1748,7 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) ' ## Git Status -`git_status`组件通过相应的符号显示您当前目录中 git 仓库的状态。 +The `git_status` module shows symbols representing the state of the repo in your current directory. ::: tip @@ -1675,7 +1761,7 @@ The Git Status module is very slow in Windows directories (for example under `/m | 选项 | 默认值 | 描述 | | ------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | | `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | The default format for `git_status` | -| `conflicted` | `'='` | 这个分支有合并冲突。 | +| `conflicted` | `'='` | This branch has merge conflicts. | | `ahead` | `'⇡'` | The format of `ahead` | | `behind` | `'⇣'` | The format of `behind` | | `diverged` | `'⇕'` | The format of `diverged` | @@ -1688,7 +1774,7 @@ The Git Status module is very slow in Windows directories (for example under `/m | `deleted` | `'✘'` | The format of `deleted` | | `style` | `'bold red'` | 此组件的样式。 | | `ignore_submodules` | `false` | Ignore changes to submodules. | -| `disabled` | `false` | 禁用 `git_status` 组件。 | +| `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. | ### Variables @@ -1719,9 +1805,9 @@ The following variables can be used in `diverged`: The following variables can be used in `conflicted`, `ahead`, `behind`, `untracked`, `stashed`, `modified`, `staged`, `renamed` and `deleted`: -| 字段 | 描述 | -| ------- | --------- | -| `count` | 显示相应的文件数量 | +| 字段 | 描述 | +| ------- | ------------------------ | +| `count` | Show the number of files | ### 示例 @@ -1787,7 +1873,7 @@ The `golang` module shows the currently installed version of [Go](https://golang | `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. | | `style` | `'bold cyan'` | 此组件的样式。 | -| `disabled` | `false` | 禁用 `golang` 组件。 | +| `disabled` | `false` | Disables the `golang` module. | ### Variables @@ -1840,6 +1926,41 @@ disabled = true format = 'via [🐂](yellow bold) ' ``` +## Gradle + +The `gradle` module shows the version of the [Gradle Wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html) currently used in the project directory. + +By default the module will be shown if any of the following conditions are met: + +- The current directory contains a `gradle/wrapper/gradle-wrapper.properties` directory. +- The current directory contains a file ending with `.gradle` or `.gradle.kts`. + +The `gradle` module is only able to read your Gradle Wrapper version from your config file, we don't execute your wrapper, because of the security concerns. + +### 配置项 + +| 选项 | 默认值 | 描述 | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | 组件格式化模板。 | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🅶 "` | A format string representing the symbol of Gradle. | +| `detect_extensions` | `["gradle", "gradle.kts"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `["gradle"]` | Which folders should trigger this module. | +| `style` | `"bold bright-cyan"` | 此组件的样式。 | +| `disabled` | `false` | Disables the `gradle` module. | +| `recursive` | `false` | Enables recursive finding for the `gradle` directory. | + +### Variables + +| 字段 | 示例 | 描述 | +| ------- | -------- | ----------------------- | +| version | `v7.5.1` | The version of `gradle` | +| symbol | | `symbol`对应值 | +| style* | | `style`对应值 | + +*: This variable can only be used as a part of a style string + ## Haskell The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot. @@ -1859,7 +1980,7 @@ By default the module will be shown if any of the following conditions are met: | `detect_files` | `['stack.yaml', 'cabal.project']` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `'bold purple'` | 此组件的样式。 | -| `disabled` | `false` | 禁用 `haskell` 组件。 | +| `disabled` | `false` | Disables the `haskell` module. | ### Variables @@ -1954,18 +2075,18 @@ format = 'via [⎈ $version](bold white) ' ## Hostname -`hostname` 组件显示系统主机名。 +The `hostname` module shows the system hostname. ### 配置项 -| 选项 | 默认值 | 描述 | -| ------------ | -------------------------------------- | ----------------------------------------------------------------------------------------------------- | -| `ssh_only` | `true` | 仅在连接到 SSH 会话时显示主机名。 | -| `ssh_symbol` | `'🌐 '` | A format string representing the symbol when connected to SSH session. | -| `trim_at` | `'.'` | 当主机名过长被截断时，会截断成第一次匹配该字符串之前的主机名。 `'.'` will stop after the first dot. `''` will disable any truncation | -| `format` | `'[$ssh_symbol$hostname]($style) in '` | 组件格式化模板。 | -| `style` | `'bold dimmed green'` | 此组件的样式。 | -| `disabled` | `false` | 禁用 `hostname` 组件。 | +| 选项 | 默认值 | 描述 | +| ------------ | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | +| `ssh_only` | `true` | Only show hostname when connected to an SSH session. | +| `ssh_symbol` | `'🌐 '` | A format string representing the symbol when connected to SSH session. | +| `trim_at` | `'.'` | String that the hostname is cut off at, after the first match. `'.'` will stop after the first dot. `''` will disable any truncation | +| `format` | `'[$ssh_symbol$hostname]($style) in '` | 组件格式化模板。 | +| `style` | `'bold dimmed green'` | 此组件的样式。 | +| `disabled` | `false` | Disables the `hostname` module. | ### Variables @@ -2007,7 +2128,7 @@ The `java` module shows the currently installed version of [Java](https://www.or | `detect_folders` | `[]` | Which folders should trigger this modules. | | `symbol` | `'☕ '` | A format string representing the symbol of Java | | `style` | `'red dimmed'` | 此组件的样式。 | -| `disabled` | `false` | 禁用 `java` 组件。 | +| `disabled` | `false` | Disables the `java` module. | ### Variables @@ -2030,7 +2151,7 @@ symbol = '🌟 ' ## Jobs -`jobs` 组件显示当前正在运行的任务数量。 仅当有后台任务运行时，此组件才会显示。 The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to _always_ show the symbol and number of jobs, even if there are 0 jobs running. +The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to _always_ show the symbol and number of jobs, even if there are 0 jobs running. The default functionality is: @@ -2054,13 +2175,13 @@ The `threshold` option is deprecated, but if you want to use it, the module will | 选项 | 默认值 | 描述 | | ------------------ | ----------------------------- | ------------------------------------------------------------------------ | -| `threshold`* | `1` | 如果超过此字段的值，显示任务数量。 | +| `threshold`* | `1` | Show number of jobs if exceeded. | | `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. | | `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. | | `format` | `'[$symbol$number]($style) '` | 组件格式化模板。 | | `symbol` | `'✦'` | The string used to represent the `symbol` variable. | | `style` | `'bold blue'` | 此组件的样式。 | -| `disabled` | `false` | 禁用 `jobs` 组件。 | +| `disabled` | `false` | Disables the `jobs` module. | *: This option is deprecated, please use the `number_threshold` and `symbol_threshold` options instead. @@ -2178,7 +2299,7 @@ Displays the current [Kubernetes context](https://kubernetes.io/docs/concepts/co ::: tip -此组件默认被禁用。 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. When the module is enabled it will always be active, unless any of `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions. @@ -2261,13 +2382,13 @@ Long and automatically generated cluster names can be identified and shortened u ## Line Break -`line_break` 组件将提示分隔为两行。 +The `line_break` module separates the prompt into two lines. ### 配置项 -| 选项 | 默认值 | 描述 | -| ---------- | ------- | --------------------------- | -| `disabled` | `false` | 禁用 `line_break` 组件，使提示成为单行。 | +| 选项 | 默认值 | 描述 | +| ---------- | ------- | ------------------------------------------------------------------ | +| `disabled` | `false` | Disables the `line_break` module, making the prompt a single line. | ### 示例 @@ -2354,25 +2475,25 @@ format = 'via [🌕 $version](bold blue) ' ## Memory Usage -`memory_usage` 组件显示当前系统内存和交换区使用情况。 +The `memory_usage` module shows current system memory and swap usage. -默认情况下，如果系统交换区使用不为 0，则会显示交换区使用情况。 +By default the swap usage is displayed if the total system swap is non-zero. ::: tip -此组件默认被禁用。 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### 配置项 -| 选项 | 默认值 | 描述 | -| ----------- | ----------------------------------------------- | ---------------------- | -| `threshold` | `75` | 隐藏内存使用情况，除非它超过这个百分比。 | -| `format` | `'via $symbol [${ram}( \| ${swap})]($style) '` | 组件格式化模板。 | -| `symbol` | `'🐏'` | 这个字段的内容会显示在当前内存使用情况之前。 | -| `style` | `'bold dimmed white'` | 此组件的样式。 | -| `disabled` | `true` | 禁用 `memory_usage` 模块 | +| 选项 | 默认值 | 描述 | +| ----------- | ----------------------------------------------- | -------------------------------------------------------- | +| `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. | +| `format` | `'via $symbol [${ram}( \| ${swap})]($style) '` | 组件格式化模板。 | +| `symbol` | `'🐏'` | The symbol used before displaying the memory usage. | +| `style` | `'bold dimmed white'` | 此组件的样式。 | +| `disabled` | `true` | Disables the `memory_usage` module. | ### Variables @@ -2440,26 +2561,27 @@ style = 'bold dimmed green' ## Mercurial Branch -`hg_branch` 组件显示当前目录的 hg 仓库的活动分支。 +The `hg_branch` module shows the active branch and topic of the repo in your current directory. ### 配置项 -| 选项 | 默认值 | 描述 | -| ------------------- | -------------------------------- | --------------------------------------------- | -| `symbol` | `' '` | 该字段的内容显示于当前仓库的 hg 书签或活动分支名之前。 | -| `style` | `'bold purple'` | 此组件的样式。 | -| `format` | `'on [$symbol$branch]($style) '` | 组件格式化模板。 | -| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to `N` graphemes | -| `truncation_symbol` | `'…'` | 此字段的内容用来表示分支名称被截断。 | -| `disabled` | `true` | 禁用 `hg_branch` 组件。 | +| 选项 | 默认值 | 描述 | +| ------------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------- | +| `symbol` | `' '` | The symbol used before the hg bookmark or branch name of the repo in your current directory. | +| `style` | `'bold purple'` | 此组件的样式。 | +| `format` | `'on [$symbol$branch(:$topic)]($style) '` | 组件格式化模板。 | +| `truncation_length` | `2^63 - 1` | Truncates the hg branch / topic name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. | +| `disabled` | `true` | Disables the `hg_branch` module. | ### Variables -| 字段 | 示例 | 描述 | -| --------- | -------- | --------------------------- | -| branch | `master` | The active mercurial branch | -| symbol | | `symbol`对应值 | -| style\* | | `style`对应值 | +| 字段 | 示例 | 描述 | +| --------- | --------- | --------------------------- | +| branch | `master` | The active mercurial branch | +| topic | `feature` | The active mercurial topic | +| symbol | | `symbol`对应值 | +| style\* | | `style`对应值 | *: This variable can only be used as a part of a style string @@ -2518,24 +2640,26 @@ symbol = '🎣 ' ## Nix-shell -The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html) environment. 当处于一个 nix-shell 环境中时，此组件会被显示。 +The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html) environment. The module will be shown when inside a nix-shell environment. ### 配置项 -| 选项 | 默认值 | 描述 | -| ------------ | ---------------------------------------------- | ----------------------------------------------------- | -| `format` | `'via [$symbol$state( \($name\))]($style) '` | 组件格式化模板。 | -| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | -| `style` | `'bold blue'` | 此组件的样式。 | -| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | -| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | -| `disabled` | `false` | 禁用 `nix_shell` 组件。 | +| 选项 | 默认值 | 描述 | +| ------------- | ---------------------------------------------- | --------------------------------------------------------------------- | +| `format` | `'via [$symbol$state( \($name\))]($style) '` | 组件格式化模板。 | +| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | +| `style` | `'bold blue'` | 此组件的样式。 | +| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | +| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | +| `unknown_msg` | `''` | A format string shown when it is unknown if the shell is pure/impure. | +| `disabled` | `false` | Disables the `nix_shell` module. | +| `heuristic` | `false` | Attempts to detect new `nix shell`-style shells with a heuristic. | ### Variables | 字段 | 示例 | 描述 | | --------- | ------- | -------------------------- | -| state | `纯色` | The state of the nix-shell | +| state | `pure` | The state of the nix-shell | | name | `lorri` | The name of the nix-shell | | symbol | | `symbol`对应值 | | style\* | | `style`对应值 | @@ -2551,6 +2675,7 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/ disabled = true impure_msg = '[impure shell](bold red)' pure_msg = '[pure shell](bold green)' +unknown_msg = '[unknown shell](bold yellow)' format = 'via [☃️ $state( \($name\))](bold blue) ' ``` @@ -2576,7 +2701,7 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n | `detect_files` | `['package.json', '.node-version']` | Which filenames should trigger this module. | | `detect_folders` | `['node_modules']` | Which folders should trigger this module. | | `style` | `'bold green'` | 此组件的样式。 | -| `disabled` | `false` | 禁用 `nodejs` 组件。 | +| `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. | ### Variables @@ -2728,7 +2853,7 @@ The [os_info](https://lib.rs/crates/os_info) crate used by this module is known ::: tip -此组件默认被禁用。 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -2815,7 +2940,7 @@ Arch = "Arch is the best! " ## Package Version -当前目录是软件包的代码仓库时，将显示 `package` 组件，并显示软件包当前版本。 The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages. +The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages. - [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory - [**Cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory @@ -2842,11 +2967,11 @@ Arch = "Arch is the best! " | 选项 | 默认值 | 描述 | | ----------------- | --------------------------------- | ------------------------------------------------------------------------- | | `format` | `'is [$symbol$version]($style) '` | 组件格式化模板。 | -| `symbol` | `'📦 '` | 这个字段的内容会显示在当前软件包版本之前。 | +| `symbol` | `'📦 '` | The symbol used before displaying the version the package. | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `style` | `'bold 208'` | 此组件的样式。 | | `display_private` | `false` | Enable displaying version for packages marked as private. | -| `disabled` | `false` | 禁用 `package` 组件。 | +| `disabled` | `false` | Disables the `package` module. | ### Variables @@ -2921,12 +3046,12 @@ The `php` module shows the currently installed version of [PHP](https://www.php. | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | | `format` | `'via [$symbol($version )]($style)'` | 组件格式化模板。 | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'🐘 '` | 这个字段的内容会显示在当前 PHP 版本之前。 | +| `symbol` | `'🐘 '` | The symbol used before displaying the version of PHP. | | `detect_extensions` | `['php']` | Which extensions should trigger this module. | | `detect_files` | `['composer.json', '.php-version']` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `'147 bold'` | 此组件的样式。 | -| `disabled` | `false` | 禁用 `php` 组件。 | +| `disabled` | `false` | Disables the `php` module. | ### Variables @@ -2947,6 +3072,21 @@ The `php` module shows the currently installed version of [PHP](https://www.php. format = 'via [🔹 $version](147 bold) ' ``` +## Pijul Channel + +The `pijul_channel` module shows the active channel of the repo in your current directory. + +### 配置项 + +| 选项 | 默认值 | 描述 | +| ------------------- | --------------------------------- | ------------------------------------------------------------------------------------ | +| `symbol` | `' '` | The symbol used before the pijul channel name of the repo in your current directory. | +| `style` | `'bold purple'` | 此组件的样式。 | +| `format` | `'on [$symbol$channel]($style) '` | 组件格式化模板。 | +| `truncation_length` | `2^63 - 1` | Truncates the pijul channel name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. | +| `disabled` | `true` | Disables the `pijul` module. | + ## Pulumi The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. @@ -3048,7 +3188,7 @@ format = 'via [$symbol$version](bold white)' The `python` module shows the currently installed version of [Python](https://www.python.org/) and the current [Python virtual environment](https://docs.python.org/tutorial/venv.html) if one is activated. -如果`pyenv_version_name`被设置为`true`, 本组件将会展示pyenv版本名。 否则则显示通过`python --version`获得的版本号 +If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. By default the module will be shown if any of the following conditions are met: @@ -3068,15 +3208,15 @@ By default the module will be shown if any of the following conditions are met: | -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- | | `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | 组件格式化模板。 | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `'🐍 '` | 用于表示Python的格式化字符串。 | +| `symbol` | `'🐍 '` | A format string representing the symbol of Python | | `style` | `'yellow bold'` | 此组件的样式。 | -| `pyenv_version_name` | `false` | 使用 pyenv 获取 Python 版本 | +| `pyenv_version_name` | `false` | Use pyenv to get Python version | | `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `python_binary` | `['python', 'python3', 'python2']` | Configures the python binaries that Starship should executes when getting the version. | | `detect_extensions` | `['py']` | Which extensions should trigger this module | | `detect_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | -| `disabled` | `false` | 禁用 `python` 组件。 | +| `disabled` | `false` | Disables the `python` module. | ::: tip @@ -3090,11 +3230,11 @@ The default values and order for `python_binary` was chosen to first identify th | 字段 | 示例 | 描述 | | ------------ | --------------- | ------------------------------------------ | -| version | `'v3.8.1'` | `python`版本 | +| version | `'v3.8.1'` | The version of `python` | | symbol | `'🐍 '` | `symbol`对应值 | | style | `'yellow bold'` | `style`对应值 | | pyenv_prefix | `'pyenv '` | Mirrors the value of option `pyenv_prefix` | -| virtualenv | `'venv'` | 当前`virtualenv`名称 | +| virtualenv | `'venv'` | The current `virtualenv` name | ### 示例 @@ -3215,7 +3355,7 @@ format = 'via [🦪 $version]($style) ' ## Red -By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). 此组件将在符合以下任意条件时显示： +By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a file with `.red` or `.reds` extension @@ -3253,7 +3393,7 @@ symbol = '🔴 ' ## Ruby -By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). 此组件将在符合以下任意条件时显示： +By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). The module will be shown if any of the following conditions are met: - 当前目录包含 `Gemfile` 文件 - The current directory contains a `.ruby-version` file @@ -3274,7 +3414,7 @@ Starship gets the current Ruby version by running `ruby -v`. | `detect_folders` | `[]` | Which folders should trigger this module. | | `detect_variables` | `['RUBY_VERSION', 'RBENV_VERSION']` | Which environment variables should trigger this module. | | `style` | `'bold red'` | 此组件的样式。 | -| `disabled` | `false` | 禁用 `ruby` 组件。 | +| `disabled` | `false` | Disables the `ruby` module. | ### Variables @@ -3297,7 +3437,7 @@ symbol = '🔺 ' ## Rust -By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). 此组件将在符合以下任意条件时显示： +By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). The module will be shown if any of the following conditions are met: - 当前目录包含 `Cargo.toml` 文件 - 当前目录包含一个使用 `.rs` 扩展名的文件 @@ -3313,7 +3453,7 @@ By default the `rust` module shows the currently installed version of [Rust](htt | `detect_files` | `['Cargo.toml']` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `'bold red'` | 此组件的样式。 | -| `disabled` | `false` | 禁用 `rust` 组件。 | +| `disabled` | `false` | Disables the `rust` module. | ### Variables @@ -3382,7 +3522,7 @@ The `shell` module shows an indicator for currently used shell. ::: tip -此组件默认被禁用。 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -3410,7 +3550,7 @@ The `shell` module shows an indicator for currently used shell. | 字段 | 默认值 | 描述 | | --------- | --- | ---------------------------------------------------------- | | indicator | | Mirrors the value of `indicator` for currently used shell. | -| style\* | | `style`对应值. | +| style\* | | Mirrors the value of option `style`. | *: This variable can only be used as a part of a style string @@ -3534,7 +3674,7 @@ The `status` module displays the exit code of the previous command. If $success_ ::: tip -此组件默认被禁用。 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -3595,7 +3735,7 @@ The `sudo` module displays if sudo credentials are currently cached. The module ::: tip -此组件默认被禁用。 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -3640,7 +3780,7 @@ disabled = false ## Swift -By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). 此组件将在符合以下任意条件时显示： +By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `Package.swift` file - The current directory contains a file with the `.swift` extension @@ -3703,7 +3843,7 @@ By default the module will be shown if any of the following conditions are met: | `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_folders` | `['.terraform']` | Which folders should trigger this module. | | `style` | `'bold 105'` | 此组件的样式。 | -| `disabled` | `false` | 禁用 `terraform` 组件。 | +| `disabled` | `false` | Disables the `terraform` module. | ### Variables @@ -3738,25 +3878,25 @@ format = '[🏎💨 $workspace]($style) ' ## Time -`time` 组件显示当前的 **本地** 时间。 `format` 字段值会提供给 [`chrono`](https://crates.io/crates/chrono) crate 用来控制时间显示方式。 请参阅 [chrono strftime 文档](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) 以了解可用格式选项。 +The `time` module shows the current **local** time. The `format` configuration value is used by the [`chrono`](https://crates.io/crates/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) to see what options are available. ::: tip -此组件默认被禁用。 若要启用此组件，请在配置文件中设置 `disable` 字段为 `false`。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### 配置项 -| 选项 | 默认值 | 描述 | -| ----------------- | ----------------------- | ----------------------------------------------------------------------------------------------------- | -| `format` | `'at [$time]($style) '` | The format string for the module. | -| `use_12hr` | `false` | 启用 12 小时格式 | -| `time_format` | 见下文解释 | 用来格式化时间显示的 [chrono 格式字符串](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) | -| `style` | `'bold yellow'` | 显示时间的样式。 | -| `utc_time_offset` | `'local'` | 设置所用 UTC 偏移量。 Range from -24 < x < 24. 允许使用浮点数来得到 30/45 分钟的时区偏移。 | -| `disabled` | `true` | 禁用 `time` 组件。 | -| `time_range` | `'-'` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | +| 选项 | 默认值 | 描述 | +| ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | +| `format` | `'at [$time]($style) '` | The format string for the module. | +| `use_12hr` | `false` | Enables 12 hour formatting | +| `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. | +| `style` | `'bold yellow'` | The style for the module time | +| `utc_time_offset` | `'local'` | Sets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. | +| `disabled` | `true` | Disables the `time` module. | +| `time_range` | `'-'` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | If `use_12hr` is `true`, then `time_format` defaults to `'%r'`. Otherwise, it defaults to `'%T'`. Manually setting `time_format` will override the `use_12hr` setting. @@ -3784,7 +3924,7 @@ time_range = '10:00:00-14:00:00' ## Username -`username` 组件显示当前活跃的用户名。 此组件将在符合以下任意条件时显示： +The `username` module shows active user's username. The module will be shown if any of the following conditions are met: - The current user is root/admin - 当前用户与登录用户不相同 @@ -3802,10 +3942,10 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, ` | 选项 | 默认值 | 描述 | | ------------- | ----------------------- | ------------------------------------------- | | `style_root` | `'bold red'` | The style used when the user is root/admin. | -| `style_user` | `'bold yellow'` | 非 root 用户使用的样式。 | +| `style_user` | `'bold yellow'` | The style used for non-root users. | | `format` | `'[$user]($style) in '` | 组件格式化模板。 | -| `show_always` | `false` | 总是显示 `username` 组件。 | -| `disabled` | `false` | 禁用 `username` 组件。 | +| `show_always` | `false` | Always shows the `username` module. | +| `disabled` | `false` | Disables the `username` module. | ### Variables @@ -3935,7 +4075,7 @@ format = '[🆅 $repo](bold blue) ' ## Zig -By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). 此组件将在符合以下任意条件时显示： +By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `.zig` file @@ -4016,7 +4156,7 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt | `command` | `''` | The command whose output should be printed. The command will be passed on stdin to the shell. | | `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. | | `shell` | | [See below](#custom-command-shell) | -| `描述` | `''` | The description of the module that is shown when running `starship explain`. | +| `description` | `''` | The description of the module that is shown when running `starship explain`. | | `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_extensions` | `[]` | The extensions that will be searched in the working directory for a match. | diff --git a/docs/zh-CN/guide/README.md b/docs/zh-CN/guide/README.md index ab212ec4..3b80319b 100644 --- a/docs/zh-CN/guide/README.md +++ b/docs/zh-CN/guide/README.md @@ -9,7 +9,7 @@

GitHub Actions 工作流状态 @@ -423,6 +423,7 @@ eval "$(starship init zsh)" **支持者级别** - [Dimension](https://dimension.dev/) +- [Appwrite](https://appwrite.io/)


diff --git a/docs/zh-CN/migrating-to-0.45.0/README.md b/docs/zh-CN/migrating-to-0.45.0/README.md index 220d4566..e83c3343 100644 --- a/docs/zh-CN/migrating-to-0.45.0/README.md +++ b/docs/zh-CN/migrating-to-0.45.0/README.md @@ -85,7 +85,7 @@ format = "took [$duration]($style) " | `style_success` | `success_symbol` | | `style_failure` | `error_symbol` | -**Changes to the Default Configuration** +**更改默认配置** ```diff [character] @@ -117,7 +117,7 @@ _Note:_ The `character` element automatically adds a space after, so unlike the | ---------------- | ----------- | | `prefix` | `format` | -**Changes to the Default Configuration** +**更改默认配置** ```diff [cmd_duration] @@ -131,7 +131,7 @@ _Note:_ The `character` element automatically adds a space after, so unlike the | ---------------- | ----------- | | `prefix` | `format` | -**Changes to the Default Configuration** +**更改默认配置** ```diff [directory] @@ -146,7 +146,7 @@ _Note:_ The `character` element automatically adds a space after, so unlike the | `prefix` | `format` | | `suffix` | `format` | -**Changes to the Default Configuration** +**更改默认配置** ```diff [env_var] @@ -162,7 +162,7 @@ _Note:_ The `character` element automatically adds a space after, so unlike the | `prefix` | `format` | | `suffix` | `format` | -**Changes to the Default Configuration** +**更改默认配置** ```diff [git_commit] @@ -179,7 +179,7 @@ _Note:_ The `character` element automatically adds a space after, so unlike the | `suffix` | `format` | | `show_sync_count` | `format` | -**Changes to the Default Configuration** +**更改默认配置** ```diff [git_status] @@ -209,7 +209,7 @@ behind = "⇣${count}" | `prefix` | `format` | | `suffix` | `format` | -**Changes to the Default Configuration** +**更改默认配置** ```diff [hostname] @@ -226,7 +226,7 @@ behind = "⇣${count}" | `prefix` | `format` | | `suffix` | `format` | -**Changes to the Default Configuration** +**更改默认配置** ```diff [singularity] @@ -241,7 +241,7 @@ behind = "⇣${count}" | ---------------- | ------------- | | `format` | `time_format` | -**Changes to the Default Configuration** +**更改默认配置** ```diff [time] @@ -257,7 +257,7 @@ behind = "⇣${count}" | `prefix` | `format` | | `suffix` | `format` | -**Changes to the Default Configuration** +**更改默认配置** ```diff [custom.example] diff --git a/docs/zh-CN/presets/README.md b/docs/zh-CN/presets/README.md index f479c615..9be33b20 100644 --- a/docs/zh-CN/presets/README.md +++ b/docs/zh-CN/presets/README.md @@ -14,7 +14,11 @@ This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt. -::: tip This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). ::: +::: tip + +This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). + +::: [Click to view No Nerd Font preset](./no-nerd-font) diff --git a/docs/zh-TW/README.md b/docs/zh-TW/README.md index e93d3cdb..de50a99c 100644 --- a/docs/zh-TW/README.md +++ b/docs/zh-TW/README.md @@ -149,14 +149,14 @@ description: Starship 是適合任何 shell 的最小、極速、高度客製化 ::: warning - This will change in the future. Only Nushell v0.61+ is supported. + This will change in the future. Only Nushell v0.73+ is supported. ::: - Add the following to to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell): + Add the following to the end of your Nushell env file (find it by running `$nu.env-path` in Nushell): ```sh mkdir ~/.cache/starship - starship init nu | save ~/.cache/starship/init.nu + starship init nu | save -f ~/.cache/starship/init.nu ``` And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`): diff --git a/docs/zh-TW/advanced-config/README.md b/docs/zh-TW/advanced-config/README.md index 05a5913a..8ede7a25 100644 --- a/docs/zh-TW/advanced-config/README.md +++ b/docs/zh-TW/advanced-config/README.md @@ -207,8 +207,6 @@ Note: The right prompt is a single line following the input location. To right a `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd, nushell. -Note: Nushell 0.71.0 or later is required - ### 範例 ```toml @@ -231,7 +229,7 @@ Produces a prompt like the following: Some shells support a continuation prompt along with the normal prompt. This prompt is rendered instead of the normal prompt when the user has entered an incomplete statement (such as a single left parenthesis or quote). -Starship can set the continuation prompt using the `continuation_prompt` option. The default prompt is `"[∙](bright-black) "`. +Starship can set the continuation prompt using the `continuation_prompt` option. The default prompt is `'[∙](bright-black) '`. Note: `continuation_prompt` should be set to a literal string without any variables. @@ -247,7 +245,7 @@ Note: Continuation prompts are only available in the following shells: # ~/.config/starship.toml # A continuation prompt that displays two filled in arrows -continuation_prompt = "▶▶" +continuation_prompt = '▶▶ ' ``` ## 風格字串 diff --git a/docs/zh-TW/config/README.md b/docs/zh-TW/config/README.md index 5880a615..06da28ea 100644 --- a/docs/zh-TW/config/README.md +++ b/docs/zh-TW/config/README.md @@ -252,12 +252,14 @@ $singularity\ $kubernetes\ $directory\ $vcsh\ +$fossil_branch\ $git_branch\ $git_commit\ $git_state\ $git_metrics\ $git_status\ $hg_branch\ +$pijul_channel\ $docker_context\ $package\ $c\ @@ -270,6 +272,7 @@ $dotnet\ $elixir\ $elm\ $erlang\ +$fennel\ $golang\ $guix_shell\ $haskell\ @@ -278,6 +281,7 @@ $helm\ $java\ $julia\ $kotlin\ +$gradle\ $lua\ $nim\ $nodejs\ @@ -1305,6 +1309,12 @@ The `env_var` module displays the current value of a selected environment variab ::: tip +The order in which env_var modules are shown can be individually set by including `${env_var.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `env_var` module will simply show all env_var modules in the order they were defined. + +::: + +::: 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 @@ -1320,13 +1330,14 @@ default = 'unknown user' ### 選項 -| Option | 預設 | 說明 | -| ---------- | ------------------------------ | -------------------------- | -| `symbol` | `''` | 顯示在變數數值之前的符號。 | -| `variable` | | 要顯示的環境變數。 | -| `default` | | 在選擇的變數值沒有定義時，顯示的預設值。 | -| `format` | `'with [$env_value]($style) '` | The format for the module. | -| `disabled` | `false` | 停用 `env_var` 模組。 | +| Option | 預設 | 說明 | +| ------------- | ------------------------------ | ---------------------------------------------------------------------------- | +| `symbol` | `""` | 顯示在變數數值之前的符號。 | +| `variable` | | 要顯示的環境變數。 | +| `default` | | 在選擇的變數值沒有定義時，顯示的預設值。 | +| `format` | `"with [$env_value]($style) "` | The format for the module. | +| `description` | `""` | The description of the module that is shown when running `starship explain`. | +| `disabled` | `false` | 停用 `env_var` 模組。 | ### Variables @@ -1399,6 +1410,44 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https: format = 'via [e $version](bold red) ' ``` +## Fennel + +The `fennel` module shows the currently installed version of [Fennel](https://fennel-lang.org). By default the module will be shown if any of the following conditions are met: + +- The current directory contains a file with the `.fnl` extension + +### 選項 + +| Option | 預設 | 說明 | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `'via [$symbol($version )]($style)'` | The format for the module. | +| `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `'🧅 '` | The symbol used before displaying the version of fennel. | +| `style` | `'bold green'` | 這個模組的風格。 | +| `detect_extensions` | `[fnl]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `disabled` | `false` | Disables the `fennel` module. | + +### Variables + +| 變數 | 範例 | 說明 | +| --------- | -------- | ------------------------------------ | +| version | `v1.2.1` | The version of `fennel` | +| symbol | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | + +*: This variable can only be used as a part of a style string + +### 範例 + +```toml +# ~/.config/starship.toml + +[fennel] +symbol = '⫰ ' +``` + ## Fill The `fill` module fills any extra space on the line with a symbol. If multiple `fill` modules are present in a line they will split the space evenly between them. This is useful for aligning other modules. @@ -1428,6 +1477,42 @@ Produces a prompt that looks like: AA -------------------------------------------- BB -------------------------------------------- CC ``` +## Fossil Branch + +The `fossil_branch` module shows the name of the active branch of the check-out in your current directory. + +### 選項 + +| Option | 預設 | 說明 | +| ------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | +| `format` | `'on [$symbol$branch]($style) '` | The format for the module. Use `'$branch'` to refer to the current branch name. | +| `symbol` | `' '` | The symbol used before the branch name of the check-out in your current directory. | +| `style` | `'bold purple'` | 這個模組的風格。 | +| `truncation_length` | `2^63 - 1` | Truncates a Fossil branch name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. You can use `''` for no symbol. | +| `disabled` | `true` | Disables the `fossil_branch` module. | + +### Variables + +| 變數 | 範例 | 說明 | +| --------- | ------- | ------------------------------------ | +| branch | `trunk` | The active Fossil branch | +| symbol | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | + +*: This variable can only be used as a part of a style string + +### 範例 + +```toml +# ~/.config/starship.toml + +[fossil_branch] +symbol = '🦎 ' +truncation_length = 4 +truncation_symbol = '' +``` + ## Google Cloud (`gcloud`) The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var. @@ -1501,23 +1586,23 @@ format = 'on [$symbol$account(@$domain)(\($project\))]($style) ' very-long-project-name = 'vlpn' ``` -## Git 分支 +## Git Branch -`git_branch` 模組顯示現在的資料夾中使用中的儲存庫的分支。 +The `git_branch` module shows the active branch of the repo in your current directory. ### 選項 -| Option | 預設 | 說明 | -| -------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------ | -| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | -| `format` | `'on [$symbol$branch(:$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. | -| `style` | `'bold purple'` | 這個模組的風格。 | -| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | -| `truncation_symbol` | `'…'` | 用來指示分支名稱被縮減的符號。 You can use `''` for no symbol. | -| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | -| `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. | -| `disabled` | `false` | 停用 `git_branch` 模組。 | +| Option | 預設 | 說明 | +| -------------------- | ------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | +| `format` | `'on [$symbol$branch(:$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. | +| `style` | `'bold purple'` | 這個模組的風格。 | +| `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. | +| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | +| `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for 'master' or 'main'. | +| `disabled` | `false` | Disables the `git_branch` module. | ### Variables @@ -1562,10 +1647,11 @@ The `git_commit` module shows the current commit hash and also the tag (if any) ### Variables -| 變數 | 範例 | 說明 | -| --------- | --------- | ----------------------------------- | -| hash | `b703eb3` | The current git commit hash | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | --------- | -------------------------------------------- | +| hash | `b703eb3` | The current git commit hash | +| tag | `v1.0.0` | The tag name if showing tag info is enabled. | +| style\* | | Mirrors the value of option `style` | *: This variable can only be used as a part of a style string @@ -1581,7 +1667,7 @@ tag_symbol = '🔖 ' ## Git State -`git_state` 模組會顯示在 git 儲存庫中的資料夾內，以及會在有作業正在進行時顯示，像是：_REBASING_、_BISECTING_ 等等。 如果有進展的資訊 (像是 REBASING 3/10)，也會一併顯示出來。 +The `git_state` module will show in directories which are part of a git repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. If there is progress information (e.g., REBASING 3/10), that information will be shown too. ### 選項 @@ -1596,7 +1682,7 @@ tag_symbol = '🔖 ' | `am_or_rebase` | `'AM/REBASE'` | A format string displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. | | `style` | `'bold yellow'` | 這個模組的風格。 | | `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | The format for the module. | -| `disabled` | `false` | 停用 `git_state` 模組。 | +| `disabled` | `false` | Disables the `git_state` module. | ### Variables @@ -1625,7 +1711,7 @@ The `git_metrics` module will show the number of added and deleted lines in the ::: tip -這個模組預設是停用的。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -1662,7 +1748,7 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) ' ## Git Status -`git_status` 模組顯示用來表示現在資料夾之中儲存庫狀態的符號。 +The `git_status` module shows symbols representing the state of the repo in your current directory. ::: tip @@ -1675,7 +1761,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` | -| `conflicted` | `'='` | 這個分支有合併衝突。 | +| `conflicted` | `'='` | This branch has merge conflicts. | | `ahead` | `'⇡'` | The format of `ahead` | | `behind` | `'⇣'` | The format of `behind` | | `diverged` | `'⇕'` | The format of `diverged` | @@ -1688,7 +1774,7 @@ The Git Status module is very slow in Windows directories (for example under `/m | `deleted` | `'✘'` | The format of `deleted` | | `style` | `'bold red'` | 這個模組的風格。 | | `ignore_submodules` | `false` | Ignore changes to submodules. | -| `disabled` | `false` | 停用 `git_status` 模組。 | +| `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. | ### Variables @@ -1787,7 +1873,7 @@ The `golang` module shows the currently installed version of [Go](https://golang | `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. | | `style` | `'bold cyan'` | 這個模組的風格。 | -| `disabled` | `false` | 停用 `golang` 模組。 | +| `disabled` | `false` | Disables the `golang` module. | ### Variables @@ -1840,6 +1926,41 @@ disabled = true format = 'via [🐂](yellow bold) ' ``` +## Gradle + +The `gradle` module shows the version of the [Gradle Wrapper](https://docs.gradle.org/current/userguide/gradle_wrapper.html) currently used in the project directory. + +By default the module will be shown if any of the following conditions are met: + +- The current directory contains a `gradle/wrapper/gradle-wrapper.properties` directory. +- The current directory contains a file ending with `.gradle` or `.gradle.kts`. + +The `gradle` module is only able to read your Gradle Wrapper version from your config file, we don't execute your wrapper, because of the security concerns. + +### 選項 + +| Option | 預設 | 說明 | +| ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"🅶 "` | A format string representing the symbol of Gradle. | +| `detect_extensions` | `["gradle", "gradle.kts"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `["gradle"]` | Which folders should trigger this module. | +| `style` | `"bold bright-cyan"` | 這個模組的風格。 | +| `disabled` | `false` | Disables the `gradle` module. | +| `recursive` | `false` | Enables recursive finding for the `gradle` directory. | + +### Variables + +| 變數 | 範例 | 說明 | +| ------- | -------- | ------------------------------------ | +| version | `v7.5.1` | The version of `gradle` | +| 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 + ## Haskell The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot. @@ -1954,24 +2075,24 @@ format = 'via [⎈ $version](bold white) ' ## 主機名稱 -`hostname` 模組顯示系統的主機名稱。 +The `hostname` module shows the system hostname. ### 選項 -| Option | 預設 | 說明 | -| ------------ | -------------------------------------- | ------------------------------------------------------------------------------------------- | -| `ssh_only` | `true` | 只在連接到一個 SSH session 時顯示主機名稱。 | -| `ssh_symbol` | `'🌐 '` | A format string representing the symbol when connected to SSH session. | -| `trim_at` | `'.'` | 擷取出主機名稱的斷點，以第一個符合的為準。 `'.'` will stop after the first dot. `''` will disable any truncation | -| `format` | `'[$ssh_symbol$hostname]($style) in '` | The format for the module. | -| `style` | `'bold dimmed green'` | 這個模組的風格。 | -| `disabled` | `false` | 停用 `hostname` 模組。 | +| Option | 預設 | 說明 | +| ------------ | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | +| `ssh_only` | `true` | Only show hostname when connected to an SSH session. | +| `ssh_symbol` | `'🌐 '` | A format string representing the symbol when connected to SSH session. | +| `trim_at` | `'.'` | String that the hostname is cut off at, after the first match. `'.'` will stop after the first dot. `''` will disable any truncation | +| `format` | `'[$ssh_symbol$hostname]($style) in '` | The format for the module. | +| `style` | `'bold dimmed green'` | 這個模組的風格。 | +| `disabled` | `false` | Disables the `hostname` module. | ### Variables | 變數 | 範例 | 說明 | | ---------- | ---------- | ----------------------------------------------------- | -| 主機名稱 | `computer` | The hostname of the computer | +| hostname | `computer` | The hostname of the computer | | style\* | | Mirrors the value of option `style` | | ssh_symbol | `'🌏 '` | The symbol to represent when connected to SSH session | @@ -2007,7 +2128,7 @@ The `java` module shows the currently installed version of [Java](https://www.or | `detect_folders` | `[]` | Which folders should trigger this modules. | | `symbol` | `'☕ '` | A format string representing the symbol of Java | | `style` | `'red dimmed'` | 這個模組的風格。 | -| `disabled` | `false` | 停用 `java` 模組。 | +| `disabled` | `false` | Disables the `java` module. | ### Variables @@ -2028,9 +2149,9 @@ The `java` module shows the currently installed version of [Java](https://www.or symbol = '🌟 ' ``` -## 工作 +## Jobs -`jobs` 模組顯示現在正在執行中的工作。 這個模組只會在有背景工作正在執行時顯示。 The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to _always_ show the symbol and number of jobs, even if there are 0 jobs running. +The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to _always_ show the symbol and number of jobs, even if there are 0 jobs running. The default functionality is: @@ -2054,13 +2175,13 @@ The `threshold` option is deprecated, but if you want to use it, the module will | Option | 預設 | 說明 | | ------------------ | ----------------------------- | ------------------------------------------------------------------------ | -| `threshold`* | `1` | 在超過指定值時顯示工作數量。 | +| `threshold`* | `1` | Show number of jobs if exceeded. | | `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_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. | | `symbol` | `'✦'` | The string used to represent the `symbol` variable. | | `style` | `'bold blue'` | 這個模組的風格。 | -| `disabled` | `false` | 停用 `jobs` 模組。 | +| `disabled` | `false` | Disables the `jobs` module. | *: This option is deprecated, please use the `number_threshold` and `symbol_threshold` options instead. @@ -2178,7 +2299,7 @@ Displays the current [Kubernetes context](https://kubernetes.io/docs/concepts/co ::: tip -這個模組預設是停用的。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. When the module is enabled it will always be active, unless any of `detect_extensions`, `detect_files` or `detect_folders` have been set in which case the module will only be active in directories that match those conditions. @@ -2259,15 +2380,15 @@ Long and automatically generated cluster names can be identified and shortened u 'gke_.*_(?P[\\w-]+)' = 'gke-$var_cluster' ``` -## 換行 +## Line Break -`line_break` 模組將提示字元分成兩行。 +The `line_break` module separates the prompt into two lines. ### 選項 -| Option | 預設 | 說明 | -| ---------- | ------- | ----------------------------- | -| `disabled` | `false` | 停用 `line_break` 模組，讓提示字元變成一行。 | +| Option | 預設 | 說明 | +| ---------- | ------- | ------------------------------------------------------------------ | +| `disabled` | `false` | Disables the `line_break` module, making the prompt a single line. | ### 範例 @@ -2352,27 +2473,27 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o format = 'via [🌕 $version](bold blue) ' ``` -## 記憶體使用量 +## Memory Usage -`memory_usage` 模組顯示現在系統記憶體與 swap 的使用量。 +The `memory_usage` module shows current system memory and swap usage. -預設 swap 使用量會在系統總 swap 使用量不為 0 時顯示出來。 +By default the swap usage is displayed if the total system swap is non-zero. ::: tip -這個模組預設是停用的。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### 選項 -| Option | 預設 | 說明 | -| ----------- | ----------------------------------------------- | -------------------------- | -| `threshold` | `75` | 將記憶體使用量隱藏，除非使用量超過指定值。 | -| `format` | `'via $symbol [${ram}( \| ${swap})]($style) '` | The format for the module. | -| `symbol` | `'🐏'` | 顯示在記憶體使用量之前的符號。 | -| `style` | `'bold dimmed white'` | 這個模組的風格。 | -| `disabled` | `true` | 停用 `memory_usage` 模組。 | +| Option | 預設 | 說明 | +| ----------- | ----------------------------------------------- | -------------------------------------------------------- | +| `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. | +| `format` | `'via $symbol [${ram}( \| ${swap})]($style) '` | The format for the module. | +| `symbol` | `'🐏'` | The symbol used before displaying the memory usage. | +| `style` | `'bold dimmed white'` | 這個模組的風格。 | +| `disabled` | `true` | Disables the `memory_usage` module. | ### Variables @@ -2440,26 +2561,27 @@ style = 'bold dimmed green' ## Mercurial Branch -The `hg_branch` module shows the active branch of the repo in your current directory. +The `hg_branch` module shows the active branch and topic of the repo in your current directory. ### 選項 -| Option | 預設 | 說明 | -| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------- | -| `symbol` | `' '` | The symbol used before the hg bookmark or branch name of the repo in your current directory. | -| `style` | `'bold purple'` | 這個模組的風格。 | -| `format` | `'on [$symbol$branch]($style) '` | The format for the module. | -| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to `N` graphemes | -| `truncation_symbol` | `'…'` | 用來指示分支名稱被縮減的符號。 | -| `disabled` | `true` | Disables the `hg_branch` module. | +| Option | 預設 | 說明 | +| ------------------- | ----------------------------------------- | -------------------------------------------------------------------------------------------- | +| `symbol` | `' '` | The symbol used before the hg bookmark or branch name of the repo in your current directory. | +| `style` | `'bold purple'` | 這個模組的風格。 | +| `format` | `'on [$symbol$branch(:$topic)]($style) '` | The format for the module. | +| `truncation_length` | `2^63 - 1` | Truncates the hg branch / topic name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. | +| `disabled` | `true` | Disables the `hg_branch` module. | ### Variables -| 變數 | 範例 | 說明 | -| --------- | -------- | ------------------------------------ | -| branch | `master` | The active mercurial branch | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| 變數 | 範例 | 說明 | +| --------- | --------- | ------------------------------------ | +| branch | `master` | The active mercurial branch | +| topic | `feature` | The active mercurial topic | +| 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 @@ -2518,18 +2640,20 @@ symbol = '🎣 ' ## Nix-shell -The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html) environment. 這個模組會在 nix-shell 環境中顯示。 +The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html) environment. The module will be shown when inside a nix-shell environment. ### 選項 -| Option | 預設 | 說明 | -| ------------ | ---------------------------------------------- | ----------------------------------------------------- | -| `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. | -| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | -| `style` | `'bold blue'` | 這個模組的風格。 | -| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | -| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | -| `disabled` | `false` | 停用 `nix_shell` 模組。 | +| Option | 預設 | 說明 | +| ------------- | ---------------------------------------------- | --------------------------------------------------------------------- | +| `format` | `'via [$symbol$state( \($name\))]($style) '` | The format for the module. | +| `symbol` | `'❄️ '` | A format string representing the symbol of nix-shell. | +| `style` | `'bold blue'` | 這個模組的風格。 | +| `impure_msg` | `'impure'` | A format string shown when the shell is impure. | +| `pure_msg` | `'pure'` | A format string shown when the shell is pure. | +| `unknown_msg` | `''` | A format string shown when it is unknown if the shell is pure/impure. | +| `disabled` | `false` | Disables the `nix_shell` module. | +| `heuristic` | `false` | Attempts to detect new `nix shell`-style shells with a heuristic. | ### Variables @@ -2551,6 +2675,7 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/ disabled = true impure_msg = '[impure shell](bold red)' pure_msg = '[pure shell](bold green)' +unknown_msg = '[unknown shell](bold yellow)' format = 'via [☃️ $state( \($name\))](bold blue) ' ``` @@ -2576,7 +2701,7 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n | `detect_files` | `['package.json', '.node-version']` | Which filenames should trigger this module. | | `detect_folders` | `['node_modules']` | Which folders should trigger this module. | | `style` | `'bold green'` | 這個模組的風格。 | -| `disabled` | `false` | 停用 `nodejs` 模組。 | +| `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. | ### Variables @@ -2728,7 +2853,7 @@ The [os_info](https://lib.rs/crates/os_info) crate used by this module is known ::: tip -這個模組預設是停用的。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -2813,9 +2938,9 @@ Windows = " " Arch = "Arch is the best! " ``` -## 套件版本 +## Package Version -The `package` 模組在現在資料夾是一個套件的儲藏庫時出現，並顯示他的現在版本。 The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages. +The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `python`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards`, `daml` and `dart` packages. - [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory - [**Cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory @@ -2842,11 +2967,11 @@ The `package` 模組在現在資料夾是一個套件的儲藏庫時出現，並 | Option | 預設 | 說明 | | ----------------- | --------------------------------- | ------------------------------------------------------------------------- | | `format` | `'is [$symbol$version]($style) '` | The format for the module. | -| `symbol` | `'📦 '` | 顯示在套件的版本之前的符號。 | +| `symbol` | `'📦 '` | The symbol used before displaying the version the package. | | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `style` | `'bold 208'` | 這個模組的風格。 | | `display_private` | `false` | Enable displaying version for packages marked as private. | -| `disabled` | `false` | 停用 `package` 模組。 | +| `disabled` | `false` | Disables the `package` module. | ### Variables @@ -2911,7 +3036,7 @@ format = 'via [🦪 $version]($style) ' The `php` module shows the currently installed version of [PHP](https://www.php.net/). By default the module will be shown if any of the following conditions are met: -- The current directory contains a `composer.json` file +- 目前資料夾中有一個 `composer.json` 檔案 - The current directory contains a `.php-version` file - The current directory contains a `.php` extension @@ -2947,6 +3072,21 @@ The `php` module shows the currently installed version of [PHP](https://www.php. format = 'via [🔹 $version](147 bold) ' ``` +## Pijul Channel + +The `pijul_channel` module shows the active channel of the repo in your current directory. + +### 選項 + +| Option | 預設 | 說明 | +| ------------------- | --------------------------------- | ------------------------------------------------------------------------------------ | +| `symbol` | `' '` | The symbol used before the pijul channel name of the repo in your current directory. | +| `style` | `'bold purple'` | 這個模組的風格。 | +| `format` | `'on [$symbol$channel]($style) '` | The format for the module. | +| `truncation_length` | `2^63 - 1` | Truncates the pijul channel name to `N` graphemes | +| `truncation_symbol` | `'…'` | The symbol used to indicate a branch name was truncated. | +| `disabled` | `true` | Disables the `pijul` module. | + ## Pulumi The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. @@ -2979,7 +3119,7 @@ By default the module will be shown if any of the following conditions are met: | --------- | ---------- | ------------------------------------ | | version | `v0.12.24` | The version of `pulumi` | | stack | `dev` | The current Pulumi stack | -| 使用者名稱 | `alice` | The current Pulumi username | +| username | `alice` | The current Pulumi username | | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | @@ -3070,13 +3210,13 @@ By default the module will be shown if any of the following conditions are met: | `version_format` | `'v${raw}'` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `symbol` | `'🐍 '` | A format string representing the symbol of Python | | `style` | `'yellow bold'` | 這個模組的風格。 | -| `pyenv_version_name` | `false` | 使用 pyenv 取得 Python 的版本。 | +| `pyenv_version_name` | `false` | Use pyenv to get Python version | | `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `python_binary` | `['python', 'python3', 'python2']` | Configures the python binaries that Starship should executes when getting the version. | | `detect_extensions` | `['py']` | Which extensions should trigger this module | | `detect_files` | `['.python-version', 'Pipfile', '__init__.py', 'pyproject.toml', 'requirements.txt', 'setup.py', 'tox.ini']` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | -| `disabled` | `false` | 停用 `python` 模組。 | +| `disabled` | `false` | Disables the `python` module. | ::: tip @@ -3215,7 +3355,7 @@ format = 'via [🦪 $version]($style) ' ## Red -By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). 這個模組將在下列其中一個條件滿足時顯示： +By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a file with `.red` or `.reds` extension @@ -3253,7 +3393,7 @@ symbol = '🔴 ' ## Ruby -By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). 這個模組將在下列其中一個條件滿足時顯示： +By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). The module will be shown if any of the following conditions are met: - 目前資料夾中有一個 `Gemfile` 檔案 - The current directory contains a `.ruby-version` file @@ -3274,7 +3414,7 @@ Starship gets the current Ruby version by running `ruby -v`. | `detect_folders` | `[]` | Which folders should trigger this module. | | `detect_variables` | `['RUBY_VERSION', 'RBENV_VERSION']` | Which environment variables should trigger this module. | | `style` | `'bold red'` | 這個模組的風格。 | -| `disabled` | `false` | 停用 `ruby` 模組。 | +| `disabled` | `false` | Disables the `ruby` module. | ### Variables @@ -3297,7 +3437,7 @@ symbol = '🔺 ' ## Rust -By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). 這個模組將在下列其中一個條件滿足時顯示： +By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). The module will be shown if any of the following conditions are met: - 目前資料夾中有一個 `Cargo.toml` 檔案 - 現在資料夾中包含一個檔案具有 `.rs` 副檔名 @@ -3313,7 +3453,7 @@ By default the `rust` module shows the currently installed version of [Rust](htt | `detect_files` | `['Cargo.toml']` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `'bold red'` | 這個模組的風格。 | -| `disabled` | `false` | 停用 `rust` 模組。 | +| `disabled` | `false` | Disables the `rust` module. | ### Variables @@ -3382,7 +3522,7 @@ The `shell` module shows an indicator for currently used shell. ::: tip -這個模組預設是停用的。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -3534,7 +3674,7 @@ The `status` module displays the exit code of the previous command. If $success_ ::: tip -這個模組預設是停用的。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -3595,7 +3735,7 @@ The `sudo` module displays if sudo credentials are currently cached. The module ::: tip -這個模組預設是停用的。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -3640,7 +3780,7 @@ disabled = false ## Swift -By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). 這個模組將在下列其中一個條件滿足時顯示： +By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `Package.swift` file - The current directory contains a file with the `.swift` extension @@ -3738,25 +3878,25 @@ format = '[🏎💨 $workspace]($style) ' ## 時間 -`time` 模組顯示目前的**當地**時間. `format` 設定值被 [`chrono`](https://crates.io/crates/chrono) crate 用來控制時間如何顯示。 請看 [chrono 的 strftime 文件](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html)來了解有那些選項可以使用。 +The `time` module shows the current **local** time. The `format` configuration value is used by the [`chrono`](https://crates.io/crates/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) to see what options are available. ::: tip -這個模組預設是停用的。 想要啟用它的話，請在設定檔中將 `disabled` 設定為 `false`。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### 選項 -| Option | 預設 | 說明 | -| ----------------- | ----------------------- | ----------------------------------------------------------------------------------------------------- | -| `format` | `'at [$time]($style) '` | The format string for the module. | -| `use_12hr` | `false` | 啟用 12 小時格式。 | -| `time_format` | 請看下列 | 用來顯示時間的 [chrono 格式字串](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html)。 | -| `style` | `'bold yellow'` | 這個模組的時間的風格。 | -| `utc_time_offset` | `'local'` | 設定相對於 UTC 的時差。 Range from -24 < x < 24. 允許使用浮點數來表示 30/45 分鐘時差的時區。 | -| `disabled` | `true` | 停用 `time` 模組。 | -| `time_range` | `'-'` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | +| Option | 預設 | 說明 | +| ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | +| `format` | `'at [$time]($style) '` | The format string for the module. | +| `use_12hr` | `false` | Enables 12 hour formatting | +| `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. | +| `style` | `'bold yellow'` | The style for the module time | +| `utc_time_offset` | `'local'` | Sets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. | +| `disabled` | `true` | Disables the `time` module. | +| `time_range` | `'-'` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | If `use_12hr` is `true`, then `time_format` defaults to `'%r'`. Otherwise, it defaults to `'%T'`. Manually setting `time_format` will override the `use_12hr` setting. @@ -3764,7 +3904,7 @@ If `use_12hr` is `true`, then `time_format` defaults to `'%r'`. Otherwise, it de | 變數 | 範例 | 說明 | | --------- | ---------- | ----------------------------------- | -| 時間 | `13:08:10` | The current time. | +| time | `13:08:10` | The current time. | | style\* | | Mirrors the value of option `style` | *: This variable can only be used as a part of a style string @@ -3782,9 +3922,9 @@ utc_time_offset = '-5' time_range = '10:00:00-14:00:00' ``` -## 使用者名稱 +## Username -`username` 模組顯示現在使用中的使用者名稱。 這個模組將在下列其中一個條件滿足時顯示： +The `username` module shows active user's username. The module will be shown if any of the following conditions are met: - The current user is root/admin - 目前使用者並非登入時的使用者 @@ -3802,10 +3942,10 @@ 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_user` | `'bold yellow'` | 非 root 使用者時使用的風格。 | +| `style_user` | `'bold yellow'` | The style used for non-root users. | | `format` | `'[$user]($style) in '` | The format for the module. | -| `show_always` | `false` | 總是顯示 `username` 模組。 | -| `disabled` | `false` | 停用 `username` 模組。 | +| `show_always` | `false` | Always shows the `username` module. | +| `disabled` | `false` | Disables the `username` module. | ### Variables @@ -3935,7 +4075,7 @@ format = '[🆅 $repo](bold blue) ' ## Zig -By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). 這個模組將在下列其中一個條件滿足時顯示： +By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). The module will be shown if any of the following conditions are met: - The current directory contains a `.zig` file @@ -4016,7 +4156,7 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt | `command` | `''` | The command whose output should be printed. The command will be passed on stdin to the shell. | | `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. | | `shell` | | [See below](#custom-command-shell) | -| `說明` | `''` | The description of the module that is shown when running `starship explain`. | +| `description` | `''` | The description of the module that is shown when running `starship explain`. | | `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_extensions` | `[]` | The extensions that will be searched in the working directory for a match. | diff --git a/docs/zh-TW/guide/README.md b/docs/zh-TW/guide/README.md index d93105cd..1bffb1d7 100644 --- a/docs/zh-TW/guide/README.md +++ b/docs/zh-TW/guide/README.md @@ -9,7 +9,7 @@

GitHub Actions workflow status @@ -423,6 +423,7 @@ Support this project by [becoming a sponsor](https://github.com/sponsors/starshi **Supporter Tier** - [Dimension](https://dimension.dev/) +- [Appwrite](https://appwrite.io/)


diff --git a/docs/zh-TW/presets/README.md b/docs/zh-TW/presets/README.md index 35413ed1..7bc035a3 100644 --- a/docs/zh-TW/presets/README.md +++ b/docs/zh-TW/presets/README.md @@ -14,7 +14,11 @@ This preset changes the symbols for each module to use Nerd Font symbols. This preset changes the symbols for several modules so that no Nerd Font symbols are used anywhere in the prompt. -::: tip This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). ::: +::: tip + +This preset will become the default preset [in a future release of starship](https://github.com/starship/starship/pull/3544). + +::: [Click to view No Nerd Font preset](./no-nerd-font)