diff --git a/docs/ar-SA/README.md b/docs/ar-SA/README.md index 9091f2c9..332f46bc 100644 --- a/docs/ar-SA/README.md +++ b/docs/ar-SA/README.md @@ -120,7 +120,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p #### Elvish - ::: warning يدعم فقط elvish v0.17 أو أعلى. ::: + ::: warning يدعم فقط elvish v0.18 أو أعلى. ::: أضف ما يلي إلى نهاية `~/.elvish/rc.elv`: diff --git a/docs/ar-SA/advanced-config/README.md b/docs/ar-SA/advanced-config/README.md index 9ba38747..c4c9f7fd 100644 --- a/docs/ar-SA/advanced-config/README.md +++ b/docs/ar-SA/advanced-config/README.md @@ -131,7 +131,7 @@ Invoke-Expression (&starship init powershell) Some shells support a right prompt which renders on the same line as the input. Starship can set the content of the right prompt using the `right_format` option. Any module that can be used in `format` is also supported in `right_format`. The `$all` variable will only contain modules not explicitly used in either `format` or `right_format`. -Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [fill module](/config/#fill). +Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [`fill` module](/config/#fill). `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd. diff --git a/docs/ar-SA/config/README.md b/docs/ar-SA/config/README.md index 4204ae37..8bcf47c8 100644 --- a/docs/ar-SA/config/README.md +++ b/docs/ar-SA/config/README.md @@ -9,6 +9,9 @@ mkdir -p ~/.config && touch ~/.config/starship.toml All configuration for starship is done in this [TOML](https://github.com/toml-lang/toml) file: ```toml +# Get editor completions based on the config schema +"$schema" = 'https://starship.rs/config-schema.json' + # Inserts a blank line between shell prompts add_newline = true @@ -199,6 +202,7 @@ $hg_branch\ $docker_context\ $package\ $buf\ +$c\ $cmake\ $cobol\ $container\ @@ -235,6 +239,7 @@ $vagrant\ $zig\ $nix_shell\ $conda\ +$spack\ $memory_usage\ $aws\ $gcloud\ @@ -263,9 +268,9 @@ format = "$all$directory$character" ## AWS -The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file. This module also shows an expiration timer when using temporary credentials. +The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. Alternatively, you can force this module to show the region and profile even when the credentials have not been setup with the `force_display` option. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file. This module also shows an expiration timer when using temporary credentials. -The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. +The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if the conditions above are not respected. When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var. @@ -275,15 +280,16 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL ### Options -| Option | الافتراضي | الوصف | -| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------- | -| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | The format for the module. | -| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. | -| `region_aliases` | | Table of region aliases to display in addition to the AWS name. | -| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | -| `style` | `"bold yellow"` | The style for the module. | -| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. | -| `disabled` | `false` | Disables the `AWS` module. | +| Option | الافتراضي | الوصف | +| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | +| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | The format for the module. | +| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. | +| `region_aliases` | | Table of region aliases to display in addition to the AWS name. | +| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | +| `style` | `"bold yellow"` | The style for the module. | +| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. | +| `disabled` | `false` | Disables the `AWS` module. | +| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. | ### Variables @@ -472,6 +478,52 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil symbol = "🦬 " ``` +## C + +The `c` module shows some information about your C compiler. By default the module will be shown if the current directory contains a `.c` or `.h` file. + +### Options + +| Option | الافتراضي | الوصف | +| ------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version(-$name) )]($style)"` | The format string for the module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"C "` | The symbol used before displaying the compiler details | +| `detect_extensions` | `["c", "h"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `commands` | [ [ "cc", "--version" ], [ "gcc", "--version" ], [ "clang", "--version" ] ] | How to detect what the compiler is | +| `style` | `"bold 149"` | The style for the module. | +| `disabled` | `false` | Disables the `c` module. | + +### Variables + +| Variable | مثال | الوصف | +| -------- | ------ | ------------------------------------ | +| name | clang | The name of the compiler | +| version | 13.0.0 | The version of the compiler | +| symbol | | Mirrors the value of option `symbol` | +| style | | Mirrors the value of option `style` | + +NB that `version` is not in the default format. + +### Commands + +The `commands` option accepts a list of commands to determine the compiler version and name. + +Each command is represented as a list of the executable name, followed by its arguments, usually something like `["mycc", "--version"]`. Starship will try executing each command until it gets a result on STDOUT. + +If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). + +### مثال + +```toml +# ~/.config/starship.toml + +[c] +format = "via [$name $version]($style)" +``` + ## Character The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. @@ -962,7 +1014,7 @@ You'll also need the .NET Core SDK installed in order to use it correctly. Internally, this module uses its own mechanism for version detection. Typically it is twice as fast as running `dotnet --version`, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting `heuristic = false` in the module options. -The module will also show the Target Framework Moniker () when there is a csproj file in the current directory. +The module will also show the Target Framework Moniker () when there is a `.csproj` file in the current directory. ### Options @@ -1103,13 +1155,13 @@ default = "unknown user" ### Options -| Option | الافتراضي | الوصف | -| ---------- | ------------------------------ | ---------------------------------------------------------------------------- | -| `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 | الافتراضي | الوصف | +| ----------- | ------------------------------ | ---------------------------------------------------------------------------- | +| `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. | ### Variables @@ -1234,7 +1286,7 @@ The `gcloud` module shows the current configuration for [`gcloud`](https://cloud | 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` | +| active | `الافتراضي` | The active config name written in `~/.config/gcloud/active_config` | | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | @@ -2969,6 +3021,39 @@ The `singularity` module shows the current [Singularity](https://sylabs.io/singu format = '[📦 \[$env\]]($style) ' ``` +## Spack + +The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set. + +### Options + +| Option | الافتراضي | الوصف | +| ------------------- | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | +| `truncation_length` | `1` | The number of directories the environment path should be truncated to. `0` means no truncation. Also see the [`directory`](#directory) module. | +| `symbol` | `"🅢 "` | The symbol used before the environment name. | +| `style` | `"bold blue"` | The style for the module. | +| `format` | `"via [$symbol$environment]($style) "` | The format for the module. | +| `disabled` | `false` | Disables the `spack` module. | + +### Variables + +| Variable | مثال | الوصف | +| ----------- | ------------ | ------------------------------------ | +| environment | `astronauts` | The current spack environment | +| 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 + +[spack] +format = "[$symbol$environment](dimmed blue) " +``` + ## Status 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. @@ -3147,12 +3232,12 @@ By default the module will be shown if any of the following conditions are met: ### Variables -| Variable | مثال | الوصف | -| --------- | ---------- | ------------------------------------ | -| version | `v0.12.24` | The version of `terraform` | -| workspace | `default` | The current Terraform workspace | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| Variable | مثال | الوصف | +| --------- | ----------- | ------------------------------------ | +| version | `v0.12.24` | The version of `terraform` | +| workspace | `الافتراضي` | The current Terraform workspace | +| 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 @@ -3226,7 +3311,7 @@ time_range = "10:00:00-14:00:00" 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 +- The current user is root/admin - The current user isn't the same as the one that is logged in - The user is currently connected as an SSH session - The variable `show_always` is set to true @@ -3239,13 +3324,13 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, ` ### Options -| Option | الافتراضي | الوصف | -| ------------- | ----------------------- | ------------------------------------- | -| `style_root` | `"bold red"` | The style used when the user is root. | -| `style_user` | `"bold yellow"` | The style used for non-root users. | -| `format` | `"[$user]($style) in "` | The format for the module. | -| `show_always` | `false` | Always shows the `username` module. | -| `disabled` | `false` | Disables the `username` module. | +| Option | الافتراضي | الوصف | +| ------------- | ----------------------- | ------------------------------------------- | +| `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 "` | The format for the module. | +| `show_always` | `false` | Always shows the `username` module. | +| `disabled` | `false` | Disables the `username` module. | ### Variables @@ -3417,9 +3502,9 @@ The `custom` modules show the output of some arbitrary commands. These modules will be shown if any of the following conditions are met: -- The current directory contains a file whose name is in `files` -- The current directory contains a directory whose name is in `directories` -- The current directory contains a file whose extension is in `extensions` +- The current directory contains a file whose name is in `detect_files` +- The current directory contains a directory whose name is in `detect_folders` +- The current directory contains a file whose extension is in `detect_extensions` - The `when` command returns 0 - The current Operating System (std::env::consts::OS) matchs with `os` field if defined. @@ -3451,20 +3536,22 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt ### Options -| Option | الافتراضي | الوصف | -| ------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `command` | `""` | The command whose output should be printed. The command will be passed on stdin to the shell. | -| `when` | | A shell command used as a condition to show the module. 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`. | -| `files` | `[]` | The files that will be searched in the working directory for a match. | -| `directories` | `[]` | The directories that will be searched in the working directory for a match. | -| `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"` | The style for the module. | -| `format` | `"[$symbol($output )]($style)"` | The format for the module. | -| `disabled` | `false` | Disables this `custom` module. | -| `os` | | Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) [See possible values](https://doc.rust-lang.org/std/env/consts/constant.OS.html). | +| Option | الافتراضي | الوصف | +| ------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `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`. | +| `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"` | The style for the module. | +| `format` | `"[$symbol($output )]($style)"` | The format for the module. | +| `disabled` | `false` | Disables this `custom` module. | +| `os` | | Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) [See possible values](https://doc.rust-lang.org/std/env/consts/constant.OS.html). | +| `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 @@ -3487,7 +3574,7 @@ If unset, it will fallback to STARSHIP_SHELL and then to "sh" on Linux, and "cmd The `command` will be passed in on stdin. -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 -`. This behavior can be avoided by explicitly passing arguments to the shell, e.g. +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", "-"] @@ -3512,12 +3599,18 @@ Automatic detection of shells and proper parameters addition are currently imple [custom.foo] command = "echo foo" # shows output of command -files = ["foo"] # can specify filters but wildcards are not supported +detect_files = ["foo"] # can specify filters but wildcards are not supported when = """ test "$HOME" == "$PWD" """ format = " transcending [$output]($style)" [custom.time] command = "time /T" -extensions = ["pst"] # filters *.pst files +detect_extensions = ["pst"] # filters *.pst files shell = ["pwsh.exe", "-NoProfile", "-Command", "-"] + +[custom.time-as-arg] +command = "time /T" +detect_extensions = ["pst"] # filters *.pst files +shell = ["pwsh.exe", "-NoProfile", "-Command"] +use_stdin = false ``` diff --git a/docs/ar-SA/guide/README.md b/docs/ar-SA/guide/README.md index 3b1c8969..b4ae0d3b 100644 --- a/docs/ar-SA/guide/README.md +++ b/docs/ar-SA/guide/README.md @@ -160,7 +160,7 @@ - **سهل:** سريع التثبيت – استخدمه في دقائق.

-Explore the Starship docs  ▶ +تصفّح مستندات Starship  ▶

@@ -297,7 +297,7 @@ load(io.popen('starship init cmd'):read("*a"))() eval (starship init elvish) ``` -Note: Only Elvish v0.17+ is supported +Note: Only Elvish v0.18+ is supported @@ -400,15 +400,15 @@ If you're looking to further customize Starship: ## 🤝 المساهمة -We are always looking for contributors of **all skill levels**! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). +نبحث دائماً عن مساهمين من **جميع المستويات**! إذا كنت تتطلع إلى تسهيل طريقك إلى المشروع، جرب [إنشاء اول مشكلة](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). -If you are fluent in a non-English language, we greatly appreciate any help keeping our docs translated and up-to-date in other languages. If you would like to help, translations can be contributed on the [Starship Crowdin](https://translate.starship.rs/). +إذا كنت تتحدث بطلاقة بلغة غير إنجليزية، فإننا نقدر أي مساعدة للحفاظ على ترجمة المستندات وتحديثها بلغات أخرى. إذا كنت ترغب في المساعدة، يمكن المساهمة بالترجمة على [Starship Crowdin](https://translate.starship.rs/). -If you are interested in helping contribute to starship, please take a look at our [Contributing Guide](https://github.com/starship/starship/blob/master/CONTRIBUTING.md). Also, feel free to drop into our [Discord server](https://discord.gg/8Jzqu3T) and say hi. 👋 +إذا كنت مهتما بالمساهمة في starship، يرجى إلقاء نظرة على [دليل المساهمة](https://github.com/starship/starship/blob/master/CONTRIBUTING.md) لدينا. أيضا، لا تتردد في أن تنضم لنا في [Discord](https://discord.gg/8Jzqu3T) وقُل مرحبا. 👋 ## 💭 مستوحاة من قبل -Please check out these previous works that helped inspire the creation of starship. 🙏 +يرجى التحقق من هذه الأعمال السابقة التي ساعدت على إنشاء starship. 🙏 - **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** – A ZSH prompt for astronauts. diff --git a/docs/ar-SA/installing/README.md b/docs/ar-SA/installing/README.md index fa88ca8d..9f8b27f5 100644 --- a/docs/ar-SA/installing/README.md +++ b/docs/ar-SA/installing/README.md @@ -1,4 +1,4 @@ -# Advanced Installation +# التثبيت المتقدم To install starship, you need to do two things: diff --git a/docs/ckb-IR/README.md b/docs/ckb-IR/README.md index be456879..2420ae84 100644 --- a/docs/ckb-IR/README.md +++ b/docs/ckb-IR/README.md @@ -120,7 +120,7 @@ description: 'Starship: یەکێ لە promptـە سوکەڵە، خێرا، و ب #### Elvish - ::: warning تەنها elvish v0.17 یان بەرزتر پشتگیری کراوە. ::: + ::: warning تەنها elvish v0.18 یان بەرزتر پشتگیری کراوە. ::: ئەمەی خوارەوە زیادبکە لە کۆتایی `~/.elvish/rc.elv`: diff --git a/docs/ckb-IR/advanced-config/README.md b/docs/ckb-IR/advanced-config/README.md index 7c9474d7..67a53d0f 100644 --- a/docs/ckb-IR/advanced-config/README.md +++ b/docs/ckb-IR/advanced-config/README.md @@ -131,7 +131,7 @@ Invoke-Expression (&starship init powershell) Some shells support a right prompt which renders on the same line as the input. Starship can set the content of the right prompt using the `right_format` option. Any module that can be used in `format` is also supported in `right_format`. The `$all` variable will only contain modules not explicitly used in either `format` or `right_format`. -Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [fill module](/config/#fill). +Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [`fill` module](/config/#fill). `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd. diff --git a/docs/ckb-IR/config/README.md b/docs/ckb-IR/config/README.md index a6588c41..d4fea6f6 100644 --- a/docs/ckb-IR/config/README.md +++ b/docs/ckb-IR/config/README.md @@ -9,6 +9,9 @@ mkdir -p ~/.config && touch ~/.config/starship.toml هەموو ڕێکخستنەکان بۆ Starship ئەنجام ئەدرێن لەم پەڕگەی [TOML](https://github.com/toml-lang/toml)ـەدا: ```toml +# Get editor completions based on the config schema +"$schema" = 'https://starship.rs/config-schema.json' + # Inserts a blank line between shell prompts add_newline = true @@ -199,6 +202,7 @@ $hg_branch\ $docker_context\ $package\ $buf\ +$c\ $cmake\ $cobol\ $container\ @@ -235,6 +239,7 @@ $vagrant\ $zig\ $nix_shell\ $conda\ +$spack\ $memory_usage\ $aws\ $gcloud\ @@ -263,9 +268,9 @@ format = "$all$directory$character" ## AWS -The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file. This module also shows an expiration timer when using temporary credentials. +The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. Alternatively, you can force this module to show the region and profile even when the credentials have not been setup with the `force_display` option. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file. This module also shows an expiration timer when using temporary credentials. -The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. +The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if the conditions above are not respected. When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var. @@ -275,15 +280,16 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------- | -| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | The format for the module. | -| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. | -| `region_aliases` | | Table of region aliases to display in addition to the AWS name. | -| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | -| `style` | `"bold yellow"` | The style for the module. | -| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. | -| `disabled` | `false` | Disables the `AWS` module. | +| Option | Default | Description | +| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | +| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | The format for the module. | +| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. | +| `region_aliases` | | Table of region aliases to display in addition to the AWS name. | +| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | +| `style` | `"bold yellow"` | The style for the module. | +| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. | +| `disabled` | `false` | Disables the `AWS` module. | +| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. | ### Variables @@ -472,6 +478,52 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil symbol = "🦬 " ``` +## C + +The `c` module shows some information about your C compiler. By default the module will be shown if the current directory contains a `.c` or `.h` file. + +### Options + +| Option | Default | Description | +| ------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version(-$name) )]($style)"` | The format string for the module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"C "` | The symbol used before displaying the compiler details | +| `detect_extensions` | `["c", "h"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `commands` | [ [ "cc", "--version" ], [ "gcc", "--version" ], [ "clang", "--version" ] ] | How to detect what the compiler is | +| `style` | `"bold 149"` | The style for the module. | +| `disabled` | `false` | Disables the `c` module. | + +### Variables + +| گۆڕاو | نموونە | Description | +| ------- | ------ | ------------------------------------ | +| name | clang | The name of the compiler | +| version | 13.0.0 | The version of the compiler | +| symbol | | Mirrors the value of option `symbol` | +| style | | Mirrors the value of option `style` | + +NB that `version` is not in the default format. + +### Commands + +The `commands` option accepts a list of commands to determine the compiler version and name. + +Each command is represented as a list of the executable name, followed by its arguments, usually something like `["mycc", "--version"]`. Starship will try executing each command until it gets a result on STDOUT. + +If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). + +### نموونە + +```toml +# ~/.config/starship.toml + +[c] +format = "via [$name $version]($style)" +``` + ## Character The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. @@ -962,7 +1014,7 @@ You'll also need the .NET Core SDK installed in order to use it correctly. Internally, this module uses its own mechanism for version detection. Typically it is twice as fast as running `dotnet --version`, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting `heuristic = false` in the module options. -The module will also show the Target Framework Moniker () when there is a csproj file in the current directory. +The module will also show the Target Framework Moniker () when there is a `.csproj` file in the current directory. ### Options @@ -1106,7 +1158,7 @@ default = "unknown user" | Option | Default | Description | | ---------- | ------------------------------ | ---------------------------------------------------------------------------- | | `symbol` | `""` | The symbol used before displaying the variable value. | -| `variable` | | The environment variable to be displayed. | +| `گۆڕاو` | | 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. | @@ -2182,12 +2234,12 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/ ### Variables -| گۆڕاو | نموونە | 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` | +| گۆڕاو | نموونە | 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` | *: This variable can only be used as a part of a style string @@ -2969,6 +3021,39 @@ The `singularity` module shows the current [Singularity](https://sylabs.io/singu format = '[📦 \[$env\]]($style) ' ``` +## Spack + +The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set. + +### Options + +| Option | Default | Description | +| ------------------- | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | +| `truncation_length` | `1` | The number of directories the environment path should be truncated to. `0` means no truncation. Also see the [`directory`](#directory) module. | +| `symbol` | `"🅢 "` | The symbol used before the environment name. | +| `style` | `"bold blue"` | The style for the module. | +| `format` | `"via [$symbol$environment]($style) "` | The format for the module. | +| `disabled` | `false` | Disables the `spack` module. | + +### Variables + +| گۆڕاو | نموونە | Description | +| ----------- | ------------ | ------------------------------------ | +| environment | `astronauts` | The current spack environment | +| 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 + +[spack] +format = "[$symbol$environment](dimmed blue) " +``` + ## Status 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. @@ -3226,7 +3311,7 @@ time_range = "10:00:00-14:00:00" 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 +- The current user is root/admin - The current user isn't the same as the one that is logged in - The user is currently connected as an SSH session - The variable `show_always` is set to true @@ -3239,13 +3324,13 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, ` ### Options -| Option | Default | Description | -| ------------- | ----------------------- | ------------------------------------- | -| `style_root` | `"bold red"` | The style used when the user is root. | -| `style_user` | `"bold yellow"` | The style used for non-root users. | -| `format` | `"[$user]($style) in "` | The format for the module. | -| `show_always` | `false` | Always shows the `username` module. | -| `disabled` | `false` | Disables the `username` module. | +| Option | Default | 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 "` | The format for the module. | +| `show_always` | `false` | Always shows the `username` module. | +| `disabled` | `false` | Disables the `username` module. | ### Variables @@ -3417,9 +3502,9 @@ The `custom` modules show the output of some arbitrary commands. These modules will be shown if any of the following conditions are met: -- The current directory contains a file whose name is in `files` -- The current directory contains a directory whose name is in `directories` -- The current directory contains a file whose extension is in `extensions` +- The current directory contains a file whose name is in `detect_files` +- The current directory contains a directory whose name is in `detect_folders` +- The current directory contains a file whose extension is in `detect_extensions` - The `when` command returns 0 - The current Operating System (std::env::consts::OS) matchs with `os` field if defined. @@ -3451,20 +3536,22 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt ### Options -| Option | Default | Description | -| ------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `command` | `""` | The command whose output should be printed. The command will be passed on stdin to the shell. | -| `when` | | A shell command used as a condition to show the module. 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`. | -| `files` | `[]` | The files that will be searched in the working directory for a match. | -| `directories` | `[]` | The directories that will be searched in the working directory for a match. | -| `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"` | The style for the module. | -| `format` | `"[$symbol($output )]($style)"` | The format for the module. | -| `disabled` | `false` | Disables this `custom` module. | -| `os` | | Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) [See possible values](https://doc.rust-lang.org/std/env/consts/constant.OS.html). | +| Option | Default | Description | +| ------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `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"` | The style for the module. | +| `format` | `"[$symbol($output )]($style)"` | The format for the module. | +| `disabled` | `false` | Disables this `custom` module. | +| `os` | | Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) [See possible values](https://doc.rust-lang.org/std/env/consts/constant.OS.html). | +| `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 @@ -3487,7 +3574,7 @@ If unset, it will fallback to STARSHIP_SHELL and then to "sh" on Linux, and "cmd The `command` will be passed in on stdin. -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 -`. This behavior can be avoided by explicitly passing arguments to the shell, e.g. +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", "-"] @@ -3512,12 +3599,18 @@ Automatic detection of shells and proper parameters addition are currently imple [custom.foo] command = "echo foo" # shows output of command -files = ["foo"] # can specify filters but wildcards are not supported +detect_files = ["foo"] # can specify filters but wildcards are not supported when = """ test "$HOME" == "$PWD" """ format = " transcending [$output]($style)" [custom.time] command = "time /T" -extensions = ["pst"] # filters *.pst files +detect_extensions = ["pst"] # filters *.pst files shell = ["pwsh.exe", "-NoProfile", "-Command", "-"] + +[custom.time-as-arg] +command = "time /T" +detect_extensions = ["pst"] # filters *.pst files +shell = ["pwsh.exe", "-NoProfile", "-Command"] +use_stdin = false ``` diff --git a/docs/ckb-IR/guide/README.md b/docs/ckb-IR/guide/README.md index 6302c572..7097aa99 100644 --- a/docs/ckb-IR/guide/README.md +++ b/docs/ckb-IR/guide/README.md @@ -141,7 +141,7 @@ Starship with iTerm2 and the Snazzy theme @@ -156,7 +156,7 @@ - **ئاسان:** خێرا لە دامەزراندن – دەست ئەکەیت بە بەکارهێنانی لە چەند خولەکێکدا.

-Explore the Starship docs  ▶ +بەڵگەنامەکانی Starship بگەڕێ  ◀

@@ -293,7 +293,7 @@ load(io.popen('starship init cmd'):read("*a"))() eval (starship init elvish) ``` -Note: Only Elvish v0.17+ is supported +Note: Only Elvish v0.18+ is supported @@ -396,15 +396,15 @@ If you're looking to further customize Starship: ## 🤝 بەژداریکردن -We are always looking for contributors of **all skill levels**! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). +ئێمە هەموو کات ئەگەڕێین بۆ بەژداریکەرێک لە هەر **ئاست و توانایەکدا بێت**! ئەگەر بەدوای ئەوەوەی کە بێیتە ئەم پڕۆژەیەوە [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue) تاقیبکەرەوە. -If you are fluent in a non-English language, we greatly appreciate any help keeping our docs translated and up-to-date in other languages. If you would like to help, translations can be contributed on the [Starship Crowdin](https://translate.starship.rs/). +ئەگەر پاراویت لە زمانێک جگە لە ئینگلیزی، ئێمە زۆر خۆشحاڵدەبین بە هەر یارمەتییەک کە بەڵگەنامەکانمان بە وەرگێڕدراوی بهێڵێتەوە و نوێکراوی بهێڵێتەوە بە زمانەکانی دیکە. ئەگەر نیازت هەیە یارمەتی بدەیت، ئەتوانی بەژداری لە وەرگێڕاندا بکەیت لەسەر [Starship Crowdin](https://translate.starship.rs/). -If you are interested in helping contribute to starship, please take a look at our [Contributing Guide](https://github.com/starship/starship/blob/master/CONTRIBUTING.md). Also, feel free to drop into our [Discord server](https://discord.gg/8Jzqu3T) and say hi. 👋 +ئەگەر حەزئەکەیت یارمەتی بدەیت بە بەژداریکردن لە starship، تکایە سەیری [ڕێبەری بەژداریکردن](https://github.com/starship/starship/blob/master/CONTRIBUTING.md)ـەکەمان بکە. هەروەها، شەرم مەکە وەرە نێوە [ڕاژەی Discord](https://discord.gg/8Jzqu3T)ـەکەمانەوە و سڵاوێک بکە. 👋 ## 💭 ئیلهامبەخشەکان -Please check out these previous works that helped inspire the creation of starship. 🙏 +تکایە ئەم کارە کۆنانە سەیربکەوە کە ئیلهامی دروستکردنی starship دا. 🙏 - **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** – A ZSH prompt for astronauts. @@ -414,9 +414,9 @@ Please check out these previous works that helped inspire the creation of starsh


- Starship rocket icon + ئایکۆنی مووشەکی Starship

## 📝 مۆڵەتنامە -Copyright © 2019-present, [Starship Contributors](https://github.com/starship/starship/graphs/contributors).
This project is [ISC](https://github.com/starship/starship/blob/master/LICENSE) licensed. +هەموو مافێکی پارێزراوە © 2019-ئێستا، [بەژداریکەرانی Starship](https://github.com/starship/starship/graphs/contributors).
ئەم پڕۆژەیە لە ژێر مۆڵەتنامەی [ISC](https://github.com/starship/starship/blob/master/LICENSE)ـە. diff --git a/docs/de-DE/README.md b/docs/de-DE/README.md index 7bd5d543..e4bb9705 100644 --- a/docs/de-DE/README.md +++ b/docs/de-DE/README.md @@ -120,7 +120,7 @@ description: Starship ist eine minimale, super schnelle, und extrem anpassbare P #### Elvish - ::: warning Nur elvish v0.17 oder höher ist unterstützt. ::: + ::: warning Nur elvish v0.18 oder höher ist unterstützt. ::: Trage folgendes am Ende von `~/.config/fish/rc.elv` ein: @@ -169,7 +169,7 @@ description: Starship ist eine minimale, super schnelle, und extrem anpassbare P ``` - #### Cmd + #### ⌘ Cmd You need to use [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) with Cmd. Add the following to a file `starship.lua` and place this file in Clink scripts directory: diff --git a/docs/de-DE/advanced-config/README.md b/docs/de-DE/advanced-config/README.md index 3a3a996a..107bfecc 100644 --- a/docs/de-DE/advanced-config/README.md +++ b/docs/de-DE/advanced-config/README.md @@ -131,7 +131,7 @@ Invoke-Expression (&starship init powershell) Some shells support a right prompt which renders on the same line as the input. Starship can set the content of the right prompt using the `right_format` option. Any module that can be used in `format` is also supported in `right_format`. The `$all` variable will only contain modules not explicitly used in either `format` or `right_format`. -Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [fill module](/config/#fill). +Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [`fill` module](/config/#fill). `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd. diff --git a/docs/de-DE/config/README.md b/docs/de-DE/config/README.md index 0f912b95..07c46737 100644 --- a/docs/de-DE/config/README.md +++ b/docs/de-DE/config/README.md @@ -9,6 +9,9 @@ mkdir -p ~/.config && touch ~/.config/starship.toml Die gesamte Konfiguration von Starship erfolgt in dieser [TOML](https://github.com/toml-lang/toml)-Datei: ```toml +# Get editor completions based on the config schema +"$schema" = 'https://starship.rs/config-schema.json' + # Inserts a blank line between shell prompts add_newline = true @@ -199,6 +202,7 @@ $hg_branch\ $docker_context\ $package\ $buf\ +$c\ $cmake\ $cobol\ $container\ @@ -235,6 +239,7 @@ $vagrant\ $zig\ $nix_shell\ $conda\ +$spack\ $memory_usage\ $aws\ $gcloud\ @@ -263,9 +268,9 @@ format = "$all$directory$character" ## AWS -The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. Dies basiert auf den Umgebungsvariablen: `AWS_REGION`, `AWS_DEFAULT_REGION`, `AWS_PROFILE` und der `~/.aws/config` Datei. This module also shows an expiration timer when using temporary credentials. +The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. Alternatively, you can force this module to show the region and profile even when the credentials have not been setup with the `force_display` option. Dies basiert auf den Umgebungsvariablen: `AWS_REGION`, `AWS_DEFAULT_REGION`, `AWS_PROFILE` und der `~/.aws/config` Datei. This module also shows an expiration timer when using temporary credentials. -The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. +The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if the conditions above are not respected. When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var. @@ -275,15 +280,16 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL ### Optionen -| Option | Standardwert | Beschreibung | -| ------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------------------- | -| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | Das Format für das Modul. | -| `symbol` | `"☁️ "` | Symbol das vor dem aktuellen AWS-Profil angezeigt wird. | -| `region_aliases` | | Tabelle der Regionaliasen, die zusätzlich zum AWS-Namen angezeigt werden sollen. | -| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | -| `style` | `"bold yellow"` | Stil für dieses Modul. | -| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. | -| `disabled` | `false` | Disables the `AWS` module. | +| Option | Standardwert | Beschreibung | +| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | +| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | Das Format für das Modul. | +| `symbol` | `"☁️ "` | Symbol das vor dem aktuellen AWS-Profil angezeigt wird. | +| `region_aliases` | | Tabelle der Regionaliasen, die zusätzlich zum AWS-Namen angezeigt werden sollen. | +| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | +| `style` | `"bold yellow"` | Stil für dieses Modul. | +| `expiration_symbol` | `X` | Das Symbol, das angezeigt wird, wenn die temporären Anmeldeinformationen abgelaufen sind. | +| `disabled` | `false` | Deaktiviert das `aws`-Modul. | +| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. | ### Variables @@ -472,11 +478,57 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil symbol = "🦬 " ``` +## C + +The `c` module shows some information about your C compiler. By default the module will be shown if the current directory contains a `.c` or `.h` file. + +### Optionen + +| Option | Standardwert | Beschreibung | +| ------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version(-$name) )]($style)"` | The format string for the module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"C "` | The symbol used before displaying the compiler details | +| `detect_extensions` | `["c", "h"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `commands` | [ [ "cc", "--version" ], [ "gcc", "--version" ], [ "clang", "--version" ] ] | How to detect what the compiler is | +| `style` | `"bold 149"` | Stil für dieses Modul. | +| `disabled` | `false` | Disables the `c` module. | + +### Variables + +| Variable | Beispiel | Beschreibung | +| -------- | -------- | ------------------------------------- | +| name | clang | The name of the compiler | +| version | 13.0.0 | The version of the compiler | +| symbol | | Spiegelt den Wert der Option `symbol` | +| style | | Spiegelt den Wert der Option `style` | + +NB that `version` is not in the default format. + +### Commands + +The `commands` option accepts a list of commands to determine the compiler version and name. + +Each command is represented as a list of the executable name, followed by its arguments, usually something like `["mycc", "--version"]`. Starship will try executing each command until it gets a result on STDOUT. + +If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). + +### Beispiel + +```toml +# ~/.config/starship.toml + +[c] +format = "via [$name $version]($style)" +``` + ## Zeichen -The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. +Das `character` Modul zeigt ein Zeichen ( meistens einen Pfeil "❯") vor der Texteingabe an. -The character will tell you whether the last command was successful or not. It can do this in two ways: +Das Zeichen zeigt an ob der letzte Befehl erfolgreich war, oder einen Fehler erzeugt hat. It can do this in two ways: - changing color (`red`/`green`) - changing shape (`❯`/`✖`) @@ -497,7 +549,7 @@ By default it only changes color. If you also want to change its shape take a lo | `success_symbol` | `"[❯](bold green)"` | The format string used before the text input if the previous command succeeded. | | `error_symbol` | `"[❯](bold red)"` | The format string used before the text input if the previous command failed. | | `vicmd_symbol` | `"[❮](bold green)"` | The format string used before the text input if the shell is in vim normal mode. | -| `disabled` | `false` | Disables the `character` module. | +| `disabled` | `false` | Deaktiviert das `character`-Modul. | ### Variables @@ -598,25 +650,25 @@ The `cobol` module shows the currently installed version of COBOL. By default, t ## Befehlsdauer -The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists. +Das `cmd_duration` Modul zeigt an wie lange der letzte Befehl ausgeführt wurde. Das Modul wird nur angezeigt wenn der letzte Befehl länger als zwei Sekunden ausgeführt wurde. Mit der `min_time` Option kann die Zeit eingestellt werden ab der <0>cmd_duration angezeigt wird. -::: warning Do not hook the DEBUG trap in Bash +::: warning Nicht die DEBUG-trap in der Bash hooken -If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. +Ist `bash` die Konsole der Wahl, dann nicht die `DEBUG`-trap nach der Ausführung von `eval $(starship init $0)` hooken, andernfalls **wird** dieses Modul unweigerlich untergehen. ::: -Bash users who need preexec-like functionality can use [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Simply define the arrays `preexec_functions` and `precmd_functions` before running `eval $(starship init $0)`, and then proceed as normal. +Bash Nutzer, die eine "preexec" ähnliche Funktion benötigen, können [rcaloras bash_preexec Framework](https://github.com/rcaloras/bash-preexec) verwenden. Definieren Sie einfach die Arrays `preexec_functions` und `precmd_functions` bevor sie `eval $(starship init $0)` ausführen, und fahren Sie dann wie gewohnt fort. ### Optionen | Option | Standardwert | Beschreibung | | ---------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). | -| `show_milliseconds` | `false` | Show milliseconds in addition to seconds for the duration. | +| `min_time` | `2_000` | Schwellwert für kleinste anzuzeigende Laufzeit (in Millisekunden). | +| `show_milliseconds` | `false` | Zeige Millisekunden zusätzlich zu Sekunden. | | `format` | `"took [$duration]($style) "` | Das Format für das Modul. | | `style` | `"bold yellow"` | Stil für dieses Modul. | -| `disabled` | `false` | Disables the `cmd_duration` module. | +| `disabled` | `false` | Deaktiviert das `cmd_duration`-Modul. | | `show_notifications` | `false` | Show desktop notifications when command completes. | | `min_time_to_notify` | `45_000` | Shortest duration for notification (in milliseconds). | | `notification_timeout` | | Duration to show notification for (in milliseconds). If unset, notification timeout will be determined by daemon. Not all notification daemons honor this option. | @@ -646,20 +698,20 @@ The `conda` module shows the current [Conda](https://docs.conda.io/en/latest/) e ::: tip -This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. +Hinweis: Dies unterdrückt nicht conda's eigenen Prompt-Modifikator, sie können jedoch conda mit `conda config --set changeps1 False` konfigurieren, um die Ausgabe von conda selbst auszuschalten. ::: ### Optionen -| Option | Standardwert | Beschreibung | -| ------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `truncation_length` | `1` | The number of directories the environment path should be truncated to, if the environment was created via `conda create -p [path]`. `0` means no truncation. Also see the [`directory`](#directory) module. | -| `symbol` | `"🅒 "` | The symbol used before the environment name. | -| `style` | `"bold green"` | Stil für dieses Modul. | -| `format` | `"via [$symbol$environment]($style) "` | Das Format für das Modul. | -| `ignore_base` | `true` | Ignores `base` environment when activated. | -| `disabled` | `false` | Disables the `conda` module. | +| Option | Standardwert | Beschreibung | +| ------------------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `truncation_length` | `1` | Die Anzahl der Verzeichnisse, auf die der Verzeichnisspfad abgeschnitten werden soll, wenn die Umgebung über `conda erstellt wurde -p [path]`. `0` bedeutet keine Kürzung. Beachte auch die Beschreibung für das [`directory`](#directory) Modul. | +| `symbol` | `"🅒 "` | Symbol das vor dem Umgebungsnamen angezeigt wird. | +| `style` | `"bold green"` | Stil für dieses Modul. | +| `format` | `"via [$symbol$environment]($style) "` | Das Format für das Modul. | +| `ignore_base` | `true` | Ignores `base` environment when activated. | +| `disabled` | `false` | Deaktiviert das `conda`-Modul. | ### Variables @@ -716,7 +768,7 @@ format = "[$symbol \\[$name\\]]($style) " The `crystal` module shows the currently installed version of [Crystal](https://crystal-lang.org/). By default the module will be shown if any of the following conditions are met: -- The current directory contains a `shard.yml` file +- Das aktuelle Verzeichnis enthält eine `shard.yml`-Datei - The current directory contains a `.cr` file ### Optionen @@ -757,7 +809,7 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d - The current directory contains a file with `.dart` extension - The current directory contains a `.dart_tool` directory -- The current directory contains a `pubspec.yaml`, `pubspec.yml` or `pubspec.lock` file +- Das aktuelle Verzeichnis enthält `pubspec.yaml`, `pubspec.yml` oder `pubspec.lock` ### Optionen @@ -829,7 +881,7 @@ format = "via [🦕 $version](green bold) " ## Verzeichnis -The `directory` module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in. +Das `directory` -Modul zeigt den Pfad zu Ihrem aktuellen Verzeichnis an, abgeschnitten auf drei übergeordnete Ordner. Your directory will also be truncated to the root of the git repo that you're currently in. When using the fish style pwd option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option. @@ -839,11 +891,11 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an | Option | Standardwert | Beschreibung | | ------------------- | ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. | +| `truncation_length` | `3` | Die Anzahl der übergeordneten Ordner, die angezeigt werden. | | `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. | | `format` | `"[$path]($style)[$read_only]($read_only_style) "` | Das Format für das Modul. | | `style` | `"bold cyan"` | Stil für dieses Modul. | -| `disabled` | `false` | Disables the `directory` module. | +| `disabled` | `false` | Deaktiviert das `directory`-Modul. | | `read_only` | `"🔒"` | The symbol indicating current directory is read only. | | `read_only_style` | `"red"` | The style for the read only symbol. | | `truncation_symbol` | `""` | The symbol to prefix to truncated paths. eg: "…/" | @@ -853,7 +905,7 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an | `use_os_path_sep` | `true` | Use the OS specific path separator instead of always using `/` (e.g. `\` on Windows) |
-This module has a few advanced configuration options that control how the directory is displayed. +Dieses Modul hat einige erweiterte Konfigurationsoptionen, welche die Darstellung von Verzeichnissen steuern. | Advanced Option | Standardwert | Beschreibung | | --------------------------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -962,21 +1014,21 @@ You'll also need the .NET Core SDK installed in order to use it correctly. Internally, this module uses its own mechanism for version detection. Typically it is twice as fast as running `dotnet --version`, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting `heuristic = false` in the module options. -The module will also show the Target Framework Moniker () when there is a csproj file in the current directory. +The module will also show the Target Framework Moniker () when there is a `.csproj` file in the current directory. ### Optionen -| Option | Standardwert | Beschreibung | +| Option | Standartwert | Beschreibung | | ------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- | | `format` | `"via [$symbol($version )(🎯 $tfm )]($style)"` | Das Format für das Modul. | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `".NET "` | The symbol used before displaying the version of dotnet. | -| `heuristic` | `true` | Use faster version detection to keep starship snappy. | +| `symbol` | `".NET "` | Symbol das vor der dotnet-Version angezeigt wird. | +| `heuristic` | `true` | Schnelle Versionserkennung nutzen um Starship bedienbar zu halten. | | `detect_extensions` | `["csproj", "fsproj", "xproj"]` | Which extensions should trigger this module. | | `detect_files` | `["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this modules. | | `style` | `"bold blue"` | Stil für dieses Modul. | -| `disabled` | `false` | Disables the `dotnet` module. | +| `disabled` | `false` | Deaktiviert das `dotnet`-Modul. | ### Variables @@ -1004,11 +1056,11 @@ heuristic = false The `elixir` module shows the currently installed version of [Elixir](https://elixir-lang.org/) and [Erlang/OTP](https://erlang.org/doc/). By default the module will be shown if any of the following conditions are met: -- The current directory contains a `mix.exs` file. +- Das aktuelle Verzeichnis enthält eine `mix.exs`-Datei. ### Optionen -| Option | Standartwert | Beschreibung | +| Option | Standardwert | Beschreibung | | ------------------- | ----------------------------------------------------------- | ------------------------------------------------------------------------- | | `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | @@ -1043,8 +1095,8 @@ symbol = "🔮 " The `elm` module shows the currently installed version of [Elm](https://elm-lang.org/). By default the module will be shown if any of the following conditions are met: -- The current directory contains a `elm.json` file -- The current directory contains a `elm-package.json` file +- Das aktuelle Verzeichnis enthält eine `elm.json`-Datei +- Das aktuelle Verzeichnis enthält eine `elm-package.json`-Datei - The current directory contains a `.elm-version` file - The current directory contains a `elm-stuff` folder - The current directory contains `*.elm` files @@ -1103,13 +1155,13 @@ default = "unknown user" ### Optionen -| Option | Standardwert | Beschreibung | -| ---------- | ------------------------------ | ---------------------------------------------------------------------------- | -| `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) "` | Das Format für das Modul. | -| `disabled` | `false` | Disables the `env_var` module. | +| Option | Standardwert | 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. | ### Variables @@ -1147,8 +1199,8 @@ default = "unknown user" The `erlang` module shows the currently installed version of [Erlang/OTP](https://erlang.org/doc/). By default the module will be shown if any of the following conditions are met: -- The current directory contains a `rebar.config` file. -- The current directory contains a `erlang.mk` file. +- Das aktuelle Verzeichnis enthält eine `rebar.config`-Datei. +- Das aktuelle Verzeichnis enthält eine `erlang.mk`-Datei. ### Optionen @@ -1284,9 +1336,9 @@ format = 'on [$symbol$account(@$domain)(\($project\))]($style) ' very-long-project-name = "vlpn" ``` -## Git Branch +## Git-Branch -The `git_branch` module shows the active branch of the repo in your current directory. +Das `git_branch`-Modul zeigt den aktiven Git-Branch des Repositories im aktuellen Verzeichnis an. ### Optionen @@ -1300,7 +1352,7 @@ The `git_branch` module shows the active branch of the repo in your current dire | `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. | +| `disabled` | `false` | Deaktiviert das `git_branch`-Modul. | ### Variables @@ -1361,7 +1413,7 @@ commit_hash_length = 4 tag_symbol = "🔖 " ``` -## Git State +## Git-Zustand 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. @@ -1378,7 +1430,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` | Disables the `git_state` module. | +| `disabled` | `false` | Deaktiviert das `git_state`-Modul. | ### Variables @@ -1407,7 +1459,7 @@ The `git_metrics` module will show the number of added and deleted lines in the ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. ::: @@ -1470,7 +1522,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` | Disables the `git_status` module. | +| `disabled` | `false` | Deaktiviert das `git_status`-Modul. | | `windows_starship` | | Use this (Linux) path to a Windows Starship executable to render `git_status` when on Windows paths in WSL. | ### Variables @@ -1548,14 +1600,14 @@ windows_starship = '/mnt/c/Users/username/scoop/apps/starship/current/starship.e The `golang` module shows the currently installed version of [Go](https://golang.org/). By default the module will be shown if any of the following conditions are met: -- The current directory contains a `go.mod` file -- The current directory contains a `go.sum` file -- The current directory contains a `glide.yaml` file -- The current directory contains a `Gopkg.yml` file -- The current directory contains a `Gopkg.lock` file +- Das aktuelle Verzeichnis enthält eine `go.mod`-Datei +- Das aktuelle Verzeichnis enthält eine `go.sum`-Datei +- Das aktuelle Verzeichnis enthält eine `glide.yaml`-Datei +- Das aktuelle Verzeichnis enthält eine `Gopkg.yml`-Datei +- Das aktuelle Verzeichnis enthält eine `Gopkg.lock`-Datei - The current directory contains a `.go-version` file -- The current directory contains a `Godeps` directory -- The current directory contains a file with the `.go` extension +- Das aktuelle Verzeichnis enthält ein `Godeps`-Verzeichnis +- Das aktuelle Verzeichnis enthält eine Datei mit der `.go`-Erweiterung ### Optionen @@ -1568,7 +1620,7 @@ The `golang` module shows the currently installed version of [Go](https://golang | `detect_files` | `["go.mod", "go.sum", "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` | Disables the `golang` module. | +| `disabled` | `false` | Deaktiviert das `golang`-Modul. | ### Variables @@ -1595,7 +1647,7 @@ The `haskell` module finds the current selected GHC version and/or the selected By default the module will be shown if any of the following conditions are met: -- The current directory contains a `stack.yaml` file +- Das aktuelle Verzeichnis enthält eine `stack.yaml`-Datei - The current directory contains any `.hs`, `.cabal`, or `.hs-boot` file ### Optionen @@ -1626,7 +1678,7 @@ By default the module will be shown if any of the following conditions are met: The `helm` module shows the currently installed version of [Helm](https://helm.sh/). By default the module will be shown if any of the following conditions are met: -- The current directory contains a `helmfile.yaml` file +- Das aktuelle Verzeichnis enthält eine `helmfile.yaml`-Datei - The current directory contains a `Chart.yaml` file ### Optionen @@ -1663,17 +1715,17 @@ format = "via [⎈ $version](bold white) " ## Hostname -The `hostname` module shows the system hostname. +Das `hostname`-Modul zeigt den Hostnamen des Systems an. ### Optionen | Option | Standardwert | Beschreibung | | ---------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | -| `ssh_only` | `true` | Only show hostname when connected to an SSH session. | +| `ssh_only` | `true` | Zeigt den Hostnamen nur, wenn via SSH-Sitzung verbunden. | | `trim_at` | `"."` | String that the hostname is cut off at, after the first match. `"."` will stop after the first dot. `""` will disable any truncation | | `format` | `"[$hostname]($style) in "` | Das Format für das Modul. | | `style` | `"bold dimmed green"` | Stil für dieses Modul. | -| `disabled` | `false` | Disables the `hostname` module. | +| `disabled` | `false` | Deaktiviert das `hostname`-Modul. | ### Variables @@ -1714,7 +1766,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` | Disables the `java` module. | +| `disabled` | `false` | Deaktiviert das `Java`-Modul. | ### Variables @@ -1759,15 +1811,15 @@ The `threshold` option is deprecated, but if you want to use it, the module will ### Optionen -| Option | Standardwert | 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. | +| Option | Standardwert | 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. | *: This option is deprecated, please use the `number_threshold` and `symbol_threshold` options instead. @@ -1885,7 +1937,7 @@ Displays the current [Kubernetes context](https://kubernetes.io/docs/concepts/co ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. ::: @@ -1897,7 +1949,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | `format` | `'[$symbol$context( \($namespace\))]($style) in '` | Das Format für das Modul. | | `style` | `"cyan bold"` | Stil für dieses Modul. | | `context_aliases` | | Table of context aliases to display. | -| `disabled` | `true` | Disables the `kubernetes` module. | +| `disabled` | `true` | Deaktiviert das `kubernetes`-Modul. | ### Variables @@ -1947,15 +1999,15 @@ Long and automatically generated cluster names can be identified and shortened u "gke_.*_(?P[\\w-]+)" = "gke-$var_cluster" ``` -## Line Break +## Zeilenumbruch -The `line_break` module separates the prompt into two lines. +Das `line_break`-Modul unterteilt den Prompt in zwei Zeilen. ### Optionen -| Option | Standardwert | Beschreibung | -| ---------- | ------------ | ------------------------------------------------------------------ | -| `disabled` | `false` | Disables the `line_break` module, making the prompt a single line. | +| Option | Standardwert | Beschreibung | +| ---------- | ------------ | ---------------------------------------------------------------------- | +| `disabled` | `false` | Deaktiviert das `line_break`-Modul, wodurch der Prompt einzeilig wird. | ### Beispiel @@ -2040,27 +2092,27 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o format = "via [🌕 $version](bold blue) " ``` -## Memory Usage +## Speicherauslastung -The `memory_usage` module shows current system memory and swap usage. +Das `memory_usage` Modul zeigt den aktuellen Systemspeicher und die swap-Nutzung an. -By default the swap usage is displayed if the total system swap is non-zero. +Standardmäßig wird die swap-Nutzung angezeigt, wenn der gesamte System-swap nicht Null ist. ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. ::: ### Optionen -| Option | Standardwert | 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. | +| Option | Standardwert | 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. | ### Variables @@ -2127,7 +2179,7 @@ truncation_symbol = "" The `nim` module shows the currently installed version of [Nim](https://nim-lang.org/). By default the module will be shown if any of the following conditions are met: -- The current directory contains a `nim.cfg` file +- Das aktuelle Verzeichnis enthält eine `nim.cfg`-Datei - The current directory contains a file with the `.nim` extension - The current directory contains a file with the `.nims` extension - The current directory contains a file with the `.nimble` extension @@ -2136,7 +2188,7 @@ The `nim` module shows the currently installed version of [Nim](https://nim-lang | Option | Standardwert | Beschreibung | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module | +| `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 Nim. | | `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this module. | @@ -2165,9 +2217,9 @@ 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. The module will be shown when inside a nix-shell environment. +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. ### Optionen @@ -2178,7 +2230,7 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/ | `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` | Disables the `nix_shell` module. | +| `disabled` | `false` | Deaktiviert das `nix_shell`-Modul. | ### Variables @@ -2207,10 +2259,10 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' The `nodejs` module shows the currently installed version of [Node.js](https://nodejs.org/). By default the module will be shown if any of the following conditions are met: -- The current directory contains a `package.json` file +- Das aktuelle Verzeichnis enthält eine `package.json`-Datei - The current directory contains a `.node-version` file - The current directory contains a `.nvmrc` file -- The current directory contains a `node_modules` directory +- Das aktuelle Verzeichnis enthält ein `node_modules`-Verzeichnis - 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 @@ -2225,7 +2277,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` | Disables the `nodejs` module. | +| `disabled` | `false` | Deaktiviert das `nodejs`-Modul. | | `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 @@ -2329,9 +2381,9 @@ style = "bold yellow" symbol = "☁️ " ``` -## Package Version +## Paketversion -The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards` and `dart` packages. +Das `Package` Modul wird angezeigt, wenn das aktuelle Verzeichnis das Repository für ein Paket ist, und zeigt dessen aktuelle Version an. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards` and `dart` packages. - [**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 @@ -2357,11 +2409,11 @@ The `package` module is shown when the current directory is the repository for a | Option | Standardwert | Beschreibung | | ----------------- | --------------------------------- | ------------------------------------------------------------------------- | | `format` | `"is [$symbol$version]($style) "` | Das Format für das Modul. | -| `symbol` | `"📦 "` | The symbol used before displaying the version the package. | +| `symbol` | `"📦 "` | Symbol das vor der Paketversion angezeigt wird. | | `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` | Disables the `package` module. | +| `disabled` | `false` | Deaktiviert das `package`-Modul. | ### Variables @@ -2426,7 +2478,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 @@ -2436,12 +2488,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` | `"🐘 "` | The symbol used before displaying the version of PHP. | +| `symbol` | `"🐘 "` | Symbol das vor der PHP-Version angezeigt wird. | | `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` | Disables the `php` module. | +| `disabled` | `false` | Deaktiviert das `php`-Modul. | ### Variables @@ -2489,13 +2541,13 @@ By default the module will be shown if any of the following conditions are met: ### Variables -| Variable | Beispiel | Beschreibung | -| --------- | ---------- | ------------------------------------- | -| version | `v0.12.24` | The version of `pulumi` | -| stack | `dev` | The current Pulumi stack | -| username | `alice` | The current Pulumi username | -| symbol | | Spiegelt den Wert der Option `symbol` | -| style\* | | Spiegelt den Wert der Option `style` | +| Variable | Beispiel | Beschreibung | +| ------------ | ---------- | ------------------------------------- | +| version | `v0.12.24` | The version of `pulumi` | +| stack | `dev` | The current Pulumi stack | +| benutzername | `alice` | The current Pulumi username | +| 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 @@ -2523,7 +2575,7 @@ format = "[$symbol$stack]($style) " The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. By default the module will be shown if any of the following conditions are met: -- The current directory contains a `spago.dhall` file +- Das aktuelle Verzeichnis enthält eine `spago.dhall`-Datei - The current directory contains a file with the `.purs` extension ### Optionen @@ -2566,15 +2618,15 @@ If `pyenv_version_name` is set to `true`, it will display the pyenv version name By default the module will be shown if any of the following conditions are met: -- The current directory contains a `.python-version` file -- The current directory contains a `Pipfile` file +- Das aktuelle Verzeichnis enthält eine `.python-version`-Datei +- Das aktuelle Verzeichnis enthält eine `Pipfile`-Datei - The current directory contains a `__init__.py` file -- The current directory contains a `pyproject.toml` file -- The current directory contains a `requirements.txt` file -- The current directory contains a `setup.py` file -- The current directory contains a `tox.ini` file -- The current directory contains a file with the `.py` extension. -- A virtual environment is currently activated +- Das aktuelle Verzeichnis enthält eine `pyproject.toml`-Datei +- Das aktuelle Verzeichnis enthält eine `requirements.txt`-Datei +- Das aktuelle Verzeichnis enthält eine `setup.py`-Datei +- Das aktuelle Verzeichnis enthält eine `tox.ini`-Datei +- Das aktuelle Verzeichnis enthält eine Datei mit der `.py`-Erweiterung. +- Ein virtualenv ist momentan aktiv ### Optionen @@ -2584,13 +2636,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` | Use pyenv to get Python version | +| `pyenv_version_name` | `false` | Verwende `pyenv` um die Python-Versionzu beziehen. | | `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` | Disables the `python` module. | +| `disabled` | `false` | Deaktiviert das `python`-Modul. | ::: tip @@ -2731,9 +2783,9 @@ symbol = "🔴 " By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). Das Modul wird nur dann angezeigt, wenn eine der folgenden Bedingungen zutrifft: -- The current directory contains a `Gemfile` file +- Das aktuelle Verzeichnis enthält eine `Gemfile`-Datei - The current directory contains a `.ruby-version` file -- The current directory contains a `.rb` file +- Das aktuelle Verzeichnis enthält eine `.rb`-Datei - The environment variables `RUBY_VERSION` or `RBENV_VERSION` are set Starship gets the current Ruby version by running `ruby -v`. @@ -2750,7 +2802,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` | Disables the `ruby` module. | +| `disabled` | `false` | Deaktiviert das `ruby`-Modul. | ### Variables @@ -2775,8 +2827,8 @@ symbol = "🔺 " By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). Das Modul wird nur dann angezeigt, wenn eine der folgenden Bedingungen zutrifft: -- The current directory contains a `Cargo.toml` file -- The current directory contains a file with the `.rs` extension +- Das aktuelle Verzeichnis enthält eine `Cargo.toml`-Datei +- Das aktuelle Verzeichnis enthält eine Datei mit der `.rs`-Erweiterung ### Optionen @@ -2789,7 +2841,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` | Disables the `rust` module. | +| `disabled` | `false` | Deaktiviert das `rust`-Modul. | ### Variables @@ -2856,7 +2908,7 @@ The `shell` module shows an indicator for currently used shell. ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. ::: @@ -2872,7 +2924,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | `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. | +| `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) "` | Das Format für das Modul. | @@ -2884,7 +2936,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | Variable | Standardwert | Beschreibung | | --------- | ------------ | ---------------------------------------------------------- | | indicator | | Mirrors the value of `indicator` for currently used shell. | -| style\* | | Mirrors the value of option `style`. | +| style\* | | Spiegelt den Wert der Option `style`. | *: This variable can only be used as a part of a style string @@ -2969,13 +3021,46 @@ The `singularity` module shows the current [Singularity](https://sylabs.io/singu format = '[📦 \[$env\]]($style) ' ``` +## Spack + +The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set. + +### Optionen + +| Option | Standardwert | Beschreibung | +| ------------------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `truncation_length` | `1` | The number of directories the environment path should be truncated to. `0` bedeutet keine Kürzung. Beachte auch die Beschreibung für das [`directory`](#directory) Modul. | +| `symbol` | `"🅢 "` | Symbol das vor dem Umgebungsnamen angezeigt wird. | +| `style` | `"bold blue"` | Stil für dieses Modul. | +| `format` | `"via [$symbol$environment]($style) "` | Das Format für das Modul. | +| `disabled` | `false` | Disables the `spack` module. | + +### Variables + +| Variable | Beispiel | Beschreibung | +| ----------- | ------------ | ------------------------------------- | +| environment | `astronauts` | The current spack environment | +| 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 + +[spack] +format = "[$symbol$environment](dimmed blue) " +``` + ## Status 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 -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. ::: @@ -3035,7 +3120,7 @@ The `sudo` module displays if sudo credentials are currently cached. The module ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. ::: @@ -3129,7 +3214,7 @@ By default the Terraform version is not shown, since this is slow for current ve By default the module will be shown if any of the following conditions are met: -- The current directory contains a `.terraform` folder +- Das aktuelle Verzeichnis enthält eine `.terraform`-Datei - Current directory contains a file with the `.tf`, `.tfplan` or `.tfstate` extensions ### Optionen @@ -3143,7 +3228,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` | Disables the `terraform` module. | +| `disabled` | `false` | Deaktiviert das `terraform` Modul. | ### Variables @@ -3178,33 +3263,33 @@ format = "[🏎💨 $workspace]($style) " ## Uhrzeit -The `time` module shows the current **local** time. The `format` configuration value is used by the [`chrono`](https://crates.io/crates/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) to see what options are available. +Das `time` Modul zeigt die aktuelle **lokale** Zeit an. Der `format` Wert wird von der crate [`chrono`](https://crates.io/crates/chrono) benutzt um die Zeit zu formatieren. Schau dir [die chrono strftime Dokumentation](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) an, um die möglichen Optionen zu sehen. ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. ::: ### Optionen -| Option | Standardwert | 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 | +| Option | Standardwert | Beschreibung | +| ----------------- | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `format` | `"at [$time]($style) "` | The format string for the module. | +| `use_12hr` | `false` | Aktiviert die Formatierung der Uhrzeit im 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"` | Legt das UTC-Offset fest, das verwendet werden soll. 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 | -If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Otherwise, it defaults to `"%T"`. Manually setting `time_format` will override the `use_12hr` setting. +If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Ansonsten ist der Standardwert hierfür `"%T"`. Manually setting `time_format` will override the `use_12hr` setting. ### Variables | Variable | Beispiel | Beschreibung | | --------- | ---------- | ------------------------------------ | -| time | `13:08:10` | The current time. | +| uhrzeit | `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 @@ -3222,14 +3307,14 @@ utc_time_offset = "-5" time_range = "10:00:00-14:00:00" ``` -## Username +## Benutzername -The `username` module shows active user's username. Das Modul wird nur dann angezeigt, wenn eine der folgenden Bedingungen zutrifft: +Das Modul `username` zeigt den Benutzernamen des aktiven Benutzers. Das Modul wird nur dann angezeigt, wenn eine der folgenden Bedingungen zutrifft: -- The current user is root -- The current user isn't the same as the one that is logged in -- The user is currently connected as an SSH session -- The variable `show_always` is set to true +- The current user is root/admin +- Der aktuelle Benutzer ist nicht derjenige, der derzeit angemeldet ist +- Der Benutzer ist über eine SSH-Sitzung verbunden +- Die Variale `show_always` ist auf `true` gesetzt ::: tip @@ -3239,13 +3324,13 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, ` ### Optionen -| Option | Standardwert | Beschreibung | -| ------------- | ----------------------- | ------------------------------------- | -| `style_root` | `"bold red"` | The style used when the user is root. | -| `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. | +| Option | Standardwert | Beschreibung | +| ------------- | ----------------------- | ------------------------------------------- | +| `style_root` | `"bold red"` | The style used when the user is root/admin. | +| `style_user` | `"bold yellow"` | Stil bei allen anderen Benutzern. | +| `format` | `"[$user]($style) in "` | Das Format für das Modul. | +| `show_always` | `false` | `username`-Modul immer anzeigen. | +| `disabled` | `false` | Deaktiviert das `username`-Modul. | ### Variables @@ -3417,9 +3502,9 @@ The `custom` modules show the output of some arbitrary commands. These modules will be shown if any of the following conditions are met: -- The current directory contains a file whose name is in `files` -- The current directory contains a directory whose name is in `directories` -- The current directory contains a file whose extension is in `extensions` +- The current directory contains a file whose name is in `detect_files` +- The current directory contains a directory whose name is in `detect_folders` +- The current directory contains a file whose extension is in `detect_extensions` - The `when` command returns 0 - The current Operating System (std::env::consts::OS) matchs with `os` field if defined. @@ -3451,20 +3536,22 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt ### Optionen -| Option | Standardwert | Beschreibung | -| ------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `command` | `""` | The command whose output should be printed. The command will be passed on stdin to the shell. | -| `when` | | A shell command used as a condition to show the module. 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`. | -| `files` | `[]` | The files that will be searched in the working directory for a match. | -| `directories` | `[]` | The directories that will be searched in the working directory for a match. | -| `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"` | Stil für dieses Modul. | -| `format` | `"[$symbol($output )]($style)"` | Das Format für das 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). | +| Option | Standardwert | Beschreibung | +| ------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `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`. | +| `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"` | Stil für dieses Modul. | +| `format` | `"[$symbol($output )]($style)"` | Das Format für das 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. | +| `ignore_timeout` | `false` | Ignore global `command_timeout` setting and keep running external commands, no matter how long they take. | ### Variables @@ -3487,7 +3574,7 @@ If unset, it will fallback to STARSHIP_SHELL and then to "sh" on Linux, and "cmd The `command` will be passed in on stdin. -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 -`. This behavior can be avoided by explicitly passing arguments to the shell, e.g. +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", "-"] @@ -3512,12 +3599,18 @@ Automatic detection of shells and proper parameters addition are currently imple [custom.foo] command = "echo foo" # shows output of command -files = ["foo"] # can specify filters but wildcards are not supported +detect_files = ["foo"] # can specify filters but wildcards are not supported when = """ test "$HOME" == "$PWD" """ format = " transcending [$output]($style)" [custom.time] command = "time /T" -extensions = ["pst"] # filters *.pst files +detect_extensions = ["pst"] # filters *.pst files shell = ["pwsh.exe", "-NoProfile", "-Command", "-"] + +[custom.time-as-arg] +command = "time /T" +detect_extensions = ["pst"] # filters *.pst files +shell = ["pwsh.exe", "-NoProfile", "-Command"] +use_stdin = false ``` diff --git a/docs/de-DE/guide/README.md b/docs/de-DE/guide/README.md index e5ee25cb..9ff0adfe 100644 --- a/docs/de-DE/guide/README.md +++ b/docs/de-DE/guide/README.md @@ -145,7 +145,7 @@ Starship with iTerm2 and the Snazzy theme @@ -160,7 +160,7 @@ - **Einfach:** schnell zu installieren – Betriebsbereit in nur wenigen Minuten.

-Explore the Starship docs  ▶ +Schau dir die Starship-Dokumentation an  ▶

@@ -173,7 +173,7 @@ ### Schritt 1. Installiere Starship -Select your operating system from the list below to view installation instructions: +Wähle dein Betriebssystem aus der Liste für detaillierte Installationsanweisungen:
Android @@ -264,7 +264,7 @@ Install Starship using any of the following package managers: ### Schritt 2. Richte deine Shell für die Nutzung von Starship ein -Configure your shell to initialize starship. Select yours from the list below: +Konfigurieren deine Shell um Starship zu initialisieren. Wähle dafür deine Shell aus der Liste aus:
Bash @@ -278,7 +278,7 @@ eval "$(starship init bash)"
-Cmd +⌘ 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: @@ -297,7 +297,7 @@ Trage folgendes am Ende von `~/.config/fish/rc.elv` ein: eval (starship init elvish) ``` -Note: Only Elvish v0.17+ is supported +Note: Only Elvish v0.18+ is supported
@@ -390,9 +390,9 @@ eval "$(starship init zsh)" ### Schritt 3. Starship konfigurieren -Start a new shell instance, and you should see your beautiful new shell prompt. If you're happy with the defaults, enjoy! +Starte eine neue Shell, um deinen neuen und schönen Prompt zu sehen. Wenn du mit den Defaults zufrieden bist, bist du bereits fertig! -If you're looking to further customize Starship: +Falls du Starship weiter anpassen möchtest: - **[Konfiguration](https://starship.rs/config/)** - Lerne, wie du Starship deinen Bedürfnissen nach anpassen kannst @@ -400,15 +400,15 @@ If you're looking to further customize Starship: ## 🤝 Mitwirken -We are always looking for contributors of **all skill levels**! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). +Wir laden Leute **aller Erfahrungsstufen** herzlich ein mitzumachen! Falls du dich mit dem Projekt vertaut machen willst, versuche ein [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). -If you are fluent in a non-English language, we greatly appreciate any help keeping our docs translated and up-to-date in other languages. If you would like to help, translations can be contributed on the [Starship Crowdin](https://translate.starship.rs/). +Wenn du eine andere Sprache flüssig sprichts, würden wir uns sehr freuen wenn du helfen würdest die Dokumentation in anderen Sprachen auf dem aktuellsten Stand zu halten. Hier kannst du bei der Übersetzung helfen [Starship Crowdin](https://translate.starship.rs/). -If you are interested in helping contribute to starship, please take a look at our [Contributing Guide](https://github.com/starship/starship/blob/master/CONTRIBUTING.md). Also, feel free to drop into our [Discord server](https://discord.gg/8Jzqu3T) and say hi. 👋 +Falls du an Starship mitwirken willst, wirf bitte einen Blick auf den [Contributing Guide](https://github.com/starship/starship/blob/master/CONTRIBUTING.md). Schau auch gerne auf unserem [Discord server](https://discord.gg/8Jzqu3T) vorbei. 👋 ## 💭 Inspiriert durch -Please check out these previous works that helped inspire the creation of starship. 🙏 +Checkt bitte diese älteren Projekte, die das Entstehen von Starhip inspiriert haben. 🙏 - **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** – A ZSH prompt for astronauts. @@ -418,9 +418,9 @@ Please check out these previous works that helped inspire the creation of starsh


- Starship rocket icon + Starship Raketen Icon

## 📝 Lizenz -Copyright © 2019-present, [Starship Contributors](https://github.com/starship/starship/graphs/contributors).
This project is [ISC](https://github.com/starship/starship/blob/master/LICENSE) licensed. +Copyright © 2019-present, [Starship Contributors](https://github.com/starship/starship/graphs/contributors).
Unter der [ISC](https://github.com/starship/starship/blob/master/LICENSE) Lizens. diff --git a/docs/de-DE/installing/README.md b/docs/de-DE/installing/README.md index 97e10c99..351a651b 100644 --- a/docs/de-DE/installing/README.md +++ b/docs/de-DE/installing/README.md @@ -1,4 +1,4 @@ -# Advanced Installation +# Erweiterte Installation Um Starship zu installieren, musst du zwei Dinge tun: diff --git a/docs/es-ES/README.md b/docs/es-ES/README.md index e4d17e12..e8599b8f 100644 --- a/docs/es-ES/README.md +++ b/docs/es-ES/README.md @@ -120,7 +120,7 @@ description: '¡Starship es el prompt minimalista, ultrarápido e infinitamente #### Elvish - ::: warning Solo se admite Elvish v0.17 o superior. ::: + ::: warning Solo se admite Elvish v0.18 o superior. ::: Añade el siguiente código al final de `~/.elvish/rc.elv`: @@ -144,13 +144,13 @@ description: '¡Starship es el prompt minimalista, ultrarápido e infinitamente #### Nushell - ::: advertencia Esto cambiará en el futuro. Only Nushell v0.60+ is supported. ::: Run the following: + ::: advertencia Esto cambiará en el futuro. Sólo se admite Nushell v0.60+. ::: Ejecuta lo siguiente: ```sh mkdir ~/.cache/starship starship init nu | save ~/.cache/starship/init.nu ``` - And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`): + Añade lo siguiente al final de tu configuración de Nushell (encuéntrala ejecutando `$nu.config-path`): ```sh mkdir ~/.cache/starship @@ -171,7 +171,7 @@ description: '¡Starship es el prompt minimalista, ultrarápido e infinitamente #### Cmd - Necesitas usar [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) con Cmd. Add the following to a file `starship.lua` and place this file in Clink scripts directory: + Necesitas usar [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) con Cmd. Añade lo siguiente a un archivo `starship.lua` y coloca este archivo en el directorio de scripts de Clink: ```lua -- starship.lua diff --git a/docs/es-ES/advanced-config/README.md b/docs/es-ES/advanced-config/README.md index 647c0567..c2c568c2 100644 --- a/docs/es-ES/advanced-config/README.md +++ b/docs/es-ES/advanced-config/README.md @@ -131,7 +131,7 @@ Invoke-Expression (&starship init powershell) Algunos intérpretes de órdenes soportan un prompt derecho que se renderiza en la misma línea que la entrada. Starship puede establecer el contenido del prompt correcto usando la opción `right_format`. Cualquier módulo que pueda ser usado en `format` también es soportado en `right_format`. La variable `$all` solo contendrá módulos no utilizados explícitamente en `format` o `right_format`. -Nota: El prompt derecho es una sola línea siguiendo la ubicación de entrada. Para alinear módulos arriba de la línea de entrada en un prompt multi-línea, vea el [módulo fill](/config/#fill). +Nota: El prompt derecho es una sola línea siguiendo la ubicación de entrada. Para alinear los módulos arriba de la línea de entrada en un prompt multi-línea, vea el [módulo `fill`](/config/#fill). `right_format` está actualmente soportado para los siguientes intérpretes de comandos: elvish, fish, zsh, xonsh, cmd. diff --git a/docs/es-ES/config/README.md b/docs/es-ES/config/README.md index 502eaf7a..69c37ec8 100644 --- a/docs/es-ES/config/README.md +++ b/docs/es-ES/config/README.md @@ -9,14 +9,17 @@ mkdir -p ~/.config && touch ~/.config/starship.toml Toda la configuración de starship se incluye en este fichero [TOML](https://github.com/toml-lang/toml): ```toml -# Inserta una línea en blanco al inicio del prompt +# Obtiene las completaciones del editor basadas en el esquema de configuración +"$schema" = 'https://starship.rs/config-schema.json' + +# Inserta una línea en blanco entre los prompts del intérprete de comandos add_newline = true -# Reemplaza el símbolo "❯" por "➜" en el prompt -[character] # El nombre del módulo que se está configurando es "character" -success_symbol = "[➜](bold green)"# El segmento "success_symbol" se establece como "➜" con el color "bold green" +# Reemplaza el símbolo "❯" en el prompt por "➜" +[character] # El nombre del módulo que estamos configurando es "character" +success_symbol = "[➜](bold green)" # El segmento "success_symbol" se está oonfigurando es "➜" con el color "bold green" -# Deshabilita el módulo "package", ocultándolo por completo del prompt +# Deshabilta el módulo "package", ocultándolo del prompt completamente [package] disabled = true ``` @@ -180,7 +183,7 @@ El `format` predeterminado se utiliza para definir el formato del prompt, si est ```toml format = "$all" -# Which is equivalent to +# El cual es equivalente a format = """ $username\ $hostname\ @@ -199,6 +202,7 @@ $hg_branch\ $docker_context\ $package\ $buf\ +$c\ $cmake\ $cobol\ $container\ @@ -235,6 +239,7 @@ $vagrant\ $zig\ $nix_shell\ $conda\ +$spack\ $memory_usage\ $aws\ $gcloud\ @@ -263,9 +268,9 @@ format="$all$directory$character" ## AWS -The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. Éste se basa en las variables de entorno `AWS_REGION`, `AWS_DEFAULT_REGION`, y `AWS_PROFILE` del fichero `~/.aws/config`. Este módulo también muestra un temporizador de caducidad al usar credenciales temporales. +El módulo `aws` muestra la región y el perfil actual de AWS cuando las credenciales, un `credential_process` o un `sso_start_url` se han configurado. Alternativamente, puedes forzar a este módulo a mostrar la región y el perfil incluso cuando las credenciales no han sido configuradas con la opción `force_display`. Éste se basa en las variables de entorno `AWS_REGION`, `AWS_DEFAULT_REGION`, y `AWS_PROFILE` del archivo `~/.aws/config`. Este módulo también muestra un temporizador de caducidad al usar credenciales temporales. -El módulo mostrará un perfil solamente si sus credenciales están presentes en `~/.aws/credentials` o un `credential_process` está definido en `~/.aws/config`. Alternativamente, es suficiente con tener cualquiera de las siguientes variables de entorno `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, o `AWS_SESSION_TOKEN`. +El módulo mostrará un perfil solamente si sus credenciales están presentes en `~/.aws/credentials` o un `credential_process` está definido en `~/.aws/config`. Alternativamente, es suficiente con tener cualquiera de las siguientes variables de entorno `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, o `AWS_SESSION_TOKEN`. Si la opción `force_display` se establece en `true`, toda la información disponible será mostrada incluso si las condiciones anteriores no se respetan. Cuando se utiliza [aws-vault](https://github.com/99designs/aws-vault), el perfil se lee de la variable de entorno `AWS_VAULT` y la fecha de expiración de credenciales se lee de la variable de entorno `AWS_SESSION_EXPIRATION`. @@ -275,15 +280,16 @@ Cuando se utiliza [AWSume](https://awsu.me), el perfil se lee de la variable de ### Opciones -| Opción | Por defecto | Descripción | -| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------- | -| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | El formato del módulo. | -| `symbol` | `"☁️ "` | El símbolo que se muestra antes del perfil de AWS. | -| `region_aliases` | | Tabla de alias de región para mostrar además del nombre AWS. | -| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | -| `style` | `"bold yellow"` | El estilo del módulo. | -| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. | -| `disabled` | `false` | Disables the `AWS` module. | +| Opción | Por defecto | Descripción | +| ------------------- | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------ | +| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | El formato del módulo. | +| `symbol` | `"☁️ "` | El símbolo que se muestra antes del perfil de AWS. | +| `region_aliases` | | Tabla de alias de región para mostrar además del nombre AWS. | +| `profile_aliases` | | Tabla de alias de región para mostrar además del nombre AWS. | +| `style` | `"bold yellow"` | El estilo del módulo. | +| `expiration_symbol` | `X` | El símbolo mostrado cuando las credenciales temporales han caducado. | +| `disabled` | `false` | Desactiva el módulo AWS. | +| `force_display` | `false` | Si `true` muestra información incluso si `credentials`, `credential_process` o `sso_start_url` no han sido configuradas. | ### Variables @@ -435,29 +441,29 @@ discharging_symbol = "💦" ## Buf -The `buf` module shows the currently installed version of [Buf](https://buf.build). By default, the module is shown if all of the following conditions are met: +El módulo `buf` muestra la versión instalada de [Buf](https://buf.build). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: -- The [`buf`](https://github.com/bufbuild/buf) CLI is installed. -- The current directory contains a [`buf.yaml`](https://docs.buf.build/configuration/v1/buf-yaml), [`buf.gen.yaml`](https://docs.buf.build/configuration/v1/buf-gen-yaml), or [`buf.work.yaml`](https://docs.buf.build/configuration/v1/buf-work-yaml) configuration file. +- La CLI de [`buf`](https://github.com/bufbuild/buf) está instalada. +- El directorio actual contiene un archivo de configuración [`buf.yaml`](https://docs.buf.build/configuration/v1/buf-yaml), [`buf.gen.yaml`](https://docs.buf.build/configuration/v1/buf-gen-yaml), o [`buf.work.yaml`](https://docs.buf.build/configuration/v1/buf-work-yaml). ### Opciones -| Opción | Por defecto | Descripción | -| ------------------- | ------------------------------------------------------------ | ----------------------------------------------------- | -| `format` | `'with [$symbol($version \(Buf $buf_version\) )]($style)'` | The format for the `buf` module. | -| `version_format` | `"v${raw}"` | El formato de versión. | -| `symbol` | `"🦬 "` | The symbol used before displaying the version of Buf. | -| `detect_extensions` | `[]` | Qué extensiones deberían activar este módulo. | -| `detect_files` | `["buf.yaml", "buf.gen.yaml", "buf.work.yaml"]` | Qué nombres de archivo deberían activar este módulo. | -| `detect_folders` | `[]` | Qué carpetas deberían activar estos módulos. | -| `style` | `"bold blue"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `elixir` module. | +| Opción | Por defecto | Descripción | +| ------------------- | ------------------------------------------------------------ | ---------------------------------------------------- | +| `format` | `'with [$symbol($version \(Buf $buf_version\) )]($style)'` | El formato para el módulo `buf`. | +| `version_format` | `"v${raw}"` | El formato de versión. | +| `symbol` | `"🦬 "` | El símbolo usado antes de mostrar la versión de Buf. | +| `detect_extensions` | `[]` | Qué extensiones deberían activar este módulo. | +| `detect_files` | `["buf.yaml", "buf.gen.yaml", "buf.work.yaml"]` | Qué nombres de archivo deberían activar este módulo. | +| `detect_folders` | `[]` | Qué carpetas deberían activar estos módulos. | +| `style` | `"bold blue"` | El estilo del módulo. | +| `disabled` | `false` | Desactiva el módulo `elixir`. | ### Variables | Variable | Ejemplo | Descripción | | ------------- | -------- | -------------------------------------- | -| `buf_version` | `v1.0.0` | The version of `buf` | +| `buf_version` | `v1.0.0` | La versión de `buf` | | `symbol` | | Refleja el valor de la opción `symbol` | | `style`* | | Refleja el valor de la opción `style` | @@ -472,38 +478,84 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil symbol = "🦬 " ``` +## C + +El módulo `c` muestra información sobre su compilador de C. Por defecto el módulo se mostrará si el directorio actual contiene un archivo `.c` o `.h`. + +### Opciones + +| Opción | Por defecto | Descripción | +| ------------------- | --------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version(-$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` | `"C "` | El símbolo usado antes de mostrar los detalles del compilador | +| `detect_extensions` | `["c", "h"]` | 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. | +| `commands` | [ [ "cc", "--version" ], [ "gcc", "--version" ], [ "clang", "--version" ] ] | Cómo detectar cuál compilador es | +| `style` | `"bold 149"` | El estilo del módulo. | +| `disabled` | `false` | Deshabilita el módulo `c`. | + +### Variables + +| Variable | Ejemplo | Descripción | +| -------- | ------- | -------------------------------------- | +| name | clang | El nombre del compilador | +| version | 13.0.0 | La versión del compilador | +| symbol | | Refleja el valor de la opción `symbol` | +| style | | Refleja el valor de la opción `style` | + +NB que `versión` no está en el formato por defecto. + +### Commands + +La opción de `commands` acepta una lista de comandos para determinar la versión y el nombre del compilador. + +Cada comando se representa como una lista del nombre del ejecutable seguido de sus argumentos, generalmente algo como `["mycc", "--version"]`. Starship intentará ejecutar cada comando hasta que obtenga un resultado en STDOUT. + +Si un compilador C no es compatible con este módulo, puede solicitarlo [planteando un problema en GitHub](https://github.com/starship/starship/). + +### Ejemplo + +```toml +# ~/.config/starship.toml + +[c] +format = "via [$name $version]($style)" +``` + ## Character -The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. +El módulo `character` muestra un carater (normalmente una flecha) tras el texto que introduces en el terminal. -The character will tell you whether the last command was successful or not. It can do this in two ways: +El carácter te dirá si el último comando funcionó o no. Se puede hacer de dos maneras: -- changing color (`red`/`green`) -- changing shape (`❯`/`✖`) +- Cambiando el color (`red`/`green`) +- Cambiando la forma (`.`/`✖`) -By default it only changes color. If you also want to change its shape take a look at [this example](#with-custom-error-shape). +Por defecto sólo cambia el color. Si también se quiere cambiar su forma, ver [este ejemplo](#with-custom-error-shape). ::: warning -`vicmd_symbol` is only supported in cmd, fish and zsh. +`vicmd_symbol` solo es compatible con cmd, fish y zsh. ::: ### Opciones -| Opción | Por defecto | Descripción | -| ---------------- | ------------------- | -------------------------------------------------------------------------------- | -| `format` | `"$symbol "` | The format string used before the text input. | -| `success_symbol` | `"[❯](bold green)"` | The format string used before the text input if the previous command succeeded. | -| `error_symbol` | `"[❯](bold red)"` | The format string used before the text input if the previous command failed. | -| `vicmd_symbol` | `"[❮](bold green)"` | The format string used before the text input if the shell is in vim normal mode. | -| `disabled` | `false` | Disables the `character` module. | +| Opción | Por defecto | Descripción | +| ---------------- | ------------------- | ------------------------------------------------------------------------------------------------------- | +| `format` | `"$symbol "` | La cadena de formato usada antes de la entrada de texto. | +| `success_symbol` | `"[❯](bold green)"` | La cadena de formato usada antes de la entrada de texto si el comando anterior tuvo éxito. | +| `error_symbol` | `"[❯](bold red)"` | La cadena de formato usada antes de la entrada de texto si el comando anterior falló. | +| `vicmd_symbol` | `"[❮](bold green)"` | El cadena de formato antes de la entrada de texto si el intérprete de comandos está en modo vim normal. | +| `disabled` | `false` | Desactiva el módulo `character`. | ### Variables -| Variable | Ejemplo | Descripción | -| -------- | ------- | --------------------------------------------------------------------- | -| symbol | | A mirror of either `success_symbol`, `error_symbol` or `vicmd_symbol` | +| Variable | Ejemplo | Descripción | +| -------- | ------- | -------------------------------------------------------------- | +| symbol | | Un espejo de `success_symbol`, `error_symbol` o `vicmd_symbol` | ### Ejemplos @@ -538,10 +590,10 @@ vicmd_symbol = "[V](bold green) " ## CMake -The `cmake` module shows the currently installed version of [CMake](https://cmake.org/). By default the module will be activated if any of the following conditions are met: +El módulo `cmake` muestra la versión actualmente instalada de [CMake](https://cmake.org/). Por defecto el módulo se activará si se cumplen cualquiera de las siguientes condiciones: -- The current directory contains a `CMakeLists.txt` file -- The current directory contains a `CMakeCache.txt` file +- El directorio actual contiene un archivo `CMakeLists.txt` +- El directorio actual contiene un archivo `CMakeCache.txt` ### Opciones @@ -549,18 +601,18 @@ The `cmake` module shows the currently installed version of [CMake](https://cmak | ------------------- | -------------------------------------- | --------------------------------------------------------------------------------------- | | `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 the version of cmake. | -| `detect_extensions` | `[]` | Which extensions should trigger this module | -| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | -| `detect_folders` | `[]` | Which folders should trigger this module | +| `symbol` | `"△ "` | El símbolo usado antes de la versión de cmake. | +| `detect_extensions` | `[]` | Qué extensiones deben activar este módulo | +| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Qué nombres de archivo deben activar este módulo | +| `detect_folders` | `[]` | Qué carpetas deben activar este módulo | | `style` | `"bold blue"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `cmake` module. | +| `disabled` | `false` | Desactiva el módulo `cmake`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | --------- | -------------------------------------- | -| version | `v3.17.3` | The version of cmake | +| version | `v3.17.3` | La versión de cmake | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -568,29 +620,29 @@ The `cmake` module shows the currently installed version of [CMake](https://cmak ## COBOL / GNUCOBOL -The `cobol` module shows the currently installed version of COBOL. By default, the module will be shown if any of the following conditions are met: +El módulo `cobol` muestra la versión instalada de COBOL. Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: -- The current directory contains any files ending in `.cob` or `.COB` -- The current directory contains any files ending in `.cbl` or `.CBL` +- El directorio actual contiene cualquier archivo que termine en `.cob` o `.COB` +- El directorio actual contiene cualquier archivo que termine en `.cbl` o `.CBL` ### Opciones | Opción | Por defecto | Descripción | | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | -| `symbol` | `"⚙️ "` | The symbol used before displaying the version of COBOL. | +| `symbol` | `"⚙️ "` | El símbolo usado antes de mostrar la versión de COBOL. | | `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` | | `style` | `"bold blue"` | El estilo del módulo. | | `detect_extensions` | `["cbl", "cob", "CBL", "COB"]` | 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. | -| `disabled` | `false` | Disables the `cobol` module. | +| `disabled` | `false` | Deshabilita el módulo `cobol`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | ---------- | -------------------------------------- | -| version | `v3.1.2.0` | The version of `cobol` | +| version | `v3.1.2.0` | La versión de `cobol` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -598,35 +650,35 @@ The `cobol` module shows the currently installed version of COBOL. By default, t ## Tiempo de ejecución -The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists. +El módulo `cmd_duration` muestra cuánto tiempo tardó el último comando en ejecutarse. El módulo se mostrará solo si el comando llevó dos segundos o más, o el valor de `min_time`, si existe. -::: warning Do not hook the DEBUG trap in Bash +::: warning No utilizar DEBUG en Bash -If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. +Si estás usando Starship con `bash`, no uses `DEBUG` después de ejecutar `eval $(starship init $0)`, o el módulo **se romperá**. ::: -Bash users who need preexec-like functionality can use [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Simply define the arrays `preexec_functions` and `precmd_functions` before running `eval $(starship init $0)`, and then proceed as normal. +Los usuarios de bash que necesiten la funcionalidad preexec-like pueden usar el framework rcaloras's bash_preexec. Simplemente define los arrays preexec_functions y precmd_functions antes de ejecutar eval $(starship init $0), y continúa con normalidad. Basta con definir los arrays `preexec_functions` y `precmd_functions` antes de ejecutar `eval $(starship init $0)`, y luego proceder como siempre. ### Opciones -| Opción | Por defecto | Descripción | -| ---------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). | -| `show_milliseconds` | `false` | Show milliseconds in addition to seconds for the duration. | -| `format` | `"took [$duration]($style) "` | El formato del módulo. | -| `style` | `"bold yellow"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `cmd_duration` module. | -| `show_notifications` | `false` | Show desktop notifications when command completes. | -| `min_time_to_notify` | `45_000` | Shortest duration for notification (in milliseconds). | -| `notification_timeout` | | Duration to show notification for (in milliseconds). If unset, notification timeout will be determined by daemon. Not all notification daemons honor this option. | +| Opción | Por defecto | Descripción | +| ---------------------- | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `min_time` | `2_000` | Duración mínima para mostrar el tiempo de ejecución (en milisegundos) | +| `show_milliseconds` | `false` | Muestra la duración con precisión en milisegundos. | +| `format` | `"took [$duration]($style) "` | El formato del módulo. | +| `style` | `"bold yellow"` | El estilo del módulo. | +| `disabled` | `false` | Desactiva el módulo `cmd_duration`. | +| `show_notifications` | `false` | Muestra notificaciones de escritorio cuando se complete el comando. | +| `min_time_to_notify` | `45_000` | Duración mínima para mostrar el tiempo de ejecución (en milisegundos). | +| `notification_timeout` | | Duración para mostrar la notificación (en milisegundos). Si no se establece, el tiempo de espera para notificar será determinado por el demonio. No todos los demonios de notificaciones honran esta opción. | ### Variables -| Variable | Ejemplo | Descripción | -| --------- | -------- | --------------------------------------- | -| duration | `16m40s` | The time it took to execute the command | -| style\* | | Refleja el valor de la opción `style` | +| Variable | Ejemplo | Descripción | +| --------- | -------- | ------------------------------------------ | +| duration | `16m40s` | El tiempo que tardó en ejecutar el comando | +| style\* | | Refleja el valor de la opción `style` | *: Esta variable sólo puede ser usada como parte de una cadena de estilo @@ -642,30 +694,30 @@ format = "underwent [$duration](bold yellow)" ## Conda -The `conda` module shows the current [Conda](https://docs.conda.io/en/latest/) environment, if `$CONDA_DEFAULT_ENV` is set. +El módulo `conda` muestra el entorno actual [Conda](https://docs.conda.io/en/latest/), si `$CONDA_DEFAULT_ENV` está configurado. ::: tip -This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. +Esto no modifica el propio símbolo de sistema de conda. En caso de querer suprimirlo, ejecuta `conda config --set changeps1 False`. ::: ### Opciones -| Opción | Por defecto | Descripción | -| ------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `truncation_length` | `1` | The number of directories the environment path should be truncated to, if the environment was created via `conda create -p [path]`. `0` means no truncation. Also see the [`directory`](#directory) module. | -| `symbol` | `"🅒 "` | The symbol used before the environment name. | -| `style` | `"bold green"` | El estilo del módulo. | -| `format` | `"via [$symbol$environment]($style) "` | El formato del módulo. | -| `ignore_base` | `true` | Ignores `base` environment when activated. | -| `disabled` | `false` | Disables the `conda` module. | +| Opción | Por defecto | Descripción | +| ------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `truncation_length` | `1` | El número de directorios a los que se debe truncar la variable de entorno, si el entorno fue creado usando `conda create -p [path]`. `0` significa sin truncamiento. Mirar también el módulo [`directory`](#directory). | +| `symbol` | `"🅒 "` | El símbolo usado antes del nombre del entorno. | +| `style` | `"bold green"` | El estilo del módulo. | +| `format` | `"via [$symbol$environment]($style) "` | El formato del módulo. | +| `ignore_base` | `true` | Ignora el entorno `base` cuando se activa. | +| `disabled` | `false` | Desactiva el módulo `conda`. | ### Variables | Variable | Ejemplo | Descripción | | ----------- | ------------ | -------------------------------------- | -| environment | `astronauts` | The current conda environment | +| environment | `astronauts` | El entorno conda actual | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -680,24 +732,24 @@ This does not suppress conda's own prompt modifier, you may want to run `conda c format = "[$symbol$environment](dimmed green) " ``` -## Container +## Contenedor -The `container` module displays a symbol and container name, if inside a container. +El módulo `container` muestra el símbolo y nombre del contenedor, si está dentro de un contenedor. ### Opciones -| Opción | Por defecto | Descripción | -| ---------- | -------------------------------------- | ----------------------------------------- | -| `symbol` | `"⬢"` | The symbol shown, when inside a container | -| `style` | `"bold red dimmed"` | El estilo del módulo. | -| `format` | `"[$symbol \\[$name\\]]($style) "` | El formato del módulo. | -| `disabled` | `false` | Disables the `container` module. | +| Opción | Por defecto | Descripción | +| ---------- | -------------------------------------- | ---------------------------------------------------------------- | +| `symbol` | `"⬢"` | El símbolo mostrado, cuando se encuentra dentro de un contenedor | +| `style` | `"bold red dimmed"` | El estilo del módulo. | +| `format` | `"[$symbol \\[$name\\]]($style) "` | El formato del módulo. | +| `disabled` | `false` | Deshabilita el módulo `container`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | ------------------- | -------------------------------------- | -| name | `fedora-toolbox:35` | The name of the container | +| name | `fedora-toolbox:35` | El nombre del contenedor | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -714,29 +766,29 @@ format = "[$symbol \\[$name\\]]($style) " ## Crystal -The `crystal` module shows the currently installed version of [Crystal](https://crystal-lang.org/). By default the module will be shown if any of the following conditions are met: +El módulo `cristal` muestra la versión instalada de [Crystal](https://crystal-lang.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: -- The current directory contains a `shard.yml` file -- The current directory contains a `.cr` file +- El directorio actual contiene un fichero `shard.yml` +- El directorio actual contiene un fichero `.cr` ### Opciones | Opción | Por defecto | Descripción | | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | -| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | +| `symbol` | `"🔮 "` | Símbolo usado antes de la versión de Crystal. | | `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` | | `style` | `"bold red"` | El estilo del módulo. | | `detect_extensions` | `["cr"]` | Qué extensiones deberían activar este módulo. | | `detect_files` | `["shard.yml"]` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | -| `disabled` | `false` | Disables the `crystal` module. | +| `disabled` | `false` | Desactiva el módulo `crystal`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | --------- | -------------------------------------- | -| version | `v0.32.1` | The version of `crystal` | +| version | `v0.32.1` | La versión de `crystal` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -753,11 +805,11 @@ format = "via [✨ $version](bold blue) " ## Dart -The `dart` module shows the currently installed version of [Dart](https://dart.dev/). By default the module will be shown if any of the following conditions are met: +El módulo `dart` muestra la versión instalada de [Dart](https://dart.dev/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: -- The current directory contains a file with `.dart` extension -- The current directory contains a `.dart_tool` directory -- The current directory contains a `pubspec.yaml`, `pubspec.yml` or `pubspec.lock` file +- El directorio actual contiene un archivo con la extensión `.dart` +- El directorio actual contiene un directorio `.dart_tool` +- El directorio actual contiene un archivo `pubspec.yaml`, `pubspec.yml` o `pubspec.lock` ### Opciones @@ -765,18 +817,18 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d | ------------------- | ------------------------------------------------- | --------------------------------------------------------------------------------------- | | `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 Dart | +| `symbol` | `"🎯 "` | Una cadena de formato que representa el símbolo de Dart | | `detect_extensions` | `["dart"]` | Qué extensiones deberían activar este módulo. | | `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `[".dart_tool"]` | Qué carpetas deberían activar este módulo. | | `style` | `"bold blue"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `dart` module. | +| `disabled` | `false` | Desactiva el módulo `dart`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `v2.8.4` | The version of `dart` | +| version | `v2.8.4` | La versión de `dart` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -793,28 +845,28 @@ format = "via [🔰 $version](bold red) " ## Deno -The `deno` module shows you your currently installed version of [Deno](https://deno.land/). By default the module will be shown if any of the following conditions are met: +El módulo `deno` le muestra la versión instalada de [Deno](https://deno.land/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: -- The current directory contains a `deno.json`, `deno.jsonc`, `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file +- El directorio actual contiene un archivo `deno.json`, `deno.jsonc`, `mod.ts`, `mod.js`, `deps.ts` o `deps.js` ### Opciones -| Opción | Por defecto | Descripción | +| Opción | Predeterminado | Descripción | | ------------------- | ----------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | | `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"🦕 "` | A format string representing the symbol of Deno | +| `symbol` | `"🦕 "` | Una cadena de formato que representa el símbolo de Deno | | `detect_extensions` | `[]` | Qué extensiones deberían activar este módulo. | | `detect_files` | `["deno.json", "deno.jsonc", "mod.ts", "mod.js", "deps.ts", "deps.js"]` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | | `style` | `"green bold"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `deno` module. | +| `disabled` | `false` | Deshabilita el módulo `deno`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `v1.8.3` | The version of `deno` | +| version | `v1.8.3` | La versión de `deno` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -829,39 +881,39 @@ format = "via [🦕 $version](green bold) " ## Directory -The `directory` module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in. +El módulo `directory` muestra la ruta hasta el directorio actual, mostrando tres directorios padre como máximo. Tu directorio se truncará a la raíz del repositorio git en el que estés. -When using the fish style pwd option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option. +Cuando usas el estilo fish de la opción pwd, en lugar de ocultar la ruta truncada, verás una versión acortada del nombre de cada directorio basada en el número que activa la opción. -For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, and the option set to `1`. You will now see `~/D/N/nixpkgs/pkgs`, whereas before it would have been `nixpkgs/pkgs`. +Por ejemplo, dado `~/Dev/Nix/nixpkgs/pkgs` donde `nixpkgs` es la raíz del repositorio y el valor de la opción es `1`. En ese caso, verás `~/D/N/nixpkgs/pkgs`, cuando antes hubiera sido `nixpkgs/pkgs`. ### Opciones -| Opción | Predeterminado | Descripción | -| ------------------- | ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. | -| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. | -| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | El formato del módulo. | -| `style` | `"bold cyan"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `directory` module. | -| `read_only` | `"🔒"` | The symbol indicating current directory is read only. | -| `read_only_style` | `"red"` | The style for the read only symbol. | -| `truncation_symbol` | `""` | The symbol to prefix to truncated paths. eg: "…/" | -| `repo_root_style` | `None` | The style for the root of the git repo. The default value is equivalent to `style`. | -| `repo_root_format` | `"[$before_root_path]($style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) "` | The format of a git repo when `repo_root_style` is defined. | -| `home_symbol` | `"~"` | The symbol indicating home directory. | -| `use_os_path_sep` | `true` | Use the OS specific path separator instead of always using `/` (e.g. `\` on Windows) | +| Opción | Predeterminado | Descripción | +| ------------------- | ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | +| `truncation_length` | `3` | El número de directorios padre a los que se debe truncar el directorio actual. | +| `truncate_to_repo` | `true` | Trunca o no hasta la raíz del repositorio git en el que estés. | +| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | El formato del módulo. | +| `style` | `"bold cyan"` | El estilo del módulo. | +| `disabled` | `false` | Desactiva el módulo `directory`. | +| `read_only` | `"🔒"` | El símbolo que indica si el directorio actual es de sólo lectura. | +| `read_only_style` | `"red"` | El estilo para el símbolo de sólo lectura. | +| `truncation_symbol` | `""` | El símbolo a prefijar a las rutas truncadas. ej: "…/" | +| `repo_root_style` | `None` | El estilo para la raíz del repositorio de git. El valor por defecto es equivalente al `style`. | +| `repo_root_format` | `"[$before_root_path]($style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) "` | El formato de un repositorio de git cuando `repo_root_style` está definido. | +| `home_symbol` | `"~"` | El símbolo que indica el directorio personal. | +| `use_os_path_sep` | `true` | Utiliza el separador de ruta del sistema operativo específico en lugar de usar siempre `/` (por ejemplo, `\` en Windows) |
-This module has a few advanced configuration options that control how the directory is displayed. +Este módulo tiene algunas opciones avanzadas de configuración que controlan cómo se muestra el directorio. -| Advanced Option | Predeterminado | Descripción | -| --------------------------- | -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `substitutions` | | A table of substitutions to be made to the path. | -| `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. | -| `use_logical_path` | `true` | If `true` render the logical path sourced from the shell via `PWD` or `--logical-path`. If `false` instead render the physical filesystem path with symlinks resolved. | +| Opciones avanzadas | Predeterminado | Descripción | +| --------------------------- | -------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `substitutions` | | Una tabla de sustituciones que se deben hacer a la ruta. | +| `fish_style_pwd_dir_length` | `0` | El número de caracteres a usar al aplicar la lógica de ruta pwd de la shell de fish. | +| `use_logical_path` | `true` | Si `true` renderiza la ruta lógica originada desde el intérprete de comandos a través de `PWD` o `--logical-path`. Si `false` en su lugar renderiza la ruta física del sistema de archivos con enlaces simbólicos resueltos. | -`substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD. +`substitutions` permite definir reemplazos arbitrarios para cadenas literales que ocurren en la ruta, por ejemplo prefijos largos de red o directorios de desarrollo (p. ej. Java). Ten en cuenta que esto desactivará el estilo PWD de fish. ```toml [directory.substitutions] @@ -869,7 +921,7 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an "src/com/long/java/path" = "mypath" ``` -`fish_style_pwd_dir_length` interacts with the standard truncation options in a way that can be surprising at first: if it's non-zero, the components of the path that would normally be truncated are instead displayed with that many characters. For example, the path `/built/this/city/on/rock/and/roll`, which would normally be displayed as as `rock/and/roll`, would be displayed as `/b/t/c/o/rock/and/roll` with `fish_style_pwd_dir_length = 1`--the path components that would normally be removed are displayed with a single character. For `fish_style_pwd_dir_length = 2`, it would be `/bu/th/ci/on/rock/and/roll`. +`fish_style_pwd_dir_length` interactúa con las opciones de truncamiento estándar de una manera que puede sorprenderse primero: si no es cero, los componentes de la ruta que normalmente se truncarían se muestran con esa cantidad de caracteres. Por ejemplo, la ruta `/built/this/city/on/rock/and/roll`, que normalmente se mostraría como `rock/and/roll`, se mostraría como `/b/t/c/o/rock/and/roll` con `fish_style_pwd_dir_length = 1`--los componentes de ruta que normalmente se eliminarían se muestran con un solo carácter. Para `fish_style_pwd_dir_length = 2`, sería `/bu/th/ci/on/rock/and/roll`.
@@ -877,23 +929,23 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an | Variable | Ejemplo | Descripción | | --------- | --------------------- | ------------------------------------- | -| path | `"D:/Projects"` | The current directory path | +| path | `"D:/Projects"` | La ruta de directorio actual | | style\* | `"black bold dimmed"` | Refleja el valor de la opción `style` | *: Esta variable sólo puede ser usada como parte de una cadena de estilo
-The git repos have additional variables. +Los repositorios de git tienen variables adicionales. -Let us consider the path `/path/to/home/git_repo/src/lib` +Consideremos la ruta `/path/to/home/git_repo/src/lib` -| Variable | Ejemplo | Descripción | -| ------------------ | --------------------- | --------------------------------------- | -| before_root_path | `"/path/to/home/"` | The path before git root directory path | -| repo_root | `"git_repo"` | The git root directory name | -| path | `"/src/lib"` | The remaining path | -| style | `"black bold dimmed"` | Refleja el valor de la opción `style` | -| repo_root_style | `"underline white"` | Style for git root directory name | +| Variable | Ejemplo | Descripción | +| ------------------ | --------------------- | --------------------------------------------------- | +| before_root_path | `"/path/to/home/"` | La ruta antes de la ruta del directorio raíz de git | +| repo_root | `"git_repo"` | El nombre del directorio raíz de git | +| path | `"/src/lib"` | La ruta restante | +| style | `"black bold dimmed"` | Refleja el valor de la opción `style` | +| repo_root_style | `"underline white"` | Estilo para el nombre del directorio raíz de git |
@@ -907,28 +959,28 @@ truncation_length = 8 truncation_symbol = "…/" ``` -## Docker Context +## Docker context -The `docker_context` module shows the currently active [Docker context](https://docs.docker.com/engine/context/working-with-contexts/) if it's not set to `default` or if the `DOCKER_MACHINE_NAME`, `DOCKER_HOST` or `DOCKER_CONTEXT` environment variables are set (as they are meant to override the context in use). +El módulo `docker_context` muestra el [contexto de Docker](https://docs.docker.com/engine/context/working-with-contexts/) actualmente activo si no está definido en `default` o si las variables de entorno `DOCKER_MACHINE_NAME`, `DOCKER_HOST` o `DOCKER_CONTEXT` están definidas (como se entiende para sobrescribir el contexto en uso). ### Opciones -| Opción | Por defecto | Descripción | -| ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `format` | `"via [$symbol$context]($style) "` | El formato del módulo. | -| `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. | -| `only_with_files` | `true` | Only show when there's a match | -| `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). | -| `detect_files` | `["docker-compose.yml", "docker-compose.yaml", "Dockerfile"]` | Which filenames should trigger this module (needs `only_with_files` to be true). | -| `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). | -| `style` | `"blue bold"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `docker_context` module. | +| Opción | Por defecto | Descripción | +| ------------------- | ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | +| `format` | `"via [$symbol$context]($style) "` | El formato del módulo. | +| `symbol` | `"🐳 "` | El símbolo usado antes de mostrar el contexto de Docker. | +| `only_with_files` | `true` | Mostrar solo cuando haya una coincidencia | +| `detect_extensions` | `[]` | Qué extensiones deberían activar este módulo (necesita que `solly_with_files` sea verdadero, con un valor "true"). | +| `detect_files` | `["docker-compose.yml", "docker-compose.yaml", "Dockerfile"]` | Qué nombres de archivo deberían activar este módulo (necesita que `solly_with_files` sea verdadero, con un valor "true"). | +| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo (necesita que `solly_with_files` sea verdadero, con un valor "true"). | +| `style` | `"blue bold"` | El estilo del módulo. | +| `disabled` | `false` | Desactiva el módulo `docker_context`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------------- | -------------------------------------- | -| context | `test_context` | The current docker context | +| context | `test_context` | El contexto actual de docker | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -945,9 +997,9 @@ format = "via [🐋 $context](blue bold)" ## Dotnet -The `dotnet` module shows the relevant version of the [.NET Core SDK](https://dotnet.microsoft.com/) for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. +El módulo `dotnet` muestra la versión usada de .NET Core SDK para el directorio actual. Si el SDK ha sido anclado en el directorio actual, se mostrará la versión fijada. De lo contrario, el módulo muestra la última versión instalada del SDK. -By default this module will only be shown in your prompt when one or more of the following files are present in the current directory: +Por defecto, este módulo solo se mostrará en tu prompt cuando uno o más de de los siguientes archivos estén presentes en el directorio actual: - `global.json` - `project.json` @@ -958,11 +1010,11 @@ By default this module will only be shown in your prompt when one or more of the - `*.fsproj` - `*.xproj` -You'll also need the .NET Core SDK installed in order to use it correctly. +También necesitará tener instalado .NET Core SDK para poder usarlo correctamente. -Internally, this module uses its own mechanism for version detection. Typically it is twice as fast as running `dotnet --version`, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting `heuristic = false` in the module options. +Internamente, este módulo utiliza su propio mecanismo para la detección de versiones. Normalmente es el doble de rápido que ejecutar `dotnet --version`, pero puede mostrar una versión incorrecta si tu proyecto .NET tiene un diseño de directorio inusual. Si la precisión es más importante que la velocidad, puede desactivar el mecanismo estableciendo `heuristic = false` en las opciones del módulo. -The module will also show the Target Framework Moniker () when there is a csproj file in the current directory. +El módulo también mostrará el Target Framework Moniker ([https://docs.microsoft. om/es/dotnet/standard/frameworks#supported-target-framework-versions](https://docs.microsoft.com/en-us/dotnet/standard/frameworks#supported-target-frameworks)) cuando exista un archivo `.csproj` en el directorio actual. ### Opciones @@ -970,22 +1022,22 @@ The module will also show the Target Framework Moniker ([\\w-]+)/.*" = "$var_cluster" -# Contexts from GKE, AWS and other cloud providers usually carry additional information, like the region/zone. -# The following entry matches on the GKE format (`gke_projectname_zone_cluster-name`) -# and renames every matching kube context into a more readable format (`gke-cluster-name`): +# Los contextos de GKE, AWS y otros proveedores de nube normalmente llevan información adicional, como la región/zona. +# La siguiente entrada coincide con el formato GKE (`gke_projectname_zone_cluster-name`) +# y renombra cada contexto de kube coincidente a un formato más legible (`gke-cluster-name`): "gke_.*_(?P[\\w-]+)" = "gke-$var_cluster" ``` -## Line Break +## Salto de línea -The `line_break` module separates the prompt into two lines. +El módulo `line_break` separa el indicador en dos líneas. ### Opciones -| Opción | Predeterminado | Descripción | -| ---------- | -------------- | ------------------------------------------------------------------ | -| `disabled` | `false` | Disables the `line_break` module, making the prompt a single line. | +| Opción | Predeterminado | Descripción | +| ---------- | -------------- | ------------------------------------------------------------------------------- | +| `disabled` | `false` | Deshabilita el módulo `line_break`, haciendo que el mensaje sea una sola línea. | ### Ejemplo @@ -1968,22 +2020,22 @@ disabled = true ## Local IP -The `localip` module shows the IPv4 address of the primary network interface. +El módulo `localip` muestra la dirección IPv4 de la interfaz de red principal. ### Opciones -| Opción | Por defecto | 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. | +| Opción | Por defecto | 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`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | ------------ | ------------------------------------- | -| localipv4 | 192.168.1.13 | Contains the primary IPv4 address | +| localipv4 | 192.168.1.13 | Contiene la dirección IPv4 primaria | | style\* | | Refleja el valor de la opción `style` | *: Esta variable sólo puede ser usada como parte de una cadena de estilo @@ -2001,11 +2053,11 @@ disabled = false ## Lua -The `lua` module shows the currently installed version of [Lua](http://www.lua.org/). By default the module will be shown if any of the following conditions are met: +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 current directory contains a `.lua-version` file -- The current directory contains a `lua` directory -- The current directory contains a file with the `.lua` extension +- El directorio actual contiene un archivo `.lua-version` +- El directorio actual contiene un directorio `lua` +- El directorio actual contiene un archivo con la extensión `.lua` ### Opciones @@ -2013,19 +2065,19 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | | `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 Lua. | +| `symbol` | `"🌙 "` | Una cadena de formato que representa el símbolo de 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"` | Configures the lua binary that Starship executes when getting the version. | -| `disabled` | `false` | Disables the `lua` module. | +| `lua_binary` | `"lua"` | Configura el binario de lua que Starship ejecuta al obtener la versión. | +| `disabled` | `false` | Desactiva el módulo `lua`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `v5.4.0` | The version of `lua` | +| version | `v5.4.0` | La versión de `lua` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -2040,40 +2092,40 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o format = "via [🌕 $version](bold blue) " ``` -## Memory Usage +## Memoria utilizada -The `memory_usage` module shows current system memory and swap usage. +El módulo `memory_usage` muestra la memoria del sistema actual y el uso de memoria de intercambio. -By default the swap usage is displayed if the total system swap is non-zero. +Por defecto, el uso de swap se muestra si el intercambio total del sistema no es cero. ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` a `false` en tu archivo de configuración. ::: ### Opciones -| Opción | Por defecto | 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. | +| Opción | Por defecto | 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`. | ### Variables -| 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` | +| 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` | -*: 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 +*: 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 ### Ejemplo @@ -2089,24 +2141,24 @@ style = "bold dimmed green" ## Mercurial Branch -The `hg_branch` module shows the active branch of the repo in your current directory. +El módulo `hg_branch` muestra la rama activa del repositorio en su directorio actual. ### Opciones -| Opción | Por defecto | 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]($style) "` | El formato del módulo. | -| `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. | +| Opción | Por defecto | 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` | Desactiva el módulo `hg_branch`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| branch | `master` | The active mercurial branch | +| branch | `master` | La rama de mercurial activa | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -2125,31 +2177,31 @@ truncation_symbol = "" ## Nim -The `nim` module shows the currently installed version of [Nim](https://nim-lang.org/). By default the module will be shown if any of the following conditions are met: +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 current directory contains a `nim.cfg` file -- The current directory contains a file with the `.nim` extension -- The current directory contains a file with the `.nims` extension -- The current directory contains a file with the `.nimble` extension +- El directorio actual contiene un archivo `nim.cfg` +- El directorio actual contiene un archivo con la extensión `.nim` +- El directorio actual contiene un archivo con la extensión `.nims` +- El directorio actual contiene un archivo con la extensión `.nimble` ### Opciones | Opción | Por defecto | Descripción | | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module | +| `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 Nim. | +| `symbol` | `"👑 "` | El símbolo usado antes de mostrar la versión de 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` | Disables the `nim` module. | +| `disabled` | `false` | Desactiva el módulo `nim`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `v1.2.0` | The version of `nimc` | +| version | `v1.2.0` | La versión de `nimc` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -2167,25 +2219,25 @@ symbol = "🎣 " ## 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. +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. ### Opciones -| Opción | Por defecto | 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. | -| `disabled` | `false` | Disables the `nix_shell` module. | +| Opción | Por defecto | 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`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | ------- | -------------------------------------- | -| state | `pure` | The state of the nix-shell | -| name | `lorri` | The name of the nix-shell | +| state | `pure` | El estado de nix-shell | +| name | `lorri` | El nombre de nix-shell | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -2205,34 +2257,34 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' ## Node.js -The `nodejs` module shows the currently installed version of [Node.js](https://nodejs.org/). By default the module will be shown if any of the following conditions are met: +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 current directory contains a `package.json` file -- The current directory contains a `.node-version` file -- The current directory contains a `.nvmrc` file -- The current directory contains a `node_modules` directory -- 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 +- El directorio actual contiene un archivo `package.json` +- El directorio actual contiene un archivo `.node-version` +- El directorio actual contiene un archivo `.nvmrc` +- El directorio actual contiene un directorio `node_modules` +- El directorio actual contiene un archivo con la extensión `.js`, `.mjs` o `.cjs` +- El directorio actual contiene un archivo con la extensión `.ts`, `.mts` o `.cts` ### Opciones -| Opción | Por defecto | Descripción | -| ------------------- | ------------------------------------------ | ----------------------------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | -| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `" "` | A format string representing the symbol of 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. | +| Opción | Por defecto | Descripción | +| ------------------- | ------------------------------------------ | --------------------------------------------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | +| `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | +| `symbol` | `" "` | 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` | Desactiva 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. | ### Variables | Variable | Ejemplo | Descripción | | --------- | ---------- | -------------------------------------- | -| version | `v13.12.0` | The version of `node` | +| version | `v13.12.0` | La versión de `node` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -2249,14 +2301,14 @@ format = "via [🤖 $version](bold green) " ## OCaml -The `ocaml` module shows the currently installed version of [OCaml](https://ocaml.org/). By default the module will be shown if any of the following conditions are met: +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 current directory contains a file with `.opam` extension or `_opam` directory -- The current directory contains a `esy.lock` directory -- The current directory contains a `dune` or `dune-project` file -- The current directory contains a `jbuild` or `jbuild-ignore` file -- The current directory contains a `.merlin` file -- The current directory contains a file with `.ml`, `.mli`, `.re` or `.rei` extension +- El directorio actual contiene un archivo con extensión `.opam` o directorio `_opam` +- El directorio actual contiene un directorio `esy.lock` +- El directorio actual contiene un archivo `dune` o `dune-project` +- El directorio actual contiene un archivo `jbuild` o `jbuild-ignore` +- El directorio actual contiene un archivo `.merlin` +- El directorio actual contiene un archivo con la extensión `.ml`, `.mli`, `.re` o `.rei` ### Opciones @@ -2264,24 +2316,24 @@ The `ocaml` module shows the currently installed version of [OCaml](https://ocam | ------------------------- | -------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | | `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` | `"🐫 "` | 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. | +| `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. | | `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` | Disables the `ocaml` module. | +| `disabled` | `false` | Desactiva el módulo `ocaml`. | ### Variables -| 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` | +| 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` | *: Esta variable sólo puede ser usada como parte de una cadena de estilo @@ -2296,23 +2348,23 @@ format = "via [🐪 $version]($style) " ## OpenStack -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. +El módulo `openstack` muestra la nube OpenStack actual y el proyecto. El módulo solo está activo cuando la variable env `OS_CLOUD` está definida en cuyo caso leerá el archivo `nubes. aml` 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. ### Opciones -| Opción | Por defecto | 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. | +| Opción | Por defecto | 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`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | ------- | -------------------------------------- | -| cloud | `corp` | The current OpenStack cloud | -| project | `dev` | The current OpenStack project | +| cloud | `corp` | La nube OpenStack actual | +| project | `dev` | El proyecto OpenStack actual | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -2329,26 +2381,26 @@ style = "bold yellow" symbol = "☁️ " ``` -## Package Version +## Versión del paquete -The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards` and `dart` packages. +El módulo `package` se muestra cuando el directorio actual es el repositorio de un paquete, y muestra su versión actual. El módulo actualmente admite los paquetes `npm`, `nimble`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards` y `dart`. -- [**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 -- [**Nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command -- [**Poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory -- [**Python**](https://www.python.org) - The `python` package version is extracted from the `setup.cfg` present in the current directory -- [**Composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory -- [**Gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present -- [**Julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present -- [**Mix**](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present -- [**Helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present -- [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present -- [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present -- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present -- [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present -- [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory -- [**Dart**](https://pub.dev/) - The `dart` package version is extracted from the `pubspec.yaml` present in the current directory +- [**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 +- [**Nimble**](https://github.com/nim-lang/nimble) - La versión del paquete `nimble` se extrae del archivo `*.nimble` presente en el directorio actual con el comando `nimble dump` +- [**Poetry**](https://python-poetry.org/) – La versión del paquete `poetry` se extrae del `pyproject.toml` presente en el directorio actual +- [**Python**](https://www.python.org) – La versión del paquete `python` se extrae del `setup.cfg` presente en el directorio actual +- [**Composer**](https://getcomposer.org/) – La versión del paquete `composer` se extrae del `composer.json` presente en el directorio actual +- [**Gradle**](https://gradle.org/) – La versión del paquete `gradle` se extrae del `build.gradle` presente en directorio actual +- [**Julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - La versión del paquete se extrae del `Project.toml` presente en el directorio actual +- [**Mix**](https://hexdocs.pm/mix/) - La versión del paquete `mix` se extrae del `mix.exs` presente en el directorio actual +- [**Help**](https://helm.sh/docs/helm/helm_package/) - La versión del paquete `helm` se extrae del `Chart.yaml` presente en el directorio actual +- [**Maven**](https://maven.apache.org/) - La versión de paquete `maven` se extrae del `pom.xml` presente en el directorio actual +- [**Meson**](https://mesonbuild.com/) - La versión del paquete `meson` se extrae del `meson.build` presente en el directorio actual +- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - La version del paquete `shards` se extrae del archivo `shard.yml` presente +- [**V**](https://vlang.io) - La versión del paquete `vlang` se extrae del `v.mod` presente en el directorio actual +- [**SBT**](https://scala-sbt.org) - La versión del paquete `sbt` se extrae del archivo `build.sbt` presente en el directorio actual +- [**Dart**](https://pub.dev/) - La versión del paquete `dart` se extrae del archivo `pubspec.yaml` presente en el directorio actual > ⚠️ La versión que se muestra es la del paquete cuyo código fuente está en tu directorio actual, no en tu gestor de paquetes. @@ -2357,17 +2409,17 @@ The `package` module is shown when the current directory is the repository for a | Opción | Por defecto | Descripción | | ----------------- | --------------------------------- | --------------------------------------------------------------------------------------- | | `format` | `"is [$symbol$version]($style) "` | El formato del módulo. | -| `symbol` | `"📦 "` | The symbol used before displaying the version the package. | +| `symbol` | `"📦 "` | El símbolo usado antes de mostrar la versión del paquete. | | `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` | Enable displaying version for packages marked as private. | -| `disabled` | `false` | Disables the `package` module. | +| `display_private` | `false` | Activar la visualización de la versión para los paquetes marcados como privados. | +| `disabled` | `false` | Desactiva el módulo `package`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `v1.0.0` | The version of your package | +| version | `v1.0.0` | La versión de su paquete | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -2384,13 +2436,13 @@ format = "via [🎁 $version](208 bold) " ## Perl -The `perl` module shows the currently installed version of [Perl](https://www.perl.org/). By default the module will be shown if any of the following conditions are met: +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 current directory contains a `Makefile.PL` or `Build.PL` file -- The current directory contains a `cpanfile` or `cpanfile.snapshot` file -- The current directory contains a `META.json` file or `META.yml` file -- The current directory contains a `.perl-version` file -- The current directory contains a `.pl`, `.pm` or `.pod` +- El directorio actual contiene un archivo `Makefile.PL` o `Build.PL` +- El directorio actual contiene un archivo `cpanfile` o `cpanfile.snapshot` +- El directorio actual contiene un archivo `META.json` o `META.yml` +- El directorio actual contiene un archivo `.perl-version` +- El directorio actual contiene un `.pl`, `.pm` o `.pod` ### Opciones @@ -2398,18 +2450,18 @@ The `perl` module shows the currently installed version of [Perl](https://www.pe | ------------------- | -------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | | `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` | `"🐪 "` | The symbol used before displaying the version of Perl | +| `symbol` | `"🐪 "` | El símbolo usado antes de mostrar la versión de 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` | Disables the `perl` module. | +| `disabled` | `false` | Desactiva el módulo `perl`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | --------- | -------------------------------------- | -| version | `v5.26.1` | The version of `perl` | +| version | `v5.26.1` | La versión de `perl` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -2424,11 +2476,11 @@ format = "via [🦪 $version]($style) " ## PHP -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: +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 current directory contains a `composer.json` file -- The current directory contains a `.php-version` file -- The current directory contains a `.php` extension +- El directorio actual contiene un archivo `composer.json` +- El directorio actual contiene un archivo `.php-version` +- El directorio actual contiene una extensión `.php` ### Opciones @@ -2436,18 +2488,18 @@ The `php` module shows the currently installed version of [PHP](https://www.php. | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | | `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 PHP. | +| `symbol` | `"🐘 "` | El símbolo usado antes de mostrar la versión de 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` | Disables the `php` module. | +| `disabled` | `false` | Desactiva el módulo `php`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `v7.3.8` | The version of `php` | +| version | `v7.3.8` | La versión de `php` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -2464,18 +2516,18 @@ format = "via [🔹 $version](147 bold) " ## Pulumi -The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. +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. ::: tip -By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, [follow the example shown below](#with-pulumi-version). +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 module will be shown if any of the following conditions are met: +Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: -- The current directory contains either `Pulumi.yaml` or `Pulumi.yml` -- A parent directory contains either `Pulumi.yaml` or `Pulumi.yml` +- El directorio actual contiene `Pulumi.yaml` o `Pulumi.yml` +- Un directorio padre contiene `Pulumi.yaml` o `Pulumi.yml` ### Opciones @@ -2483,19 +2535,19 @@ By default the module will be shown if any of the following conditions are met: | ---------------- | -------------------------------------------- | --------------------------------------------------------------------------------------- | | `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` | `" "` | A format string shown before the Pulumi stack. | +| `symbol` | `" "` | Una cadena de formato que se muestra antes de la pila de Pulumi. | | `style` | `"bold 5"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `pulumi` module. | +| `disabled` | `false` | Deshabilita el módulo `pulumi`. | ### Variables -| Variable | Ejemplo | Descripción | -| --------- | ---------- | -------------------------------------- | -| 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` | +| Variable | Ejemplo | Descripción | +| ----------------- | ---------- | -------------------------------------- | +| version | `v0.12.24` | La versión de `pulumi` | +| stack | `dev` | La pila actual de Pulumi | +| nombre de usuario | `alice` | El usuario actual de Pulumi | +| 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 @@ -2521,10 +2573,10 @@ format = "[$symbol$stack]($style) " ## PureScript -The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. By default the module will be shown if any of the following conditions are met: +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 current directory contains a `spago.dhall` file -- The current directory contains a file with the `.purs` extension +- El directorio actual contiene un archivo `spago.dhall` +- El directorio actual contiene un archivo con la extensión `.purs` ### Opciones @@ -2532,18 +2584,18 @@ The `purescript` module shows the currently installed version of [PureScript](ht | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | | `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 PureScript. | +| `symbol` | `"<=> "` | El símbolo usado antes de mostrar la versión de 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` | Disables the `purescript` module. | +| `disabled` | `false` | Deshabilita el módulo `purescript`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `0.13.5` | The version of `purescript` | +| version | `0.13.5` | La versión de `purescript` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -2560,21 +2612,21 @@ format = "via [$symbol$version](bold white)" ## Python -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. +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. -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`. +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`. -By default the module will be shown if any of the following conditions are met: +Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: -- The current directory contains a `.python-version` file -- The current directory contains a `Pipfile` file -- The current directory contains a `__init__.py` file -- The current directory contains a `pyproject.toml` file -- The current directory contains a `requirements.txt` file -- The current directory contains a `setup.py` file -- The current directory contains a `tox.ini` file -- The current directory contains a file with the `.py` extension. -- A virtual environment is currently activated +- El directorio actual contiene un archivo `.python-version` +- El directorio actual contiene un archivo `Pipfile` +- El directorio actual contiene un archivo `__init__.py` +- El directorio actual contiene un archivo `pyproject.toml` +- El directorio actual contiene un archivo `requirements.txt` +- El directorio actual contiene un archivo `setup.py` +- El directorio actual contiene un archivo `tox.ini` +- El directorio actual contiene un archivo con la extensión `.py`. +- Un entorno virtual está activado actualmente ### Opciones @@ -2582,33 +2634,33 @@ By default the module will be shown if any of the following conditions are met: | -------------------- | ------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------- | | `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` | `"🐍 "` | A format string representing the symbol of Python | +| `symbol` | `"🐍 "` | Una cadena de formato que representa el símbolo de Python | | `style` | `"yellow bold"` | El estilo del 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"]` | 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` | Disables the `python` module. | +| `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. | +| `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` | Desactiva el módulo `python`. | ::: tip -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. +La variable `python_binary` acepta una cadena o una lista de cadenas. 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 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. +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 `pithon3` o `pithon2`). 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). Si ya no trabajas con Python 2 pero no puedes removerlo del sistema, cambiando esto a `"python3"` ocultará cualquier versión de Python 2, ver ejemplo a continuación. ::: ### Variables -| 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 | +| 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 "` | Ordena el valor de la opción `pyenv_prefix` | +| virtualenv | `"venv"` | El nombre actual del `virtualenv` | ### Ejemplo @@ -2624,7 +2676,7 @@ pyenv_version_name = true # ~/.config/starship.toml [python] -# Only use the `python3` binary to get the version. +# Solo usa el binario `python3` para obtener la versión. python_binary = "python3" ``` @@ -2632,7 +2684,7 @@ python_binary = "python3" # ~/.config/starship.toml [python] -# Don't trigger for files with the py extension +# No se dispara con archivos con extensión py detect_extensions = [] ``` @@ -2640,24 +2692,24 @@ detect_extensions = [] # ~/.config/starship.toml [python] -# Display the version of python from inside a local venv. +# Muestra la versión de python desde dentro de un entorno virtual local. # -# 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? +# 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? python_binary = ["./venv/bin/python", "python", "python3", "python2"] ``` ## R -The `rlang` module shows the currently installed version of [R](https://www.r-project.org/). The module will be shown if any of the following conditions are met: +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 current directory contains a file with the `.R` extension. -- The current directory contains a file with the `.Rd` extension. -- The current directory contains a file with the `.Rmd` extension. -- The current directory contains a file with the `.Rproj` extension. -- The current directory contains a file with the `.Rsx` extension. -- The current directory contains a `.Rprofile` file -- The current directory contains a `.Rproj.user` folder +- El directorio actual contiene un archivo con la extensión `.R`. +- El directorio actual contiene un archivo con la extensión `.Rd`. +- El directorio actual contiene un archivo con la extensión `.Rmd`. +- El directorio actual contiene un archivo con la extensión `.Rproj`. +- El directorio actual contiene un archivo con la extensión `.Rsx`. +- El directorio actual contiene un archivo `.Rprofile` +- El directorio actual contiene una carpeta `.Rproj.user` ### Opciones @@ -2665,18 +2717,18 @@ The `rlang` module shows the currently installed version of [R](https://www.r-pr | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | | `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 R. | +| `symbol` | `"📐"` | Una cadena de formato que representa el símbolo de R. | | `style` | `"blue bold"` | El estilo del módulo. | -| `detect_extensions` | `["R", "Rd", "Rmd", "Rproj", "Rsx"]` | Which extensions should trigger this module | -| `detect_files` | `[".Rprofile"]` | Which filenames should trigger this module | -| `detect_folders` | `[".Rproj.user"]` | Which folders should trigger this module | -| `disabled` | `false` | Disables the `r` module. | +| `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`. | ### Variables | Variable | Ejemplo | Descripción | | -------- | ------------- | -------------------------------------- | -| version | `v4.0.5` | The version of `R` | +| version | `v4.0.5` | La versión de `R` | | symbol | | Refleja el valor de la opción `symbol` | | style | `"blue bold"` | Refleja el valor de la opción `style` | @@ -2691,9 +2743,9 @@ format = "with [📐 $version](blue bold) " ## Red -By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). El módulo se muestra si algunas de las siguientes condiciones se cumplen: +Por defecto, el módulo `red` muestra la versión actualmente instalada de [Red](https://www.red-lang.org/). El módulo se muestra si algunas de las siguientes condiciones se cumplen: -- The current directory contains a file with `.red` or `.reds` extension +- El directorio actual contiene un archivo con extensión `.red` o `.Red` ### Opciones @@ -2701,18 +2753,18 @@ By default the `red` module shows the currently installed version of [Red](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` | `"🔺 "` | A format string representing the symbol of Red. | +| `symbol` | `"🔺 "` | Una cadena de formato que representa el símbolo de 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` | Disables the `red` module. | +| `disabled` | `false` | Deshabilita el módulo `rojo`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `v2.5.1` | The version of `red` | +| version | `v2.5.1` | La versión de `red` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -2729,14 +2781,14 @@ symbol = "🔴 " ## Ruby -By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). El módulo se muestra si algunas de las siguientes condiciones se cumplen: +Por defecto, el módulo `ruby` muestra la versión actualmente instalada de [Ruby](https://www.ruby-lang.org/). El módulo se muestra si algunas de las siguientes condiciones se cumplen: -- The current directory contains a `Gemfile` file -- The current directory contains a `.ruby-version` file -- The current directory contains a `.rb` file -- The environment variables `RUBY_VERSION` or `RBENV_VERSION` are set +- 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 gets the current Ruby version by running `ruby -v`. +Starship obtiene la versión actual de Ruby ejecutando `ruby -v`. ### Opciones @@ -2744,23 +2796,23 @@ Starship gets the current Ruby version by running `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` | `"💎 "` | A format string representing the symbol of Ruby. | +| `symbol` | `"💎 "` | Una cadena de formato que representa el símbolo de 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"]` | Which environment variables should trigger this module. | +| `detect_variables` | `["RUBY_VERSION", "RBENV_VERSION"]` | Qué variables de entorno deben activar este módulo. | | `style` | `"bold red"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `ruby` module. | +| `disabled` | `false` | Desactiva el módulo `ruby`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `v2.5.1` | The version of `ruby` | +| version | `v2.5.1` | La versión de `ruby` | | 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 +*: Esta variable sólo puede ser usada como parte de una cadena de estilo ### Ejemplo @@ -2773,10 +2825,10 @@ symbol = "🔺 " ## Rust -By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). El módulo se muestra si algunas de las siguientes condiciones se cumplen: +Por defecto, el módulo `rust` muestra la versión instalada de [Rust](https://www.rust-lang.org/). El módulo se muestra si algunas de las siguientes condiciones se cumplen: -- The current directory contains a `Cargo.toml` file -- The current directory contains a file with the `.rs` extension +- El directorio actual contiene un archivo `Cargo.toml` +- El directorio actual contiene un archivo con la extensión `.rs` ### Opciones @@ -2784,18 +2836,18 @@ By default the `rust` module shows the currently installed version of [Rust](htt | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | | `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 Rust | +| `symbol` | `"🦀 "` | Una cadena de formato que representa el símbolo de 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` | Disables the `rust` module. | +| `disabled` | `false` | Desactiva el módulo `rust`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | ----------------- | -------------------------------------- | -| version | `v1.43.0-nightly` | The version of `rustc` | +| version | `v1.43.0-nightly` | La versión de `rustc` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -2812,11 +2864,11 @@ format = "via [⚙️ $version](red bold)" ## Scala -The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). By default the module will be shown if any of the following conditions are met: +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 current directory contains a `build.sbt`, `.scalaenv` or `.sbtenv` file -- The current directory contains a file with the `.scala` or `.sbt` extension -- The current directory contains a directory named `.metals` +- El directorio actual contiene un archivo `build.sbt`, `.scalaenv` o `.sbtenv` +- El directorio actual contiene un archivo con la extensión `.scala` o `.sbt` +- El directorio actual contiene un directorio llamado `.metals` ### Opciones @@ -2827,15 +2879,15 @@ The `scala` module shows the currently installed version of [Scala](https://www. | `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` | `"🆂 "` | A format string representing the symbol of Scala. | +| `symbol` | `"🆂 "` | Una cadena de formato que representa el símbolo de Scala. | | `style` | `"red dimmed"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `scala` module. | +| `disabled` | `false` | Deshabilita el módulo `scala`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `2.13.5` | The version of `scala` | +| version | `2.13.5` | La versión de `scala` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -2852,39 +2904,39 @@ symbol = "🌟 " ## Shell -The `shell` module shows an indicator for currently used shell. +El módulo `shell` muestra un indicador para el intérprete de comandos actualmente utilizado. ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` a `false` en tu archivo de configuración. ::: ### Opciones -| Opción | Por defecto | 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. | +| Opción | Por defecto | 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` | Una cadena de formato usada para representar 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 comando. | +| `format` | `"[$indicator]($style) "` | El formato del módulo. | +| `style` | `"white bold"` | El estilo del módulo. | +| `disabled` | `true` | Deshabilita el módulo `shell`. | ### Variables -| Variable | Predeterminado | Descripción | -| --------- | -------------- | ---------------------------------------------------------- | -| indicator | | Mirrors the value of `indicator` for currently used shell. | -| style\* | | Mirrors the value of option `style`. | +| Variable | Predeterminado | Descripción | +| --------- | -------------- | ------------------------------------------------------------------------------------ | +| indicator | | Ordena el valor de `indicator` para el intérprete de comandos actualmente utilizado. | +| style\* | | Refleja el valor de la opción `style`. | *: Esta variable sólo puede ser usada como parte de una cadena de estilo @@ -2903,24 +2955,24 @@ disabled = false ## SHLVL -The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold. +El módulo `shlvl` muestra la variable de entorno [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ("shell level") actual, si está establecido en un número y reúne o supera el umbral especificado. ### Opciones -| Opción | Por defecto | 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. | +| Opción | Por defecto | Descripción | +| ----------- | ---------------------------- | ----------------------------------------------------------------- | +| `threshold` | `2` | Mostrar umbral. | +| `format` | `"[$symbol$shlvl]($style) "` | El formato del módulo. | +| `symbol` | `"↕️ "` | El símbolo utilizado para representar el `SHLVL`. | +| `repeat` | `false` | Hace que el `symbol` se repita con la cantidad actual de `SHLVL`. | +| `style` | `"bold yellow"` | El estilo del módulo. | +| `disabled` | `true` | Desactiva el módulo `shlvl`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | ------- | -------------------------------------- | -| shlvl | `3` | The current value of `SHLVL` | +| shlvl | `3` | El valor actual de `SHLVL` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -2939,22 +2991,22 @@ threshold = 3 ## Singularity -The `singularity` module shows the current [Singularity](https://sylabs.io/singularity/) image, if inside a container and `$SINGULARITY_NAME` is set. +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. ### Opciones -| Opción | Por defecto | 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. | +| Opción | Por defecto | 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` | Desactiva el módulo `singularity`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | ------------ | -------------------------------------- | -| env | `centos.img` | The current Singularity image | +| env | `centos.img` | La imagen de Singularity actual | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -2969,13 +3021,46 @@ The `singularity` module shows the current [Singularity](https://sylabs.io/singu format = '[📦 \[$env\]]($style) ' ``` +## Spack + +El módulo `spack` muestra el entorno actual [Spack](https://spack.readthedocs.io/en/latest/), si `$SPACK_ENV` está configurado. + +### Opciones + +| Opción | Por defecto | Descripción | +| ------------------- | -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `truncation_length` | `1` | El número de directorios a los que se debe truncar la ruta de entorno. `0` significa sin truncamiento. Mirar también el módulo [`directory`](#directory). | +| `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`. | + +### Variables + +| Variable | Ejemplo | Descripción | +| ----------- | ------------ | -------------------------------------- | +| environment | `astronauts` | El entorno de spack actual | +| symbol | | Refleja el valor de la opción `symbol` | +| style\* | | Refleja el valor de la opción `style` | + +*: Esta variable sólo puede ser usada como parte de una cadena de estilo + +### Ejemplo + +```toml +# ~/.config/starship.toml + +[spack] +format = "[$symbol$environment](dimmed blue) " +``` + ## Status -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. +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. ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` a `false` en tu archivo de configuración. ::: @@ -2984,34 +3069,34 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | Opción | Por defecto | Descripción | | ----------------------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------- | | `format` | `"[$symbol$status]($style) "` | El formato del módulo | -| `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 | +| `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` | Enable signal mapping from exit code | -| `map_symbol` | `false` | Enable symbols mapping from exit code | -| `pipestatus` | `false` | Enable pipestatus reporting | +| `recognize_signal_code` | `true` | Habilita el mapeo de señales desde el código de salida | +| `map_symbol` | `false` | Habilita el mapeo de símbolos desde el código de salida | +| `pipestatus` | `false` | Habilita el reporte de pipstatus | | `pipestatus_separator` | `|` | | -| `pipestatus_format` | `\\[$pipestatus\\] => [$symbol$common_meaning$signal_name$maybe_int]($style)` | The format of the module when the command is a pipeline | -| `disabled` | `true` | Disables the `status` module. | +| `pipestatus_format` | `\\[$pipestatus\\] => [$symbol$common_meaning$signal_name$maybe_int]($style)` | El formato del módulo cuando el comando es un pipeline | +| `disabled` | `true` | Deshabilita el módulo `status`. | ### Variables -| 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` | +| 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ñalizada | +| 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` | *: Esta variable sólo puede ser usada como parte de una cadena de estilo @@ -3031,23 +3116,23 @@ disabled = false ## Sudo -The `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached. +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é. ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` a `false` en tu archivo de configuración. ::: ### Opciones -| Opción | Por defecto | Descripción | -| --------------- | ----------------------- | ------------------------------------------------------- | -| `format` | `[as $symbol]($style)"` | El formato del módulo | -| `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. | +| Opción | Por defecto | Descripción | +| --------------- | ----------------------- | -------------------------------------------------------------------------------- | +| `format` | `[as $symbol]($style)"` | El formato del módulo | +| `symbol` | `"🧙 "` | El símbolo mostrado cuando las credenciales se almacenan en caché | +| `style` | `"bold blue"` | El estilo del módulo. | +| `allow_windows` | `false` | Como Windows no tiene sudo por defecto, el valor por defecto está deshabilitado. | +| `disabled` | `true` | Deshabilita el módulo `sudo`. | ### Variables @@ -3070,7 +3155,7 @@ disabled = false ``` ```toml -# On windows +# En Windows # $HOME\.starship\config.toml [sudo] @@ -3080,10 +3165,10 @@ disabled = false ## Swift -By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). El módulo se muestra si algunas de las siguientes condiciones se cumplen: +Por defecto, el módulo `swift` muestra la versión instalada de [Swift](https://swift.org/). El módulo se muestra si algunas de las siguientes condiciones se cumplen: -- The current directory contains a `Package.swift` file -- The current directory contains a file with the `.swift` extension +- El directorio actual contiene un archivo `Package.swift` +- El directorio actual contiene un archivo con la extensión `.swift` ### Opciones @@ -3091,18 +3176,18 @@ By default the `swift` module shows the currently installed version of [Swift](h | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | | `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 Swift | +| `symbol` | `"🐦 "` | Una cadena de formato que representa el símbolo de 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` | Disables the `swift` module. | +| `disabled` | `false` | Deshabilita el módulo `swift`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `v5.2.4` | The version of `swift` | +| version | `v5.2.4` | La versión de `swift` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -3119,18 +3204,18 @@ format = "via [🏎 $version](red bold)" ## Terraform -The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. +El módulo `Terraform` muestra el [espacio de trabajo de Terraform](https://www.terraform.io/docs/language/state/workspaces.html) y la versión seleccionados actualmente. ::: tip -By default the Terraform version is not shown, since this is slow for current versions of Terraform when a lot of plugins are in use. If you still want to enable it, [follow the example shown below](#with-terraform-version). +Por defecto 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 module will be shown if any of the following conditions are met: +Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: -- The current directory contains a `.terraform` folder -- Current directory contains a file with the `.tf`, `.tfplan` or `.tfstate` extensions +- El directorio actual contiene una carpeta `.terraform` +- El directorio actual contiene un archivo con las extensiones `.tf`, `.tfplan` o `.tfstate` ### Opciones @@ -3138,21 +3223,21 @@ By default the module will be shown if any of the following conditions are met: | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | | `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` | `"💠"` | A format string shown before the terraform workspace. | +| `symbol` | `"💠"` | Una cadena de formato que se muestra antes del espacio de trabajo terraform. | | `detect_extensions` | `["tf", "tfplan", "tfstate"]` | Qué extensiones deberían activar este módulo. | | `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `[".terraform"]` | Qué carpetas deberían activar este módulo. | | `style` | `"bold 105"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `terraform` module. | +| `disabled` | `false` | Deshabilita el módulo `terraform`. | ### Variables -| 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` | +| Variable | Ejemplo | Descripción | +| --------- | ---------- | ----------------------------------------- | +| version | `v0.12.24` | La versión de `terraform` | +| workspace | `default` | El espacio de trabajo actual de Terraform | +| symbol | | Refleja el valor de la opción `symbol` | +| style\* | | Refleja el valor de la opción `style` | *: Esta variable sólo puede ser usada como parte de una cadena de estilo @@ -3178,33 +3263,33 @@ format = "[🏎💨 $workspace]($style) " ## Hora -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. +El módulo `time` muestra la hora **local** actual. El valor de configuración de `format` es usado por la caja de [`chrono`](https://crates.io/crates/chrono) para controlar cómo se muestra la hora. Echa un vistazo a [los documentos de chrono strftime](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) para ver qué opciones están disponibles. ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +Este módulo está deshabilitado por defecto. Para activarlo, establece `disabled` a `false` en tu archivo de configuración. ::: ### Opciones -| Opción | Por defecto | 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 | +| Opción | Por defecto | 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` | ver abajo | La [cadena de formato de chrono](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) utilizada para dar formato a la hora. | +| `style` | `"bold yellow"` | El estilo para el módulo de time | +| `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 | -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. +Si `use_12hr` es `true`, entonces `time_format` por defecto es `"%r"`. De lo contrario, el valor por defecto es `"%T"`. Configurar manualmente `time_format` sobrescribirá la configuración `use_12hr`. ### Variables | Variable | Ejemplo | Descripción | | --------- | ---------- | ------------------------------------- | -| time | `13:08:10` | The current time. | +| time | `13:08:10` | La hora actual. | | style\* | | Refleja el valor de la opción `style` | *: Esta variable sólo puede ser usada como parte de una cadena de estilo @@ -3224,35 +3309,35 @@ time_range = "10:00:00-14:00:00" ## Username -The `username` module shows active user's username. El módulo se muestra si algunas de las siguientes condiciones se cumplen: +El módulo `username` muestra el nombre de usuario activo. El módulo se muestra si algunas de las siguientes condiciones se cumplen: -- The current user is root -- The current user isn't the same as the one that is logged in -- The user is currently connected as an SSH session -- The variable `show_always` is set to true +- El usuario actual es root/admin +- El usuario actual no es el mismo que el que está conectado +- El usuario está actualmente conectado como una sesión SSH +- La variable `show_always` se establece en true ::: tip -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. +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. ::: ### Opciones -| Opción | Por defecto | Descripción | -| ------------- | ----------------------- | ------------------------------------- | -| `style_root` | `"bold red"` | The style used when the user is root. | -| `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. | +| Opción | Por defecto | 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`. | ### Variables -| 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. | +| Variable | Ejemplo | Descripción | +| -------- | ------------ | --------------------------------------------------------------------------------------------------- | +| `style` | `"red bold"` | Refleja el valor de la opción `style_root` cuando root inició sesión y `style_user` por otra parte. | +| `user` | `"matchai"` | El ID de usuario conectado actualmente. | ### Ejemplo @@ -3269,9 +3354,9 @@ show_always = true ## Vagrant -The `vagrant` module shows the currently installed version of [Vagrant](https://www.vagrantup.com/). By default the module will be shown if any of the following conditions are met: +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 current directory contains a `Vagrantfile` file +- El directorio actual contiene un archivo `Vagrantfile` ### Opciones @@ -3279,18 +3364,18 @@ The `vagrant` module shows the currently installed version of [Vagrant](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` | `"⍱ "` | A format string representing the symbol of Vagrant. | +| `symbol` | `"⍱ "` | Una cadena de formato que representa el símbolo de 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` | Disables the `vagrant` module. | +| `disabled` | `false` | Deshabilita el módulo `vagrant`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | ---------------- | -------------------------------------- | -| version | `Vagrant 2.2.10` | The version of `Vagrant` | +| version | `Vagrant 2.2.10` | La versión de `Vagrant` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -3307,29 +3392,29 @@ format = "via [⍱ $version](bold white) " ## V -The `vlang` module shows you your currently installed version of [V](https://vlang.io/). By default the module will be shown if any of the following conditions are met: +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 current directory contains a file with `.v` extension -- The current directory contains a `v.mod`, `vpkg.json` or `.vpkg-lock.json` file +- 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` ### Opciones -| Opción | Por defecto | Descripción | +| Opción | Predeterminado | Descripción | | ------------------- | -------------------------------------------- | --------------------------------------------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | | `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"V "` | A format string representing the symbol of V | +| `symbol` | `"V "` | Una cadena de formato que representa el símbolo de 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` | Disables the `vlang` module. | +| `disabled` | `false` | Deshabilita el módulo `vlang`. | ### Variables | Variable | Ejemplo | Descripción | | --------- | ------- | -------------------------------------- | -| version | `v0.2` | The version of `v` | +| version | `v0.2` | La versión de `v` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -3343,24 +3428,24 @@ format = "via [V $version](blue bold) " ## VCSH -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. +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. ### Opciones -| Opción | Por defecto | 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. | +| 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`. | ### Variables -| 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` | +| 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` | *: Esta variable sólo puede ser usada como parte de una cadena de estilo @@ -3375,9 +3460,9 @@ format = "[🆅 $repo](bold blue) " ## Zig -By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). El módulo se muestra si algunas de las siguientes condiciones se cumplen: +Por defecto, el módulo `zig` muestra la versión instalada de [Zig](https://ziglang.org/). El módulo se muestra si algunas de las siguientes condiciones se cumplen: -- The current directory contains a `.zig` file +- El directorio actual contiene un archivo `.zig` ### Opciones @@ -3385,9 +3470,9 @@ By default the the `zig` module shows the currently installed version of [Zig](h | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | | `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 Zig. | +| `symbol` | `"↯ "` | El símbolo usado antes de mostrar la versión de Zig. | | `style` | `"bold yellow"` | El estilo del módulo. | -| `disabled` | `false` | Disables the `zig` module. | +| `disabled` | `false` | Deshabilita el módulo `zig`. | | `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. | @@ -3396,7 +3481,7 @@ By default the the `zig` module shows the currently installed version of [Zig](h | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `v0.6.0` | The version of `zig` | +| version | `v0.6.0` | La versión de `zig` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -3411,97 +3496,99 @@ By default the the `zig` module shows the currently installed version of [Zig](h symbol = "⚡️ " ``` -## Custom commands +## Comandos personalizados -The `custom` modules show the output of some arbitrary commands. +Los módulos `personalizados` muestran la salida de algunos comandos arbitrarios. -These modules will be shown if any of the following conditions are met: +Estos módulos se mostrarán si se cumplen alguna de las siguientes condiciones: -- The current directory contains a file whose name is in `files` -- The current directory contains a directory whose name is in `directories` -- The current directory contains a file whose extension is in `extensions` -- The `when` command returns 0 -- The current Operating System (std::env::consts::OS) matchs with `os` field if defined. +- The current directory contains a file whose name is in `detect_files` +- The current directory contains a directory whose name is in `detect_folders` +- The current directory contains a file whose extension is in `detect_extensions` +- El comando `when` devuelve 0 +- El sistema operativo actual (std::env::consts::OS) coincide con el campo `os` si está definido. ::: tip -Multiple custom modules can be defined by using a `.`. +Múltiples módulos personalizados pueden definirse usando un `.` (un punto). ::: ::: tip -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. +El orden en el que se muestran los módulos personalizados se puede establecer individualmente incluyendo `${custom.foo}` en el `format` de nivel superior (ya que incluye un punto, necesita usar `${...}`). Por defecto, el módulo `custom` simplemente mostrará todos los módulos personalizados en el orden en que fueron definidos. ::: ::: tip -[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! +[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í! ::: -::: warning Command output is printed unescaped to the prompt +::: warning la salida de comandos se imprime sin escapar al prompt -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. +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. -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). +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). ::: ### Opciones -| Opción | Predeterminado | Descripción | -| ------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `command` | `""` | The command whose output should be printed. The command will be passed on stdin to the shell. | -| `when` | | A shell command used as a condition to show the module. 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`. | -| `files` | `[]` | The files that will be searched in the working directory for a match. | -| `directories` | `[]` | The directories that will be searched in the working directory for a match. | -| `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). | +| Opción | Predeterminado | Descripción | +| ------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `command` | `""` | El comando cuya salida debe ser impresa. El comando se pasará en stdin al intérprete de comandos. | +| `when` | `false` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. | +| `shell` | | [Ver abajo](#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 personalizado`. | +| `os` | | Nombre del sistema operativo en el que se mostrará el módulo (unix, linux, macos, windows, ... ) [Ver valores posibles](https://doc.rust-lang.org/std/env/consts/constant.OS.html). | +| `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 | -| --------- | -------------------------------------- | -| 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` | +| Variable | Descripción | +| --------- | ----------------------------------------------------------- | +| output | La salida del comando del intérprete de comandos en `shell` | +| symbol | Refleja el valor de la opción `symbol` | +| style\* | Refleja el valor de la opción `style` | *: Esta variable sólo puede ser usada como parte de una cadena de estilo #### Comando personalizado del intérprete de comandos -`shell` accepts a non-empty list of strings, where: +`shell` acepta una lista no vacía de cadenas, donde: -- The first string is the path to the shell to use to execute the command. -- Other following arguments are passed to the shell. +- La primera cadena es la ruta al intérprete de comandos a usar para ejecutar el comando. +- Otros argumentos siguientes son pasados al shell. -If unset, it will fallback to STARSHIP_SHELL and then to "sh" on Linux, and "cmd /C" on Windows. +Si no está activado, se retornará a STARSHIP_SHELL y luego a "sh" en Linux, y "cmd /C" en Windows. -The `command` will be passed in on stdin. +El `comando` será pasado en stdin. -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 -`. This behavior can be avoided by explicitly passing arguments to the shell, e.g. +Si no se da el `shell` o solo contiene un elemento y Starship detecta PowerShell los siguientes argumentos se añadirán automáticamente: `-NoProfile -Command -`. If `shell` is not given or only contains one element and Starship detects Cmd will be used, the following argument will automatically be added: `/C` and `stdin` will be set to `false`. If `shell` is not given or only contains one element and Starship detects Nushell will be used, the following arguments will automatically be added: `-c` and `stdin` will be set to `false`. This behavior can be avoided by explicitly passing arguments to the shell, e.g. ```toml shell = ["pwsh", "-Command", "-"] ``` -::: warning Make sure your custom shell configuration exits gracefully +::: warning Asegúrate de que tu configuración personalizada del intérprete de comandos salga con éxito -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). +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`). -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. +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. -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. +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. -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. +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. ::: @@ -3512,12 +3599,18 @@ Automatic detection of shells and proper parameters addition are currently imple [custom.foo] command = "echo foo" # shows output of command -files = ["foo"] # can specify filters but wildcards are not supported +detect_files = ["foo"] # can specify filters but wildcards are not supported when = """ test "$HOME" == "$PWD" """ format = " transcending [$output]($style)" [custom.time] command = "time /T" -extensions = ["pst"] # filters *.pst files +detect_extensions = ["pst"] # filters *.pst files shell = ["pwsh.exe", "-NoProfile", "-Command", "-"] + +[custom.time-as-arg] +command = "time /T" +detect_extensions = ["pst"] # filters *.pst files +shell = ["pwsh.exe", "-NoProfile", "-Command"] +use_stdin = false ``` diff --git a/docs/es-ES/faq/README.md b/docs/es-ES/faq/README.md index 3dd650ed..8fba5be7 100644 --- a/docs/es-ES/faq/README.md +++ b/docs/es-ES/faq/README.md @@ -1,4 +1,4 @@ -# Frequently Asked Questions +# Preguntas frecuentes ## ¿Cuál es la configuración usada en el GIF de demostración? diff --git a/docs/es-ES/guide/README.md b/docs/es-ES/guide/README.md index 6efe876f..a83fe480 100644 --- a/docs/es-ES/guide/README.md +++ b/docs/es-ES/guide/README.md @@ -145,7 +145,7 @@ Starship with iTerm2 and the Snazzy theme @@ -160,7 +160,7 @@ - **Fácil:** rápido de instalar – empieza a usarlo en minutos.

-Explore the Starship docs  ▶ +Explora la documentación de Starship  ▶

@@ -173,12 +173,12 @@ ### Paso 1. Instalar Starship -Select your operating system from the list below to view installation instructions: +Seleccione su sistema operativo de la lista de abajo para ver las instrucciones de instalación:
Android -Install Starship using any of the following package managers: +Instalar Starship usando cualquiera de los siguientes gestores de paquetes: | Repositorio | Instrucciones | | --------------------------------------------------------------------------------- | ---------------------- | @@ -189,7 +189,7 @@ Install Starship using any of the following package managers:
BSD -Install Starship using any of the following package managers: +Instalar Starship usando cualquiera de los siguientes gestores de paquetes: | Distribución | Repositorio | Instrucciones | | ---------------- | -------------------------------------------------------- | --------------------------------- | @@ -264,7 +264,7 @@ Instalar Starship usando cualquiera de los siguientes gestores de paquetes: ### Paso 2. Configura tu shell para usar Starship -Configure your shell to initialize starship. Selecciona el tuyo de la lista de abajo: +Configure su shell para inicializar starship. Selecciona el tuyo de la lista de abajo:
Bash @@ -280,7 +280,7 @@ eval "$(starship init bash)"
Cmd -Necesitas usar [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) con Cmd. Create a file at this path `%LocalAppData%\clink\starship.lua` with the following contents: +Necesitas usar [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) con Cmd. Crea un archivo en esta ruta `%LocalAppData%\clink\starship.lua` con el siguiente contenido: ```lua load(io.popen('starship init cmd'):read("*a"))() @@ -297,7 +297,7 @@ Añade el siguiente código al final de `~/.elvish/rc.elv`: eval (starship init elvish) ``` -Nota: Sólo se admite Elvish v0.17+ +Nota: Solo se admite Elvish v0.18+
@@ -326,28 +326,28 @@ eval $(starship init ion)
Nushell -Run the following: +Ejecuta lo siguiente: ```sh mkdir ~/.cache/starship starship init nu | save ~/.cache/starship/init.nu ``` -And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`): +Añade lo siguiente al final de tu configuración de Nushell (encuéntrala ejecutando `$nu.config-path`): ```sh starship init nu | save ~/.cache/starship/init.nu source ~/.cache/starship/init.nu ``` -Note: Only Nushell v0.60+ is supported +Nota: Solo se admite Nushell v0.60+
PowerShell -Add the following to the end of your PowerShell configuration (find it by running `$PROFILE`): +Añade lo siguiente al final de tu configuración de PowerShell (encuéntrala ejecutando `$PROFILE`): ```powershell Invoke-Expression (&starship init powershell) @@ -390,9 +390,9 @@ eval "$(starship init zsh)" ### Paso 3. Configurar Starship -Start a new shell instance, and you should see your beautiful new shell prompt. If you're happy with the defaults, enjoy! +Inicia una nueva instancia de shell, y deberías ver tu nuevo y hermoso prompt para shell. Si estás contento con los valores por defecto, ¡disfruta! -If you're looking to further customize Starship: +Si estás buscando personalizar Starship: - **[Configuración](https://starship.rs/config/)** – aprende a configurar Starship para ajustar el prompt a tu gusto @@ -400,15 +400,15 @@ If you're looking to further customize Starship: ## 🤝 Contribuir -We are always looking for contributors of **all skill levels**! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). +¡Siempre estamos buscando colaboradores de **todos los niveles y habilidades**! Si estás interesado en empezar en el proyecto con algo sencillo, prueba con un problema etiquetado como [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). -If you are fluent in a non-English language, we greatly appreciate any help keeping our docs translated and up-to-date in other languages. If you would like to help, translations can be contributed on the [Starship Crowdin](https://translate.starship.rs/). +Si hablas con fluidez en un idioma que no sea inglés, agradecemos mucho cualquier ayuda para mantener nuestros documentos traducidos y actualizados en otros idiomas. Si quieres ayudar, puedes contribuir con las traducciones en el [Crowdin de Starship](https://translate.starship.rs/). -If you are interested in helping contribute to starship, please take a look at our [Contributing Guide](https://github.com/starship/starship/blob/master/CONTRIBUTING.md). Also, feel free to drop into our [Discord server](https://discord.gg/8Jzqu3T) and say hi. 👋 +Si estás interesado en ayudar contribuyendo a starship, por favor échale un vistazo a [Guía de Colaboración](https://github.com/starship/starship/blob/master/CONTRIBUTING.md). También siéntete libre de pasarte por nuestro [servidor de Discord](https://discord.gg/8Jzqu3T) y saludarnos. 👋 ## 💭 Inspirado por -Please check out these previous works that helped inspire the creation of starship. 🙏 +Por favor, revisa estos proyectos que inspiraron la creación de Starship. 🙏 - **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** – Un prompt de ZSH para astronautas. @@ -418,9 +418,9 @@ Please check out these previous works that helped inspire the creation of starsh


- Starship rocket icon + Icono de Starship

## 📝 Licencia -Copyright © 2019-present, [Starship Contributors](https://github.com/starship/starship/graphs/contributors).
This project is [ISC](https://github.com/starship/starship/blob/master/LICENSE) licensed. +Copyright © 2019-actualidad, [Creadores de Starship](https://github.com/starship/starship/graphs/contributors).
Este proyecto está bajo una licencia [ISC](https://github.com/starship/starship/blob/master/LICENSE). diff --git a/docs/es-ES/installing/README.md b/docs/es-ES/installing/README.md index f6e60dfd..5eb18f71 100644 --- a/docs/es-ES/installing/README.md +++ b/docs/es-ES/installing/README.md @@ -1,4 +1,4 @@ -# Advanced Installation +# Instalación avanzada Para instalar Starship, necesitas hacer dos cosas: @@ -63,7 +63,7 @@ Activa el módulo `programs.starship` en tu archivo `home.nix` y añade tus ajus { programs.starship = { enable = true; - # Configuration written to ~/.config/starship.toml + # Configuración escrita en ~/.config/starship.toml settings = { # add_newline = false; diff --git a/docs/es-ES/presets/README.md b/docs/es-ES/presets/README.md index 7b929f8c..3eeca9aa 100644 --- a/docs/es-ES/presets/README.md +++ b/docs/es-ES/presets/README.md @@ -2,40 +2,40 @@ Aqui tienes una colección de preajustes creados por la comunidad de Starship. ¡Si quieres compartir un preajuste, por favor, [envía un PR](https://github.com/starship/starship/edit/master/docs/presets/README.md) actualizando este archivo! 😊 -To get details on how to use a preset, simply click on the image. +Para obtener detalles sobre cómo utilizar un preajuste, simplemente haga clic en la imagen. ## [Símbolos de Nerd Font](./nerd-font.md) -This preset changes the symbols for each module to use Nerd Font symbols. +Este preajuste cambia los símbolos de cada módulo para usar símbolos Nerd Font. -[![Captura de pantalla del preajuste de los Símbolos de Nerd Font](/presets/img/nerd-font-symbols.png "Click to view Nerd Font Symbols preset")](./nerd-font) +[![Captura de pantalla del preajuste de los Símbolos de Nerd Font](/presets/img/nerd-font-symbols.png "Haga clic para ver el preajuste de Símbolos de Nerd Font")](./nerd-font) ## [Segmentos entre Corchetes](./bracketed-segments.md) Este preajuste cambia el formato de todos los módulos incorporados para mostrar su segmento entre corchetes en lugar de usar la redacción por defecto de Starship ("via", "on", etc.). -[![Captura de pantalla del preajuste de los Segmentos entre Corchetes](/presets/img/bracketed-segments.png "Click to view Bracketed Segments preset")](./bracketed-segments) +[![Captura de pantalla del preajuste de los Segmentos entre Corchetes](/presets/img/bracketed-segments.png "Haga clic para ver el preajuste de Segmentos entre Corchetes")](./bracketed-segments) ## [Símbolos de texto sin formato](./plain-text.md) -This preset changes the symbols for each module into plain text. Great if you don't have access to Unicode. +Este preajuste cambia los símbolos a texto sin formato. Bueno si usted no tiene acceso a Unicode. -[![Captura de pantalla del ajuste de los Símbolos de Texto Plano](/presets/img/plain-text-symbols.png "Click to view Plain Text Symbols preset")](./plain-text) +[![Captura de pantalla del ajuste de los Símbolos de Texto Plano](/presets/img/plain-text-symbols.png "Haga clic para ver el preajuste de Símbolos de Texto Sin Formato")](./plain-text) -## [No Runtime Versions](./no-runtimes.md) +## [Ocultar Versiones en Tiempo de Ejecución](./no-runtimes.md) Este preajuste oculta la versión de los tiempos de ejecución del idioma. Si trabajas en contenedores o entornos virtualizados, ¡ésto es para ti! -[![Captura de pantalla del preajuste de Ocultar de versiones de tiempo de ejecución](/presets/img/no-runtime-versions.png "Click to view No Runtime Versions preset")](./no-runtimes) +[![Captura de pantalla del preajuste de Ocultar de versiones de tiempo de ejecución](/presets/img/no-runtime-versions.png "Haga clic para ver el preajuste de Ocultar Versiones en Tiempo de Ejecución")](./no-runtimes) -## [Pure Prompt](./pure-preset.md) +## [Prompt de Pure](./pure-preset.md) Esta preajuste emula la apariencia y el comportamiento de [Pure](https://github.com/sindresorhus/pure). -[![Captura de pantalla del ajuste de Pure](/presets/img/pure-preset.png "Click to view Pure Prompt preset")](./pure-preset) +[![Captura de pantalla del ajuste de Pure](/presets/img/pure-preset.png "Haga clic para ver el preajuste del Prompt de Pure")](./pure-preset) ## [Pastel Powerline](./pastel-powerline.md) -This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). It also shows how path substitution works in starship. +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. -[![Screenshot of Pastel Powerline preset](/presets/img/pastel-powerline.png "Click to view Pure Prompt preset")](./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) diff --git a/docs/es-ES/presets/bracketed-segments.md b/docs/es-ES/presets/bracketed-segments.md index 6320bf5b..45f75185 100644 --- a/docs/es-ES/presets/bracketed-segments.md +++ b/docs/es-ES/presets/bracketed-segments.md @@ -1,6 +1,6 @@ -[Return to Presets](./README.md#bracketed-segments) +[Volver a Preajustes](./README.md#bracketed-segments) -# Bracketed Segments Preset +# Preajuste Segmentos entre Corchetes Este preajuste cambia el formato de todos los módulos incorporados para mostrar su segmento entre corchetes en lugar de usar la redacción por defecto de Starship ("via", "on", etc.). @@ -8,6 +8,6 @@ Este preajuste cambia el formato de todos los módulos incorporados para mostrar ### Configuración -[Click to download TOML](/presets/toml/bracketed-segments.toml) +[Clic para descargar TOML](/presets/toml/bracketed-segments.toml) <<< @/.vuepress/public/presets/toml/bracketed-segments.toml diff --git a/docs/es-ES/presets/nerd-font.md b/docs/es-ES/presets/nerd-font.md index a35d2b8a..a577119a 100644 --- a/docs/es-ES/presets/nerd-font.md +++ b/docs/es-ES/presets/nerd-font.md @@ -1,8 +1,8 @@ -[Return to Presets](./README.md#nerd-font-symbols) +[Volver a Preajustes](./README.md#nerd-font-symbols) -# Nerd Font Symbols Preset +# Preajuste de Símbolos de Nerd Font -This preset changes the symbols for each module to use Nerd Font symbols. +Este preajuste cambia los símbolos de cada módulo para usar símbolos Nerd Font. ![Captura de pantalla del preajuste de los Símbolos de Nerd Font](/presets/img/nerd-font-symbols.png) @@ -12,6 +12,6 @@ This preset changes the symbols for each module to use Nerd Font symbols. ### Configuración -[Click to download TOML](/presets/toml/nerd-font-symbols.toml) +[Clic para descargar TOML](/presets/toml/nerd-font-symbols.toml) <<< @/.vuepress/public/presets/toml/nerd-font-symbols.toml diff --git a/docs/es-ES/presets/no-runtimes.md b/docs/es-ES/presets/no-runtimes.md index bf6331b9..93d04dd8 100644 --- a/docs/es-ES/presets/no-runtimes.md +++ b/docs/es-ES/presets/no-runtimes.md @@ -1,6 +1,6 @@ -[Return to Presets](./README.md#no-runtime-versions) +[Volver a Preajustes](./README.md#no-runtime-versions) -# No Runtime Versions Preset +# Preajuste Ocultar Versiones en Tiempo de Ejecución Este preajuste oculta la versión de los tiempos de ejecución del idioma. Si trabajas en contenedores o entornos virtualizados, ¡ésto es para ti! @@ -8,6 +8,6 @@ Este preajuste oculta la versión de los tiempos de ejecución del idioma. Si tr ### Configuración -[Click to download TOML](/presets/toml/no-runtime-versions.toml) +[Clic para descargar TOML](/presets/toml/no-runtime-versions.toml) <<< @/.vuepress/public/presets/toml/no-runtime-versions.toml diff --git a/docs/es-ES/presets/pastel-powerline.md b/docs/es-ES/presets/pastel-powerline.md index d55aecd3..a1a8772c 100644 --- a/docs/es-ES/presets/pastel-powerline.md +++ b/docs/es-ES/presets/pastel-powerline.md @@ -1,17 +1,17 @@ -[Return to Presets](./README.md#pastel-powerline) +[Volver a Preajustes](./README.md#pastel-powerline) -# Pastel Powerline Preset +# Preajuste Pastel Powerline -This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). It also shows how path substitution works in starship. +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. -![Screenshot of Pastel Powerline preset](/presets/img/pastel-powerline.png) +![Captura de pantalla del preajuste Pastel Powerline](/presets/img/pastel-powerline.png) ### Prerequisitos -- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (the example uses Caskaydia Cove Nerd Font) +- Una [Nerd Font](https://www.nerdfonts.com/) instalada y habilitada en tu terminal (el ejemplo usa Fira Code Nerd Font) ### Configuración -[Click to download TOML](/presets/toml/pastel-powerline.toml) +[Clic para descargar TOML](/presets/toml/pastel-powerline.toml) <<< @/.vuepress/public/presets/toml/pastel-powerline.toml diff --git a/docs/es-ES/presets/plain-text.md b/docs/es-ES/presets/plain-text.md index f0faefe2..bfd384d4 100644 --- a/docs/es-ES/presets/plain-text.md +++ b/docs/es-ES/presets/plain-text.md @@ -1,13 +1,13 @@ -[Return to Presets](./README.md#plain-text-symbols) +[Volver a Preajustes](./README.md#plain-text-symbols) -## Plain Text Symbols Preset +## Preajuste Símbolos de Texto sin Formato -This preset changes the symbols for each module into plain text. Great if you don't have access to Unicode. +Este preajuste cambia los símbolos a texto sin formato. Bueno si usted no tiene acceso a Unicode. ![Captura de pantalla del ajuste de los Símbolos de Texto Plano](/presets/img/plain-text-symbols.png) ### Configuración -[Click to download TOML](/presets/toml/plain-text-symbols.toml) +[Clic para descargar TOML](/presets/toml/plain-text-symbols.toml) <<< @/.vuepress/public/presets/toml/plain-text-symbols.toml diff --git a/docs/es-ES/presets/pure-preset.md b/docs/es-ES/presets/pure-preset.md index e122dfc7..1fe311f9 100644 --- a/docs/es-ES/presets/pure-preset.md +++ b/docs/es-ES/presets/pure-preset.md @@ -1,6 +1,6 @@ -[Return to Presets](./README.md#pure) +[Volver a Preajustes](./README.md#pure) -# Pure Preset +# Preajuste Pure Esta preajuste emula la apariencia y el comportamiento de [Pure](https://github.com/sindresorhus/pure). @@ -8,6 +8,6 @@ Esta preajuste emula la apariencia y el comportamiento de [Pure](https://github. ### Configuración -[Click to download TOML](/presets/toml/pure-preset.toml) +[Clic para descargar TOML](/presets/toml/pure-preset.toml) <<< @/.vuepress/public/presets/toml/pure-preset.toml diff --git a/docs/fr-FR/README.md b/docs/fr-FR/README.md index 149b18f8..0a70439b 100644 --- a/docs/fr-FR/README.md +++ b/docs/fr-FR/README.md @@ -120,7 +120,7 @@ description: Starship est une invite minimaliste, ultra-rapide et hautement pers #### Elvish - ::: warning Seul elvish v0.17 ou supérieur est pris en charge. ::: + ::: warning Seul elvish v0.18 ou supérieur est pris en charge. ::: Ajoutez ce qui suit à la fin de `~/.elvish/rc.elv`: @@ -144,13 +144,13 @@ description: Starship est une invite minimaliste, ultra-rapide et hautement pers #### Nushell - ::: warning Cela va changer dans le futur. Only Nushell v0.60+ is supported. ::: Run the following: + ::: warning Cela va changer dans le futur. Seul Nushell v0.60+ est supporté. ::: Exécutez les commandes suivantes: ```sh mkdir ~/.cache/starship starship init nu | save ~/.cache/starship/init.nu ``` - And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`): + Ajoutez le code suivant à la fin de votre configuration Nushell (trouvez-la en exécutant `$nu.config path`): ```sh mkdir ~/.cache/starship @@ -171,7 +171,7 @@ description: Starship est une invite minimaliste, ultra-rapide et hautement pers #### Cmd - Vous devez utiliser [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) avec Cmd. Add the following to a file `starship.lua` and place this file in Clink scripts directory: + Vous devez utiliser [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) avec Cmd. Ajoutez le code ci-dessous dans un fichier `starship.lua` et placez-le dans le dossier des scripts Clink: ```lua -- starship.lua diff --git a/docs/fr-FR/advanced-config/README.md b/docs/fr-FR/advanced-config/README.md index 85d6f618..28b85aa6 100644 --- a/docs/fr-FR/advanced-config/README.md +++ b/docs/fr-FR/advanced-config/README.md @@ -10,9 +10,9 @@ Les configurations dans cette section sont sujettes à modification dans les fut ## Commandes pré-invite et pré-exécution personnalisées dans Cmd -Clink provides extremely flexible APIs to run pre-prompt and pre-exec commands in Cmd shell. It is fairly simple to use with Starship. Make the following changes to your `starship.lua` file as per your requirements: +Clink fournit des APIs extrêmement flexibles pour exécuter des commandes pre-invite et pre-exec dans Cmd. Il est assez simple à utiliser avec Starship. Effectuez les modifications suivantes dans votre fichier `starship.lua`, en fonction de vos besoins: -- To run a custom function right before the prompt is drawn, define a new function called `starship_preprompt_user_func`. This function receives the current prompt as a string that you can utilize. For example, to draw a rocket before the prompt, you would do +- Pour exécuter une fonction juste avant que l’invite soit dessinée, définissez une nouvelle fonction appelée `starship_preprompt_user_func`. Cette fonction reçoit l’invite courante sous la forme d’une chaine que vous pouvez utiliser. Par exemple, pour dessiner une fusée avant l’invite, vous pouvez faire ```lua function starship_preprompt_user_func(prompt) @@ -22,7 +22,7 @@ end 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 +- Pour exécuter une fonction personnalisée juste avant qu’une commande soit exécutée, définissez une nouvelle fonction appelée `starship_precmd_user_func`. Cette fonction reçoit la ligne de commande courante sous la forme d’une chaine que vous pouvez utiliser. Par exemple, pour afficher la commande sur le point d’être exécutée, vous pouvez faire ```lua function starship_precmd_user_func(line) @@ -71,7 +71,7 @@ function Invoke-Starship-PreCommand { ## Modifier le titre des fenêtres -Certaines commandes du shell changeront automatiquement le titre de la fenêtre (par exemple, pour refléter le dossier courant). Fish le fait même par défaut. Starship does not do this, but it's fairly straightforward to add this functionality to `bash`, `zsh`, `cmd` or `powershell`. +Certaines commandes du shell changeront automatiquement le titre de la fenêtre (par exemple, pour refléter le dossier courant). Fish le fait même par défaut. Starship ne fait pas ça, mais c’est assez facile d’ajouter cette fonctionnalité à `bash`, `zsh`, `cmd` ou `powershell`. Tout d'abord, définissez une fonction de changement de titre de fenêtre (identique en bash et zsh) : @@ -106,7 +106,7 @@ function set_win_title(){ starship_precmd_user_func="set_win_title" ``` -For Cmd, you can change the window title using the `starship_preprompt_user_func` function. +Pour Cmd, vous pouvez changer le titre de la fenêtre en utilisant la fonction `starship_preprompt_user_func`. ```lua function starship_preprompt_user_func(prompt) @@ -116,7 +116,7 @@ end load(io.popen('starship init cmd'):read("*a"))() ``` -You can also set a similar output with PowerShell by creating a function named `Invoke-Starship-PreCommand`. +Vous pouvez également faire la même chose avec PowerShell en créant une fonction nommée `Invoke-Starship-PreCommand`. ```powershell # edit $PROFILE @@ -129,11 +129,11 @@ Invoke-Expression (&starship init powershell) ## Mettre l’invite à droite -Some shells support a right prompt which renders on the same line as the input. Starship can set the content of the right prompt using the `right_format` option. Any module that can be used in `format` is also supported in `right_format`. The `$all` variable will only contain modules not explicitly used in either `format` or `right_format`. +Certains shells peuvent gérer une invite de commande à droite, sur la même ligne que l’entrée utilisateur. Starship peut définir le contenu de cet invite à droite en utilisant l’option `right_format`. N’importe quel module qui peut être utilisé dans `format` est aussi géré dans `right_format`. La variable `$all` va seulement contenir les modules qui ne sont explicitement utilisés ni dans `format`, ni dans `right_format`. -Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [fill module](/config/#fill). +Note: l’invite à droite est une seule ligne, sur la même ligne que l’entrée. To right align modules above the input line in a multi-line prompt, see the [`fill` module](/config/#fill). -`right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd. +`right_format` est actuellement géré pour les shells suivants: elvish, fish, zsh, xonsh, cmd. ### Exemple @@ -155,13 +155,13 @@ Génère l’invite suivante: ## Invite de continuation -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). +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 can set the continuation prompt using the `continuation_prompt` option. The default prompt is `"[∙](bright-black) "`. +Starship peut définir l’invite de continuation en utilisant l’option `continuation_prompt`. L’invite par défaut est `"[∙](bright-black) "`. -Note: `continuation_prompt` should be set to a literal string without any variables. +Note: la valeur de `continuation_prompt` doit être une chaine littérale, sans variable. -Note: Continuation prompts are only available in the following shells: +Note: les invites de confirmation sont uniquement disponibles pour les shells suivants: - `bash` - `zsh` @@ -172,7 +172,7 @@ Note: Continuation prompts are only available in the following shells: ```toml # ~/.config/starship.toml -# A continuation prompt that displays two filled in arrows +# Un invite de continuation qui affiche deux flèches pleines continuation_prompt = "▶▶" ``` diff --git a/docs/fr-FR/config/README.md b/docs/fr-FR/config/README.md index 735bf19d..64cd86cc 100644 --- a/docs/fr-FR/config/README.md +++ b/docs/fr-FR/config/README.md @@ -9,14 +9,17 @@ mkdir -p ~/.config && touch ~/.config/starship.toml Toute la configuration de starship est effectuée dans ce fichier [TOML](https://github.com/toml-lang/toml) : ```toml -# Insère un saut de ligne entre les invites de commande +# Get editor completions based on the config schema +"$schema" = 'https://starship.rs/config-schema.json' + +# Inserts a blank line between shell prompts add_newline = true -# Remplace le symbole «❯» dans le prompt par «➜» -[character] # Le nom du module qu’on configure est «character» -success_symbol = "[➜](bold green)" # Le segment «success_symbol» est changé à «➜» avec la couleur «bold green» +# Replace the "❯" symbol in the prompt with "➜" +[character] # The name of the module we are configuring is "character" +success_symbol = "[➜](bold green)" # The "success_symbol" segment is being set to "➜" with the color "bold green" -# Désactive le module «package», le cachant complètement de l’invite +# Disable the package module, hiding it from the prompt completely [package] disabled = true ``` @@ -180,7 +183,7 @@ Le `format` par défaut est utilisé pour définir le format de l'invite, si il ```toml format = "$all" -# Ce qui est équivalent à +# Which is equivalent to format = """ $username\ $hostname\ @@ -199,6 +202,7 @@ $hg_branch\ $docker_context\ $package\ $buf\ +$c\ $cmake\ $cobol\ $container\ @@ -235,6 +239,7 @@ $vagrant\ $zig\ $nix_shell\ $conda\ +$spack\ $memory_usage\ $aws\ $gcloud\ @@ -263,9 +268,9 @@ format = "$all$directory$character" ## AWS -The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. Ces informations sont basées sur les variables d'environnement `AWS_REGION`, `AWS_DEFAULT_REGION`, et `AWS_PROFILE` ainsi que le fichier `~/.aws/config`. Ce module affiche également un minuteur d'expiration lorsque vous utilisez des identifiants temporaires. +Le module `aws` affiche la région et le profil AWS actuelle quand des identifiants, un `credential_process` ou une `sso_start_url` ont été configurées. Alternatively, you can force this module to show the region and profile even when the credentials have not been setup with the `force_display` option. Il se base sur les variables d’environnement `AWS_REGION`, `AWS_DEFAULT_REGION` et `AWS_PROFILE` avec un fichier `~/.aws/config`. Ce module montre aussi un minuteur d’expiration lors de l’utilisation d’identifiants temporaires. -The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. +Le module n’affichera un profil que si ses identifiants sont présents dans `~/.aws/credentials` ou si un `credential_process` est définie dans `~/.aws/config`. Sinon, avoir l’une des variables d’environnement `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` ou `AWS_SESSION_TOKEN` définie est suffisant. Si l’option `force_display` est définie à `true`, toutes les informations disponibles seront affichées même si les conditions ne sont pas respectées. Lorsque vous utilisez [aws-vault](https://github.com/99designs/aws-vault) le profil est lu à partir de la variable d'environnement `AWS_VAULT` et la date d'expiration des identifiants est lue à partir de la variable d'environnement `AWS_SESSION_EXPIRATION`. @@ -275,15 +280,16 @@ Lorsque vous utilisez [AWSume](https://awsu.me) le profil est lu à partir de la ### Options -| Option | Défaut | Description | -| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------- | -| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | Format du module. | -| `symbol` | `"☁️ "` | Le symbole est affiché avant le profil AWS actuel. | -| `region_aliases` | | Table des alias de région à afficher en plus du nom AWS. | -| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | -| `style` | `"bold yellow"` | Le style du module. | -| `expiration_symbol` | `X` | Le symbole est affiché lorsque les identifiants temporaires ont expiré. | -| `disabled` | `false` | Désactive le module `AWS`. | +| Option | Défaut | Description | +| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | +| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | Format du module. | +| `symbol` | `"☁️ "` | Le symbole est affiché avant le profil AWS actuel. | +| `region_aliases` | | Table des alias de région à afficher en plus du nom AWS. | +| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | +| `style` | `"bold yellow"` | Le style du module. | +| `expiration_symbol` | `X` | Le symbole est affiché lorsque les identifiants temporaires ont expiré. | +| `disabled` | `false` | Désactive le module `AWS`. | +| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. | ### Variables @@ -472,16 +478,62 @@ Le module `buf` affiche la version de [Buf](https://buf.build) installée. Par d symbol = "🦬 " ``` -## Caractère +## C -Le module `character` affiche un caractère (en général une flèche) à côté de là où vous entrez le texte dans votre terminal. +Le module `c` affiche des informations à propos de votre compilateur C. Par défaut, ce module sera affiché si le dossier courant contient un fichier `.c` ou `.h`. -Le caractère vous dira si la dernière commande a été réussie ou pas. Il peut faire ça de deux façons: +### Options + +| Option | Défaut | Description | +| ------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | +| `format` | `"via [$symbol($version(-$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` | +| `symbol` | `"C "` | Le symbole utilisé avant d’afficher les détails du compilateur | +| `detect_extensions` | `["c", "h"]` | Quelles extensions devraient activer ce module. | +| `detect_files` | `[]` | Les fichiers qui activent ce module. | +| `detect_folders` | `[]` | Les dossiers qui activent ce module. | +| `commands` | [ [ "cc", "--version" ], [ "gcc", "--version" ], [ "clang", "--version" ] ] | Comment détecter quel est le compilateur | +| `style` | `"bold 149"` | Le style du module. | +| `disabled` | `false` | Désactive le module `c`. | + +### Variables + +| Variable | Exemple | Description | +| -------- | ------- | -------------------------------------- | +| name | clang | Le nom du compilateur | +| version | 13.0.0 | La version du compilateur | +| symbol | | Reflète la valeur de l'option `symbol` | +| style | | Reflète la valeur de l'option `style` | + +Notez que `version` n’est pas dans le format par défaut. + +### Commandes + +L’option `commands` accepte une liste de commandes pour déterminer la version du compilateur et son nom. + +Each command is represented as a list of the executable name, followed by its arguments, usually something like `["mycc", "--version"]`. Starship will try executing each command until it gets a result on STDOUT. + +Si un compilateur C n’est pas supporté par ce module, vous pouvez demander son ajout en [créant un ticket sur GitHub](https://github.com/starship/starship/). + +### Exemple + +```toml +# ~/.config/starship.toml + +[c] +format = "via [$name $version]($style)" +``` + +## Caractères + +Le module `character` affiche un caractère (habituellement une flèche) à côté de l'endroit où le texte est entré dans votre terminal. + +Le caractère vous dira si la dernière commande a été réussie ou pas. Cela peut être fait de deux manières: - en changeant de couleur(`red`/`green`) - en changeant de forme (`❯`/`✖`) -Par défaut, il ne change que de couleur. Si vous désirez également changer sa forme, jetez un à [cet exemple](#with-custom-error-shape). +Par défaut, il ne change que la couleur. Si vous désirez également changer sa forme, jetez un œil à [cet exemple](#with-custom-error-shape). ::: warning @@ -491,19 +543,19 @@ Par défaut, il ne change que de couleur. Si vous désirez également changer sa ### Options -| Option | Défaut | Description | -| ---------------- | ------------------- | -------------------------------------------------------------------------------- | -| `format` | `"$symbol "` | The format string used before the text input. | -| `success_symbol` | `"[❯](bold green)"` | The format string used before the text input if the previous command succeeded. | -| `error_symbol` | `"[❯](bold red)"` | The format string used before the text input if the previous command failed. | -| `vicmd_symbol` | `"[❮](bold green)"` | The format string used before the text input if the shell is in vim normal mode. | -| `disabled` | `false` | Désactive le module `character`. | +| Option | Défaut | Description | +| ---------------- | ------------------- | ----------------------------------------------------------------------------- | +| `format` | `"$symbol "` | Le format utilisée avant l'entrée de texte. | +| `success_symbol` | `"[❯](bold green)"` | Le format utilisé avant l'entrée de texte si la commande précédente a réussi. | +| `error_symbol` | `"[❯](bold red)"` | Le format utilisé avant l'entrée de texte si la commande précédente a échoué. | +| `vicmd_symbol` | `"[❮](bold green)"` | Le format utilisé avant l'entrée de texte si le shell est en mode vim normal. | +| `disabled` | `false` | Désactive le module `character`. | ### Variables -| Variable | Exemple | Description | -| -------- | ------- | --------------------------------------------------------------------- | -| symbol | | A mirror of either `success_symbol`, `error_symbol` or `vicmd_symbol` | +| Variable | Exemple | Description | +| -------- | ------- | --------------------------------------------------------------- | +| symbol | | Reflète sois `success_symbol`, `error_symbol` ou `vicmd_symbol` | ### Exemples @@ -538,7 +590,7 @@ vicmd_symbol = "[V](bold green) " ## CMake -Le module `cmake` affiche la version de [CMake](https://cmake.org/) installée. By default the module will be activated if any of the following conditions are met: +Le module `cmake` affiche la version actuellement installée de [CMake](https://cmake.org/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: - Le dossier courant contient un fichier `CMakeLists.txt` - Le dossier courant contient un fichier `CMakeCache.txt` @@ -549,10 +601,10 @@ Le module `cmake` affiche la version de [CMake](https://cmake.org/) installée. | ------------------- | -------------------------------------- | ------------------------------------------------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"△ "` | The symbol used before the version of cmake. | -| `detect_extensions` | `[]` | Which extensions should trigger this module | -| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | -| `detect_folders` | `[]` | Which folders should trigger this module | +| `symbol` | `"△ "` | Le symbole utilisé avant la version de cmake. | +| `detect_extensions` | `[]` | Quelles extensions devraient activer ce module | +| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Quels fichiers devraient activer ce module | +| `detect_folders` | `[]` | Quels dossiers devraient activer ce module | | `style` | `"bold blue"` | Le style du module. | | `disabled` | `false` | Désactive le module `cmake`. | @@ -568,7 +620,7 @@ Le module `cmake` affiche la version de [CMake](https://cmake.org/) installée. ## COBOL / GNUCOBOL -Le module `cobol` affiche la version de COBOL installée. By default, the module will be shown if any of the following conditions are met: +Le module `cobol` affiche la version de COBOL installée. Par défaut, le module sera affiché si l’une de ces conditions est remplie : - Le dossier courant contient un fichier finissant par `.cob` ou `.COB` - Le dossier courant contiens un fichier finissant par `.cbl` ou `.CBL` @@ -598,35 +650,35 @@ Le module `cobol` affiche la version de COBOL installée. By default, the module ## Temps d'exécution -The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists. +Le module `cmd_duration` montre le temps qu'a pris la dernière commande pour s'exécuter. Le module ne sera affiché que si la commande a pris plus de deux secondes, ou si la valeur de configuration `min_time` existe. -::: warning Do not hook the DEBUG trap in Bash +::: warning N'interceptez pas le signal DEBUG avec Bash -If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. +Si vous utilisez starship en `bash`, n'accrochez pas `DEBUG` après avoir exécuté `eval $(starship init $0)`, ou ce module **cassera**. ::: -Bash users who need preexec-like functionality can use [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Simply define the arrays `preexec_functions` and `precmd_functions` before running `eval $(starship init $0)`, and then proceed as normal. +Les utilisateurs de Bash qui ont besoin de fonctionnalité pré-exec peuvent utiliser [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Définissez simplement les array `preexec_functions` et `precmd_functions` avant d'éxécuter `eval $(starship init $0)`, puis procédez comme d'habitude. ### Options -| Option | Défaut | Description | -| ---------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). | -| `show_milliseconds` | `false` | Show milliseconds in addition to seconds for the duration. | -| `format` | `"took [$duration]($style) "` | Format du module. | -| `style` | `"bold yellow"` | Le style du module. | -| `disabled` | `false` | Désactive le module `cmd_duration`. | -| `show_notifications` | `false` | Show desktop notifications when command completes. | -| `min_time_to_notify` | `45_000` | Shortest duration for notification (in milliseconds). | -| `notification_timeout` | | Duration to show notification for (in milliseconds). If unset, notification timeout will be determined by daemon. Not all notification daemons honor this option. | +| Option | Défaut | Description | +| ---------------------- | ----------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `min_time` | `2_000` | Durée la plus courte quand afficher le temps (en millisecondes). | +| `show_milliseconds` | `false` | Afficher les millisecondes en plus des secondes pendant la durée. | +| `format` | `"took [$duration]($style) "` | Format du module. | +| `style` | `"bold yellow"` | Le style du module. | +| `disabled` | `false` | Désactive le module `cmd_duration`. | +| `show_notifications` | `false` | Afficher les notifications du bureau lorsque la commande est terminée. | +| `min_time_to_notify` | `45_000` | Durée minimale après laquelle activer la notification (en millisecondes). | +| `notification_timeout` | | Durée d’affichage des notifications (en milisecondes). Si non défini, la durée sera déterminée par le démon. Tous les démons de notification ne respectent pas cette option. | ### Variables -| Variable | Exemple | Description | -| --------- | -------- | --------------------------------------- | -| duration | `16m40s` | The time it took to execute the command | -| style\* | | Reflète la valeur de l'option `style` | +| Variable | Exemple | Description | +| --------- | -------- | --------------------------------------------- | +| duration | `16m40s` | Le temps nécessaire pour exécuter la commande | +| style\* | | Reflète la valeur de l'option `style` | *: Cette variable peut uniquement être utilisée dans une chaine de style @@ -642,32 +694,32 @@ format = "underwent [$duration](bold yellow)" ## Conda -The `conda` module shows the current [Conda](https://docs.conda.io/en/latest/) environment, if `$CONDA_DEFAULT_ENV` is set. +Le module `conda` affiche l’environnement [Conda](https://docs.conda.io/en/latest/) courant, si `$CONDA_DEFAULT_ENV` est définie. ::: tip -This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. +Cela ne supprime pas le modificateur d'invite de conda, vous pouvez exécuter `conda config --set changeps1 False`. ::: ### Options -| Option | Défaut | Description | -| ------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `truncation_length` | `1` | The number of directories the environment path should be truncated to, if the environment was created via `conda create -p [path]`. `0` means no truncation. Also see the [`directory`](#directory) module. | -| `symbol` | `"🅒 "` | The symbol used before the environment name. | -| `style` | `"bold green"` | Le style du module. | -| `format` | `"via [$symbol$environment]($style) "` | Format du module. | -| `ignore_base` | `true` | Ignores `base` environment when activated. | -| `disabled` | `false` | Désactive le module `conda`. | +| Option | Défaut | Description | +| ------------------- | -------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `truncation_length` | `1` | Le nombre de répertoires dans lesquels le chemin d'environnement (Path) doit être tronqué, si l'environnement a été créé via `conda create -p [path]`. `0` ne signifie pas de troncature. Regardez aussi le module [`directory`](#directory). | +| `symbol` | `"🅒 "` | Le symbole utilisé avant le nom d'environnement. | +| `style` | `"bold green"` | Le style du module. | +| `format` | `"via [$symbol$environment]($style) "` | Format du module. | +| `ignore_base` | `true` | Ignore l'environnement `base` lorsqu'il est activé. | +| `disabled` | `false` | Désactive le module `conda`. | ### Variables -| Variable | Exemple | Description | -| ----------- | ------------ | -------------------------------------- | -| environment | `astronauts` | The current conda environment | -| symbol | | Reflète la valeur de l'option `symbol` | -| style\* | | Reflète la valeur de l'option `style` | +| Variable | Exemple | Description | +| ------------- | ------------ | -------------------------------------- | +| environnement | `astronauts` | La version courante de conda | +| symbol | | Reflète la valeur de l'option `symbol` | +| style\* | | Reflète la valeur de l'option `style` | *: Cette variable peut uniquement être utilisée dans une chaine de style @@ -680,18 +732,18 @@ This does not suppress conda's own prompt modifier, you may want to run `conda c format = "[$symbol$environment](dimmed green) " ``` -## Container +## Conteneur -The `container` module displays a symbol and container name, if inside a container. +Le module `container` affiche un symbole et le nom du conteneur, si vous êtes dans un conteneur. ### Options -| Option | Défaut | Description | -| ---------- | -------------------------------------- | ----------------------------------------- | -| `symbol` | `"⬢"` | The symbol shown, when inside a container | -| `style` | `"bold red dimmed"` | Le style du module. | -| `format` | `"[$symbol \\[$name\\]]($style) "` | Format du module. | -| `disabled` | `false` | Désactive le module `container`. | +| Option | Défaut | Description | +| ---------- | -------------------------------------- | ---------------------------------------------------- | +| `symbol` | `"⬢"` | Le symbole affiché quand vous êtes dans un conteneur | +| `style` | `"bold red dimmed"` | Le style du module. | +| `format` | `"[$symbol \\[$name\\]]($style) "` | Format du module. | +| `disabled` | `false` | Désactive le module `container`. | ### Variables @@ -714,7 +766,7 @@ format = "[$symbol \\[$name\\]]($style) " ## Crystal -Le module `crystal` affiche la version de [Crystal](https://crystal-lang.org/) installée. By default the module will be shown if any of the following conditions are met: +Le module `crystal` affiche la version actuellement installée de [Crystal](https://crystal-lang.org/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: - Le dossier courant contient un fichier `shard.yml` - Le dossier courant contient un fichier `.cr` @@ -726,7 +778,7 @@ Le module `crystal` affiche la version de [Crystal](https://crystal-lang.org/) i | `symbol` | `"🔮 "` | Le symbole utilisé avant d'afficher la version de crystal. | | `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` | -| `style` | `"bold red"` | Le style du module. | +| `style` | `"bold green"` | Le style du module. | | `detect_extensions` | `["cr"]` | Quelles extensions devraient activer ce module. | | `detect_files` | `["shard.yml"]` | Les fichiers qui activent ce module. | | `detect_folders` | `[]` | Les dossiers qui activent ce module. | @@ -736,7 +788,7 @@ Le module `crystal` affiche la version de [Crystal](https://crystal-lang.org/) i | Variable | Exemple | Description | | --------- | --------- | -------------------------------------- | -| version | `v0.32.1` | La version de `crystal` | +| version | `v0.32.1` | La version de `cristal` | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -753,7 +805,7 @@ format = "via [✨ $version](bold blue) " ## Dart -Le module `dart` affiche la version de [Dart](https://dart.dev/) installée. By default the module will be shown if any of the following conditions are met: +Le module `dart` affiche la version actuellement installée de [Dart](https://dart.dev/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: - Le dossier courant contient un fichier avec l’extension `.dart` - Le dossier courant contient un fichier `.dart_tool` @@ -765,7 +817,7 @@ Le module `dart` affiche la version de [Dart](https://dart.dev/) installée. By | ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | +| `symbol` | `"🎯 "` | Une chaîne de caractères représentant le symbole de Dart | | `detect_extensions` | `["dart"]` | Quelles extensions devraient activer ce module. | | `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Les fichiers qui activent ce module. | | `detect_folders` | `[".dart_tool"]` | Les dossiers qui activent ce module. | @@ -793,7 +845,7 @@ format = "via [🔰 $version](bold red) " ## Deno -Le module `deno` affiche la version de [Deno](https://deno.land/) installée. By default the module will be shown if any of the following conditions are met: +Le module `deno` affiche la version actuellement installée de [Deno](https://deno.land/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: - Le dossier courant contient un fichier `deno.json`, `deno.jsonc`, `mod.ts`, `mod.js`, `deps.ts` ou `deps.js` @@ -803,7 +855,7 @@ Le module `deno` affiche la version de [Deno](https://deno.land/) installée. By | ------------------- | ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"🦕 "` | A format string representing the symbol of Deno | +| `symbol` | `"🦕 "` | Une chaîne de caractères représentant le symbole de Deno | | `detect_extensions` | `[]` | Quelles extensions devraient activer ce module. | | `detect_files` | `["deno.json", "deno.jsonc", "mod.ts", "mod.js", "deps.ts", "deps.js"]` | Les fichiers qui activent ce module. | | `detect_folders` | `[]` | Les dossiers qui activent ce module. | @@ -829,39 +881,39 @@ format = "via [🦕 $version](green bold) " ## Dossier -The `directory` module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in. +Le mode `directory` montre le chemin de votre dossier actuel, tronqué aux 3 dossiers parents. Votre répertoire sera également tronqué à la racine du repo git dans lequel vous vous trouvez actuellement. -When using the fish style pwd option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option. +Quand vous utilisez le style pwd de fish, au lieu de cacher le chemin qui est tronqué, vous verrez un nom raccourci de chaque dossier basé sur le nombre établi pour l'option. -For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, and the option set to `1`. You will now see `~/D/N/nixpkgs/pkgs`, whereas before it would have been `nixpkgs/pkgs`. +Par exemple, donné `~/Dev/Nix/nixpkgs/pkgs` où `nixpkgs` est la racine du repo, et l'option définie à `1`. Vous verrez maintenant `~/D/N/nixpkgs/pkgs`, alors que vous auriez vu `nixpkgs/pkgs` avant. ### Options -| Option | Défaut | Description | -| ------------------- | ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. | -| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. | -| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | Format du module. | -| `style` | `"bold cyan"` | Le style du module. | -| `disabled` | `false` | Désactive le module `directory`. | -| `read_only` | `"🔒"` | The symbol indicating current directory is read only. | -| `read_only_style` | `"red"` | The style for the read only symbol. | -| `truncation_symbol` | `""` | The symbol to prefix to truncated paths. eg: "…/" | -| `repo_root_style` | `None` | The style for the root of the git repo. The default value is equivalent to `style`. | -| `repo_root_format` | `"[$before_root_path]($style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) "` | The format of a git repo when `repo_root_style` is defined. | -| `home_symbol` | `"~"` | The symbol indicating home directory. | -| `use_os_path_sep` | `true` | Use the OS specific path separator instead of always using `/` (e.g. `\` on Windows) | +| Option | Défaut | Description | +| ------------------- | ----------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- | +| `truncation_length` | `3` | Le nombre de dossiers parents selon lesquels le répertoire courant doit être tronqué. | +| `truncate_to_repo` | `true` | Si oui ou non tronquer à la racine du repo git dans lequel vous vous trouvez. | +| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | Format du module. | +| `style` | `"bold cyan"` | Le style du module. | +| `disabled` | `false` | Désactive le module `directory`. | +| `read_only` | `"🔒"` | Le symbole indiquant que le répertoire courant est en lecture seule. | +| `read_only_style` | `"red"` | Le style du symbole en lecture seule. | +| `truncation_symbol` | `""` | Le symbole en préfixe aux chemins tronqués. eg: "…/" | +| `repo_root_style` | `None` | Le style pour la racine du dépôt Git. La valeur par défaut est équivalent à `style`. | +| `repo_root_format` | `"[$before_root_path]($style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) "` | Le format d’un dépôt Git quand `repo_root_style` est défini. | +| `home_symbol` | `"~"` | Le symbole indiquant le répertoire personnel. | +| `use_os_path_sep` | `true` | Utiliser le séparateur de chemin du système d’exploitation au lieu de toujours utiliser `/` (par ex. `\` sous Windows) |
-This module has a few advanced configuration options that control how the directory is displayed. +Ce module possède quelques options de configuration avancées qui contrôlent l'affichage du répertoire. -| Advanced Option | Défaut | Description | -| --------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `substitutions` | | A table of substitutions to be made to the path. | -| `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. | -| `use_logical_path` | `true` | If `true` render the logical path sourced from the shell via `PWD` or `--logical-path`. If `false` instead render the physical filesystem path with symlinks resolved. | +| Options avancées | Défaut | Description | +| --------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `substitutions` | | Table de substitutions à faire au chemin. | +| `fish_style_pwd_dir_length` | `0` | Le nombre de caractères à utiliser lors de l'application de la logique de troncature du pwd de fish. | +| `use_logical_path` | `true` | Si `true` affiche le chemin logique issu du shell via `PWD` ou `--logical-path`. Si `false` renvoie plutôt le chemin du système de fichiers physique avec les liens symboliques résolus. | -`substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD. +`substitutions` vous permet de définir des remplacements arbitraires pour les chaînes littérales qui apparaissent dans le chemin, par exemple pour de longs préfixes de réseau ou des répertoires de développement (ex. Java). Notez que cela désactivera la PWD de style fish. ```toml [directory.substitutions] @@ -869,7 +921,7 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an "src/com/long/java/path" = "mypath" ``` -`fish_style_pwd_dir_length` interacts with the standard truncation options in a way that can be surprising at first: if it's non-zero, the components of the path that would normally be truncated are instead displayed with that many characters. For example, the path `/built/this/city/on/rock/and/roll`, which would normally be displayed as as `rock/and/roll`, would be displayed as `/b/t/c/o/rock/and/roll` with `fish_style_pwd_dir_length = 1`--the path components that would normally be removed are displayed with a single character. For `fish_style_pwd_dir_length = 2`, it would be `/bu/th/ci/on/rock/and/roll`. +`fish_style_pwd_dir_leng` interagit avec les options de troncature d'une manière qui peut être surprenante au début : si elle n'est pas nulle, les composantes du chemin qui seraient normalement tronquées sont affichées à la place avec autant de caractères. Par exemple, le chemin `/built/this/city/on/rock/and/roll`, qui devrait normalement être affiché comme `rock/and/roll`, sera affiché sous la forme de `/b/t/c/o/rock/and/roll` avec `fish_style_pwd_dir_length = 1`--les composants de chemin qui seraient normalement supprimés sont affichés avec un caractère unique. Pour `fish_style_pwd_dir_length = 2`, ce serait `/bu/th/ci/on/rock/and/roll`.
@@ -877,23 +929,23 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an | Variable | Exemple | Description | | --------- | --------------------- | ------------------------------------- | -| path | `"D:/Projects"` | The current directory path | +| path | `"D:/Projects"` | Le chemin du répertoire courant | | style\* | `"black bold dimmed"` | Reflète la valeur de l'option `style` | *: Cette variable peut uniquement être utilisée dans une chaine de style
-The git repos have additional variables. +Les dépôts Git peuvent avoir des variables additionnelles. -Let us consider the path `/path/to/home/git_repo/src/lib` +Considérons le chemin `/path/to/home/git_repo/src/lib` | Variable | Exemple | Description | | ------------------ | --------------------- | --------------------------------------- | -| before_root_path | `"/path/to/home/"` | The path before git root directory path | -| repo_root | `"git_repo"` | The git root directory name | -| path | `"/src/lib"` | The remaining path | +| before_root_path | `"/path/to/home/"` | Le chemin avant le dossier racine Git | +| repo_root | `"git_repo"` | Le nom du dossier racine Git | +| path | `"/src/lib"` | Le reste du chemin | | style | `"black bold dimmed"` | Reflète la valeur de l'option `style` | -| repo_root_style | `"underline white"` | Style for git root directory name | +| repo_root_style | `"underline white"` | Style pour le nom du dossier racine Git |
@@ -907,28 +959,28 @@ truncation_length = 8 truncation_symbol = "…/" ``` -## Docker Context +## Contexte Docker -The `docker_context` module shows the currently active [Docker context](https://docs.docker.com/engine/context/working-with-contexts/) if it's not set to `default` or if the `DOCKER_MACHINE_NAME`, `DOCKER_HOST` or `DOCKER_CONTEXT` environment variables are set (as they are meant to override the context in use). +Le module `docker_context` affiche le [context Docker](https://docs.docker.com/engine/context/working-with-contexts/) actif, si sa valeur est différente de `default` ou si les variables d’environnement `DOCKER_MACHINE_NAME`, `DOCKER_HOST` ou `DOCKER_CONTEXT` sont définies (puisqu’elles sont utilisées pour changer le contexte utilisé). ### Options -| Option | Défaut | Description | -| ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `format` | `"via [$symbol$context]($style) "` | Format du module. | -| `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. | -| `only_with_files` | `true` | Only show when there's a match | -| `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). | -| `detect_files` | `["docker-compose.yml", "docker-compose.yaml", "Dockerfile"]` | Which filenames should trigger this module (needs `only_with_files` to be true). | -| `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). | -| `style` | `"blue bold"` | Le style du module. | -| `disabled` | `false` | Désactive le module `docker_context`. | +| Option | Défaut | Description | +| ------------------- | ------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------ | +| `format` | `"via [$symbol$context]($style) "` | Format du module. | +| `symbol` | `"🐳 "` | Le symbole utilisé avant d'afficher le contexte Docker. | +| `only_with_files` | `true` | Afficher uniquement quand il y a une correspondance | +| `detect_extensions` | `[]` | Quelles extensions devraient activer ce module (il faut que `only_with_files` soit réglé sur true). | +| `detect_files` | `["docker-compose.yml", "docker-compose.yaml", "Dockerfile"]` | Quels noms de fichier devraient activer ce module (il faut que `only_with_files` soit réglé sur true). | +| `detect_folders` | `[]` | Quels dossiers devraient activer ce module (il faut que `only_with_files` soit réglé sur true). | +| `style` | `"blue bold"` | Le style du module. | +| `disabled` | `false` | Désactive le module `docker_context`. | ### Variables | Variable | Exemple | Description | | --------- | -------------- | -------------------------------------- | -| context | `test_context` | Le contexte docker courant | +| context | `test_context` | Le contexte actuel de Docker | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -945,9 +997,9 @@ format = "via [🐋 $context](blue bold)" ## Dotnet -The `dotnet` module shows the relevant version of the [.NET Core SDK](https://dotnet.microsoft.com/) for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. +Le module `dotnet` montre la version pertinente du [SDK .NET Core](https://dotnet.microsoft.com/) pour le répertoire courant. Si le SDK a été épinglé dans le répertoire courant, la version épinglée est affichée. Sinon, le module affiche la dernière version installée du SDK. -By default this module will only be shown in your prompt when one or more of the following files are present in the current directory: +Par défaut, ce module ne sera affiché dans votre invite que lorsqu'un ou plusieurs des fichiers suivants sont présents dans le répertoire courant : - `global.json` - `project.json` @@ -958,11 +1010,11 @@ By default this module will only be shown in your prompt when one or more of the - `*.fsproj` - `*.xproj` -You'll also need the .NET Core SDK installed in order to use it correctly. +Vous aurez également besoin du SDK .NET Core pour pouvoir l'utiliser correctement. -Internally, this module uses its own mechanism for version detection. Typically it is twice as fast as running `dotnet --version`, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting `heuristic = false` in the module options. +En interne, ce module utilise son propre mécanisme de détection de version. Généralement, il est deux fois plus rapide que d'exécuter `dotnet --version`, mais il peut afficher une version incorrecte si votre projet .NET a une arborescence inhabituelle. Si la précision est plus importante que la vitesse, vous pouvez désactiver le mécanisme en définissant `heuristic = false` dans les options du module. -The module will also show the Target Framework Moniker () when there is a csproj file in the current directory. +The module will also show the Target Framework Moniker () when there is a `.csproj` file in the current directory. ### Options @@ -970,9 +1022,9 @@ The module will also show the Target Framework Moniker ( Nothing is shown. -- 1 job -> `symbol` is shown. -- 2 jobs or more -> `symbol` + `number` are shown. +- 0 tâche -> Rien n’est affiché. +- 1 tâche -> `symbol` est affiché. +- 2 taĉhes ou plus -> `symbol` + `number` sont affichés. ::: warning -This module is not supported on tcsh and nu. +Ce module n'est pas pris en charge sur tcsh et 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. +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. ::: ### Options -| 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. | -| `symbol` | `"✦"` | The string used to represent the `symbol` variable. | -| `style` | `"bold blue"` | Le style du module. | -| `disabled` | `false` | Désactive le module `jobs`. | +| 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. | +| `symbol` | `"✦"` | La chaine utilisée pour représenter la variable `symbole`. | +| `style` | `"bold blue"` | Le style du module. | +| `disabled` | `false` | Désactive le module `jobs`. | -*: This option is deprecated, please use the `number_threshold` and `symbol_threshold` options instead. +*: Cette option is dépréciée, utilisez les options `number_threshold` et `symbol_threshold` à la place. ### Variables | Variable | Exemple | Description | | --------- | ------- | -------------------------------------- | -| number | `1` | The number of jobs | +| number | `1` | Le nombre de tâches | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -1794,7 +1846,7 @@ symbol_threshold = 0 ## Julia -The `julia` module shows the currently installed version of [Julia](https://julialang.org/). By default the module will be shown if any of the following conditions are met: +Le module `julia` affiche la version actuellement installée de [Julia](https://julialang.org/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: - Le dossier courant contient un fichier `Project.toml` - Le dossier courant contient un fichier `Manifest.toml` @@ -1809,7 +1861,7 @@ The `julia` module shows the currently installed version of [Julia](https://juli | `detect_extensions` | `["jl"]` | Quelles extensions devraient activer ce module. | | `detect_files` | `["Project.toml", "Manifest.toml"]` | Les fichiers qui activent ce module. | | `detect_folders` | `[]` | Quels dossiers devraient activer ce module. | -| `symbol` | `"ஃ "` | A format string representing the symbol of Julia. | +| `symbol` | `"ஃ "` | Une chaîne de caractères représentant le symbole de Julia. | | `style` | `"bold purple"` | Le style du module. | | `disabled` | `false` | Désactive le module `Julia`. | @@ -1817,7 +1869,7 @@ The `julia` module shows the currently installed version of [Julia](https://juli | Variable | Exemple | Description | | --------- | -------- | -------------------------------------- | -| version | `v1.4.0` | The version of `julia` | +| version | `v1.4.0` | La version de `julia` | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -1834,7 +1886,7 @@ symbol = "∴ " ## Kotlin -The `kotlin` module shows the currently installed version of [Kotlin](https://kotlinlang.org/). By default the module will be shown if any of the following conditions are met: +Le module `kotlin` affiche la version actuellement installée de [Kotlin](https://kotlinlang.org/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: - Le dossier courant contient un fichier `.kt` ou `.kts` @@ -1847,16 +1899,16 @@ The `kotlin` module shows the currently installed version of [Kotlin](https://ko | `detect_extensions` | `["kt", "kts"]` | Quelles extensions devraient activer ce module. | | `detect_files` | `[]` | Les fichiers qui activent ce module. | | `detect_folders` | `[]` | Quels dossiers devraient activer ce module. | -| `symbol` | `"🅺 "` | A format string representing the symbol of Kotlin. | +| `symbol` | `"🅺 "` | Une chaîne de caractères représentant le symbole de Kotlin. | | `style` | `"bold blue"` | Le style du module. | -| `kotlin_binary` | `"kotlin"` | Configures the kotlin binary that Starship executes when getting the version. | +| `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`. | ### Variables | Variable | Exemple | Description | | --------- | --------- | -------------------------------------- | -| version | `v1.4.21` | The version of `kotlin` | +| version | `v1.4.21` | La version de `kotlin` | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -1881,34 +1933,34 @@ 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`. If the `$KUBECONFIG` env var is set the module will use that if not it will use the `~/.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`. Si la variable d'environnement `$KUBECONFIG` est définie, le module l'utilisera sinon il utilisera le fichier `~/.kube/config`. ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. ::: ### Options -| Option | Défaut | Description | -| ----------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | -| `symbol` | `"☸ "` | A format string representing the symbol displayed before the Cluster. | -| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | Format du module. | -| `style` | `"cyan bold"` | Le style du module. | -| `context_aliases` | | Table of context aliases to display. | -| `disabled` | `true` | Désactiver le module `kubernetes`. | +| Option | Défaut | Description | +| ----------------- | ---------------------------------------------------- | ---------------------------------------------------------------------- | +| `symbol` | `"☸ "` | 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 du module. | +| `context_aliases` | | Tableau des alias de contexte à afficher. | +| `disabled` | `true` | Désactiver le module `kubernetes`. | ### Variables -| 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 | -| symbol | | Reflète la valeur de l'option `symbol` | -| style\* | | Reflète la valeur de l'option `style` | +| 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 | +| symbol | | Reflète la valeur de l'option `symbol` | +| style\* | | Reflète la valeur de l'option `style` | *: Cette variable peut uniquement être utilisée dans une chaine de style @@ -1947,15 +1999,15 @@ Long and automatically generated cluster names can be identified and shortened u "gke_.*_(?P[\\w-]+)" = "gke-$var_cluster" ``` -## Line Break +## Saut de ligne -The `line_break` module separates the prompt into two lines. +Le module `line_break` sépare l'invite en deux lignes. ### Options | Option | Défaut | Description | | ---------- | ------- | ----------------------------------------------------------------------- | -| `disabled` | `false` | Désactive le module `line_break`, mettant l'invite sur une seule ligne. | +| `disabled` | `false` | Désactive le module `line_break` , faisant de l'invite une seule ligne. | ### Exemple @@ -1966,24 +2018,24 @@ The `line_break` module separates the prompt into two lines. disabled = true ``` -## Local IP +## IP locale -The `localip` module shows the IPv4 address of the primary network interface. +Le module `localip` affiche l’adresse IPv4 de l’interface réseau principale. ### Options -| 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 du module. | -| `disabled` | `true` | Désactive le module `localip`. | +| 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 du module. | +| `disabled` | `true` | Désactive le module `localip`. | ### Variables | Variable | Exemple | Description | | --------- | ------------ | ------------------------------------- | -| localipv4 | 192.168.1.13 | Contains the primary IPv4 address | +| localipv4 | 192.168.1.13 | Contient l’adresse IPv4 principale | | style\* | | Reflète la valeur de l'option `style` | *: Cette variable peut uniquement être utilisée dans une chaine de style @@ -2001,7 +2053,7 @@ disabled = false ## Lua -The `lua` module shows the currently installed version of [Lua](http://www.lua.org/). By default the module will be shown if any of the following conditions are met: +Le module `lua` affiche la version actuellement installée de [Lua](http://www.lua.org/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: - Le dossier courant contient un fichier `.lua-version` - Le dossier courant contient un dossier `lua` @@ -2013,19 +2065,19 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. | +| `symbol` | `"🌙 "` | Une chaîne de caractères représentant le symbole de Lua. | | `detect_extensions` | `["lua"]` | Quelles extensions devraient activer 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 du module. | -| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. | +| `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`. | ### Variables | Variable | Exemple | Description | | --------- | -------- | -------------------------------------- | -| version | `v5.4.0` | The version of `lua` | +| version | `v5.4.0` | La version de `lua` | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -2040,40 +2092,40 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o format = "via [🌕 $version](bold blue) " ``` -## Memory Usage +## Utilisation mémoire -The `memory_usage` module shows current system memory and swap usage. +Le module `memory_usage` affiche la mémoire système actuelle et l'utilisation de swap. -By default the swap usage is displayed if the total system swap is non-zero. +Par défaut, l'utilisation du swap est affichée si le swap total du système n'est pas nul. ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. ::: ### Options -| Option | Défaut | Description | -| ----------- | ----------------------------------------------- | -------------------------------------------------------- | -| `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. | -| `format` | `"via $symbol [${ram}( \| ${swap})]($style) "` | Format du module. | -| `symbol` | `"🐏"` | The symbol used before displaying the memory usage. | -| `style` | `"bold dimmed white"` | Le style du module. | -| `disabled` | `true` | Désactiver le module `memory_usage`. | +| 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. | +| `symbol` | `"🐏"` | Le symbole utilisé avant d'afficher l'utilisation de la mémoire. | +| `style` | `"bold dimmed white"` | Le style du module. | +| `disabled` | `true` | Désactiver le module `memory_usage`. | ### Variables -| 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. | -| symbol | `🐏` | Reflète la valeur de l'option `symbol` | -| style\* | | Reflète la valeur de l'option `style` | +| 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. | +| symbol | `🐏` | Reflète la valeur de l'option `symbol` | +| style\* | | Reflète la valeur de l'option `style` | -*: 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 +*: 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 ### Exemple @@ -2087,26 +2139,26 @@ symbol = " " style = "bold dimmed green" ``` -## Mercurial Branch +## Branche Mercurial -The `hg_branch` module shows the active branch of the repo in your current directory. +Le module `hg_branch` affiche la branche active du dépôt dans votre répertoire courant. ### Options -| Option | Défaut | Description | -| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------- | -| `symbol` | `" "` | The symbol used before the hg bookmark or branch name of the repo in your current directory. | -| `style` | `"bold purple"` | Le style du module. | -| `format` | `"on [$symbol$branch]($style) "` | Format du 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` | Désactive le module `hg_branch`. | +| Option | Défaut | Description | +| ------------------- | -------------------------------- | ---------------------------------------------------------------------------------------------------------- | +| `symbol` | `" "` | 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 du 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`. | ### Variables | Variable | Exemple | Description | | --------- | -------- | -------------------------------------- | -| branch | `master` | The active mercurial branch | +| branch | `master` | La branche mercuriale active | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -2125,7 +2177,7 @@ truncation_symbol = "" ## Nim -The `nim` module shows the currently installed version of [Nim](https://nim-lang.org/). By default the module will be shown if any of the following conditions are met: +Le module `nim` affiche la version actuellement installée de [Nim](https://nim-lang.org/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: - Le dossier courant contient un fichier `nim.cfg` - Le dossier courant contient un fichier avec l’extension `.nim` @@ -2136,9 +2188,9 @@ The `nim` module shows the currently installed version of [Nim](https://nim-lang | Option | Défaut | Description | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module | +| `format` | `"via [$symbol($version )]($style)"` | Format du module | | `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. | +| `symbol` | `"👑 "` | Le symbole utilisé avant d'afficher la version de Nim. | | `detect_extensions` | `["nim", "nims", "nimble"]` | Quelles extensions devraient activer ce module. | | `detect_files` | `["nim.cfg"]` | Les fichiers qui activent ce module. | | `detect_folders` | `[]` | Les dossiers qui activent ce module. | @@ -2149,7 +2201,7 @@ The `nim` module shows the currently installed version of [Nim](https://nim-lang | Variable | Exemple | Description | | --------- | -------- | -------------------------------------- | -| version | `v1.2.0` | The version of `nimc` | +| version | `v1.2.0` | La version de `nim` | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -2167,25 +2219,25 @@ symbol = "🎣 " ## 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. +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. ### Options -| Option | Défaut | Description | -| ------------ | ---------------------------------------------- | ----------------------------------------------------- | -| `format` | `'via [$symbol$state( \($name\))]($style) '` | Format du module. | -| `symbol` | `"❄️ "` | A format string representing the symbol of nix-shell. | -| `style` | `"bold blue"` | Le style du 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` | Désactive le module `nix_shell`. | +| Option | Défaut | Description | +| ------------ | ---------------------------------------------- | ---------------------------------------------------------- | +| `format` | `'via [$symbol$state( \($name\))]($style) '` | Format du module. | +| `symbol` | `"❄️ "` | Une chaîne de format représentant le symbole de nix-shell. | +| `style` | `"bold blue"` | Le style du 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`. | ### Variables | Variable | Exemple | Description | | --------- | ------- | -------------------------------------- | -| state | `pure` | The state of the nix-shell | -| name | `lorri` | The name of the nix-shell | +| state | `pure` | L’état du nix-shell | +| name | `lorri` | Le nom du nix-shell | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -2205,12 +2257,12 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' ## Node.js -The `nodejs` module shows the currently installed version of [Node.js](https://nodejs.org/). By default the module will be shown if any of the following conditions are met: +Le module `nodejs` affiche la version actuellement installée de [Node.js](https://nodejs.org/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: - Le dossier courant contient un fichier `package.json` - Le dossier courant contient un fichier `.node-version` - Le dossier courant contient un fichier `.nvmrc` -- The current directory contains a `node_modules` directory +- Le répertoire courant contient un répertoire `node_modules` - Le dossier courant contient un fichier avec l’extension `.js`, `.mjs` ou `.cjs` - Le dossier courant contient un fichier avec l’extension `.ts`, `.mts` ou `.cts` @@ -2220,7 +2272,7 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n | ------------------- | ------------------------------------------ | ----------------------------------------------------------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | -| `symbol` | `" "` | A format string representing the symbol of Node.js. | +| `symbol` | `" "` | Une chaîne de caractères représentant le symbole de Node.js. | | `detect_extensions` | `["js", "mjs", "cjs", "ts", "mts", "cts"]` | Quelles extensions devraient activer ce module. | | `detect_files` | `["package.json", ".node-version"]` | Les fichiers qui activent ce module. | | `detect_folders` | `["node_modules"]` | Les dossiers qui activent ce module. | @@ -2232,7 +2284,7 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n | Variable | Exemple | Description | | --------- | ---------- | -------------------------------------- | -| version | `v13.12.0` | The version of `node` | +| version | `v13.12.0` | La version de `node` | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -2249,10 +2301,10 @@ format = "via [🤖 $version](bold green) " ## OCaml -The `ocaml` module shows the currently installed version of [OCaml](https://ocaml.org/). By default the module will be shown if any of the following conditions are met: +Le module `ocaml` affiche la version actuellement installée de [OCaml](https://ocaml.org/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: - Le dossier courant contient un fichier avec l’extension `.opam` ou un dossier `_opam` -- The current directory contains a `esy.lock` directory +- Le répertoire courant contient un répertoire `esy.lock` - Le dossier courant contient un fichier `dune` ou `dune-project` - Le dossier courant contient un fichier `jbuild` ou `jbuild-ignore` - Le dossier courant contient un fichier `.merlin` @@ -2264,9 +2316,9 @@ The `ocaml` module shows the currently installed version of [OCaml](https://ocam | ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | | `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` | -| `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. | +| `symbol` | `"🐫 "` | 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. | | `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | Quelles extensions devraient activer 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. | @@ -2277,7 +2329,7 @@ The `ocaml` module shows the currently installed version of [OCaml](https://ocam | Variable | Exemple | Description | | ---------------- | ------------ | ----------------------------------------------------------------- | -| version | `v4.10.0` | The version of `ocaml` | +| version | `v4.10.0` | La version de `ocaml` | | switch_name | `my-project` | The active OPAM switch | | switch_indicator | | Mirrors the value of `indicator` for currently active OPAM switch | | symbol | | Reflète la valeur de l'option `symbol` | @@ -2303,7 +2355,7 @@ 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. | -| `symbol` | `"☁️ "` | The symbol used before displaying the current OpenStack cloud. | +| `symbol` | `"☁️ "` | Le symbole utilisé avant d'afficher le cloud OpenStack actuel. | | `style` | `"bold yellow"` | Le style du module. | | `disabled` | `false` | Désactive le module `openstack`. | @@ -2329,16 +2381,16 @@ style = "bold yellow" symbol = "☁️ " ``` -## Package Version +## Version du package -The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards` and `dart` packages. +The `package` module is shown when the current directory is the repository for a package, and shows its current version. Le module gère actuellement les paquets `npm`, `nimble`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards` et `dart`. -- [**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 -- [**Nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command -- [**Poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory -- [**Python**](https://www.python.org) - The `python` package version is extracted from the `setup.cfg` present in the current directory -- [**Composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory +- [**npm**](https://docs.npmjs.com/cli/commands/npm) – La version du paquet `npm` est extraite du `package.json` présent dans le répertoire courant +- [**Cargo**](https://doc.rust-lang.org/cargo/) – La version du paquet `cargo` est extraite du `Cargo.toml` présent dans le répertoire courant +- [**Nimble**](https://github.com/nim-lang/nimble) - La version du paquet `nimble` est extraite du fichier `*.nimble` dans le répertoire courant avec la commande `nimble dump` +- [**Poetry**](https://python-poetry.org/) – La version du paquet `poetry` est extraite du `pyproject.toml` présent dans le répertoire courant +- [**Python**](https://www.python.org) - La version du paquet `python` est extraite du `setup.cfg` présent dans le répertoire courant +- [**Composer**](https://getcomposer.org/) – La version du paquet `composer` est extraite du `composer.json` présent dans le répertoire courant - [**Gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present - [**Julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present - [**Mix**](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present @@ -2348,7 +2400,7 @@ The `package` module is shown when the current directory is the repository for a - [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present - [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present - [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory -- [**Dart**](https://pub.dev/) - The `dart` package version is extracted from the `pubspec.yaml` present in the current directory +- [**Dart**](https://pub.dev/) – La version du paquet `dart` est extrait du `pubspec.yaml` présent dans le répertoire courant > ⚠️ La version montrée est celle du paquet dont le code source est dans votre dossier courant, pas votre gestionnaire de paquet. @@ -2357,7 +2409,7 @@ 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. | -| `symbol` | `"📦 "` | The symbol used before displaying the version the package. | +| `symbol` | `"📦 "` | Le symbole utilisé avant d'afficher la version du paquet. | | `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | | `style` | `"bold 208"` | Le style du module. | | `display_private` | `false` | Enable displaying version for packages marked as private. | @@ -2367,7 +2419,7 @@ The `package` module is shown when the current directory is the repository for a | Variable | Exemple | Description | | --------- | -------- | -------------------------------------- | -| version | `v1.0.0` | The version of your package | +| version | `v1.0.0` | La version de votre package | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -2384,13 +2436,13 @@ format = "via [🎁 $version](208 bold) " ## Perl -The `perl` module shows the currently installed version of [Perl](https://www.perl.org/). By default the module will be shown if any of the following conditions are met: +Le module `perl` affiche la version actuellement installée de [Perl](https://www.perl.org/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: - Le dossier courant contient un fichier `Makefile.PL` ou `Build.PL` - Le dossier courant contient un fichier `cpanfile` ou `cpanfile.snapshot` - Le dossier courant contient un fichier `META.json` ou `META.yml` - Le dossier courant contient un fichier `.perl-version` -- The current directory contains a `.pl`, `.pm` or `.pod` +- Le répertoire courant contient un fichier `.pl`, `.pm` ou `.pod` ### Options @@ -2398,7 +2450,7 @@ The `perl` module shows the currently installed version of [Perl](https://www.pe | ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | | `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` | -| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | +| `symbol` | `"🐪 "` | Le symbole utilisé avant d'afficher la version de Perl | | `detect_extensions` | `["pl", "pm", "pod"]` | Quelles extensions devraient activer 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. | @@ -2409,7 +2461,7 @@ The `perl` module shows the currently installed version of [Perl](https://www.pe | Variable | Exemple | Description | | --------- | --------- | -------------------------------------- | -| version | `v5.26.1` | The version of `perl` | +| version | `v5.26.1` | La version de `perl` | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -2424,11 +2476,11 @@ format = "via [🦪 $version]($style) " ## PHP -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: +Le module `php` affiche la version actuellement installée de [PHP](https://www.php.net/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: - Le dossier courant contient un fichier `composer.json` - Le dossier courant contient un fichier `.php-version` -- The current directory contains a `.php` extension +- Le répertoire courant contient un fichier avec l'extension `.php` ### Options @@ -2436,7 +2488,7 @@ The `php` module shows the currently installed version of [PHP](https://www.php. | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | +| `symbol` | `"🐘 "` | Le symbole utilisé avant d'afficher la version de PHP. | | `detect_extensions` | `["php"]` | Quelles extensions devraient activer ce module. | | `detect_files` | `["composer.json", ".php-version"]` | Les fichiers qui activent ce module. | | `detect_folders` | `[]` | Les dossiers qui activent ce module. | @@ -2447,7 +2499,7 @@ The `php` module shows the currently installed version of [PHP](https://www.php. | Variable | Exemple | Description | | --------- | -------- | -------------------------------------- | -| version | `v7.3.8` | The version of `php` | +| version | `v7.3.8` | La version de `php` | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -2472,7 +2524,7 @@ By default the Pulumi version is not shown, since it takes an order of magnitude ::: -By default the module will be shown if any of the following conditions are met: +Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: - The current directory contains either `Pulumi.yaml` or `Pulumi.yml` - A parent directory contains either `Pulumi.yaml` or `Pulumi.yml` @@ -2489,19 +2541,19 @@ By default the module will be shown if any of the following conditions are met: ### Variables -| Variable | Exemple | Description | -| --------- | ---------- | -------------------------------------- | -| version | `v0.12.24` | The version of `pulumi` | -| stack | `dev` | The current Pulumi stack | -| username | `alice` | The current Pulumi username | -| symbol | | Reflète la valeur de l'option `symbol` | -| style\* | | Reflète la valeur de l'option `style` | +| 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 | +| symbol | | Reflète la valeur de l'option `symbol` | +| style\* | | Reflète la valeur de l'option `style` | *: Cette variable peut uniquement être utilisée dans une chaine de style ### Exemple -#### With Pulumi Version +#### Avec la version de Pulumi ```toml # ~/.config/starship.toml @@ -2510,7 +2562,7 @@ By default the module will be shown if any of the following conditions are met: format = "[🛥 ($version )$stack]($style) " ``` -#### Without Pulumi version +#### Sans la version de Pulumi ```toml # ~/.config/starship.toml @@ -2521,7 +2573,7 @@ format = "[$symbol$stack]($style) " ## PureScript -The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. By default the module will be shown if any of the following conditions are met: +Le module `purescript` affiche la version actuellement installée de [PureScript](https://www.purescript.org/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: - Le dossier courant contient un fichier `spago.dhall` - Le dossier courant contient un fichier avec l’extension `.purs` @@ -2532,7 +2584,7 @@ The `purescript` module shows the currently installed version of [PureScript](ht | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | +| `symbol` | `"<=> "` | Le symbole utilisé avant d'afficher la version de PureScript. | | `detect_extensions` | `["purs"]` | Quelles extensions devraient activer ce module. | | `detect_files` | `["spago.dhall"]` | Les fichiers qui activent ce module. | | `detect_folders` | `[]` | Les dossiers qui activent ce module. | @@ -2543,7 +2595,7 @@ The `purescript` module shows the currently installed version of [PureScript](ht | Variable | Exemple | Description | | --------- | -------- | -------------------------------------- | -| version | `0.13.5` | The version of `purescript` | +| version | `0.13.5` | La version de `purescript` | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -2560,11 +2612,11 @@ format = "via [$symbol$version](bold white)" ## Python -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. +Le module `python` affiche la version actuellement installée de [Python](https://www.python.org/) ainsi que la version d'[environnement virtuel Python](https://docs.python.org/tutorial/venv.html) si il y en a un d'activé. -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`. +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`. -By default the module will be shown if any of the following conditions are met: +Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: - Le dossier courant contient un fichier `.python-version` - Le dossier courant contient un fichier `Pipfile` @@ -2574,7 +2626,7 @@ By default the module will be shown if any of the following conditions are met: - Le dossier courant contient un fichier `setup.py` - Le dossier courant contient un fichier `tox.ini` - Le dossier courant contient un fichier avec l’extension `.py`. -- A virtual environment is currently activated +- Un environnement virtuel est actuellement activé ### Options @@ -2582,33 +2634,33 @@ By default the module will be shown if any of the following conditions are met: | -------------------- | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | | `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` | -| `symbol` | `"🐍 "` | A format string representing the symbol of Python | +| `symbol` | `"🐍 "` | Une chaîne de caractères représentant le symbole de Python | | `style` | `"yellow bold"` | Le style du module. | -| `pyenv_version_name` | `false` | Use pyenv to get Python version | +| `pyenv_version_name` | `false` | Utiliser pyenv pour obtenir la version de Python | | `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 | +| `detect_extensions` | `["py"]` | Quelles extensions devraient activer 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`. | ::: tip -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. +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 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. +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). Si vous ne travaillez plus avec Python 2 mais ne pouvez pas le supprimer du système, changer ceci par `"python3"` cachera tous les Python version 2, voir l’exemple ci-dessous. ::: ### Variables -| Variable | Exemple | Description | -| ------------ | --------------- | ------------------------------------------ | -| version | `"v3.8.1"` | The version of `python` | -| symbol | `"🐍 "` | 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 | +| Variable | Exemple | Description | +| ------------ | --------------- | -------------------------------------------- | +| version | `"v3.8.1"` | La version de `python` | +| symbol | `"🐍 "` | 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 | ### Exemple @@ -2624,7 +2676,7 @@ pyenv_version_name = true # ~/.config/starship.toml [python] -# Only use the `python3` binary to get the version. +# N'utilisez que le binaire `python3` pour obtenir la version. python_binary = "python3" ``` @@ -2632,7 +2684,7 @@ python_binary = "python3" # ~/.config/starship.toml [python] -# Don't trigger for files with the py extension +# Ne pas déclencher pour les fichiers avec l'extension py detect_extensions = [] ``` @@ -2640,16 +2692,17 @@ detect_extensions = [] # ~/.config/starship.toml [python] -# Display the version of python from inside a local venv. +# Affiche la version de python depuis l'intérieur d'un venv local. # -# 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? +# 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? python_binary = ["./venv/bin/python", "python", "python3", "python2"] ``` ## R -The `rlang` module shows the currently installed version of [R](https://www.r-project.org/). The module will be shown if any of the following conditions are met: +Le module `rlang` affiche la version de [R](https://www.r-project.org/) actuellement installée. Le module s’affiche si l’une de ces conditions est remplie : - Le dossier courant contient un fichier avec l’extension `.R`. - Le dossier courant contient un fichier avec l’extension `.Rd`. @@ -2657,7 +2710,7 @@ The `rlang` module shows the currently installed version of [R](https://www.r-pr - Le dossier courant contient un fichier avec l’extension `.Rproj`. - Le dossier courant contient un fichier avec l’extension `.Rsx`. - Le dossier courant contient un fichier `.Rprofile` -- The current directory contains a `.Rproj.user` folder +- Le répertoire courant contient un dossier `.Rproj.user` ### Options @@ -2665,18 +2718,18 @@ The `rlang` module shows the currently installed version of [R](https://www.r-pr | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"📐"` | A format string representing the symbol of R. | +| `symbol` | `"📐"` | Une chaîne de caractères représentant le symbole de R. | | `style` | `"blue bold"` | Le style du module. | -| `detect_extensions` | `["R", "Rd", "Rmd", "Rproj", "Rsx"]` | Which extensions should trigger this module | -| `detect_files` | `[".Rprofile"]` | Which filenames should trigger this module | -| `detect_folders` | `[".Rproj.user"]` | Which folders should trigger this module | +| `detect_extensions` | `["R", "Rd", "Rmd", "Rproj", "Rsx"]` | Quelles extensions devraient activer 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`. | ### Variables | Variable | Exemple | Description | | -------- | ------------- | -------------------------------------- | -| version | `v4.0.5` | The version of `R` | +| version | `v4.0.5` | La version de `R` | | symbol | | Reflète la valeur de l'option `symbol` | | style | `"blue bold"` | Reflète la valeur de l'option `style` | @@ -2691,7 +2744,7 @@ format = "with [📐 $version](blue bold) " ## Red -By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). Le module est affiché si l'une de ces conditions est remplie : +Par défaut, le module `red` affiche la version actuellement installée de [Red](https://www.red-lang.org/). Le module est affiché si l'une de ces conditions est remplie : - Le dossier courant contient un fichier avec l’extension `.red` ou `.reds` @@ -2701,7 +2754,7 @@ By default the `red` module shows the currently installed version of [Red](https | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"🔺 "` | A format string representing the symbol of Red. | +| `symbol` | `"🔺 "` | Une chaîne de caractères représentant le symbole de Red. | | `detect_extensions` | `["red"]` | Quelles extensions devraient activer ce module. | | `detect_files` | `[]` | Les fichiers qui activent ce module. | | `detect_folders` | `[]` | Les dossiers qui activent ce module. | @@ -2712,7 +2765,7 @@ By default the `red` module shows the currently installed version of [Red](https | Variable | Exemple | Description | | --------- | -------- | -------------------------------------- | -| version | `v2.5.1` | The version of `red` | +| version | `v2.5.1` | La version de `red` | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -2729,14 +2782,14 @@ symbol = "🔴 " ## Ruby -By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). Le module est affiché si l'une de ces conditions est remplie : +Par défaut, le module `ruby` affiche la version actuellement installée de [Ruby](https://www.ruby-lang.org/). Le module est affiché si l'une de ces conditions est remplie : - Le dossier courant contient un fichier `Gemfile` - Le dossier courant contient un fichier `.ruby-version` - Le dossier courant contient un fichier `.rb` -- The environment variables `RUBY_VERSION` or `RBENV_VERSION` are set +- La variable d’environnement `RUBY_VERSION` ou `RBENV_VERSION` est définie -Starship gets the current Ruby version by running `ruby -v`. +Starship obtient la version actuelle de Ruby en exécutant `ruby -v`. ### Options @@ -2744,19 +2797,19 @@ Starship gets the current Ruby version by running `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` | -| `symbol` | `"💎 "` | A format string representing the symbol of Ruby. | +| `symbol` | `"💎 "` | Une chaîne de caractères représentant le symbole de Ruby. | | `detect_extensions` | `["rb"]` | Quelles extensions devraient activer 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"]` | Which environment variables should trigger this module. | -| `style` | `"bold red"` | Le style du module. | +| `detect_variables` | `["RUBY_VERSION", "RBENV_VERSION"]` | Les variables d’environnement qui activent ce module. | +| `style` | `"bold green"` | Le style du module. | | `disabled` | `false` | Désactive le module `ruby`. | ### Variables | Variable | Exemple | Description | | --------- | -------- | -------------------------------------- | -| version | `v2.5.1` | The version of `ruby` | +| version | `v2.5.1` | La version de `ruby` | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -2773,7 +2826,7 @@ symbol = "🔺 " ## Rust -By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). Le module est affiché si l'une de ces conditions est remplie : +Par défaut, le module `rust` affiche la version actuellement installée de [Rust](https://www.rust-lang.org/). Le module est affiché si l'une de ces conditions est remplie : - Le dossier courant contient un fichier `Cargo.toml` - Le dossier courant contient un fichier avec l’extension `.rs` @@ -2784,18 +2837,18 @@ By default the `rust` module shows the currently installed version of [Rust](htt | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"🦀 "` | A format string representing the symbol of Rust | +| `symbol` | `"🦀 "` | Une chaîne de caractères représentant le symbole de Rust | | `detect_extensions` | `["rs"]` | Quelles extensions devraient activer 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 du module. | +| `style` | `"bold green"` | Le style du module. | | `disabled` | `false` | Désactive le module `rust`. | ### Variables | Variable | Exemple | Description | | --------- | ----------------- | -------------------------------------- | -| version | `v1.43.0-nightly` | The version of `rustc` | +| version | `v1.43.0-nightly` | La version de `rustc` | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -2812,11 +2865,11 @@ format = "via [⚙️ $version](red bold)" ## Scala -The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). By default the module will be shown if any of the following conditions are met: +Le module `scala` affiche la version actuellement installée de [Scala](https://www.scala-lang.org/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: - Le dossier courant contient un fichier `build.sbt`, `.scalaenv` ou `.sbtenv` - Le dossier courant contient un fichier avec l’extension `.scala` ou `.sbt` -- The current directory contains a directory named `.metals` +- Le répertoire courant contient un répertoire nommé `.metals` ### Options @@ -2827,7 +2880,7 @@ The `scala` module shows the currently installed version of [Scala](https://www. | `detect_extensions` | `["sbt", "scala"]` | Quelles extensions devraient activer ce module. | | `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Les fichiers qui activent ce module. | | `detect_folders` | `[".metals"]` | Quels dossiers devraient activer ce module. | -| `symbol` | `"🆂 "` | A format string representing the symbol of Scala. | +| `symbol` | `"🆂 "` | Une chaîne de caractères représentant le symbole de Scala. | | `style` | `"red dimmed"` | Le style du module. | | `disabled` | `false` | Désactive le module `scala`. | @@ -2835,7 +2888,7 @@ The `scala` module shows the currently installed version of [Scala](https://www. | Variable | Exemple | Description | | --------- | -------- | -------------------------------------- | -| version | `2.13.5` | The version of `scala` | +| version | `2.13.5` | La version de `scala` | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -2852,39 +2905,39 @@ symbol = "🌟 " ## Shell -The `shell` module shows an indicator for currently used shell. +Le module `shell` affiche un indicateur en fonction du shell actuellement utilisé. ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. ::: ### Options -| 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 du module. | -| `disabled` | `true` | Désactive le module `shell`. | +| 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 du module. | +| `disabled` | `true` | Désactive le module `shell`. | ### Variables | Variable | Défaut | Description | | --------- | ------ | ---------------------------------------------------------- | | indicator | | Mirrors the value of `indicator` for currently used shell. | -| style\* | | Mirrors the value of option `style`. | +| style\* | | Reflète la valeur de l'option `style`. | *: Cette variable peut uniquement être utilisée dans une chaine de style @@ -2920,7 +2973,7 @@ The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/int | Variable | Exemple | Description | | --------- | ------- | -------------------------------------- | -| shlvl | `3` | The current value of `SHLVL` | +| shlvl | `3` | La valeur actuelle de `SHLVL` | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -2943,18 +2996,18 @@ The `singularity` module shows the current [Singularity](https://sylabs.io/singu ### Options -| Option | Défaut | Description | -| ---------- | -------------------------------- | ------------------------------------------------ | -| `format` | `'[$symbol\[$env\]]($style) '` | Format du module. | -| `symbol` | `""` | A format string displayed before the image name. | -| `style` | `"bold dimmed blue"` | Le style du module. | -| `disabled` | `false` | Désactive le module `singularity`. | +| Option | Défaut | Description | +| ---------- | -------------------------------- | ------------------------------------------------------ | +| `format` | `'[$symbol\[$env\]]($style) '` | Format du module. | +| `symbol` | `""` | Une chaîne de format affichée avant le nom de l'image. | +| `style` | `"bold dimmed blue"` | Le style du module. | +| `disabled` | `false` | Désactive le module `singularity`. | ### Variables | Variable | Exemple | Description | | --------- | ------------ | -------------------------------------- | -| env | `centos.img` | The current Singularity image | +| env | `centos.img` | L’image Singularity actuelle | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -2969,13 +3022,46 @@ The `singularity` module shows the current [Singularity](https://sylabs.io/singu format = '[📦 \[$env\]]($style) ' ``` +## Spack + +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` | The number of directories the environment path should be truncated to. `0` ne signifie pas de troncature. Regardez aussi le module [`directory`](#directory). | +| `symbol` | `"🅢 "` | Le symbole utilisé avant le nom d'environnement. | +| `style` | `"bold blue"` | Le style du module. | +| `format` | `"via [$symbol$environment]($style) "` | Format du module. | +| `disabled` | `false` | Disables the `spack` module. | + +### Variables + +| Variable | Exemple | Description | +| ------------- | ------------ | -------------------------------------- | +| environnement | `astronauts` | The current spack environment | +| symbol | | Reflète la valeur de l'option `symbol` | +| style\* | | Reflète la valeur de l'option `style` | + +*: Cette variable peut uniquement être utilisée dans une chaine de style + +### Exemple + +```toml +# ~/.config/starship.toml + +[spack] +format = "[$symbol$environment](dimmed blue) " +``` + ## Status -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. +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. ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. ::: @@ -2983,14 +3069,14 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | Option | Défaut | Description | | ----------------------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------- | -| `format` | `"[$symbol$status]($style) "` | The format of the module | +| `format` | `"[$symbol$status]($style) "` | Le format du 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"` | Le style du module. | +| `style` | `"bold green"` | Le style du module. | | `recognize_signal_code` | `true` | Enable signal mapping from exit code | | `map_symbol` | `false` | Enable symbols mapping from exit code | | `pipestatus` | `false` | Enable pipestatus reporting | @@ -3002,10 +3088,10 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | Variable | Exemple | Description | | -------------- | ------- | ------------------------------------------------------------------------------------------- | -| 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 | +| status | `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 | | 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 | @@ -3035,7 +3121,7 @@ The `sudo` module displays if sudo credentials are currently cached. The module ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. ::: @@ -3043,7 +3129,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | Option | Défaut | Description | | --------------- | ----------------------- | ------------------------------------------------------- | -| `format` | `[as $symbol]($style)"` | The format of the module | +| `format` | `[as $symbol]($style)"` | Le format du module | | `symbol` | `"🧙 "` | The symbol displayed when credentials are cached | | `style` | `"bold blue"` | Le style du module. | | `allow_windows` | `false` | Since windows has no default sudo, default is disabled. | @@ -3070,7 +3156,7 @@ disabled = false ``` ```toml -# On windows +# Sous Windows # $HOME\.starship\config.toml [sudo] @@ -3080,7 +3166,7 @@ disabled = false ## Swift -By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). Le module est affiché si l'une de ces conditions est remplie : +Par défaut, le module `swift` affiche la version actuellement installée de [Swift](https://swift.org/). Le module est affiché si l'une de ces conditions est remplie : - Le dossier courant contient un fichier `Package.swift` - Le dossier courant contient un fichier avec l’extension `.swift` @@ -3091,7 +3177,7 @@ By default the `swift` module shows the currently installed version of [Swift](h | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | +| `symbol` | `"🐦 "` | Une chaîne de caractères représentant le symbole de Swift | | `detect_extensions` | `["swift"]` | Quelles extensions devraient activer ce module. | | `detect_files` | `["Package.swift"]` | Les fichiers qui activent ce module. | | `detect_folders` | `[]` | Les dossiers qui activent ce module. | @@ -3102,7 +3188,7 @@ By default the `swift` module shows the currently installed version of [Swift](h | Variable | Exemple | Description | | --------- | -------- | -------------------------------------- | -| version | `v5.2.4` | The version of `swift` | +| version | `v5.2.4` | La version de `swift` | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -3119,7 +3205,7 @@ format = "via [🏎 $version](red bold)" ## Terraform -The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. +Le module `terraform` affiche [l’espace de travail Terraform](https://www.terraform.io/docs/language/state/workspaces.html) sélectionné et sa version. ::: tip @@ -3127,9 +3213,9 @@ By default the Terraform version is not shown, since this is slow for current ve ::: -By default the module will be shown if any of the following conditions are met: +Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: -- The current directory contains a `.terraform` folder +- Le dossier courant contient un dossier `.terraform` - Le dossier courant contient un fichier avec l’extension `.tf`, `.tfplan` ou `.tfstate` ### Options @@ -3138,7 +3224,7 @@ By default the module will be shown if any of the following conditions are met: | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------ | | `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` | -| `symbol` | `"💠"` | A format string shown before the terraform workspace. | +| `symbol` | `"💠"` | Une chaîne de format montrée avant l'espace de travail terraform. | | `detect_extensions` | `["tf", "tfplan", "tfstate"]` | Quelles extensions devraient activer ce module. | | `detect_files` | `[]` | Les fichiers qui activent ce module. | | `detect_folders` | `[".terraform"]` | Les dossiers qui activent ce module. | @@ -3149,8 +3235,8 @@ By default the module will be shown if any of the following conditions are met: | Variable | Exemple | Description | | --------- | ---------- | -------------------------------------- | -| version | `v0.12.24` | The version of `terraform` | -| workspace | `default` | The current Terraform workspace | +| version | `v0.12.24` | La version de `terraform` | +| workspace | `default` | L’espace de travail Terraform courant | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -3178,33 +3264,33 @@ format = "[🏎💨 $workspace]($style) " ## Date et Heure -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. +Le module `time` affiche l'heure actuelle **localement**. La valeur de `format` est utilisée par le package [`chrono`](https://crates.io/crates/chrono) pour contrôler la façon dont l'heure est affichée. Consultez la [doc de chrono strftime](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) pour découvrir les options disponibles. ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. ::: ### Options -| 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` | Désactiver le module `time`. | -| `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | +| 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ésactiver le module `time`. | +| `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | -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. +Si `use_12hr` est à `true`, alors `time_format` vaut `"%r"`. Sinon, il est défini comme `"%T"`. Définir manuellement `time_format` outrepasse le paramètre `use_12hr`. ### Variables | Variable | Exemple | Description | | --------- | ---------- | ------------------------------------- | -| time | `13:08:10` | The current time. | +| time | `13:08:10` | L’heure actuelle. | | style\* | | Reflète la valeur de l'option `style` | *: Cette variable peut uniquement être utilisée dans une chaine de style @@ -3222,14 +3308,14 @@ utc_time_offset = "-5" time_range = "10:00:00-14:00:00" ``` -## Username +## Nom d'utilisateur -The `username` module shows active user's username. Le module est affiché si l'une de ces conditions est remplie : +Le module `username` affiche le nom d'utilisateur de l'utilisateur actif. Le module est affiché si l'une de ces conditions est remplie : -- The current user is root -- The current user isn't the same as the one that is logged in -- The user is currently connected as an SSH session -- The variable `show_always` is set to true +- The current user is root/admin +- L'utilisateur courant est différent de celui connecté +- L'utilisateur est actuellement connecté à une session SSH +- La variable `show_always` a comme valeur true ::: tip @@ -3239,20 +3325,20 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, ` ### Options -| Option | Défaut | Description | -| ------------- | ----------------------- | --------------------------------------- | -| `style_root` | `"bold red"` | The style used when the user is root. | -| `style_user` | `"bold yellow"` | The style used for non-root users. | -| `format` | `"[$user]($style) in "` | Format du module. | -| `show_always` | `false` | Toujours afficher le module `username`. | -| `disabled` | `false` | Désactiver le module `username`. | +| Option | Défaut | Description | +| ------------- | ----------------------- | ------------------------------------------------ | +| `style_root` | `"bold green"` | The style used when the user is root/admin. | +| `style_user` | `"bold yellow"` | Le style utilisé pour les utilisateurs non-root. | +| `format` | `"[$user]($style) in "` | Format du module. | +| `show_always` | `false` | Toujours afficher le module `username`. | +| `disabled` | `false` | Désactiver le module `username`. | ### 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"` | The currently logged-in user ID. | +| `user` | `"matchai"` | L’identifiant de l’utilisateur courant. | ### Exemple @@ -3269,7 +3355,7 @@ show_always = true ## Vagrant -The `vagrant` module shows the currently installed version of [Vagrant](https://www.vagrantup.com/). By default the module will be shown if any of the following conditions are met: +Le module `vagrant` affiche la version actuellement installée de [Vagrant](https://www.vagrantup.com/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: - Le dossier courant contient un fichier `Vagrantfile` @@ -3279,7 +3365,7 @@ The `vagrant` module shows the currently installed version of [Vagrant](https:// | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | +| `symbol` | `"⍱ "` | Une chaîne de caractères représentant le symbole de Vagrant. | | `detect_extensions` | `[]` | Quelles extensions devraient activer ce module. | | `detect_files` | `["Vagrantfile"]` | Les fichiers qui activent ce module. | | `detect_folders` | `[]` | Les dossiers qui activent ce module. | @@ -3290,7 +3376,7 @@ The `vagrant` module shows the currently installed version of [Vagrant](https:// | Variable | Exemple | Description | | --------- | ---------------- | -------------------------------------- | -| version | `Vagrant 2.2.10` | The version of `Vagrant` | +| version | `Vagrant 2.2.10` | La version de `Vagrant` | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -3307,7 +3393,7 @@ format = "via [⍱ $version](bold white) " ## V -The `vlang` module shows you your currently installed version of [V](https://vlang.io/). By default the module will be shown if any of the following conditions are met: +Le module `vlang` affiche la version de [V](https://vlang.io/) installée. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: - Le dossier courant contient un fichier avec l’extension `.v` - Le dossier courant contient un fichier `v.mod`, `vpkg.json` ou `.vpkg-lock.json` @@ -3318,7 +3404,7 @@ The `vlang` module shows you your currently installed version of [V](https://vla | ------------------- | -------------------------------------------- | ------------------------------------------------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"V "` | A format string representing the symbol of V | +| `symbol` | `"V "` | Une chaîne de caractères représentant le symbole de V | | `detect_extensions` | `["v"]` | Quelles extensions devraient activer ce module. | | `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Les fichiers qui activent ce module. | | `detect_folders` | `[]` | Les dossiers qui activent ce module. | @@ -3329,7 +3415,7 @@ The `vlang` module shows you your currently installed version of [V](https://vla | Variable | Exemple | Description | | --------- | ------- | -------------------------------------- | -| version | `v0.2` | The version of `v` | +| version | `v0.2` | La version de `v` | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -3347,20 +3433,20 @@ The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/v ### Options -| Option | Défaut | Description | -| ---------- | -------------------------------- | ------------------------------------------------------ | -| `symbol` | | The symbol used before displaying the repository name. | -| `style` | `"bold yellow"` | Le style du module. | -| `format` | `"vcsh [$symbol$repo]($style) "` | Format du module. | -| `disabled` | `false` | Désactive le module `vcsh`. | +| Option | Défaut | Description | +| ---------- | -------------------------------- | ---------------------------------------------------- | +| `symbol` | | Le symbole utilisé avant d'afficher le nom du dépôt. | +| `style` | `"bold yellow"` | Le style du module. | +| `format` | `"vcsh [$symbol$repo]($style) "` | Format du module. | +| `disabled` | `false` | Désactive le module `vcsh`. | ### Variables -| Variable | Exemple | Description | -| --------- | ------------------------------------------- | -------------------------------------- | -| repo | `dotfiles` if in a VCSH repo named dotfiles | The active repository name | -| symbol | | 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` si dans un dépôt VCSH nommé dotfiles | Le nom du dépôt actif | +| symbol | | 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 @@ -3375,7 +3461,7 @@ format = "[🆅 $repo](bold blue) " ## Zig -By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). Le module est affiché si l'une de ces conditions est remplie : +Par défaut, le module `zig` affiche la version actuellement installée de [Zig](https://ziglang.org/). Le module est affiché si l'une de ces conditions est remplie : - Le dossier courant contient un fichier `.zip` @@ -3385,7 +3471,7 @@ By default the the `zig` module shows the currently installed version of [Zig](h | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | +| `symbol` | `"↯ "` | Le symbole utilisé avant d'afficher la version de Zig. | | `style` | `"bold yellow"` | Le style du module. | | `disabled` | `false` | Désactive le module `zig`. | | `detect_extensions` | `["zig"]` | Quelles extensions devraient activer ce module. | @@ -3396,7 +3482,7 @@ By default the the `zig` module shows the currently installed version of [Zig](h | Variable | Exemple | Description | | --------- | -------- | -------------------------------------- | -| version | `v0.6.0` | La version de `zip` | +| version | `v0.6.0` | La version de `zig` | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -3413,14 +3499,14 @@ symbol = "⚡️ " ## Commandes personnalisées -The `custom` modules show the output of some arbitrary commands. +Les modules `custom` affichent la sortie d’une commande arbitaitre. -These modules will be shown if any of the following conditions are met: +Ces modules seront affichés si l'une de ces conditions est remplie: -- Le dossier courant contient un fichier dont le nom est dans `files` -- The current directory contains a directory whose name is in `directories` -- Le dossier courant contient un fichier dont l’extension est dans `extensions` -- The `when` command returns 0 +- The current directory contains a file whose name is in `detect_files` +- The current directory contains a directory whose name is in `detect_folders` +- The current directory contains a file whose extension is in `detect_extensions` +- La commande `when` retourne 0 - The current Operating System (std::env::consts::OS) matchs with `os` field if defined. ::: tip @@ -3451,43 +3537,45 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt ### Options -| Option | Défaut | Description | -| ------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `command` | `""` | The command whose output should be printed. The command will be passed on stdin to the shell. | -| `when` | | A shell command used as a condition to show the module. 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`. | -| `files` | `[]` | The files that will be searched in the working directory for a match. | -| `directories` | `[]` | The directories that will be searched in the working directory for a match. | -| `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"` | Le style du module. | -| `format` | `"[$symbol($output )]($style)"` | Format du module. | -| `disabled` | `false` | Disables this `custom` module. | -| `os` | | Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) [See possible values](https://doc.rust-lang.org/std/env/consts/constant.OS.html). | +| Option | Défaut | Description | +| ------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `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` | `""` | Le symbole utilisé avant d'afficher la sortie de la commande. | +| `style` | `"bold green"` | Le style du module. | +| `format` | `"[$symbol($output )]($style)"` | Format du module. | +| `disabled` | `false` | Désactive le module `custom`. | +| `os` | | Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) [See possible values](https://doc.rust-lang.org/std/env/consts/constant.OS.html). | +| `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 | Description | -| --------- | -------------------------------------- | -| output | The output of shell command in `shell` | -| symbol | Reflète la valeur de l'option `symbol` | -| style\* | Reflète la valeur de l'option `style` | +| Variable | Description | +| --------- | ------------------------------------------- | +| output | La sortie de la commande shell dans `shell` | +| symbol | Reflète la valeur de l'option `symbol` | +| style\* | Reflète la valeur de l'option `style` | *: Cette variable peut uniquement être utilisée dans une chaine de style #### Commandes shell personnalisées -`shell` accepts a non-empty list of strings, where: +`shell` accepte une liste de chaînes non vide, où: -- The first string is the path to the shell to use to execute the command. +- 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. If unset, it will fallback to STARSHIP_SHELL and then to "sh" on Linux, and "cmd /C" on Windows. The `command` will be passed in on stdin. -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 -`. This behavior can be avoided by explicitly passing arguments to the shell, e.g. +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", "-"] @@ -3511,13 +3599,19 @@ Automatic detection of shells and proper parameters addition are currently imple # ~/.config/starship.toml [custom.foo] -command = "echo foo" # affiche la sortie de la commande -files = ["foo"] # possible de spécifier des filtres, mais les jokers ne sont pas supportés +command = "echo foo" # shows output of command +detect_files = ["foo"] # can specify filters but wildcards are not supported when = """ test "$HOME" == "$PWD" """ format = " transcending [$output]($style)" [custom.time] command = "time /T" -extensions = ["pst"] # filtre les fichiers *.pst +detect_extensions = ["pst"] # filters *.pst files shell = ["pwsh.exe", "-NoProfile", "-Command", "-"] + +[custom.time-as-arg] +command = "time /T" +detect_extensions = ["pst"] # filters *.pst files +shell = ["pwsh.exe", "-NoProfile", "-Command"] +use_stdin = false ``` diff --git a/docs/fr-FR/guide/README.md b/docs/fr-FR/guide/README.md index d350cc5d..420fa484 100644 --- a/docs/fr-FR/guide/README.md +++ b/docs/fr-FR/guide/README.md @@ -297,7 +297,7 @@ Ajoutez ce qui suit à la fin de `~/.elvish/rc.elv`: eval (starship init elvish) ``` -Note: Seul Elvish v0.17+ est supporté +Note : Seul Elvish v0.18+ est supporté
@@ -326,28 +326,28 @@ eval $(starship init ion)
Nushell -Run the following: +Exécutez les commandes suivantes: ```sh mkdir ~/.cache/starship starship init nu | save ~/.cache/starship/init.nu ``` -And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`): +Ajoutez le code suivant à la fin de votre configuration Nushell (trouvez-la en exécutant `$nu.config path`): ```sh starship init nu | save ~/.cache/starship/init.nu source ~/.cache/starship/init.nu ``` -Note: Only Nushell v0.60+ is supported +Note: Seul Nushell v0.60+ est supporté
PowerShell -Add the following to the end of your PowerShell configuration (find it by running `$PROFILE`): +Ajoutez ce qui suit à la fin de votre configuration PowerShell (trouvez-la en exécutant `$PROFILE`) : ```powershell Invoke-Expression (&starship init powershell) @@ -390,9 +390,9 @@ eval "$(starship init zsh)" ### Étape 3. Configurer Starship -Start a new shell instance, and you should see your beautiful new shell prompt. If you're happy with the defaults, enjoy! +Démarrez une nouvelle instance de votre shell, et vous devriez voir votre magnifique nouveau prompt. Si vous appréciez les paramètres par défaut, profitez! -If you're looking to further customize Starship: +Si vous souhaitez personnaliser Starship: - **[Configuration](https://starship.rs/config/)** – apprenez à configurer Starship pour ajuster votre prompt à vos préférences @@ -400,15 +400,15 @@ If you're looking to further customize Starship: ## 🤝 Contribuer -We are always looking for contributors of **all skill levels**! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). +Nous sommes toujours à la recherche de contributeurs de **tous les niveaux de compétence**! Si vous cherchez à faciliter votre entrée dans le projet, essayez un [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). -If you are fluent in a non-English language, we greatly appreciate any help keeping our docs translated and up-to-date in other languages. If you would like to help, translations can be contributed on the [Starship Crowdin](https://translate.starship.rs/). +Si vous parlez couramment une langue autre que l'anglais, nous apprécions grandement toute aide pour que nos documents soient traduits et mis à jour dans d'autres langues. Si vous souhaitez nous aider, les traductions peuvent êtres suggérées sur le [Crowdin de Starship](https://translate.starship.rs/). -If you are interested in helping contribute to starship, please take a look at our [Contributing Guide](https://github.com/starship/starship/blob/master/CONTRIBUTING.md). Also, feel free to drop into our [Discord server](https://discord.gg/8Jzqu3T) and say hi. 👋 +Si vous êtes intéressé à aider à contribuer à Starship, veuillez jeter un coup d'oeil à notre [Guide de contribution](https://github.com/starship/starship/blob/master/CONTRIBUTING.md). Aussi, n'hésitez pas à vous rendre sur notre [serveur Discord](https://discord.gg/8Jzqu3T) pour dire bonjour. 👋 ## 💭Inspiré par -Please check out these previous works that helped inspire the creation of starship. 🙏 +Jetez un œil aux précédents projets qui ont inspiré la création de starship. 🙏 - **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** – Un prompt ZSH pour les astronautes. @@ -418,9 +418,9 @@ Please check out these previous works that helped inspire the creation of starsh


- Starship rocket icon + Icône de fusée de Starship

## 📝 License -Copyright © 2019-present, [Starship Contributors](https://github.com/starship/starship/graphs/contributors).
This project is [ISC](https://github.com/starship/starship/blob/master/LICENSE) licensed. +Copyright © 2019-présent, [Contributeurs Starship](https://github.com/starship/starship/graphs/contributors).
Ce projet est sous licence [ISC](https://github.com/starship/starship/blob/master/LICENSE). diff --git a/docs/id-ID/README.md b/docs/id-ID/README.md index 0ce4f520..cb18288c 100644 --- a/docs/id-ID/README.md +++ b/docs/id-ID/README.md @@ -120,7 +120,7 @@ description: Starship merupakan sebuah prompt yang minimal, super cepat, dan san #### Elvish - ::: warning Hanya elvish v0.17 atau versi yang lebih baru yang mendapat dukungan pengembangan. ::: + ::: warning Hanya elvish v0.18 atau versi yang lebih baru yang mendapat dukungan pengembangan. ::: Tambahkan skrip berikut pada baris akhir `~/.elvish/rc.elv`: diff --git a/docs/id-ID/advanced-config/README.md b/docs/id-ID/advanced-config/README.md index 4fac9da7..d8ab6e1f 100644 --- a/docs/id-ID/advanced-config/README.md +++ b/docs/id-ID/advanced-config/README.md @@ -131,7 +131,7 @@ Invoke-Expression (&starship init powershell) Some shells support a right prompt which renders on the same line as the input. Starship can set the content of the right prompt using the `right_format` option. Any module that can be used in `format` is also supported in `right_format`. The `$all` variable will only contain modules not explicitly used in either `format` or `right_format`. -Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [fill module](/config/#fill). +Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [`fill` module](/config/#fill). `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd. diff --git a/docs/id-ID/config/README.md b/docs/id-ID/config/README.md index 6b54a25d..977cc6e6 100644 --- a/docs/id-ID/config/README.md +++ b/docs/id-ID/config/README.md @@ -9,6 +9,9 @@ mkdir -p ~/.config && touch ~/.config/starship.toml Seluruh konfigurasi starship dilakukan dalam file [TOML](https://github.com/toml-lang/toml) berikut: ```toml +# Get editor completions based on the config schema +"$schema" = 'https://starship.rs/config-schema.json' + # Inserts a blank line between shell prompts add_newline = true @@ -199,6 +202,7 @@ $hg_branch\ $docker_context\ $package\ $buf\ +$c\ $cmake\ $cobol\ $container\ @@ -235,6 +239,7 @@ $vagrant\ $zig\ $nix_shell\ $conda\ +$spack\ $memory_usage\ $aws\ $gcloud\ @@ -263,9 +268,9 @@ format = "$all$directory$character" ## AWS -The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. Diperoleh dari variabel environment `AWS_REGION`, `AWS_DEFAULT_REGION`, dan `AWS_PROFILE` pada file `~/.aws/config`. Modul ini juga menampilkan penghitung waktu mundur kedaluwarsa ketika menggunakan temporer kredensial. +The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. Alternatively, you can force this module to show the region and profile even when the credentials have not been setup with the `force_display` option. Diperoleh dari variabel environment `AWS_REGION`, `AWS_DEFAULT_REGION`, dan `AWS_PROFILE` pada file `~/.aws/config`. Modul ini juga menampilkan penghitung waktu mundur kedaluwarsa ketika menggunakan temporer kredensial. -The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. +The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if the conditions above are not respected. Ketika menggunakan [aws-vault](https://github.com/99designs/aws-vault), profil dibaca dari variabel environment `AWS_VAULT` dan tanggal kedaluwarsanya dibaca dari variabel environment `AWS_SESSION_EXPIRATION`. @@ -275,15 +280,16 @@ Ketika menggunakan [AWSume](https://awsu.me) profil dibaca dari variabel environ ### Opsi -| Opsi | Bawaan | Deskripsi | -| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------- | -| `fromat` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | Format dari modul. | -| `symbol` | `"☁️ "` | Simbol yang digunakan sebelum menampilkan profil AWS terkini. | -| `region_aliases` | | Tabel alias dari region yang ditampilan selain nama AWS. | -| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | -| `style` | `"bold yellow"` | Gaya penataan untuk modul. | -| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. | -| `disabled` | `false` | Disables the `AWS` module. | +| Opsi | Bawaan | Deskripsi | +| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | +| `fromat` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | Format dari modul. | +| `symbol` | `"☁️ "` | Simbol yang digunakan sebelum menampilkan profil AWS terkini. | +| `region_aliases` | | Tabel alias dari region yang ditampilan selain nama AWS. | +| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | +| `style` | `"bold yellow"` | Gaya penataan untuk modul. | +| `expiration_symbol` | `X` | Simbol ditampilkan ketika temporer kredensial telah kedaluwarsa. | +| `disabled` | `false` | Menonaktifkan modul `AWS`. | +| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. | ### Variabel @@ -451,7 +457,7 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil | `detect_files` | `["buf.yaml", "buf.gen.yaml", "buf.work.yaml"]` | filenames mana yang sebaiknya memicu modul ini. | | `detect_folders` | `[]` | Folder mana yang sebaiknya memicul modul ini. | | `style` | `"bold blue"` | Gaya penataan untuk modul. | -| `disabled` | `false` | Disables the `elixir` module. | +| `disabled` | `false` | Menonaktifkan modul `elixir`. | ### Variabel @@ -472,16 +478,62 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil symbol = "🦬 " ``` +## C + +The `c` module shows some information about your C compiler. By default the module will be shown if the current directory contains a `.c` or `.h` file. + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------------- | --------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | +| `fromat` | `"via [$symbol($version(-$name) )]($style)"` | The format string for the module. | +| `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"C "` | The symbol used before displaying the compiler details | +| `detect_extensions` | `["c", "h"]` | 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. | +| `commands` | [ [ "cc", "--version" ], [ "gcc", "--version" ], [ "clang", "--version" ] ] | How to detect what the compiler is | +| `style` | `"bold 149"` | Gaya penataan untuk modul. | +| `disabled` | `false` | Disables the `c` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| -------- | ------ | --------------------------------- | +| name | clang | The name of the compiler | +| version | 13.0.0 | The version of the compiler | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style | | Menyalin nilai dari opsi `style` | + +NB that `version` is not in the default format. + +### Commands + +The `commands` option accepts a list of commands to determine the compiler version and name. + +Each command is represented as a list of the executable name, followed by its arguments, usually something like `["mycc", "--version"]`. Starship will try executing each command until it gets a result on STDOUT. + +If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). + +### Contoh + +```toml +# ~/.config/starship.toml + +[c] +format = "via [$name $version]($style)" +``` + ## Karakter -The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. +Modul `character` menampilkan sebuah karakter (biasanya anak panah) di samping teks pada terminalmu. -The character will tell you whether the last command was successful or not. It can do this in two ways: +Karakter dapat memberitahu kamu apakah perintah terakhir berhasil atau tidak. Karakter dapat memberitahumu dengan dua cara ini: -- changing color (`red`/`green`) -- changing shape (`❯`/`✖`) +- mengganti warna (`red`/`green`) +- mengganti bentuk (`❯`/`✖`) -By default it only changes color. If you also want to change its shape take a look at [this example](#with-custom-error-shape). +Secara bawaan karakter hanya dapat mengganti warna. Jika kamu juga ingin mengganti bentuknya, perhatikan [contoh](#with-custom-error-shape) berikut. ::: warning @@ -491,19 +543,19 @@ By default it only changes color. If you also want to change its shape take a lo ### Opsi -| Opsi | Bawaan | Deskripsi | -| ---------------- | ------------------- | -------------------------------------------------------------------------------- | -| `fromat` | `"$symbol "` | The format string used before the text input. | -| `success_symbol` | `"[❯](bold green)"` | The format string used before the text input if the previous command succeeded. | -| `error_symbol` | `"[❯](bold red)"` | The format string used before the text input if the previous command failed. | -| `vicmd_symbol` | `"[❮](bold green)"` | The format string used before the text input if the shell is in vim normal mode. | -| `disabled` | `false` | Disables the `character` module. | +| Opsi | Bawaan | Deskripsi | +| ---------------- | ------------------- | ------------------------------------------------------------------------------------------------- | +| `fromat` | `"$symbol "` | Format string yang digunakan sebelum masukan teks. | +| `success_symbol` | `"[❯](bold green)"` | Format string yang digunakan sebelum masukan teks jika perintah sebelumnya berhasil. | +| `error_symbol` | `"[❯](bold red)"` | Format string yang digunakan sebelum masukan teks jika perintah sebelumnya gagal. | +| `vicmd_symbol` | `"[❮](bold green)"` | Format string yang digunakan sebelum masukan teks jika shell sedang dalam vim dengan mode normal. | +| `disabled` | `false` | Menonaktifkan module `character`. | ### Variabel -| Variabel | Contoh | Deskripsi | -| -------- | ------ | --------------------------------------------------------------------- | -| symbol | | A mirror of either `success_symbol`, `error_symbol` or `vicmd_symbol` | +| Variabel | Contoh | Deskripsi | +| -------- | ------ | ---------------------------------------------------------------------- | +| symbol | | Representasi dari `success_symbol`, `error_symbol` atau `vicmd_symbol` | ### Contoh @@ -538,10 +590,10 @@ vicmd_symbol = "[V](bold green) " ## CMake -The `cmake` module shows the currently installed version of [CMake](https://cmake.org/). By default the module will be activated if any of the following conditions are met: +Modul `cmake` menampilkan versi terkini dari [CMake](https://cmake.org/) yang terpasang. Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: -- The current directory contains a `CMakeLists.txt` file -- The current directory contains a `CMakeCache.txt` file +- Direktori terkini yang berisikan sebuah file `CMakeLists.txt` +- Direktori terkini yang berisikan sebuah file `CMakeCache.txt` ### Opsi @@ -549,18 +601,18 @@ The `cmake` module shows the currently installed version of [CMake](https://cmak | ------------------- | -------------------------------------- | ----------------------------------------------------------------------------------- | | `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 the version of cmake. | -| `detect_extensions` | `[]` | Which extensions should trigger this module | -| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | -| `detect_folders` | `[]` | Which folders should trigger this module | +| `symbol` | `"△ "` | Simbol yang digunakan sebelum versi cmake. | +| `detect_extensions` | `[]` | Ekstensi mana yang sebaiknya memicu modul ini | +| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | filenames mana yang sebaiknya memicu modul ini | +| `detect_folders` | `[]` | Folder mana yang sebaiknya memicul modul ini | | `style` | `"bold blue"` | Gaya penataan untuk modul. | -| `disabled` | `false` | Disables the `cmake` module. | +| `disabled` | `false` | Menonaktifkan modul `cmake`. | ### Variabel | Variabel | Contoh | Deskripsi | | --------- | --------- | --------------------------------- | -| version | `v3.17.3` | The version of cmake | +| version | `v3.17.3` | Versi dari cmake | | symbol | | Menyalin nilai dari opsi `symbol` | | style\* | | Menyalin nilai dari opsi `style` | @@ -598,35 +650,35 @@ The `cobol` module shows the currently installed version of COBOL. By default, t ## Durasi Perintah -The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists. +Modul `cmd_duration` menampilkan seberapa lama perintah sebelumnya membutuhkan waktu untuk dilaksanakan. Modulnya hanya akan ditampilkan jika perintahnya membutuhkan waktu lebih dari dua detik, atau ada nilai dari konfigurasi `min_time`. -::: warning Do not hook the DEBUG trap in Bash +::: warning lakukan hook DEBUG trap dalam Bash -If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. +Jia kamu menjalankan Starship di `bash`, jangan lakukan hook DEBUG trap setelah menjalankan `eval $(starship init $0)`, atau modulnya **akan** rusak. ::: -Bash users who need preexec-like functionality can use [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Simply define the arrays `preexec_functions` and `precmd_functions` before running `eval $(starship init $0)`, and then proceed as normal. +Pengguna Bash yang membutuhkan fungsi seperti preexec dapat menggunakan [kerangka kerja bash_preexec dari rcaloras](https://github.com/rcaloras/bash-preexec). Cukup dengan membuat array `preexec_functions` dan `precmd_functions` sebelum menjalankan `eval $(starship init $0)`, lalu lanjutkan seperti biasa. ### Opsi | Opsi | Bawaan | Deskripsi | | ---------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). | -| `show_milliseconds` | `false` | Show milliseconds in addition to seconds for the duration. | +| `min_tim` | `2_000` | Durasi terpendek untuk menampilkan waktu (dalam milidetik). | +| `show_milliseconds` | `false` | Tampilkan milidetik sebagai ganti detik untuk durasinya. | | `fromat` | `"took [$duration]($style) "` | Format dari modul. | | `style` | `"bold yellow"` | Gaya penataan untuk modul. | -| `disabled` | `false` | Disables the `cmd_duration` module. | -| `show_notifications` | `false` | Show desktop notifications when command completes. | -| `min_time_to_notify` | `45_000` | Shortest duration for notification (in milliseconds). | +| `disabled` | `false` | Menonaktifkan modul `cmd_duration`. | +| `show_notifications` | `false` | Menampilkan notifikasi layar ketika perintah selesai. | +| `min_time_to_notify` | `45_000` | Durasi terpendek untuk menampilkan notifikasi (dalam milidetik). | | `notification_timeout` | | Duration to show notification for (in milliseconds). If unset, notification timeout will be determined by daemon. Not all notification daemons honor this option. | ### Variabel -| Variabel | Contoh | Deskripsi | -| --------- | -------- | --------------------------------------- | -| duration | `16m40s` | The time it took to execute the command | -| style\* | | Menyalin nilai dari opsi `style` | +| Variabel | Contoh | Deskripsi | +| --------- | -------- | -------------------------------------------------- | +| duration | `16m40s` | Waktu yang dibutuhkan untuk menyelesaikan perintah | +| style\* | | Menyalin nilai dari opsi `style` | *: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string @@ -646,26 +698,26 @@ The `conda` module shows the current [Conda](https://docs.conda.io/en/latest/) e ::: tip -This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. +Hal ini tidak menahan pengubah (modifier) prompt dari conda sendiri, kamu mungkin bisa menjalankan `conda config --set changeps1 False`. ::: ### Opsi -| Opsi | Bawaan | Deskripsi | -| ------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `truncation_length` | `1` | The number of directories the environment path should be truncated to, if the environment was created via `conda create -p [path]`. `0` means no truncation. Also see the [`directory`](#directory) module. | -| `symbol` | `"🅒 "` | The symbol used before the environment name. | -| `style` | `"bold green"` | Gaya penataan untuk modul. | -| `fromat` | `"via [$symbol$environment]($style) "` | Format dari modul. | -| `ignore_base` | `true` | Ignores `base` environment when activated. | -| `disabled` | `false` | Disables the `conda` module. | +| Opsi | Bawaan | Deskripsi | +| ------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `truncation_length` | `1` | Jumlah direktori yang dipotong oleh environment path, jika environment-nya dibuat melalui `conda create -p [path]`. `0` artinya tidak ada potongan. Lihat juga modul [`directory`](#directory). | +| `symbol` | `"🅒 "` | Simbol yang digunakan sebelum nama environment. | +| `style` | `"bold green"` | Gaya penataan untuk modul. | +| `fromat` | `"via [$symbol$environment]($style) "` | Format dari modul. | +| `ignore_base` | `true` | Mengabaikan `base` environment saat aktif. | +| `disabled` | `false` | Menonaktifkan modul `conda`. | ### Variabel | Variabel | Contoh | Deskripsi | | ----------- | ------------ | --------------------------------- | -| environment | `astronauts` | The current conda environment | +| environment | `astronauts` | Environment conda saat ini | | symbol | | Menyalin nilai dari opsi `symbol` | | style\* | | Menyalin nilai dari opsi `style` | @@ -714,29 +766,29 @@ format = "[$symbol \\[$name\\]]($style) " ## Crystal -The `crystal` module shows the currently installed version of [Crystal](https://crystal-lang.org/). By default the module will be shown if any of the following conditions are met: +Modul `crystal` menampilkan versi terkini dari [Crystal](https://crystal-lang.org/) yang terpasang. Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: -- The current directory contains a `shard.yml` file -- The current directory contains a `.cr` file +- Direktori terkini yang berisikan sebuah file `shard.yml` +- Direktori terkini yang berisikan sebuah file `.cr` ### Opsi | Opsi | Bawaan | Deskripsi | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | -| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | +| `symbol` | `"🔮 "` | Simbol yang digunakan sebelum menampilkan versi crystal terkini. | | `fromat` | `"via [$symbol($version )]($style)"` | Format dari modul. | | `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `style` | `"bold red"` | Gaya penataan untuk modul. | | `detect_extensions` | `["cr"]` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_files` | `["shard.yml"]` | filenames mana yang sebaiknya memicu modul ini. | | `detect_folders` | `[]` | Folder mana yang sebaiknya memicul modul ini. | -| `disabled` | `false` | Disables the `crystal` module. | +| `disabled` | `false` | Menonaktifkan modul `crystal`. | ### Variabel | Variabel | Contoh | Deskripsi | | --------- | --------- | --------------------------------- | -| version | `v0.32.1` | The version of `crystal` | +| version | `v0.32.1` | Versi dari `crystal` | | symbol | | Menyalin nilai dari opsi `symbol` | | style\* | | Menyalin nilai dari opsi `style` | @@ -753,11 +805,11 @@ format = "via [✨ $version](bold blue) " ## Dart -The `dart` module shows the currently installed version of [Dart](https://dart.dev/). By default the module will be shown if any of the following conditions are met: +Modul `dart` menampilkan versi terkini dari [Dart](https://dart.dev/) yang terpasang. Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: -- The current directory contains a file with `.dart` extension -- The current directory contains a `.dart_tool` directory -- The current directory contains a `pubspec.yaml`, `pubspec.yml` or `pubspec.lock` file +- Direktori terkini yang berisikan sebuah file berekstensi `.dart` +- Direktori terkini yang berisikan sebuah direktori `dart_tool` +- Direktori terkini yang berisikan sebuah file `pubspec.yaml`, `pubspec.yml` atau `pubspec.lock` ### Opsi @@ -765,18 +817,18 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d | ------------------- | ------------------------------------------------- | ----------------------------------------------------------------------------------- | | `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 Dart | +| `symbol` | `"🎯 "` | Sebuah format string yang melambangkan simbol Dart | | `detect_extensions` | `["dart"]` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | filenames mana yang sebaiknya memicu modul ini. | | `detect_folders` | `[".dart_tool"]` | Folder mana yang sebaiknya memicul modul ini. | | `style` | `"bold blue"` | Gaya penataan untuk modul. | -| `disabled` | `false` | Disables the `dart` module. | +| `disabled` | `false` | Menonaktifkan modul `dart`. | ### Variabel | Variabel | Contoh | Deskripsi | | --------- | -------- | --------------------------------- | -| version | `v2.8.4` | The version of `dart` | +| version | `v2.8.4` | Versi dari `dart` | | symbol | | Menyalin nilai dari opsi `symbol` | | style\* | | Menyalin nilai dari opsi `style` | @@ -793,7 +845,7 @@ format = "via [🔰 $version](bold red) " ## Deno -The `deno` module shows you your currently installed version of [Deno](https://deno.land/). By default the module will be shown if any of the following conditions are met: +Modul `deno` menampilkan versi terkini dari [Deno](https://deno.land/) yang terpasang. Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: - The current directory contains a `deno.json`, `deno.jsonc`, `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file @@ -803,18 +855,18 @@ The `deno` module shows you your currently installed version of [Deno](https://d | ------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | | `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 Deno | +| `symbol` | `🦕 "` | Sebuah format string yang melambangkan simbol Deno | | `detect_extensions` | `[]` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_files` | `["deno.json", "deno.jsonc", "mod.ts", "mod.js", "deps.ts", "deps.js"]` | filenames mana yang sebaiknya memicu modul ini. | | `detect_folders` | `[]` | Folder mana yang sebaiknya memicul modul ini. | | `style` | `"green bold"` | Gaya penataan untuk modul. | -| `disabled` | `false` | Disables the `deno` module. | +| `disabled` | `false` | Menonaktifkan modul `deno`. | ### Variabel | Variabel | Contoh | Deskripsi | | --------- | -------- | --------------------------------- | -| version | `v1.8.3` | The version of `deno` | +| version | `v1.8.3` | Versi dari `deno` | | symbol | | Menyalin nilai dari opsi `symbol` | | style\* | | Menyalin nilai dari opsi `style` | @@ -829,31 +881,31 @@ format = "via [🦕 $version](green bold) " ## Direktori -The `directory` module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in. +Modul `directory` menampilkan arah ke direkori terkinimu, disingkat ke tiga folder induk. Direkrotimu juga akan disingkat ke root dari git repo di tempatmu berada saat ini. -When using the fish style pwd option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option. +Ketika kamu menggunakan penataan pwd option fish, alih-alih menyembunyikan jalur yang disingkat, kamu akan melihat nama yang disingkat untuk tiap-tiap direktori berdasarkan dari jumlah nomor yang kamu aktifkan untuk opsi tersebut. -For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, and the option set to `1`. You will now see `~/D/N/nixpkgs/pkgs`, whereas before it would have been `nixpkgs/pkgs`. +Sebagai contoh, untuk `~/Dev/Nix/nixpkgs/pkgs` dimana `nixpkgs` merupakan root repo-nya, dan lalu opsinya diset menjadi `1`. Kamu akan melihat `~/D/N/nixpkgs/pkgs`, sedangkan sebelumnya direktori tersebut harusnya `nixpkgs/pkgs`. ### Opsi | Opsi | Bawaan | Deskripsi | | ------------------- | ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. | -| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. | +| `truncation_length` | `3` | Jumlah dari folder induk yang harusnya disingkat oleh direktori saat ini. | +| `truncate_to_repo` | `true` | Apakah harus menyingkat root dari git repo tempatmu berada saat ini. | | `fromat` | `"[$path]($style)[$read_only]($read_only_style) "` | Format dari modul. | | `style` | `"bold cyan"` | Gaya penataan untuk modul. | -| `disabled` | `false` | Disables the `directory` module. | -| `read_only` | `"🔒"` | The symbol indicating current directory is read only. | -| `read_only_style` | `"red"` | The style for the read only symbol. | -| `truncation_symbol` | `""` | The symbol to prefix to truncated paths. eg: "…/" | +| `disabled` | `false` | Menonaktifkan modul `directory`. | +| `read_only` | `"🔒"` | Simbol yang mengindikasikan direktori saat ini bersifat read only. | +| `read_only_style` | `"red"` | Corak gaya untuk simbol read only. | +| `truncation_symbol` | `""` | Simbol untuk awalan jalur yang disingkat. misalnya: ".../" | | `repo_root_style` | `None` | The style for the root of the git repo. The default value is equivalent to `style`. | | `repo_root_format` | `"[$before_root_path]($style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) "` | The format of a git repo when `repo_root_style` is defined. | -| `home_symbol` | `"~"` | The symbol indicating home directory. | +| `home_symbol` | `"~"` | Simbol yang mengindikasikan direktori home. | | `use_os_path_sep` | `true` | Use the OS specific path separator instead of always using `/` (e.g. `\` on Windows) |
-This module has a few advanced configuration options that control how the directory is displayed. +Modul ini memilki beberapa opsi konfigurasi lanjutan yang mengontrol bagaimana direktori ditampilkan. | Advanced Option | Bawaan | Deskripsi | | --------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -877,7 +929,7 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an | Variabel | Contoh | Deskripsi | | --------- | --------------------- | -------------------------------- | -| path | `"D:/Projects"` | The current directory path | +| path | `"D:/Projects"` | Direktori terkini | | style\* | `"black bold dimmed"` | Menyalin nilai dari opsi `style` | *: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string @@ -913,22 +965,22 @@ The `docker_context` module shows the currently active [Docker context](https:// ### Opsi -| Opsi | Bawaan | Deskripsi | -| ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `fromat` | `"via [$symbol$context]($style) "` | Format dari modul. | -| `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. | -| `only_with_files` | `true` | Only show when there's a match | -| `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). | -| `detect_files` | `["docker-compose.yml", "docker-compose.yaml", "Dockerfile"]` | Which filenames should trigger this module (needs `only_with_files` to be true). | -| `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). | -| `style` | `"blue bold"` | Gaya penataan untuk modul. | -| `disabled` | `false` | Disables the `docker_context` module. | +| Opsi | Bawaan | Deskripsi | +| ------------------- | ------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | +| `fromat` | `"via [$symbol$context]($style) "` | Format dari modul. | +| `symbol` | `"🐳 "` | Simbol yang digunakan sebelum menampilkan Docker context. | +| `only_with_files` | `true` | Hanya ditampilkan jika terdapat kecocokan | +| `detect_extensions` | `[]` | Extensions mana yang harusnya memicu modul (butuh `only_with_files` untuk diset true). | +| `detect_files` | `["docker-compose.yml", "docker-compose.yaml", "Dockerfile"]` | filenames mana yang harusnya memicu modul ini (butuh `only_with_files` untuk diset true). | +| `detect_folders` | `[]` | Folder mana yang harusnya memicu modul (butuh `only_with_files` untuk diset true). | +| `style` | `"blue bold"` | Gaya penataan untuk modul. | +| `disabled` | `false` | Menonaktifkan module `docket_context`. | ### Variabel | Variabel | Contoh | Deskripsi | | --------- | -------------- | --------------------------------- | -| context | `test_context` | The current docker context | +| context | `test_context` | Docker context terkini | | symbol | | Menyalin nilai dari opsi `symbol` | | style\* | | Menyalin nilai dari opsi `style` | @@ -945,9 +997,9 @@ format = "via [🐋 $context](blue bold)" ## Dotnet -The `dotnet` module shows the relevant version of the [.NET Core SDK](https://dotnet.microsoft.com/) for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. +Modul `dotnet` menampilkan informasi terkait versi dari [.NET Core SDK](https://dotnet.microsoft.com/) pada direktori terkini. Apabila SDK telah disematkan pada direktori terkni, maka veri yang telah disematkan tersebutlah yang ditampilkan. Jika tidak, maka modul akan menampilkan versi SDK terkini. -By default this module will only be shown in your prompt when one or more of the following files are present in the current directory: +Secara bawaan, modul ini hanya akan ditampilkan ke prompt kamu ketika teradapat satu atau lebih file berikut di dalam direktorimu saat ini: - `global.json` - `project.json` @@ -958,11 +1010,11 @@ By default this module will only be shown in your prompt when one or more of the - `*.fsproj` - `*.xproj` -You'll also need the .NET Core SDK installed in order to use it correctly. +Kamu juga perlu memasang .NET Core SDK untuk menggunakannya dengan baik. -Internally, this module uses its own mechanism for version detection. Typically it is twice as fast as running `dotnet --version`, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting `heuristic = false` in the module options. +Secara internal, modul ini menggunakan mekenasimenya sendiri untuk melakukan pendeteksian versi. Biasanya, hal ini dua kali lebih cepat seperti untuk menjalankan `dotnet --version`, tetapi ada kemungkinan hal ini akan menampilkan versi yang salah jika proyek .NET milikmu memiliki tata letak direktori yang tidak biasa. Jika menurutmu akurasi lebih penting dari kecepatan, kamu dapat menonaktifkan mekanisme tersebut dengan mengatur `heuristic = false` di dalam opsi modul. -The module will also show the Target Framework Moniker () when there is a csproj file in the current directory. +The module will also show the Target Framework Moniker () when there is a `.csproj` file in the current directory. ### Opsi @@ -970,22 +1022,22 @@ The module will also show the Target Framework Moniker ("` | The description of the module that is shown when running `starship explain`. | -| `files` | `[]` | The files that will be searched in the working directory for a match. | -| `directories` | `[]` | The directories that will be searched in the working directory for a match. | -| `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. | -| `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). | +| Opsi | Bawaan | Deskripsi | +| ------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `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`. | +| `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. | +| `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. | +| `ignore_timeout` | `false` | Ignore global `command_timeout` setting and keep running external commands, no matter how long they take. | ### Variabel @@ -3487,7 +3574,7 @@ If unset, it will fallback to STARSHIP_SHELL and then to "sh" on Linux, and "cmd The `command` will be passed in on stdin. -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 -`. This behavior can be avoided by explicitly passing arguments to the shell, e.g. +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", "-"] @@ -3512,12 +3599,18 @@ Automatic detection of shells and proper parameters addition are currently imple [custom.foo] command = "echo foo" # shows output of command -files = ["foo"] # can specify filters but wildcards are not supported +detect_files = ["foo"] # can specify filters but wildcards are not supported when = """ test "$HOME" == "$PWD" """ format = " transcending [$output]($style)" [custom.time] command = "time /T" -extensions = ["pst"] # filters *.pst files +detect_extensions = ["pst"] # filters *.pst files shell = ["pwsh.exe", "-NoProfile", "-Command", "-"] + +[custom.time-as-arg] +command = "time /T" +detect_extensions = ["pst"] # filters *.pst files +shell = ["pwsh.exe", "-NoProfile", "-Command"] +use_stdin = false ``` diff --git a/docs/id-ID/guide/README.md b/docs/id-ID/guide/README.md index 6bf1588b..efa1c98c 100644 --- a/docs/id-ID/guide/README.md +++ b/docs/id-ID/guide/README.md @@ -160,7 +160,7 @@ - **Mudah:** pemasangan singkat – mulai menggunakannya dalam hitungan menit.

-Explore the Starship docs  ▶ +Jelajahi dokumentasi Starship  ▶

@@ -297,7 +297,7 @@ Tambahkan skrip berikut pada baris akhir `~/.elvish/rc.elv`: eval (starship init elvish) ``` -Note: Only Elvish v0.17+ is supported +Note: Only Elvish v0.18+ is supported
@@ -392,7 +392,7 @@ eval "$(starship init zsh)" Start a new shell instance, and you should see your beautiful new shell prompt. If you're happy with the defaults, enjoy! -If you're looking to further customize Starship: +Jika kamu ingin mengkustomisasi Starship lebih jauh: - **[Configuration](https://starship.rs/config/)** – learn how to configure Starship to tweak your prompt to your liking @@ -404,7 +404,7 @@ We are always looking for contributors of **all skill levels**! If you're lookin If you are fluent in a non-English language, we greatly appreciate any help keeping our docs translated and up-to-date in other languages. If you would like to help, translations can be contributed on the [Starship Crowdin](https://translate.starship.rs/). -If you are interested in helping contribute to starship, please take a look at our [Contributing Guide](https://github.com/starship/starship/blob/master/CONTRIBUTING.md). Also, feel free to drop into our [Discord server](https://discord.gg/8Jzqu3T) and say hi. 👋 +Jika kamu tertarik untuk membantu berkontribusi ke starship, silakan lihat [Pedoman Berkontribusi](https://github.com/starship/starship/blob/master/CONTRIBUTING.md) kami. Also, feel free to drop into our [Discord server](https://discord.gg/8Jzqu3T) and say hi. 👋 ## 💭 Terinspirasi Oleh @@ -418,7 +418,7 @@ Please check out these previous works that helped inspire the creation of starsh


- Starship rocket icon + Ikon roket Starship

## 📝 Lisensi diff --git a/docs/it-IT/README.md b/docs/it-IT/README.md index 667afe99..de15d9ca 100644 --- a/docs/it-IT/README.md +++ b/docs/it-IT/README.md @@ -120,7 +120,7 @@ description: Starship è il prompt minimalista, super veloce ed estremamente per #### Elvish - ::: warning È supportato solo elvish v0.17 o superiore. ::: + ::: warning È supportato solo elvish v0.18 o superiore. ::: Aggiungi quanto segue alla fine di `~/.elvish/rc.elv`: diff --git a/docs/it-IT/advanced-config/README.md b/docs/it-IT/advanced-config/README.md index e5a77cef..da1a38f3 100644 --- a/docs/it-IT/advanced-config/README.md +++ b/docs/it-IT/advanced-config/README.md @@ -131,7 +131,7 @@ Invoke-Expression (&starship init powershell) Some shells support a right prompt which renders on the same line as the input. Starship can set the content of the right prompt using the `right_format` option. Any module that can be used in `format` is also supported in `right_format`. The `$all` variable will only contain modules not explicitly used in either `format` or `right_format`. -Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [fill module](/config/#fill). +Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [`fill` module](/config/#fill). `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd. diff --git a/docs/it-IT/config/README.md b/docs/it-IT/config/README.md index 3fc7c368..5efd6cb5 100644 --- a/docs/it-IT/config/README.md +++ b/docs/it-IT/config/README.md @@ -9,6 +9,9 @@ mkdir -p ~/.config && touch ~/.config/starship.toml Tutta la configurazione per starship è fatta in questo file [TOML](https://github.com/toml-lang/toml): ```toml +# Get editor completions based on the config schema +"$schema" = 'https://starship.rs/config-schema.json' + # Inserts a blank line between shell prompts add_newline = true @@ -199,6 +202,7 @@ $hg_branch\ $docker_context\ $package\ $buf\ +$c\ $cmake\ $cobol\ $container\ @@ -235,6 +239,7 @@ $vagrant\ $zig\ $nix_shell\ $conda\ +$spack\ $memory_usage\ $aws\ $gcloud\ @@ -263,9 +268,9 @@ format = "$all$directory$character" ## AWS -The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file. This module also shows an expiration timer when using temporary credentials. +The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. Alternatively, you can force this module to show the region and profile even when the credentials have not been setup with the `force_display` option. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file. This module also shows an expiration timer when using temporary credentials. -The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. +The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if the conditions above are not respected. When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var. @@ -275,15 +280,16 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL ### Opzioni -| Opzione | Default | Descrizione | -| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------- | -| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | The format for the module. | -| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. | -| `region_aliases` | | Table of region aliases to display in addition to the AWS name. | -| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | -| `style` | `"bold yellow"` | Lo stile per il modulo. | -| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. | -| `disabled` | `false` | Disables the `AWS` module. | +| Opzione | Default | Descrizione | +| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | +| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | The format for the module. | +| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. | +| `region_aliases` | | Table of region aliases to display in addition to the AWS name. | +| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | +| `style` | `"bold yellow"` | Lo stile per il modulo. | +| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. | +| `disabled` | `false` | Disables the `AWS` module. | +| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. | ### Variables @@ -472,6 +478,52 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil symbol = "🦬 " ``` +## C + +The `c` module shows some information about your C compiler. By default the module will be shown if the current directory contains a `.c` or `.h` file. + +### Opzioni + +| Opzione | Default | Descrizione | +| ------------------- | --------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version(-$name) )]($style)"` | The format string for the module. | +| `version_format` | `"v${raw}"` | Il formato della versione. Le variabili disponibili sono `raw`, `major`, `minore`, & `patch` | +| `symbol` | `"C "` | The symbol used before displaying the compiler details | +| `detect_extensions` | `["c", "h"]` | Quali estensioni dovrebbero attivare questo modulo. | +| `detect_files` | `[]` | Quali nomi di file dovrebbero attivare questo modulo. | +| `detect_folders` | `[]` | Quali cartelle dovrebbero attivare questo modulo. | +| `commands` | [ [ "cc", "--version" ], [ "gcc", "--version" ], [ "clang", "--version" ] ] | How to detect what the compiler is | +| `style` | `"bold 149"` | Lo stile per il modulo. | +| `disabled` | `false` | Disables the `c` module. | + +### Variables + +| Variable | Esempio | Descrizione | +| -------- | ------- | ------------------------------------ | +| name | clang | The name of the compiler | +| version | 13.0.0 | The version of the compiler | +| symbol | | Mirrors the value of option `symbol` | +| style | | Mirrors the value of option `style` | + +NB that `version` is not in the default format. + +### Commands + +The `commands` option accepts a list of commands to determine the compiler version and name. + +Each command is represented as a list of the executable name, followed by its arguments, usually something like `["mycc", "--version"]`. Starship will try executing each command until it gets a result on STDOUT. + +If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). + +### Esempio + +```toml +# ~/.config/starship.toml + +[c] +format = "via [$name $version]($style)" +``` + ## Character The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. @@ -550,9 +602,9 @@ The `cmake` module shows the currently installed version of [CMake](https://cmak | `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 the version of cmake. | -| `detect_extensions` | `[]` | Which extensions should trigger this module | -| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | -| `detect_folders` | `[]` | Which folders should trigger this module | +| `detect_extensions` | `[]` | Quali estensioni dovrebbero attivare questo modulo | +| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Quali nomi di file dovrebbero attivare questo modulo | +| `detect_folders` | `[]` | Quali cartelle dovrebbero attivare questo modulo | | `style` | `"bold blue"` | Lo stile per il modulo. | | `disabled` | `false` | Disables the `cmake` module. | @@ -962,7 +1014,7 @@ You'll also need the .NET Core SDK installed in order to use it correctly. Internally, this module uses its own mechanism for version detection. Typically it is twice as fast as running `dotnet --version`, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting `heuristic = false` in the module options. -The module will also show the Target Framework Moniker () when there is a csproj file in the current directory. +The module will also show the Target Framework Moniker () when there is a `.csproj` file in the current directory. ### Opzioni @@ -2360,8 +2412,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`, `minore`, & `patch` | | `style` | `"bold 208"` | Lo stile per il modulo. | -| `display_private` | `false` | Enable displaying version for packages marked as private. | -| `disabled` | `false` | Disables the `package` module. | +| `display_private` | `false` | Abilita la visualizzazione della versione per i pacchetti contrassegnati come privati. | +| `disabled` | `false` | Disabilita il modulo `package`. | ### Variables @@ -2587,9 +2639,9 @@ By default the module will be shown if any of the following conditions are met: | `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 | +| `detect_extensions` | `["py"]` | Quali estensioni dovrebbero attivare questo modulo | +| `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | Quali nomi di file dovrebbero attivare questo modulo | +| `detect_folders` | `[]` | Quali cartelle dovrebbero attivare questo modulo | | `disabled` | `false` | Disables the `python` module. | ::: tip @@ -2667,9 +2719,9 @@ The `rlang` module shows the currently installed version of [R](https://www.r-pr | `version_format` | `"v${raw}"` | Il formato della versione. Le variabili disponibili sono `raw`, `major`, `minore`, & `patch` | | `symbol` | `"📐"` | A format string representing the symbol of R. | | `style` | `"blu grassetto"` | Lo stile per il modulo. | -| `detect_extensions` | `["R", "Rd", "Rmd", "Rproj", "Rsx"]` | Which extensions should trigger this module | -| `detect_files` | `[".Rprofile"]` | Which filenames should trigger this module | -| `detect_folders` | `[".Rproj.user"]` | Which folders should trigger this module | +| `detect_extensions` | `["R", "Rd", "Rmd", "Rproj", "Rsx"]` | Quali estensioni dovrebbero attivare questo modulo | +| `detect_files` | `[".Rprofile"]` | Quali nomi di file dovrebbero attivare questo modulo | +| `detect_folders` | `[".Rproj.user"]` | Quali cartelle dovrebbero attivare questo modulo | | `disabled` | `false` | Disables the `r` module. | ### Variables @@ -2969,6 +3021,39 @@ The `singularity` module shows the current [Singularity](https://sylabs.io/singu format = '[📦 \[$env\]]($style) ' ``` +## Spack + +The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set. + +### Opzioni + +| Opzione | Default | Descrizione | +| ------------------- | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | +| `truncation_length` | `1` | The number of directories the environment path should be truncated to. `0` means no truncation. Also see the [`directory`](#directory) module. | +| `symbol` | `"🅢 "` | The symbol used before the environment name. | +| `style` | `"bold blue"` | Lo stile per il modulo. | +| `format` | `"via [$symbol$environment]($style) "` | The format for the module. | +| `disabled` | `false` | Disables the `spack` module. | + +### Variables + +| Variable | Esempio | Descrizione | +| ----------- | ------------ | ------------------------------------ | +| environment | `astronauts` | The current spack environment | +| 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 + +[spack] +format = "[$symbol$environment](dimmed blue) " +``` + ## Status 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. @@ -3204,7 +3289,7 @@ If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Otherwise, it de | Variable | Esempio | Descrizione | | --------- | ---------- | ----------------------------------- | -| time | `13:08:10` | The current time. | +| ora | `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 @@ -3226,7 +3311,7 @@ time_range = "10:00:00-14:00:00" 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 +- The current user is root/admin - The current user isn't the same as the one that is logged in - The user is currently connected as an SSH session - The variable `show_always` is set to true @@ -3239,13 +3324,13 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, ` ### Opzioni -| Opzione | Default | Descrizione | -| ------------- | ----------------------- | ------------------------------------- | -| `style_root` | `"bold red"` | The style used when the user is root. | -| `style_user` | `"bold yellow"` | The style used for non-root users. | -| `format` | `"[$user]($style) in "` | The format for the module. | -| `show_always` | `false` | Always shows the `username` module. | -| `disabled` | `false` | Disables the `username` module. | +| Opzione | Default | Descrizione | +| ------------- | ----------------------- | ------------------------------------------- | +| `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 "` | The format for the module. | +| `show_always` | `false` | Always shows the `username` module. | +| `disabled` | `false` | Disables the `username` module. | ### Variables @@ -3318,12 +3403,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`, `minore`, & `patch` | -| `symbol` | `"V "` | A format string representing the symbol of V | +| `symbol` | `"V "` | Una stringa di formato che rappresenta il simbolo di 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` | Disables the `vlang` module. | +| `disabled` | `false` | Disabilita il modulo `vlang`. | ### Variables @@ -3417,9 +3502,9 @@ The `custom` modules show the output of some arbitrary commands. These modules will be shown if any of the following conditions are met: -- The current directory contains a file whose name is in `files` -- The current directory contains a directory whose name is in `directories` -- The current directory contains a file whose extension is in `extensions` +- The current directory contains a file whose name is in `detect_files` +- The current directory contains a directory whose name is in `detect_folders` +- The current directory contains a file whose extension is in `detect_extensions` - The `when` command returns 0 - The current Operating System (std::env::consts::OS) matchs with `os` field if defined. @@ -3451,20 +3536,22 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt ### Opzioni -| Opzione | Default | Descrizione | -| ------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `command` | `""` | The command whose output should be printed. The command will be passed on stdin to the shell. | -| `when` | | A shell command used as a condition to show the module. 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`. | -| `files` | `[]` | The files that will be searched in the working directory for a match. | -| `directories` | `[]` | The directories that will be searched in the working directory for a match. | -| `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"` | Lo stile per il modulo. | -| `format` | `"[$symbol($output )]($style)"` | The format for the module. | -| `disabled` | `false` | Disables this `custom` module. | -| `os` | | Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) [See possible values](https://doc.rust-lang.org/std/env/consts/constant.OS.html). | +| Opzione | Default | Descrizione | +| ------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `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`. | +| `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"` | Lo stile per il modulo. | +| `format` | `"[$symbol($output )]($style)"` | The format for the module. | +| `disabled` | `false` | Disables this `custom` module. | +| `os` | | Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) [See possible values](https://doc.rust-lang.org/std/env/consts/constant.OS.html). | +| `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 @@ -3487,7 +3574,7 @@ If unset, it will fallback to STARSHIP_SHELL and then to "sh" on Linux, and "cmd The `command` will be passed in on stdin. -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 -`. This behavior can be avoided by explicitly passing arguments to the shell, e.g. +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", "-"] @@ -3512,12 +3599,18 @@ Automatic detection of shells and proper parameters addition are currently imple [custom.foo] command = "echo foo" # shows output of command -files = ["foo"] # can specify filters but wildcards are not supported +detect_files = ["foo"] # can specify filters but wildcards are not supported when = """ test "$HOME" == "$PWD" """ format = " transcending [$output]($style)" [custom.time] command = "time /T" -extensions = ["pst"] # filters *.pst files +detect_extensions = ["pst"] # filters *.pst files shell = ["pwsh.exe", "-NoProfile", "-Command", "-"] + +[custom.time-as-arg] +command = "time /T" +detect_extensions = ["pst"] # filters *.pst files +shell = ["pwsh.exe", "-NoProfile", "-Command"] +use_stdin = false ``` diff --git a/docs/it-IT/guide/README.md b/docs/it-IT/guide/README.md index 10049666..17aab2e6 100644 --- a/docs/it-IT/guide/README.md +++ b/docs/it-IT/guide/README.md @@ -145,7 +145,7 @@ Starship with iTerm2 and the Snazzy theme @@ -160,7 +160,7 @@ - **Facile:** veloce da installare - inizia ad usarlo in pochi minuti.

-Explore the Starship docs  ▶ +Esplora la documentazione di Starship  ▶

@@ -173,7 +173,7 @@ ### Fase 1. Installa Starship -Select your operating system from the list below to view installation instructions: +Selezionare il sistema operativo dall'elenco qui sotto per visualizzare le istruzioni per l'installazione:
Android @@ -264,7 +264,7 @@ Install Starship using any of the following package managers: ### Fase 2. Imposta la tua shell a utilizzare Starship -Configure your shell to initialize starship. Select yours from the list below: +Configura la shell a inizializzare Starship. Seleziona la tua dalla lista qui sotto:
Bash @@ -297,7 +297,7 @@ Aggiungi quanto segue alla fine di `~/.elvish/rc.elv`: eval (starship init elvish) ``` -Note: Only Elvish v0.17+ is supported +Note: Only Elvish v0.18+ is supported
@@ -390,9 +390,9 @@ eval "$(starship init zsh)" ### Fase 3. Configura Starship -Start a new shell instance, and you should see your beautiful new shell prompt. If you're happy with the defaults, enjoy! +Inizia una nuova istanza del shell, e dovresti vedere il tuo bellissimo nuovo shell prompt. Se sei soddisfatto dei valori predefiniti, ottimo! -If you're looking to further customize Starship: +Se stai cercando di personalizzare ulteriormente Starship: - **[Configurazione](https://starship.rs/config/)** – impara come configurare Starship per modificare il tuo prompt a tuo piacimento @@ -400,15 +400,15 @@ If you're looking to further customize Starship: ## 🤝 Contribuire -We are always looking for contributors of **all skill levels**! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). +Siamo sempre alla ricerca di collaboratori di **tutti i livelli**! Se stai cercando di entrare facilmente nel progetto, prova un [buon primo problema](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). -If you are fluent in a non-English language, we greatly appreciate any help keeping our docs translated and up-to-date in other languages. If you would like to help, translations can be contributed on the [Starship Crowdin](https://translate.starship.rs/). +Se parli correntemente una lingua diversa dall'inglese, apprezziamo molto qualsiasi aiuto per mantenere i nostri documenti tradotti e aggiornati in altre lingue. Se desideri collaborare, le traduzioni possono essere fornite su [Starship Crowdin](https://translate.starship.rs/). -If you are interested in helping contribute to starship, please take a look at our [Contributing Guide](https://github.com/starship/starship/blob/master/CONTRIBUTING.md). Also, feel free to drop into our [Discord server](https://discord.gg/8Jzqu3T) and say hi. 👋 +Se sei interessato ad aiutare a contribuire a Starship, dai un'occhiata alla nostra [Guida al Contributo](https://github.com/starship/starship/blob/master/CONTRIBUTING.md). Inoltre, sentiti libero di entrare nel nostro [server Discord](https://discord.gg/8Jzqu3T) e dire ciao. 👋 ## 💭 Ispirato Da -Please check out these previous works that helped inspire the creation of starship. 🙏 +Ti invito di controllare questi lavori precedenti che hanno contribuito a ispirare la creazione di Starship. 🙏 - **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** – Un prompt ZSH per astronauti. @@ -423,4 +423,4 @@ Please check out these previous works that helped inspire the creation of starsh ## 📝 Licenza -Copyright © 2019-present, [Starship Contributors](https://github.com/starship/starship/graphs/contributors).
This project is [ISC](https://github.com/starship/starship/blob/master/LICENSE) licensed. +Copyright © 2019-presente, [Starship Contributors](https://github.com/starship/starship/graphs/contributors).
Questo progetto è sotto licenza [ISC](https://github.com/starship/starship/blob/master/LICENSE). diff --git a/docs/it-IT/installing/README.md b/docs/it-IT/installing/README.md index 749c62c5..0c9a3b03 100644 --- a/docs/it-IT/installing/README.md +++ b/docs/it-IT/installing/README.md @@ -1,4 +1,4 @@ -# Advanced Installation +# Installazione Avanzata Per installare starship, è necessario fare due cose: diff --git a/docs/ja-JP/README.md b/docs/ja-JP/README.md index ef79eaed..eadb6c98 100644 --- a/docs/ja-JP/README.md +++ b/docs/ja-JP/README.md @@ -18,7 +18,7 @@ features: footer: ISC Licensed | Copyright © 2019-present Starship Contributors #Used for the description meta tag, for SEO metaTitle: "Starship: Cross-Shell Prompt" -description: Starship はミニマルで、非常に高速で、カスタマイズ性の高い、あらゆるシェルのためのプロンプトです！ ミニマルかつ洗練された形で、あなたに必要な情報を表示します。 Quick installation available for Bash, Fish, ZSH, Ion, Tcsh, Elvish, Nu, Xonsh, Cmd, and PowerShell. +description: Starship はミニマルで、非常に高速で、カスタマイズ性の高い、あらゆるシェルのためのプロンプトです！ ミニマルかつ洗練された形で、あなたに必要な情報を表示します。 Bash, Fish, ZSH, Ion, Tcsh, Elvish, Nu, Xonsh, Cmd, PowerShellで簡単に利用できます。 ---
@@ -120,7 +120,7 @@ description: Starship はミニマルで、非常に高速で、カスタマイ #### Elvish - ::: warning elvish v0.17以上のみサポートされています。 ::: + ::: warning elvish v0.18以上のみサポートされています。 ::: `~/.elvish/rc.elv` の最後に以下を追記してください。 @@ -144,13 +144,13 @@ description: Starship はミニマルで、非常に高速で、カスタマイ #### Nushell - ::: warning This will change in the future. Only Nushell v0.60+ is supported. ::: Run the following: + ::: 警告 これは将来的に変更されます。 Only Nushell v0.60+ is supported. 以下を実行します: ```sh mkdir ~/.cache/starship starship init nu | save ~/.cache/starship/init.nu ``` - And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`): + そして、Nushellの設定ファイルの最後に以下を追加してください（ `$nu.config-path` を実行してください）。 ```sh mkdir ~/.cache/starship @@ -171,7 +171,7 @@ description: Starship はミニマルで、非常に高速で、カスタマイ #### 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: + [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) コマンドを使用する必要があります。 以下をファイル `starship.lua` に追加し、Clinkスクリプトディレクトリに配置します: ```lua -- starship.lua diff --git a/docs/ja-JP/advanced-config/README.md b/docs/ja-JP/advanced-config/README.md index bd4cf2b4..941e9311 100644 --- a/docs/ja-JP/advanced-config/README.md +++ b/docs/ja-JP/advanced-config/README.md @@ -131,7 +131,7 @@ Invoke-Expression (&starship init powershell) シェルによっては、入力と同じ行にレンダリングされる右プロンプトをサポートしています。 Starship では `right_format` オプションを使って右プロンプトの内容を設定できます。 `format`で使用できるモジュールはすべて`right_format`でも使用できます。 変数`$all`には、`format`や`right_format`で明示的に使用されていないモジュールのみが格納されます。 -注意: 右プロンプトは入力の場所に続く単一の行です。 複数行のプロンプトで入力行の上を右寄せにするには、[fillモジュール](/config/#fill)を参照してください。 +注意: 右プロンプトは入力の場所に続く単一の行です。 To right align modules above the input line in a multi-line prompt, see the [`fill` module](/config/#fill). `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd. diff --git a/docs/ja-JP/config/README.md b/docs/ja-JP/config/README.md index 4141b743..dba4ba5f 100644 --- a/docs/ja-JP/config/README.md +++ b/docs/ja-JP/config/README.md @@ -9,6 +9,9 @@ mkdir -p ~/.config && touch ~/.config/starship.toml Starshipのすべての設定は、この[TOML](https://github.com/toml-lang/toml)ファイルで行われます。 ```toml +# Get editor completions based on the config schema +"$schema" = 'https://starship.rs/config-schema.json' + # Inserts a blank line between shell prompts add_newline = true @@ -33,7 +36,7 @@ PowerShell (Windows) で同様に `$PROFILE` にこの行を追加します。 $ENV:STARSHIP_CONFIG = "$HOME\example\non\default\path\starship.toml" ``` -Or for Cmd (Windows) would be adding this line to your `starship.lua`: +または、Cmd (Windows) の場合、`starship.lua`にこの行を追加します。 ```lua os.setenv('STARSHIP_CONFIG', 'C:\\Users\\user\\example\\non\\default\\path\\starship.toml') @@ -53,7 +56,7 @@ PowerShell (Windows) で同様に `$PROFILE`にこの行を追加します。 $ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp" ``` -Or for Cmd (Windows) would be adding this line to your `starship.lua`: +または、Cmd (Windows) の場合、`starship.lua`にこの行を追加します。 ```lua os.setenv('STARSHIP_CACHE', 'C:\\Users\\user\\AppData\\Local\\Temp') @@ -73,7 +76,7 @@ os.setenv('STARSHIP_CACHE', 'C:\\Users\\user\\AppData\\Local\\Temp') #### 変数 -変数には、 `$` 記号と、その変数の名前が続きます。 The name of a variable can only contain letters, numbers and `_`. +変数には、 `$` 記号と、その変数の名前が続きます。 変数の名前には英字と数字、`_`のみを含めることができます。 例： @@ -118,11 +121,11 @@ Starshipのほとんどのモジュールでは、表示スタイルを設定で - `(some text)` は括弧の中に変数がないので、常に何も表示しません。 - `$all` が `\[$a$b\]` のショートカットである時、 `$a` と `$b` が両方とも `None` である場合に限り、`($all)` は何も表示しません。 これは `(\[$a$b\] )` と同じ動作をします。 -#### Special characters +#### 特殊文字 -The following symbols have special usage in a format string and must be escaped: `$ \ [ ] ( )`. +次の記号はフォーマット文字列で特殊な用途を持っているため、エスケープする必要があります。: `$ \ [ ] ( )`. -Note that TOML has [both basic strings and literal strings](https://toml.io/en/v1.0.0#string). It is recommended to use a literal string (surrounded by single quotes) in your config. If you want to use a basic string (surrounded by double quotes), you must escape the backslash itself (i.e. use `\\`). +TOMLには、 [基本文字列とリテラル文字列](https://toml.io/en/v1.0.0#string)の両方があることに注意してください。 設定では、リテラル文字列(シングルクォートで囲まれた文字列)を使用することをお勧めします。基本文字列(ダブルクォートで囲まれた文字列)を使用したい場合は、バックスラッシュ自体をエスケープする必要があります。(例: `\\`を使用する) 例えば、新しい行に `$` 記号を表示したい場合、以下の `format` の設定が等価です。 @@ -200,6 +203,7 @@ $hg_branch\ $docker_context\ $package\ $buf\ +$c\ $cmake\ $cobol\ $container\ @@ -236,6 +240,7 @@ $vagrant\ $zig\ $nix_shell\ $conda\ +$spack\ $memory_usage\ $aws\ $gcloud\ @@ -264,9 +269,9 @@ format = "$all$directory$character" ## AWS -The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. これは `~/.aws/config` に記述されている `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` 環境変数に基づいています。 This module also shows an expiration timer when using temporary credentials. +The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. Alternatively, you can force this module to show the region and profile even when the credentials have not been setup with the `force_display` option. これは `~/.aws/config` に記述されている `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` 環境変数に基づいています。 This module also shows an expiration timer when using temporary credentials. -The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. +The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if the conditions above are not respected. When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var. @@ -276,15 +281,16 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL ### オプション -| オプション | デフォルト | 説明 | -| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------- | -| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | module のフォーマットです。 | -| `symbol` | `"☁️ "` | 現在のAWSプロファイルを表示する前に表示される記号です。 | -| `region_aliases` | | AWS名に加えて表示するリージョンのエイリアスです。 | -| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | -| `style` | `"bold yellow"` | モジュールのスタイルです。 | -| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. | -| `disabled` | `false` | Disables the `AWS` module. | +| オプション | デフォルト | 説明 | +| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | +| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | module のフォーマットです。 | +| `symbol` | `"☁️ "` | 現在のAWSプロファイルを表示する前に表示される記号です。 | +| `region_aliases` | | AWS名に加えて表示するリージョンのエイリアスです。 | +| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | +| `style` | `"bold yellow"` | モジュールのスタイルです。 | +| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. | +| `disabled` | `false` | `aws`モジュールを無効にします。 | +| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. | ### 変数 @@ -473,16 +479,62 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil symbol = "🦬 " ``` +## C + +The `c` module shows some information about your C compiler. By default the module will be shown if the current directory contains a `.c` or `.h` file. + +### オプション + +| オプション | デフォルト | 説明 | +| ------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------ | +| `format` | `"via [$symbol($version(-$name) )]($style)"` | モジュールのフォーマット文字列。 | +| `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | +| `symbol` | `"C "` | The symbol used before displaying the compiler details | +| `detect_extensions` | `["c", "h"]` | どの拡張子がこのモジュールをアクティブにするか | +| `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか | +| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | +| `commands` | [ [ "cc", "--version" ], [ "gcc", "--version" ], [ "clang", "--version" ] ] | How to detect what the compiler is | +| `style` | `"bold 149"` | モジュールのスタイルです。 | +| `disabled` | `false` | Disables the `c` module. | + +### 変数 + +| 変数 | 設定例 | 説明 | +| ------- | ------ | --------------------------- | +| name | clang | The name of the compiler | +| version | 13.0.0 | The version of the compiler | +| symbol | | オプション `記号` の値をミラーする | +| style | | オプション `style` の値をミラーする | + +NB that `version` is not in the default format. + +### Commands + +The `commands` option accepts a list of commands to determine the compiler version and name. + +Each command is represented as a list of the executable name, followed by its arguments, usually something like `["mycc", "--version"]`. Starship will try executing each command until it gets a result on STDOUT. + +If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). + +### 設定例 + +```toml +# ~/.config/starship.toml + +[c] +format = "via [$name $version]($style)" +``` + ## 文字 -The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. +`character`モジュールは、端末でテキストが入力される場所の横に文字（通常は矢印）を表示します。 -The character will tell you whether the last command was successful or not. It can do this in two ways: +文字は、最後のコマンドが成功したかどうかを示します。 表し方は下記の2つです。 -- changing color (`red`/`green`) -- changing shape (`❯`/`✖`) +- 色の変更 (`赤`/`緑`) +- プロンプトの表示の変更 (`❯`/`✖`) -By default it only changes color. If you also want to change its shape take a look at [this example](#with-custom-error-shape). +デフォルトでは、色だけが変更されます。 形も変えてみたい場合は[このサンプル](#with-custom-error-shape)も参考にしてください。 ::: warning @@ -492,19 +544,19 @@ By default it only changes color. If you also want to change its shape take a lo ### オプション -| オプション | デフォルト | 説明 | -| ---------------- | ------------------- | -------------------------------------------------------------------------------- | -| `format` | `"$symbol "` | The format string used before the text input. | -| `success_symbol` | `"[❯](bold green)"` | The format string used before the text input if the previous command succeeded. | -| `error_symbol` | `"[❯](bold red)"` | The format string used before the text input if the previous command failed. | -| `vicmd_symbol` | `"[❮](bold green)"` | The format string used before the text input if the shell is in vim normal mode. | -| `disabled` | `false` | Disables the `character` module. | +| オプション | デフォルト | 説明 | +| ---------------- | ------------------- | -------------------------------------------- | +| `format` | `"$symbol"` | テキスト入力の前に使用される書式文字列。 | +| `success_symbol` | `"[❯](bold green)"` | 前のコマンドが成功した場合にテキスト入力の前に使用される書式文字列です。 | +| `error_symbol` | `"[❯](bold red)"` | 前のコマンドが失敗した場合にテキスト入力の前に使用される書式文字列です。 | +| `vicmd_symbol` | `"[❮](bold green)"` | シェルが vim ノーマルモードの場合にテキスト入力の前に使用されるフォーマット文字列。 | +| `disabled` | `false` | `character`モジュールを無効にします。 | ### 変数 -| 変数 | 設定例 | 説明 | -| ------ | --- | --------------------------------------------------------------------- | -| symbol | | A mirror of either `success_symbol`, `error_symbol` or `vicmd_symbol` | +| 変数 | 設定例 | 説明 | +| ------ | --- | ----------------------------------------------------------- | +| symbol | | `success_symbol` 、もしくは `error_symbol` 、 `vicmd_symbol` のミラー | ### 設定例 @@ -539,10 +591,10 @@ vicmd_symbol = "[V](bold green) " ## CMake -The `cmake` module shows the currently installed version of [CMake](https://cmake.org/). By default the module will be activated if any of the following conditions are met: +`cmake`モジュールは、現在インストールされている[Cmake](https://cmake.org/)のバージョンを表示します。 デフォルトでは次のいずれかの条件が満たされると、モジュールがアクティブになります。 -- The current directory contains a `CMakeLists.txt` file -- The current directory contains a `CMakeCache.txt` file +- カレントディレクトリに `CMakeLists.txt` ファイルが含まれている +- カレントディレクトリに `CMakeCache.txt` ファイルが含まれている ### オプション @@ -550,18 +602,18 @@ The `cmake` module shows the currently installed version of [CMake](https://cmak | ------------------- | -------------------------------------- | ------------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 | | `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | -| `symbol` | `"△ "` | The symbol used before the version of cmake. | -| `detect_extensions` | `[]` | Which extensions should trigger this module | -| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | -| `detect_folders` | `[]` | Which folders should trigger this module | +| `symbol` | `"△ "` | cmakeのバージョンの前に使用される記号 | +| `detect_extensions` | `[]` | どの拡張子がこのモジュールをアクティブにするか | +| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | どのファイル名がこのモジュールをアクティブにするか | +| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | | `style` | `"bold blue"` | モジュールのスタイルです。 | -| `disabled` | `false` | Disables the `cmake` module. | +| `disabled` | `false` | `cmake`モジュールを無効にします。 | ### 変数 | 変数 | 設定例 | 説明 | | --------- | --------- | ---------------------- | -| version | `v3.17.3` | The version of cmake | +| version | `v3.17.3` | cmake のバージョン | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | @@ -569,7 +621,7 @@ The `cmake` module shows the currently installed version of [CMake](https://cmak ## COBOL / GNUCOBOL -The `cobol` module shows the currently installed version of COBOL. By default, the module will be shown if any of the following conditions are met: +`COBOL` モジュールは、現在インストールされているCOBOLのバージョンを表示します。 By default, the module will be shown if any of the following conditions are met: - The current directory contains any files ending in `.cob` or `.COB` - The current directory contains any files ending in `.cbl` or `.CBL` @@ -599,35 +651,35 @@ The `cobol` module shows the currently installed version of COBOL. By default, t ## コマンド実行時間 -The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists. +`cmd_duration`モジュールは、最後のコマンドの実行にかかった時間を示します。 モジュールが表示されるのは、コマンドが2秒以上かかった場合、または`min_time`値が存在する場合のみです。 -::: warning Do not hook the DEBUG trap in Bash +::: warning BashでDEBUGトラップをhookしない -If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. +`bash`でStarshipを実行している場合、 `eval $(starship init $0)`実行した後に`DEBUG`トラップをフックしないでください。そうしないと、このモジュールが**おそらくですが**壊れます。 ::: -Bash users who need preexec-like functionality can use [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Simply define the arrays `preexec_functions` and `precmd_functions` before running `eval $(starship init $0)`, and then proceed as normal. +preexecのような機能を必要とするBashユーザーは、 [rcalorasのbash_preexecフレームワーク](https://github.com/rcaloras/bash-preexec)を使用できます。 `eval $(starship init $0)` を実行する前に、`preexec_functions`、および`precmd_functions`定義するだけで、通常どおり続行します。 ### オプション | オプション | デフォルト | 説明 | | ---------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). | -| `show_milliseconds` | `false` | Show milliseconds in addition to seconds for the duration. | +| `min_time` | `2_000` | 実行時間を表示する最短期間（ミリ秒単位）です。 | +| `show_milliseconds` | `false` | 実行時間の秒に加えてミリ秒を表示します。 | | `format` | `"took [$duration]($style) "` | module のフォーマットです。 | | `style` | `"bold yellow"` | モジュールのスタイルです。 | -| `disabled` | `false` | Disables the `cmd_duration` module. | -| `show_notifications` | `false` | Show desktop notifications when command completes. | -| `min_time_to_notify` | `45_000` | Shortest duration for notification (in milliseconds). | +| `disabled` | `false` | `cmd_duration`モジュールを無効にします。 | +| `show_notifications` | `false` | コマンドが完了したらデスクトップ通知を表示します。 | +| `min_time_to_notify` | `45_000` | 通知を持続する最短期間(ミリ秒単位) | | `notification_timeout` | | Duration to show notification for (in milliseconds). If unset, notification timeout will be determined by daemon. Not all notification daemons honor this option. | ### 変数 -| 変数 | 設定例 | 説明 | -| --------- | -------- | --------------------------------------- | -| duration | `16m40s` | The time it took to execute the command | -| style\* | | オプション `style` の値をミラーする | +| 変数 | 設定例 | 説明 | +| --------- | -------- | ---------------------- | +| duration | `16m40s` | コマンドの実行時間 | +| style\* | | オプション `style` の値をミラーする | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -647,28 +699,28 @@ The `conda` module shows the current [Conda](https://docs.conda.io/en/latest/) e ::: tip -This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. +Note: これはconda自身の プロンプト修飾子 を抑制しません。`conda config --set changeps1 False` で実行することができます。 ::: ### オプション -| オプション | デフォルト | 説明 | -| ------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `truncation_length` | `1` | The number of directories the environment path should be truncated to, if the environment was created via `conda create -p [path]`. `0` means no truncation. Also see the [`directory`](#directory) module. | -| `symbol` | `"🅒 "` | The symbol used before the environment name. | -| `style` | `"bold green"` | モジュールのスタイルです。 | -| `format` | `"via [$symbol$environment]($style) "` | module のフォーマットです。 | -| `ignore_base` | `true` | Ignores `base` environment when activated. | -| `disabled` | `false` | Disables the `conda` module. | +| オプション | デフォルト | 説明 | +| ------------------- | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `truncation_length` | `1` | 環境が`conda create -p [path]`で作成された場合、環境パスが切り捨てられるディレクトリ数。 `0`は切り捨てがないことを意味します。 [`directory`](#directory)もご覧ください。 | +| `symbol` | `"🅒 "` | 環境名の直前に使用されるシンボルです。 | +| `style` | `"bold green"` | モジュールのスタイルです。 | +| `format` | `"via [$symbol$environment]($style) "` | module のフォーマットです。 | +| `ignore_base` | `true` | アクティブになった時、環境`base`を無視します。 | +| `disabled` | `false` | `conda`モジュールを無効にします。 | ### 変数 -| 変数 | 設定例 | 説明 | -| ----------- | ------------ | ----------------------------- | -| environment | `astronauts` | The current conda environment | -| symbol | | オプション `記号` の値をミラーする | -| style\* | | オプション `style` の値をミラーする | +| 変数 | 設定例 | 説明 | +| ----------- | ------------ | ---------------------- | +| environment | `astronauts` | 現在の conda 環境 | +| symbol | | オプション `記号` の値をミラーする | +| style\* | | オプション `style` の値をミラーする | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -715,31 +767,31 @@ format = "[$symbol \\[$name\\]]($style) " ## Crystal -The `crystal` module shows the currently installed version of [Crystal](https://crystal-lang.org/). By default the module will be shown if any of the following conditions are met: +`crystal`モジュールは、現在インストールされている[Crystal](https://crystal-lang.org/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 -- The current directory contains a `shard.yml` file -- The current directory contains a `.cr` file +- カレントディレクトリに`shard.yml`ファイルが含まれている +- カレントディレクトリに`.cr`の拡張子のファイルが含まれている ### オプション -| オプション | デフォルト | 説明 | -| ------------------- | ------------------------------------ | --------------------------------------------------------- | -| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | -| `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 | -| `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | -| `style` | `"bold red"` | モジュールのスタイルです。 | -| `detect_extensions` | `["cr"]` | どの拡張子がこのモジュールをアクティブにするか | -| `detect_files` | `["shard.yml"]` | どのファイル名がこのモジュールをアクティブにするか | -| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | -| `disabled` | `false` | Disables the `crystal` module. | +| オプション | デフォルト | 説明 | +| ------------------- | ------------------------------------ | ------------------------------------------------------ | +| `symbol` | `"🔮 "` | Crystalのバージョンを表示する前に使用される記号です。 | +| `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 | +| `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | +| `style` | `"bold red"` | モジュールのスタイルです。 | +| `detect_extensions` | `["cr"]` | どの拡張子がこのモジュールをアクティブにするか | +| `detect_files` | `["shard.yml"]` | どのファイル名がこのモジュールをアクティブにするか | +| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | +| `disabled` | `false` | `crystal`モジュールを無効にします。 | ### 変数 -| 変数 | 設定例 | 説明 | -| --------- | --------- | ------------------------ | -| version | `v0.32.1` | The version of `crystal` | -| symbol | | オプション `記号` の値をミラーする | -| style\* | | オプション `style` の値をミラーする | +| 変数 | 設定例 | 説明 | +| --------- | --------- | ---------------------- | +| version | `v0.32.1` | `crystal` のバージョン | +| symbol | | オプション `記号` の値をミラーする | +| style\* | | オプション `style` の値をミラーする | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -754,30 +806,30 @@ format = "via [✨ $version](bold blue) " ## Dart -The `dart` module shows the currently installed version of [Dart](https://dart.dev/). By default the module will be shown if any of the following conditions are met: +`dart`モジュールは、現在インストールされている[Dart](https://dart.dev/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 -- The current directory contains a file with `.dart` extension -- The current directory contains a `.dart_tool` directory -- The current directory contains a `pubspec.yaml`, `pubspec.yml` or `pubspec.lock` file +- カレントディレクトリに`.dart`の拡張子のファイルが含まれている +- カレントディレクトリに`.dart_tool`ディレクトリが含まれている +- カレントディレクトリに`pubspec.yaml`, `pubspec.yml`,もしくは`pubspec.lock`が含まれている ### オプション | オプション | デフォルト | 説明 | | ------------------- | ------------------------------------------------- | ------------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | +| `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 | | `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | -| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | +| `symbol` | `"🎯 "` | Dartのシンボルを表すフォーマット文字列 | | `detect_extensions` | `["dart"]` | どの拡張子がこのモジュールをアクティブにするか | | `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | どのファイル名がこのモジュールをアクティブにするか | | `detect_folders` | `[".dart_tool"]` | どのフォルダーがこのモジュールをアクティブにするか | | `style` | `"bold blue"` | モジュールのスタイルです。 | -| `disabled` | `false` | Disables the `dart` module. | +| `disabled` | `false` | `dart`モジュールを無効にします。 | ### 変数 | 変数 | 設定例 | 説明 | | --------- | -------- | ---------------------- | -| version | `v2.8.4` | The version of `dart` | +| version | `v2.8.4` | `dart` のバージョン | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | @@ -794,7 +846,7 @@ format = "via [🔰 $version](bold red) " ## Deno -The `deno` module shows you your currently installed version of [Deno](https://deno.land/). By default the module will be shown if any of the following conditions are met: +`deno`モジュールは、現在インストールされている[Deno](https://deno.land/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - The current directory contains a `deno.json`, `deno.jsonc`, `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file @@ -804,18 +856,18 @@ The `deno` module shows you your currently installed version of [Deno](https://d | ------------------- | ----------------------------------------------------------------------- | ------------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 | | `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | -| `symbol` | `"🦕 "` | A format string representing the symbol of Deno | +| `symbol` | `"🦕 "` | Dart のシンボルを表すフォーマット文字列 | | `detect_extensions` | `[]` | どの拡張子がこのモジュールをアクティブにするか | | `detect_files` | `["deno.json", "deno.jsonc", "mod.ts", "mod.js", "deps.ts", "deps.js"]` | どのファイル名がこのモジュールをアクティブにするか | | `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | | `style` | `"green bold"` | モジュールのスタイルです。 | -| `disabled` | `false` | Disables the `deno` module. | +| `disabled` | `false` | `deno`モジュールを無効化します。 | ### 変数 | 変数 | 設定例 | 説明 | | --------- | -------- | ---------------------- | -| version | `v1.8.3` | The version of `deno` | +| version | `v1.8.3` | `deno`のバージョン | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | @@ -830,36 +882,36 @@ format = "via [🦕 $version](green bold) " ## Directory -The `directory` module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in. +`directory`モジュールには、現在のディレクトリへのパスが表示され、3つの親フォルダは切り捨てられます。 ディレクトリは、現在のgitリポジトリであるとルートとなります。 -When using the fish style pwd option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option. +fishスタイルのpwdオプションを使用すると、切り捨てられたパスを非表示にする代わりに、オプションで有効にした番号に基づいて各ディレクトリの短縮名が表示されます。 -For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, and the option set to `1`. You will now see `~/D/N/nixpkgs/pkgs`, whereas before it would have been `nixpkgs/pkgs`. +例として、`~/Dev/Nix/nixpkgs/pkgs`で、`nixpkgs`がリポジトリルートであり、オプションが`1`に設定されている場合を挙げます。 以前は`nixpkgs/pkgs`でしたが、`~/D/N/nixpkgs/pkgs`が表示されます。 ### オプション | オプション | デフォルト | 説明 | | ------------------- | ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. | -| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. | +| `truncation_length` | `3` | 現在のディレクトリを切り捨てる親フォルダーの数です。 | +| `truncate_to_repo` | `true` | 現在いるgitリポジトリのルートに切り捨てるかどうかです。 | | `format` | `"[$path]($style)[$read_only]($read_only_style) "` | module のフォーマットです。 | | `style` | `"bold cyan"` | モジュールのスタイルです。 | -| `disabled` | `false` | Disables the `directory` module. | -| `read_only` | `"🔒"` | The symbol indicating current directory is read only. | -| `read_only_style` | `"red"` | The style for the read only symbol. | -| `truncation_symbol` | `""` | The symbol to prefix to truncated paths. eg: "…/" | +| `disabled` | `false` | `directory`モジュールを無効にします。 | +| `read_only` | `"🔒"` | このシンボルが表示されている時、現在のディレクトリは読み取り専用です。 | +| `read_only_style` | `"red"` | 読み取り専用シンボルのスタイルです。 | +| `truncation_symbol` | `""` | The symbol to prefix to truncated paths. 例: "…/" | | `repo_root_style` | `None` | The style for the root of the git repo. The default value is equivalent to `style`. | | `repo_root_format` | `"[$before_root_path]($style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) "` | The format of a git repo when `repo_root_style` is defined. | -| `home_symbol` | `"~"` | The symbol indicating home directory. | +| `home_symbol` | `"~"` | ホームディレクトリを示すシンボルです。 | | `use_os_path_sep` | `true` | Use the OS specific path separator instead of always using `/` (e.g. `\` on Windows) |
-This module has a few advanced configuration options that control how the directory is displayed. +このモジュールは、どのようにディレクトリを表示するかについての高度なオプションをいくつか持っています。 | Advanced Option | デフォルト | 説明 | | --------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `substitutions` | | A table of substitutions to be made to the path. | -| `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. | +| `fish_style_pwd_dir_length` | `0` | fish shellのpwdパスロジックを適用するときに使用する文字数です。 | | `use_logical_path` | `true` | If `true` render the logical path sourced from the shell via `PWD` or `--logical-path`. If `false` instead render the physical filesystem path with symlinks resolved. | `substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD. @@ -876,10 +928,10 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an ### 変数 -| 変数 | 設定例 | 説明 | -| --------- | --------------------- | -------------------------- | -| path | `"D:/Projects"` | The current directory path | -| style\* | `"black bold dimmed"` | オプション `style` の値をミラーする | +| 変数 | 設定例 | 説明 | +| --------- | --------------------- | ---------------------- | +| path | `"D:/Projects"` | カレントディレクトリのパス | +| style\* | `"black bold dimmed"` | オプション `style` の値をミラーする | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -914,24 +966,24 @@ The `docker_context` module shows the currently active [Docker context](https:// ### オプション -| オプション | デフォルト | 説明 | -| ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `format` | `"via [$symbol$context]($style) "` | moduleのフォーマットです。 | -| `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. | -| `only_with_files` | `true` | Only show when there's a match | -| `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). | -| `detect_files` | `["docker-compose.yml", "docker-compose.yaml", "Dockerfile"]` | Which filenames should trigger this module (needs `only_with_files` to be true). | -| `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). | -| `style` | `"blue bold"` | モジュールのスタイルです。 | -| `disabled` | `false` | Disables the `docker_context` module. | +| オプション | デフォルト | 説明 | +| ------------------- | ---------------------------------- | -------------------------------------------------------------- | +| `format` | `"via [$symbol$context]($style) "` | module のフォーマットです。 | +| `symbol` | `"🐳 "` | Dockerコンテキストを表示する前に使用される記号です。 | +| `only_with_files` | `true` | ファイルに一致する場合にのみ表示 | +| `detect_extensions` | `[]` | どの拡張子がこのモジュールをトリガーするか(`only_with_files`がtrueになっている必要があります)。 | +| `detect_files` | `The format for the module.` | どんなファイル名がこのモジュールをトリガーするか(`only_with_files`がtrueになっている必要があります)。 | +| `detect_folders` | `[]` | どんなフォルダがこのモジュールをトリガーするか(`only_with_files`がtrueになっている必要があります)。 | +| `style` | `"blue bold"` | モジュールのスタイルです。 | +| `disabled` | `false` | `docker_context`モジュールを無効にします。 | ### 変数 -| 変数 | 設定例 | 説明 | -| --------- | -------------- | -------------------------- | -| context | `test_context` | The current docker context | -| symbol | | オプション `記号` の値をミラーする | -| style\* | | オプション `style` の値をミラーする | +| 変数 | 設定例 | 説明 | +| --------- | -------------- | ---------------------- | +| context | `test_context` | 現在の Docker コンテキスト | +| symbol | | オプション `記号` の値をミラーする | +| style\* | | オプション `style` の値をミラーする | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -946,9 +998,9 @@ format = "via [🐋 $context](blue bold)" ## Dotnet -The `dotnet` module shows the relevant version of the [.NET Core SDK](https://dotnet.microsoft.com/) for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. +`dotnet`モジュールはカレントディレクトリに関係する[.NET Core SDK](https://dotnet.microsoft.com/)のバージョンを表示します。 もし SDKは現在のディレクトリに固定されているのであれば、その固定されたバージョンが表示されます。 それ以外の場合、モジュール SDKの最新のインストールバージョンを示します。 -By default this module will only be shown in your prompt when one or more of the following files are present in the current directory: +デフォルトでは、このモジュールは現在のディレクトリに以下のファイルが 存在する場合にのみプロンプトで表示されます: - `global.json` - `project.json` @@ -961,29 +1013,29 @@ By default this module will only be shown in your prompt when one or more of the You'll also need the .NET Core SDK installed in order to use it correctly. -Internally, this module uses its own mechanism for version detection. Typically it is twice as fast as running `dotnet --version`, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting `heuristic = false` in the module options. +内部的に、このモジュールは自身のバージョン検知のメカニズムを利用します。 `dotnet --version` を実行するより2倍速く実行できますが、.NET project一般的でないディレクトリlayoutの場合は間違ったバージョンが示されてしまうことがあります。 速度よりも精度が重要な場合は、次の方法でメカニズムを無効にできます。 モジュールオプションで`heuristic = false `を設定します。 -The module will also show the Target Framework Moniker () when there is a csproj file in the current directory. +The module will also show the Target Framework Moniker () when there is a `.csproj` file in the current directory. ### オプション -| オプション | デフォルト | 説明 | -| ------------------- | ------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | -| `format` | `"via [$symbol($version )(🎯 $tfm )]($style)"` | module のフォーマットです。 | -| `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | -| `symbol` | `".NET "` | The symbol used before displaying the version of dotnet. | -| `heuristic` | `true` | Use faster version detection to keep starship snappy. | -| `detect_extensions` | `["csproj", "fsproj", "xproj"]` | どの拡張子がこのモジュールをアクティブにするか | -| `detect_files` | `["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]` | どのファイル名がこのモジュールをアクティブにするか | -| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | -| `style` | `"bold blue"` | モジュールのスタイルです。 | -| `disabled` | `false` | Disables the `dotnet` module. | +| オプション | デフォルト | 説明 | +| ------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ | +| `format` | `"via [$symbol($version )(🎯 $tfm )]($style)"` | module のフォーマットです。 | +| `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | +| `symbol` | `".NET "` | dotnetのバージョンを表示する前に使用される記号です。 | +| `heuristic` | `true` | より高速なバージョン検出を使用して、starshipの動作を維持します。 | +| `detect_extensions` | `["csproj", "fsproj", "xproj"]` | どの拡張子がこのモジュールをアクティブにするか | +| `detect_files` | `["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]` | どのファイル名がこのモジュールをアクティブにするか | +| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | +| `style` | `"bold blue"` | モジュールのスタイルです。 | +| `disabled` | `false` | `dotnet`モジュールを無効にします。 | ### 変数 | 変数 | 設定例 | 説明 | | --------- | ---------------- | ------------------------------------------------------------------ | -| version | `v3.1.201` | The version of `dotnet` sdk | +| version | `v3.1.201` | `dotnet sdk` のバージョンです | | tfm | `netstandard2.0` | The Target Framework Moniker that the current project is targeting | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | @@ -1003,9 +1055,9 @@ heuristic = false ## Elixir -The `elixir` module shows the currently installed version of [Elixir](https://elixir-lang.org/) and [Erlang/OTP](https://erlang.org/doc/). By default the module will be shown if any of the following conditions are met: +The `elixir` module shows the currently installed version of [Elixir](https://elixir-lang.org/) and [Erlang/OTP](https://erlang.org/doc/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 -- The current directory contains a `mix.exs` file. +- カレントディレクトリに`mix.exs`ファイルが含まれている. ### オプション @@ -1042,12 +1094,12 @@ symbol = "🔮 " ## Elm -The `elm` module shows the currently installed version of [Elm](https://elm-lang.org/). By default the module will be shown if any of the following conditions are met: +The `elm` module shows the currently installed version of [Elm](https://elm-lang.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 -- The current directory contains a `elm.json` file -- The current directory contains a `elm-package.json` file -- The current directory contains a `.elm-version` file -- The current directory contains a `elm-stuff` folder +- カレントディレクトリに`elm.json`ファイルが含まれている +- カレントディレクトリに`elm-package.json`ファイルが含まれている +- カレントディレクトリに`.elm-version`ファイルが含まれている +- カレントディレクトリに`elm-stuff`フォルダが含まれている - The current directory contains `*.elm` files ### オプション @@ -1061,7 +1113,7 @@ The `elm` module shows the currently installed version of [Elm](https://elm-lang | `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | どのファイル名がこのモジュールをアクティブにするか | | `detect_folders` | `["elm-stuff"]` | どのフォルダーがこのモジュールをアクティブにするか | | `style` | `"cyan bold"` | モジュールのスタイルです。 | -| `disabled` | `false` | Disables the `elm` module. | +| `disabled` | `false` | `elm`モジュールを無効にします。 | ### 変数 @@ -1084,10 +1136,10 @@ format = "via [ $version](cyan bold) " ## 環境変数 -The `env_var` module displays the current value of a selected environment variables. The module will be shown only if any of the following conditions are met: +The `env_var` module displays the current value of a selected environment variables. 次の条件のいずれかが満たされると、モジュールが表示されます。 -- The `variable` configuration option matches an existing environment variable -- The `variable` configuration option is not defined, but the `default` configuration option is +- `variable`オプションが、既存の環境変数と一致する +- `variable`オプションが定義されておらず、`default`オプションが定義されている ::: tip Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. @@ -1104,13 +1156,13 @@ default = "unknown user" ### オプション -| オプション | デフォルト | 説明 | -| ---------- | ------------------------------ | ---------------------------------------------------------------------------- | -| `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) "` | module のフォーマットです。 | -| `disabled` | `false` | Disables the `env_var` module. | +| オプション | デフォルト | 説明 | +| ---------- | ------------------------------ | ------------------------------------- | +| `symbol` | `""` | 環境変数を表示する前に使用される記号です。 | +| `variable` | | 表示される環境変数です。 | +| `default` | | 上のvariableが定義されていない場合に表示されるデフォルトの値です。 | +| `format` | `"with [$env_value]($style) "` | module のフォーマットです。 | +| `disabled` | `false` | `env_var`モジュールを無効にします。 | ### 変数 @@ -1146,10 +1198,10 @@ default = "unknown user" ## Erlang -The `erlang` module shows the currently installed version of [Erlang/OTP](https://erlang.org/doc/). By default the module will be shown if any of the following conditions are met: +The `erlang` module shows the currently installed version of [Erlang/OTP](https://erlang.org/doc/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 -- The current directory contains a `rebar.config` file. -- The current directory contains a `erlang.mk` file. +- カレントディレクトリに`rebar.config`ファイルが含まれている. +- カレントディレクトリに`erlang.mk`ファイルが含まれている. ### オプション @@ -1162,15 +1214,15 @@ The `erlang` module shows the currently installed version of [Erlang/OTP](https: | `detect_extensions` | `[]` | どの拡張子がこのモジュールをアクティブにするか | | `detect_files` | `["rebar.config", "elang.mk"]` | どのファイル名がこのモジュールをアクティブにするか | | `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | -| `disabled` | `false` | Disables the `erlang` module. | +| `disabled` | `false` | `erlang`モジュールを無効にします。 | ### 変数 -| 変数 | 設定例 | 説明 | -| --------- | --------- | ----------------------- | -| version | `v22.1.3` | The version of `erlang` | -| symbol | | オプション `記号` の値をミラーする | -| style\* | | オプション `style` の値をミラーする | +| 変数 | 設定例 | 説明 | +| --------- | --------- | ---------------------- | +| version | `v22.1.3` | `erlang` のバージョン | +| symbol | | オプション `記号` の値をミラーする | +| style\* | | オプション `style` の値をミラーする | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -1185,7 +1237,7 @@ format = "via [e $version](bold red) " ## 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. +`fill` モジュールは行の余分なスペースを記号で埋めます。 一行に複数の`fill`モジュールが存在する場合、それらはスペースを均等に分割します。 これは、他のモジュールの位置合わせに便利です。 ### オプション @@ -1214,30 +1266,30 @@ AA -------------------------------------------- BB ----------------------------- ## 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. +`gcloud` モジュールは、 [`gcloud`](https://cloud.google.com/sdk/gcloud) CLIの現在の設定が表示されます。 これは `~/.config/gcloud/active_config` ファイルと `~/.config/gcloud/configurations/config_{CONFIG NAME}` ファイルと `CLOUDSDK_CONFIG` 環境変数に基づきます。 ### オプション | オプション | デフォルト | 説明 | | ----------------- | ---------------------------------------------------------- | ---------------------------------------------------------------- | | `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. | +| `symbol` | `"☁️ "` | 現在のGCPプロファイルを表示する前に表示される記号です。 | +| `region_aliases` | | GCP名に加えて表示するリージョンのエイリアスです。 | | `project_aliases` | | Table of project aliases to display in addition to the GCP name. | | `style` | `"bold blue"` | モジュールのスタイルです。 | -| `disabled` | `false` | Disables the `gcloud` module. | +| `disabled` | `false` | `gcloud`モジュールを無効にします。 | ### 変数 -| 変数 | 設定例 | 説明 | -| --------- | ------------- | ------------------------------------------------------------------ | -| 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 | | オプション `記号` の値をミラーする | -| style\* | | オプション `style` の値をミラーする | +| 変数 | 設定例 | 説明 | +| --------- | ------------- | ----------------------------------------------- | +| region | `us-central1` | 現在のGCPリージョン | +| account | `foo` | 現在のGCPプロファイル | +| domain | `example.com` | The current GCP profile domain | +| project | | 現在のGCPプロジェクト | +| active | `default` | `~/.config/gcloud/active_config` に書かれたアクティブな設定名 | +| symbol | | オプション `記号` の値をミラーする | +| style\* | | オプション `style` の値をミラーする | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -1287,21 +1339,21 @@ very-long-project-name = "vlpn" ## Git Branch -The `git_branch` module shows the active branch of the repo in your current directory. +`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]($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. | +| オプション | デフォルト | 説明 | +| -------------------- | -------------------------------- | ------------------------------------------------------------------------------------ | +| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | +| `format` | `"on [$symbol$branch]($style) "` | module のフォーマットです。 Use `"$branch"` to refer to the current branch name. | +| `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`モジュールを無効にします。 | ### 変数 @@ -1329,26 +1381,26 @@ ignore_branches = ["master", "main"] ## Git コミット -The `git_commit` module shows the current commit hash and also the tag (if any) of the repo in your current directory. +`git_commit` モジュールは、カレントディレクトリのリポジトリの現在のコミットハッシュとタグ (もしあれば) を表示します。 ### オプション -| オプション | デフォルト | 説明 | -| -------------------- | ---------------------------------- | ------------------------------------------------------- | -| `commit_hash_length` | `7` | The length of the displayed git commit hash. | -| `format` | `"[\\($hash$tag\\)]($style) "` | module のフォーマットです。 | -| `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_symbol` | `" 🏷 "` | Tag symbol prefixing the info shown | -| `disabled` | `false` | Disables the `git_commit` module. | +| オプション | デフォルト | 説明 | +| -------------------- | ---------------------------------- | ----------------------------------------- | +| `commit_hash_length` | `7` | 表示されるgitコミットハッシュの長さです。 | +| `format` | `"[\\($hash$tag\\)]($style) "` | module のフォーマットです。 | +| `style` | `"bold green"` | モジュールのスタイルです。 | +| `only_detached` | `true` | detached `HEAD` 状態のときのみ git コミットハッシュを表示する | +| `tag_disabled` | `true` | `git_commit` モジュールのタグ情報の表示を無効にする。 | +| `tag_symbol` | `" 🏷 "` | 表示される情報の前に追加されるタグシンボル | +| `disabled` | `false` | `git_commit`モジュールを無効にします。 | ### 変数 -| 変数 | 設定例 | 説明 | -| --------- | --------- | --------------------------- | -| hash | `b703eb3` | The current git commit hash | -| style\* | | オプション `style` の値をミラーする | +| 変数 | 設定例 | 説明 | +| --------- | --------- | ---------------------- | +| hash | `b703eb3` | 現在の git コミットハッシュ | +| style\* | | オプション `style` の値をミラーする | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -1364,7 +1416,7 @@ tag_symbol = "🔖 " ## 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. +`git_state`モジュールはgitディレクトリの進行状態を表します。 (例: _REBASING_, _BISECTING_, その他) 進捗情報がある場合(例: REBASING 3/10)はその情報も表示されます。 ### オプション @@ -1379,7 +1431,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"` | モジュールのスタイルです。 | | `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | module のフォーマットです。 | -| `disabled` | `false` | Disables the `git_state` module. | +| `disabled` | `false` | `git_state`モジュールを無効にします。 | ### 変数 @@ -1408,7 +1460,7 @@ The `git_metrics` module will show the number of added and deleted lines in the ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで`disabled`を`false`に設定します。 ::: @@ -1445,7 +1497,7 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) ' ## Git Status -The `git_status` module shows symbols representing the state of the repo in your current directory. +`git_status`モジュールは、現在のディレクトリのリポジトリの状態を表すシンボルを表示します。 ::: tip @@ -1457,11 +1509,11 @@ 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` | `"="` | This branch has merge conflicts. | -| `ahead` | `"⇡"` | The format of `ahead` | -| `behind` | `"⇣"` | The format of `behind` | -| `diverged` | `"⇕"` | The format of `diverged` | +| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | `git_status` のデフォルトフォーマット | +| `conflicted` | `"="` | このブランチにはマージの競合があります。 | +| `ahead` | `"⇡"` | `ahead`のフォーマット | +| `behind` | `"⇣"` | `behind`のフォーマット | +| `diverged` | `"⇕"` | `diverged`のフォーマット | | `up_to_date` | `""` | The format of `up_to_date` | | `untracked` | `"?"` | The format of `untracked` | | `stashed` | `"$"` | The format of `stashed` | @@ -1471,12 +1523,12 @@ 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` | Disables the `git_status` module. | +| `disabled` | `false` | `git_status`モジュールを無効にします。 | | `windows_starship` | | Use this (Linux) path to a Windows Starship executable to render `git_status` when on Windows paths in WSL. | ### 変数 -The following variables can be used in `format`: +` format` 内では以下の変数が利用できます。 | 変数 | 説明 | | -------------- | ------------------------------------------------------------------------------------------------------------- | @@ -1502,9 +1554,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` | Show the number of files | +| 変数 | 説明 | +| ------- | ------------- | +| `count` | ファイルの数を表示します。 | ### 設定例 @@ -1547,29 +1599,29 @@ windows_starship = '/mnt/c/Users/username/scoop/apps/starship/current/starship.e ## Go -The `golang` module shows the currently installed version of [Go](https://golang.org/). By default the module will be shown if any of the following conditions are met: +The `golang` module shows the currently installed version of [Go](https://golang.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 -- The current directory contains a `go.mod` file -- The current directory contains a `go.sum` file -- The current directory contains a `glide.yaml` file -- The current directory contains a `Gopkg.yml` file -- The current directory contains a `Gopkg.lock` file -- The current directory contains a `.go-version` file -- The current directory contains a `Godeps` directory -- The current directory contains a file with the `.go` extension +- カレントディレクトリに`go.mod`ファイルが含まれている +- カレントディレクトリに`go.sum`ファイルが含まれている +- カレントディレクトリに`glide.yaml`ファイルが含まれている +- カレントディレクトリに`Gopkg.yml`ファイルが含まれている +- カレントディレクトリに`Gopkg.lock`ファイルが含まれている +- カレントディレクトリに`.go-version`ファイルが含まれている +- カレントディレクトリに`Godeps`ファイルが含まれている +- カレントディレクトリに`.go`の拡張子のファイルが含まれている ### オプション | オプション | デフォルト | 説明 | | ------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | +| `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 | | `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | | `symbol` | `"🐹 "` | A format string representing the symbol of Go. | | `detect_extensions` | `["go"]` | どの拡張子がこのモジュールをアクティブにするか | | `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | どのファイル名がこのモジュールをアクティブにするか | | `detect_folders` | `["Godeps"]` | どのフォルダーがこのモジュールをアクティブにするか | | `style` | `"bold cyan"` | モジュールのスタイルです。 | -| `disabled` | `false` | Disables the `golang` module. | +| `disabled` | `false` | `golang`モジュールを無効にします。 | ### 変数 @@ -1594,9 +1646,9 @@ format = "via [🏎💨 $version](bold cyan) " The `haskell` module finds the current selected GHC version and/or the selected Stack snapshot. -By default the module will be shown if any of the following conditions are met: +デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 -- The current directory contains a `stack.yaml` file +- カレントディレクトリに`stack.yaml`ファイルが含まれている - The current directory contains any `.hs`, `.cabal`, or `.hs-boot` file ### オプション @@ -1625,9 +1677,9 @@ By default the module will be shown if any of the following conditions are met: ## Helm -The `helm` module shows the currently installed version of [Helm](https://helm.sh/). By default the module will be shown if any of the following conditions are met: +The `helm` module shows the currently installed version of [Helm](https://helm.sh/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 -- The current directory contains a `helmfile.yaml` file +- カレントディレクトリに`helmfile.yaml`ファイルが含まれている - The current directory contains a `Chart.yaml` file ### オプション @@ -1664,23 +1716,23 @@ format = "via [⎈ $version](bold white) " ## ホスト名 -The `hostname` module shows the system hostname. +`hostname`モジュールには、システムのホスト名が表示されます。 ### オプション -| オプション | デフォルト | 説明 | -| ---------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | -| `ssh_only` | `true` | Only show hostname when connected to an SSH session. | -| `trim_at` | `"."` | String that the hostname is cut off at, after the first match. `"."` will stop after the first dot. `""` will disable any truncation | -| `format` | `"[$hostname]($style) in "` | module のフォーマットです。 | -| `style` | `"bold dimmed green"` | モジュールのスタイルです。 | -| `disabled` | `false` | Disables the `hostname` module. | +| オプション | デフォルト | 説明 | +| ---------- | --------------------------- | --------------------------------------------------------------------------- | +| `ssh_only` | `true` | SSHセッションに接続されている場合にのみホスト名を表示します。 | +| `trim_at` | `"."` | この文字が最初にマッチするまでをホスト名と認識します。 `"."`は最初の. までをホスト名として認識します。 `""`を指定した場合トリムしません。 | +| `format` | `"[$hostname]($style) in "` | module のフォーマットです。 | +| `style` | `"bold dimmed green"` | モジュールのスタイルです。 | +| `disabled` | `false` | `hostname`モジュールを無効にします。 | ### 変数 | 変数 | 設定例 | 説明 | | --------- | ---------- | ---------------------------- | -| hostname | `computer` | The hostname of the computer | +| ホスト名 | `computer` | The hostname of the computer | | style\* | | オプション `style` の値をミラーする | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -1699,7 +1751,7 @@ disabled = false ## Java -The `java` module shows the currently installed version of [Java](https://www.oracle.com/java/). By default the module will be shown if any of the following conditions are met: +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 - The current directory contains a file with the `.java`, `.class`, `.gradle`, `.jar`, `.clj`, or `.cljc` extension @@ -1715,7 +1767,7 @@ The `java` module shows the currently installed version of [Java](https://www.or | `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | | `symbol` | `"☕ "` | A format string representing the symbol of Java | | `style` | `"red dimmed"` | モジュールのスタイルです。 | -| `disabled` | `false` | Disables the `java` module. | +| `disabled` | `false` | `Java`モジュールを無効にします。 | ### 変数 @@ -1736,9 +1788,9 @@ The `java` module shows the currently installed version of [Java](https://www.or symbol = "🌟 " ``` -## Jobs +## ジョブ -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. +`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 default functionality is: @@ -1762,13 +1814,13 @@ The `threshold` option is deprecated, but if you want to use it, the module will | オプション | デフォルト | 説明 | | ------------------ | ----------------------------- | ------------------------------------------------------------------------ | -| `threshold`* | `1` | Show number of jobs if exceeded. | +| `threshold`* | `1` | 超過した場合、ジョブの数を表示します。 | | `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` | Disables the `jobs` module. | +| `disabled` | `false` | `jobs`モジュールを無効にします。 | *: This option is deprecated, please use the `number_threshold` and `symbol_threshold` options instead. @@ -1776,7 +1828,7 @@ The `threshold` option is deprecated, but if you want to use it, the module will | 変数 | 設定例 | 説明 | | --------- | --- | ---------------------- | -| number | `1` | The number of jobs | +| number | `1` | ジョブの数 | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | @@ -1795,11 +1847,11 @@ symbol_threshold = 0 ## Julia -The `julia` module shows the currently installed version of [Julia](https://julialang.org/). By default the module will be shown if any of the following conditions are met: +The `julia` module shows the currently installed version of [Julia](https://julialang.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 -- The current directory contains a `Project.toml` file -- The current directory contains a `Manifest.toml` file -- The current directory contains a file with the `.jl` extension +- カレントディレクトリに`Project.toml`ファイルが含まれている +- カレントディレクトリに`Manifest.toml`ファイルが含まれている +- カレントディレクトリに`.jl`の拡張子のファイルが含まれている ### オプション @@ -1810,15 +1862,15 @@ The `julia` module shows the currently installed version of [Julia](https://juli | `detect_extensions` | `["jl"]` | どの拡張子がこのモジュールをアクティブにするか | | `detect_files` | `["Project.toml", "Manifest.toml"]` | どのファイル名がこのモジュールをアクティブにするか | | `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | -| `symbol` | `"ஃ "` | A format string representing the symbol of Julia. | +| `symbol` | `"ஃ "` | Juliaのシンボルを表すフォーマット文字列 | | `style` | `"bold purple"` | モジュールのスタイルです。 | -| `disabled` | `false` | Disables the `julia` module. | +| `disabled` | `false` | `julia`モジュールを無効にします。 | ### 変数 | 変数 | 設定例 | 説明 | | --------- | -------- | ---------------------- | -| version | `v1.4.0` | The version of `julia` | +| version | `v1.4.0` | `julia`のバージョン | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | @@ -1835,31 +1887,31 @@ symbol = "∴ " ## Kotlin -The `kotlin` module shows the currently installed version of [Kotlin](https://kotlinlang.org/). By default the module will be shown if any of the following conditions are met: +`kotlin`モジュールは、現在インストールされている[Kotlin](https://kotlinlang.org/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 -- The current directory contains a `.kt` or a `.kts` file +- カレントディレクトリに`.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` | `"🅺 "` | 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. | +| オプション | デフォルト | 説明 | +| ------------------- | ------------------------------------ | ------------------------------------------------------ | +| `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`モジュールを無効にします。 | ### 変数 -| 変数 | 設定例 | 説明 | -| --------- | --------- | ----------------------- | -| version | `v1.4.21` | The version of `kotlin` | -| symbol | | オプション `記号` の値をミラーする | -| style\* | | オプション `style` の値をミラーする | +| 変数 | 設定例 | 説明 | +| --------- | --------- | ---------------------- | +| version | `v1.4.21` | `kotlin`のバージョン | +| symbol | | オプション `記号` の値をミラーする | +| style\* | | オプション `style` の値をミラーする | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -1876,40 +1928,40 @@ symbol = "🅺 " # ~/.config/starship.toml [kotlin] -# Uses the Kotlin Compiler binary to get the installed version +# Kotlinコンパイラバイナリを使用してバージョンを確認する 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`. If the `$KUBECONFIG` env var is set the module will use that if not it will use the `~/.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`. `$KUBECONFIG` 環境変数が設定されている場合、このモジュールは環境変数を優先して使用し、`~/.kube/config` は使用しません。 ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで`disabled`を`false`に設定します。 ::: ### オプション -| オプション | デフォルト | 説明 | -| ----------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | -| `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. | -| `disabled` | `true` | Disables the `kubernetes` module. | +| オプション | デフォルト | 説明 | +| ----------------- | ---------------------------------------------------- | ------------------------------- | +| `symbol` | `"☸ "` | クラスター名の前に表示されるシンボルを表すフォーマット文字列。 | +| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | module のフォーマットです。 | +| `style` | `"cyan bold"` | モジュールのスタイルです。 | +| `context_aliases` | | コンテキストの表示エイリアスを定義するテーブル。 | +| `disabled` | `true` | `kubernetes` モジュールを無効にする。 | ### 変数 -| 変数 | 設定例 | 説明 | -| --------- | -------------------- | ---------------------------------------- | -| 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 | | オプション `記号` の値をミラーする | -| style\* | | オプション `style` の値をミラーする | +| 変数 | 設定例 | 説明 | +| --------- | -------------------- | -------------------------------------- | +| 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 | | オプション `記号` の値をミラーする | +| style\* | | オプション `style` の値をミラーする | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -1950,13 +2002,13 @@ Long and automatically generated cluster names can be identified and shortened u ## Line Break -The `line_break` module separates the prompt into two lines. +`line_break`モジュールは、プロンプトを2行に分割します。 ### オプション -| オプション | デフォルト | 説明 | -| ---------- | ------- | ------------------------------------------------------------------ | -| `disabled` | `false` | Disables the `line_break` module, making the prompt a single line. | +| オプション | デフォルト | 説明 | +| ---------- | ------- | ------------------------------------- | +| `disabled` | `false` | `line_break`モジュールを無効にして、プロンプトを1行にします。 | ### 設定例 @@ -2002,7 +2054,7 @@ disabled = false ## Lua -The `lua` module shows the currently installed version of [Lua](http://www.lua.org/). By default the module will be shown if any of the following conditions are met: +The `lua` module shows the currently installed version of [Lua](http://www.lua.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - The current directory contains a `.lua-version` file - The current directory contains a `lua` directory @@ -2026,7 +2078,7 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o | 変数 | 設定例 | 説明 | | --------- | -------- | ---------------------- | -| version | `v5.4.0` | The version of `lua` | +| version | `v5.4.0` | `lua` のバージョン | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | @@ -2041,27 +2093,27 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o format = "via [🌕 $version](bold blue) " ``` -## Memory Usage +## メモリ使用量 -The `memory_usage` module shows current system memory and swap usage. +`memory_usage` モジュールは、現在のシステムメモリとスワップ使用量を示します。 -By default the swap usage is displayed if the total system swap is non-zero. +デフォルトでは、システムスワップの合計がゼロ以外の場合、スワップ使用量が表示されます。 ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで`disabled`を`false`に設定します。 ::: ### オプション -| オプション | デフォルト | 説明 | -| ----------- | ----------------------------------------------- | -------------------------------------------------------- | -| `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. | +| オプション | デフォルト | 説明 | +| ----------- | ----------------------------------------------- | --------------------------- | +| `threshold` | `75` | この閾値を超えない限り、メモリ使用率は表示されません。 | +| `format` | `"via $symbol [${ram}( \| ${swap})]($style) "` | module のフォーマットです。 | +| `symbol` | `"🐏"` | メモリ使用率を表示する前に使用される記号です。 | +| `style` | `"bold dimmed white"` | モジュールのスタイルです。 | +| `disabled` | `true` | `memory_usage`モジュールを無効にします。 | ### 変数 @@ -2090,7 +2142,7 @@ style = "bold dimmed green" ## Mercurial Branch -The `hg_branch` module shows the active branch of the repo in your current directory. +` hg_branch `モジュールは、現在のディレクトリにあるリポジトリのアクティブなブランチを示します。 ### オプション @@ -2100,7 +2152,7 @@ The `hg_branch` module shows the active branch of the repo in your current direc | `style` | `"bold purple"` | モジュールのスタイルです。 | | `format` | `"on [$symbol$branch]($style) "` | 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. | +| `truncation_symbol` | `"…"` | ブランチ名切り捨てられていることを示すための記号です。 | | `disabled` | `true` | Disables the `hg_branch` module. | ### 変数 @@ -2126,9 +2178,9 @@ truncation_symbol = "" ## Nim -The `nim` module shows the currently installed version of [Nim](https://nim-lang.org/). By default the module will be shown if any of the following conditions are met: +The `nim` module shows the currently installed version of [Nim](https://nim-lang.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 -- The current directory contains a `nim.cfg` file +- カレントディレクトリに`nim.cfg`ファイルが含まれている - The current directory contains a file with the `.nim` extension - The current directory contains a file with the `.nims` extension - The current directory contains a file with the `.nimble` extension @@ -2168,7 +2220,7 @@ symbol = "🎣 " ## 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. +The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html) environment. このモジュールは、nixシェル環境内にあるときに表示されます。 ### オプション @@ -2179,7 +2231,7 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/ | `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` | Disables the `nix_shell` module. | +| `disabled` | `false` | `nix_shell`モジュールを無効にします。 | ### 変数 @@ -2206,12 +2258,12 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' ## Node.js -The `nodejs` module shows the currently installed version of [Node.js](https://nodejs.org/). By default the module will be shown if any of the following conditions are met: +The `nodejs` module shows the currently installed version of [Node.js](https://nodejs.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 -- The current directory contains a `package.json` file +- カレントディレクトリに`package.json`ファイルが含まれている - The current directory contains a `.node-version` file - The current directory contains a `.nvmrc` file -- The current directory contains a `node_modules` directory +- カレントディレクトリに`node_modules`ディレクトリが含まれている - The current directory contains a file with the `.js`, `.mjs` or `.cjs` extension - The current directory contains a file with the `.ts`, `.mts` or `.cts` extension @@ -2226,7 +2278,7 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n | `detect_files` | `["package.json", ".node-version"]` | どのファイル名がこのモジュールをアクティブにするか | | `detect_folders` | `["node_modules"]` | どのフォルダーがこのモジュールをアクティブにするか | | `style` | `"bold green"` | モジュールのスタイルです。 | -| `disabled` | `false` | Disables the `nodejs` module. | +| `disabled` | `false` | `nodejs`モジュールを無効にします。 | | `not_capable_style` | `bold red` | The style for the module when an engines property in package.json does not match the Node.js version. | ### 変数 @@ -2250,7 +2302,7 @@ format = "via [🤖 $version](bold green) " ## OCaml -The `ocaml` module shows the currently installed version of [OCaml](https://ocaml.org/). By default the module will be shown if any of the following conditions are met: +The `ocaml` module shows the currently installed version of [OCaml](https://ocaml.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - The current directory contains a file with `.opam` extension or `_opam` directory - The current directory contains a `esy.lock` directory @@ -2330,9 +2382,9 @@ style = "bold yellow" symbol = "☁️ " ``` -## Package Version +## パッケージのバージョン -The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards` and `dart` packages. +`package`モジュールは、現在のディレクトリがパッケージのリポジトリである場合に表示され、現在のバージョンが表示されます。 The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards` and `dart` packages. - [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory - [**Cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory @@ -2355,14 +2407,14 @@ The `package` module is shown when the current directory is the repository for a ### オプション -| オプション | デフォルト | 説明 | -| ----------------- | --------------------------------- | ---------------------------------------------------------- | -| `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. | +| オプション | デフォルト | 説明 | +| ----------------- | --------------------------------- | --------------------------------------------------------- | +| `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`モジュールを無効にします。 | ### 変数 @@ -2385,7 +2437,7 @@ format = "via [🎁 $version](208 bold) " ## Perl -The `perl` module shows the currently installed version of [Perl](https://www.perl.org/). By default the module will be shown if any of the following conditions are met: +The `perl` module shows the currently installed version of [Perl](https://www.perl.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - The current directory contains a `Makefile.PL` or `Build.PL` file - The current directory contains a `cpanfile` or `cpanfile.snapshot` file @@ -2425,9 +2477,9 @@ format = "via [🦪 $version]($style) " ## PHP -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 `php` module shows the currently installed version of [PHP](https://www.php.net/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 -- 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 @@ -2437,12 +2489,12 @@ The `php` module shows the currently installed version of [PHP](https://www.php. | ------------------- | ------------------------------------ | ------------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 | | `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | -| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | +| `symbol` | `"🐘 "` | PHPのバージョンを表示する前に使用される記号です。 | | `detect_extensions` | `["php"]` | どの拡張子がこのモジュールをアクティブにするか | | `detect_files` | `["composer.json", ".php-version"]` | どのファイル名がこのモジュールをアクティブにするか | | `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | | `style` | `"147 bold"` | モジュールのスタイルです。 | -| `disabled` | `false` | Disables the `php` module. | +| `disabled` | `false` | `php`モジュールを無効にします。 | ### 変数 @@ -2469,11 +2521,11 @@ The `pulumi` module shows the current username, selected [Pulumi Stack](https:// ::: tip -By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, [follow the example shown below](#with-pulumi-version). +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 module will be shown if any of the following conditions are met: +デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - The current directory contains either `Pulumi.yaml` or `Pulumi.yml` - A parent directory contains either `Pulumi.yaml` or `Pulumi.yml` @@ -2494,7 +2546,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 | -| username | `alice` | The current Pulumi username | +| ユーザ名 | `alice` | The current Pulumi username | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | @@ -2522,9 +2574,9 @@ format = "[$symbol$stack]($style) " ## PureScript -The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. By default the module will be shown if any of the following conditions are met: +The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 -- The current directory contains a `spago.dhall` file +- カレントディレクトリに`spago.dhall`ファイルが含まれている - The current directory contains a file with the `.purs` extension ### オプション @@ -2563,19 +2615,19 @@ 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. -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`. +`pyenvversionname` が `true` に設定されている場合 、pyenv でのバージョン名が表示されます 。 そうでなければ、`python --version` を元にバージョン番号を表示します。 -By default the module will be shown if any of the following conditions are met: +デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 -- The current directory contains a `.python-version` file -- The current directory contains a `Pipfile` file +- カレントディレクトリに`.python-version`ファイルが含まれている +- カレントディレクトリに`Pipfile`ファイルが含まれている - The current directory contains a `__init__.py` file -- The current directory contains a `pyproject.toml` file -- The current directory contains a `requirements.txt` file -- The current directory contains a `setup.py` file -- The current directory contains a `tox.ini` file -- The current directory contains a file with the `.py` extension. -- A virtual environment is currently activated +- カレントディレクトリに`pyproject.toml`ファイルが含まれている +- カレントディレクトリに`requirements.txt`ファイルが含まれている +- カレントディレクトリに`setup.py`ファイルが含まれている +- カレントディレクトリに`tox.ini`ファイルが含まれている +- カレントディレクトリに`.py`の拡張子のファイルが含まれている. +- 仮想環境がアクティブである ### オプション @@ -2585,13 +2637,13 @@ By default the module will be shown if any of the following conditions are met: | `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | | `symbol` | `"🐍 "` | A format string representing the symbol of Python | | `style` | `"yellow bold"` | モジュールのスタイルです。 | -| `pyenv_version_name` | `false` | Use pyenv to get Python version | +| `pyenv_version_name` | `false` | pyenvを使用してPythonバージョンを取得します | | `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` | Disables the `python` module. | +| `detect_extensions` | `["py"]` | どの拡張子がこのモジュールをアクティブにするか | +| `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | どのファイル名がこのモジュールをアクティブにするか | +| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | +| `disabled` | `false` | `python`モジュールを無効にします。 | ::: tip @@ -2668,9 +2720,9 @@ The `rlang` module shows the currently installed version of [R](https://www.r-pr | `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | | `symbol` | `"📐"` | A format string representing the symbol of R. | | `style` | `"blue bold"` | モジュールのスタイルです。 | -| `detect_extensions` | `["R", "Rd", "Rmd", "Rproj", "Rsx"]` | Which extensions should trigger this module | -| `detect_files` | `[".Rprofile"]` | Which filenames should trigger this module | -| `detect_folders` | `[".Rproj.user"]` | Which folders should trigger this module | +| `detect_extensions` | `["R", "Rd", "Rmd", "Rproj", "Rsx"]` | どの拡張子がこのモジュールをアクティブにするか | +| `detect_files` | `[".Rprofile"]` | どのファイル名がこのモジュールをアクティブにするか | +| `detect_folders` | `[".Rproj.user"]` | どのフォルダーがこのモジュールをアクティブにするか | | `disabled` | `false` | Disables the `r` module. | ### 変数 @@ -2730,11 +2782,11 @@ symbol = "🔴 " ## Ruby -By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). 次の条件のいずれかが満たされると、モジュールが表示されます: +デフォルトでは`ruby`モジュールは現在インストールされている[Ruby](https://www.ruby-lang.org/)のバージョンを表示します。 次の条件のいずれかが満たされると、モジュールが表示されます: -- The current directory contains a `Gemfile` file -- The current directory contains a `.ruby-version` file -- The current directory contains a `.rb` file +- カレントディレクトリに`Gemfile`ファイルが含まれている +- カレントディレクトリに `.ruby-version` ファイルが含まれている +- カレントディレクトリに`.rb`の拡張子のファイルが含まれている - The environment variables `RUBY_VERSION` or `RBENV_VERSION` are set Starship gets the current Ruby version by running `ruby -v`. @@ -2743,15 +2795,15 @@ Starship gets the current Ruby version by running `ruby -v`. | オプション | デフォルト | 説明 | | ------------------- | ------------------------------------ | ------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | +| `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 | | `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | -| `symbol` | `"💎 "` | A format string representing the symbol of Ruby. | +| `symbol` | `"💎 "` | 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` | Disables the `ruby` module. | +| `disabled` | `false` | `ruby`モジュールを無効にします。 | ### 変数 @@ -2774,10 +2826,10 @@ symbol = "🔺 " ## Rust -By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). 次の条件のいずれかが満たされると、モジュールが表示されます: +デフォルトでは`rust`モジュールは現在インストールされている[Rust](https://www.rust-lang.org/)のバージョンを表示します。 次の条件のいずれかが満たされると、モジュールが表示されます: -- The current directory contains a `Cargo.toml` file -- The current directory contains a file with the `.rs` extension +- カレントディレクトリに`Cargo.toml`ファイルが含まれている +- カレントディレクトリに`.rs`の拡張子のファイルが含まれている ### オプション @@ -2785,18 +2837,18 @@ By default the `rust` module shows the currently installed version of [Rust](htt | ------------------- | ------------------------------------ | ------------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 | | `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | -| `symbol` | `"🦀 "` | A format string representing the symbol of Rust | +| `symbol` | `"🦀 "` | Rustのシンボルを表すフォーマット文字列 | | `detect_extensions` | `["rs"]` | どの拡張子がこのモジュールをアクティブにするか | | `detect_files` | `["Cargo.toml"]` | どのファイル名がこのモジュールをアクティブにするか | | `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | | `style` | `"bold red"` | モジュールのスタイルです。 | -| `disabled` | `false` | Disables the `rust` module. | +| `disabled` | `false` | `rust`モジュールを無効にします。 | ### 変数 | 変数 | 設定例 | 説明 | | --------- | ----------------- | ---------------------- | -| version | `v1.43.0-nightly` | The version of `rustc` | +| version | `v1.43.0-nightly` | `rustc`のバージョン | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | @@ -2813,7 +2865,7 @@ format = "via [⚙️ $version](red bold)" ## Scala -The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). By default the module will be shown if any of the following conditions are met: +The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - The current directory contains a `build.sbt`, `.scalaenv` or `.sbtenv` file - The current directory contains a file with the `.scala` or `.sbt` extension @@ -2857,7 +2909,7 @@ The `shell` module shows an indicator for currently used shell. ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで`disabled`を`false`に設定します。 ::: @@ -2885,7 +2937,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | 変数 | デフォルト | 説明 | | --------- | ----- | ---------------------------------------------------------- | | indicator | | Mirrors the value of `indicator` for currently used shell. | -| style\* | | Mirrors the value of option `style`. | +| style\* | | オプション `style` の値をミラーする. | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -2970,13 +3022,46 @@ The `singularity` module shows the current [Singularity](https://sylabs.io/singu format = '[📦 \[$env\]]($style) ' ``` +## Spack + +The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set. + +### オプション + +| オプション | デフォルト | 説明 | +| ------------------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | +| `truncation_length` | `1` | The number of directories the environment path should be truncated to. `0`は切り捨てがないことを意味します。 [`directory`](#directory)もご覧ください。 | +| `symbol` | `"🅢 "` | 環境名の直前に使用されるシンボルです。 | +| `style` | `"bold blue"` | モジュールのスタイルです。 | +| `format` | `"via [$symbol$environment]($style) "` | module のフォーマットです。 | +| `disabled` | `false` | Disables the `spack` module. | + +### 変数 + +| 変数 | 設定例 | 説明 | +| ----------- | ------------ | ----------------------------- | +| environment | `astronauts` | The current spack environment | +| symbol | | オプション `記号` の値をミラーする | +| style\* | | オプション `style` の値をミラーする | + +*: この変数は、スタイル文字列の一部としてのみ使用することができます。 + +### 設定例 + +```toml +# ~/.config/starship.toml + +[spack] +format = "[$symbol$environment](dimmed blue) " +``` + ## Status 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 -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで`disabled`を`false`に設定します。 ::: @@ -3036,7 +3121,7 @@ The `sudo` module displays if sudo credentials are currently cached. The module ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで`disabled`を`false`に設定します。 ::: @@ -3120,18 +3205,18 @@ format = "via [🏎 $version](red bold)" ## Terraform -The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. +`terraform` モジュールは、現在選択されている[Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) とバージョンを表示します。 ::: tip -By default the Terraform version is not shown, since this is slow for current versions of Terraform when a lot of plugins are in use. If you still want to enable it, [follow the example shown below](#with-terraform-version). +Terraformのバージョンはデフォルトでは表示されません。多くのプラグインが使用されている場合、現在のTerraformのバージョンでは遅くなるからです。 それでも有効にしたい場合は、 [以下の例に従ってください](#with-terraform-version). ::: -By default the module will be shown if any of the following conditions are met: +デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 -- The current directory contains a `.terraform` folder -- Current directory contains a file with the `.tf`, `.tfplan` or `.tfstate` extensions +- カレントディレクトリに`.terraform`フォルダが含まれている +- 現在のディレクトリに `.tf`, `.tfplan` または `.tfstate` のいずれかの拡張子を持つファイルがある。 ### オプション @@ -3139,21 +3224,21 @@ By default the module will be shown if any of the following conditions are met: | ------------------- | ------------------------------------ | ------------------------------------------------------ | | `format` | `"via [$symbol$workspace]($style) "` | モジュールのフォーマット文字列。 | | `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | -| `symbol` | `"💠"` | A format string shown before the terraform workspace. | +| `symbol` | `"💠"` | ワークスペースの前に表示されるフォーマット文字列。 | | `detect_extensions` | `["tf", "tfplan", "tfstate"]` | どの拡張子がこのモジュールをアクティブにするか | | `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか | | `detect_folders` | `[".terraform"]` | どのフォルダーがこのモジュールをアクティブにするか | | `style` | `"bold 105"` | モジュールのスタイルです。 | -| `disabled` | `false` | Disables the `terraform` module. | +| `disabled` | `false` | `terraform`モジュールを無効にします。 | ### 変数 -| 変数 | 設定例 | 説明 | -| --------- | ---------- | ------------------------------- | -| version | `v0.12.24` | The version of `terraform` | -| workspace | `default` | The current Terraform workspace | -| symbol | | オプション `記号` の値をミラーする | -| style\* | | オプション `style` の値をミラーする | +| 変数 | 設定例 | 説明 | +| --------- | ---------- | ---------------------- | +| version | `v0.12.24` | `terraform` のバージョン | +| workspace | `default` | 現在のTerraformワークスペース | +| symbol | | オプション `記号` の値をミラーする | +| style\* | | オプション `style` の値をミラーする | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -3179,33 +3264,33 @@ format = "[🏎💨 $workspace]($style) " ## 時刻 -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. +`time`モジュールは、現在の**現地**時間を示します。 `format`設定は、時間の表示方法を制御するために[`chrono`](https://crates.io/crates/chrono)クレートによって使用されます。 使用可能なオプションを確認するには、[chrono strftimeのドキュメント](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html)をご覧ください。 ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで`disabled`を`false`に設定します。 ::: ### オプション -| オプション | デフォルト | 説明 | -| ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `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 | +| オプション | デフォルト | 説明 | +| ----------------- | ----------------------- | ----------------------------------------------------------------------------------------------------- | +| `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 | -If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Otherwise, it defaults to `"%T"`. Manually setting `time_format` will override the `use_12hr` setting. +If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. それ以外の場合、デフォルトは`"%T"`です。 Manually setting `time_format` will override the `use_12hr` setting. ### 変数 | 変数 | 設定例 | 説明 | | --------- | ---------- | ---------------------- | -| time | `13:08:10` | The current time. | +| 時刻 | `13:08:10` | The current time. | | style\* | | オプション `style` の値をミラーする | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -3223,14 +3308,14 @@ utc_time_offset = "-5" time_range = "10:00:00-14:00:00" ``` -## Username +## ユーザー名 -The `username` module shows active user's username. 次の条件のいずれかが満たされると、モジュールが表示されます: +`username`モジュールには、アクティブなユーザーのユーザー名が表示されます。 次の条件のいずれかが満たされると、モジュールが表示されます: -- The current user is root -- The current user isn't the same as the one that is logged in -- The user is currently connected as an SSH session -- The variable `show_always` is set to true +- The current user is root/admin +- カレントユーザーが、ログインしているユーザーとは異なる +- ユーザーがSSHセッションとして接続されている +- `show_always`変数がtrueに設定されている ::: tip @@ -3240,13 +3325,13 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, ` ### オプション -| オプション | デフォルト | 説明 | -| ------------- | ----------------------- | ------------------------------------- | -| `style_root` | `"bold red"` | The style used when the user is root. | -| `style_user` | `"bold yellow"` | The style used for non-root users. | -| `format` | `"[$user]($style) in "` | module のフォーマットです。 | -| `show_always` | `false` | Always shows the `username` module. | -| `disabled` | `false` | Disables the `username` module. | +| オプション | デフォルト | 説明 | +| ------------- | ----------------------- | ------------------------------------------- | +| `style_root` | `"bold red"` | The style used when the user is root/admin. | +| `style_user` | `"bold yellow"` | 非rootユーザーに使用されるスタイルです。 | +| `format` | `"[$user]($style) in "` | module のフォーマットです。 | +| `show_always` | `false` | `username`モジュールを常に表示します。 | +| `disabled` | `false` | `username`モジュールを無効にします。 | ### 変数 @@ -3270,7 +3355,7 @@ show_always = true ## Vagrant -The `vagrant` module shows the currently installed version of [Vagrant](https://www.vagrantup.com/). By default the module will be shown if any of the following conditions are met: +The `vagrant` module shows the currently installed version of [Vagrant](https://www.vagrantup.com/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - The current directory contains a `Vagrantfile` file @@ -3308,7 +3393,7 @@ format = "via [⍱ $version](bold white) " ## V -The `vlang` module shows you your currently installed version of [V](https://vlang.io/). By default the module will be shown if any of the following conditions are met: +The `vlang` module shows you your currently installed version of [V](https://vlang.io/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 - The current directory contains a file with `.v` extension - The current directory contains a `v.mod`, `vpkg.json` or `.vpkg-lock.json` file @@ -3418,9 +3503,9 @@ The `custom` modules show the output of some arbitrary commands. These modules will be shown if any of the following conditions are met: -- The current directory contains a file whose name is in `files` -- The current directory contains a directory whose name is in `directories` -- The current directory contains a file whose extension is in `extensions` +- The current directory contains a file whose name is in `detect_files` +- The current directory contains a directory whose name is in `detect_folders` +- The current directory contains a file whose extension is in `detect_extensions` - The `when` command returns 0 - The current Operating System (std::env::consts::OS) matchs with `os` field if defined. @@ -3452,20 +3537,22 @@ 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` | | A shell command used as a condition to show the module. 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`. | -| `files` | `[]` | The files that will be searched in the working directory for a match. | -| `directories` | `[]` | The directories that will be searched in the working directory for a match. | -| `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"` | モジュールのスタイルです。 | -| `format` | `"[$symbol($output )]($style)"` | module のフォーマットです。 | -| `disabled` | `false` | Disables this `custom` module. | -| `os` | | Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) [See possible values](https://doc.rust-lang.org/std/env/consts/constant.OS.html). | +| オプション | デフォルト | 説明 | +| ------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `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`. | +| `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"` | モジュールのスタイルです。 | +| `format` | `"[$symbol($output )]($style)"` | module のフォーマットです。 | +| `disabled` | `false` | Disables this `custom` module. | +| `os` | | Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) [See possible values](https://doc.rust-lang.org/std/env/consts/constant.OS.html). | +| `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. | ### 変数 @@ -3488,7 +3575,7 @@ If unset, it will fallback to STARSHIP_SHELL and then to "sh" on Linux, and "cmd The `command` will be passed in on stdin. -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 -`. This behavior can be avoided by explicitly passing arguments to the shell, e.g. +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", "-"] @@ -3513,12 +3600,18 @@ Automatic detection of shells and proper parameters addition are currently imple [custom.foo] command = "echo foo" # shows output of command -files = ["foo"] # can specify filters but wildcards are not supported +detect_files = ["foo"] # can specify filters but wildcards are not supported when = """ test "$HOME" == "$PWD" """ format = " transcending [$output]($style)" [custom.time] command = "time /T" -extensions = ["pst"] # filters *.pst files +detect_extensions = ["pst"] # filters *.pst files shell = ["pwsh.exe", "-NoProfile", "-Command", "-"] + +[custom.time-as-arg] +command = "time /T" +detect_extensions = ["pst"] # filters *.pst files +shell = ["pwsh.exe", "-NoProfile", "-Command"] +use_stdin = false ``` diff --git a/docs/ja-JP/faq/README.md b/docs/ja-JP/faq/README.md index 85e5b1fe..caeff15c 100644 --- a/docs/ja-JP/faq/README.md +++ b/docs/ja-JP/faq/README.md @@ -12,7 +12,7 @@ ## デモのGIFのようにコマンド補完はどうしたら使用できますか？ -補完サポート、または自動補完は選択したシェルによって提供されます。 デモ中では、デフォルトの[Fish Shell](https://fishshell.com/)によって補完されています。 Z Shell (zsh) を利用しているのであれば、[zsh-autosuggestions](https://github.com/zsh-users/zsh-autosuggestions)を照参してください。 +補完サポート、または自動補完は選択したシェルによって提供されます。 デモ中では、デフォルトの[Fish Shell](https://fishshell.com/)によって補完されています。 Z Shell (zsh) を利用しているのであれば、[zsh-autosuggestions](https://github.com/zsh-users/zsh-autosuggestions)を参照してください。 ## トップレベルの`format`と`.disabled`は同じように動作しますか？ diff --git a/docs/ja-JP/guide/README.md b/docs/ja-JP/guide/README.md index ab804eff..47ce28b3 100644 --- a/docs/ja-JP/guide/README.md +++ b/docs/ja-JP/guide/README.md @@ -160,7 +160,7 @@ - **簡単:** 迅速なインストールが可能であり、数分で使用開始可能です。

-Explore the Starship docs  ▶ +Starshipのドキュメントを見る  ▶

@@ -173,12 +173,12 @@ ### Step 1. Install Starship -Select your operating system from the list below to view installation instructions: +以下のリストからお使いのOSを選択し、インストール方法をご確認ください。
Android -Install Starship using any of the following package managers: +以下のいずれかのパッケージマネージャーを使用して、Starshipをインストールします。 | Repository | Instructions | | --------------------------------------------------------------------------------- | ---------------------- | @@ -189,7 +189,7 @@ Install Starship using any of the following package managers:
BSD -Install Starship using any of the following package managers: +以下のいずれかのパッケージマネージャーを使用して、Starshipをインストールします。 | Distribution | Repository | Instructions | | ------------ | -------------------------------------------------------- | --------------------------------- | @@ -202,13 +202,13 @@ Install Starship using any of the following package managers:
Linux -Install the latest version for your system: +お使いのシステムに合わせた最新版をインストールしてください。 ```sh curl -sS https://starship.rs/install.sh | sh ``` -Alternatively, install Starship using any of the following package managers: +または、以下のパッケージマネージャを使用して、Starshipをインストールします。 | Distribution | Repository | Instructions | | ------------------ | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | @@ -231,13 +231,13 @@ Alternatively, install Starship using any of the following package managers:
macOS -Install the latest version for your system: +お使いのシステムに合わせた最新版をインストールしてください。 ```sh curl -sS https://starship.rs/install.sh | sh ``` -Alternatively, install Starship using any of the following package managers: +または、以下のパッケージマネージャを使用して、Starshipをインストールします。 | Repository | Instructions | | -------------------------------------------------------- | --------------------------------------- | @@ -251,7 +251,7 @@ Alternatively, install Starship using any of the following package managers:
Windows -Install Starship using any of the following package managers: +以下のいずれかのパッケージマネージャーを使用して、Starshipをインストールします。 | Repository | Instructions | | -------------------------------------------------------------------------------- | --------------------------------------- | @@ -264,7 +264,7 @@ Install Starship using any of the following package managers: ### Step 2. Setup your shell to use Starship -Configure your shell to initialize starship. Select yours from the list below: +Starshipを初期化するためのシェルの設定。 以下のリストからお使いのシェルを選択してください。
Bash @@ -280,7 +280,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: +[Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) コマンドを使用する必要があります。 このパス`%LocalAppData%\clink\starship.lua` に以下の内容を含むファイルを作成する。 ```lua load(io.popen('starship init cmd'):read("*a"))() @@ -297,7 +297,7 @@ load(io.popen('starship init cmd'):read("*a"))() eval (starship init elvish) ``` -Note: Only Elvish v0.17+ is supported +Note: Only Elvish v0.18+ is supported
@@ -333,7 +333,7 @@ mkdir ~/.cache/starship starship init nu | save ~/.cache/starship/init.nu ``` -And add the following to the end of your Nushell configuration (find it by running `$nu.config-path`): +そして、Nushellの設定ファイルの最後に以下を追加してください（ `$nu.config-path` を実行してください）。 ```sh starship init nu | save ~/.cache/starship/init.nu @@ -390,9 +390,9 @@ eval "$(starship init zsh)" ### Step 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! +新しいシェルインスタンスを起動すると、美しくて新しいシェルプロンプトが表示されるはずです。 デフォルトで問題なければ、お楽しみください！ -If you're looking to further customize Starship: +Starshipのさらなるカスタマイズを目指すなら以下を参考にしてみてください。 - **[Configuration](https://starship.rs/config/)** – learn how to configure Starship to tweak your prompt to your liking @@ -400,15 +400,15 @@ If you're looking to further customize Starship: ## 🤝 貢献 -We are always looking for contributors of **all skill levels**! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). +私たちは常に**すべてのスキルレベル**の貢献者を探しています！ もし簡単にプロジェクトへ参加する方法をお探しなら、 [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue) に取り組んでみてください。 -If you are fluent in a non-English language, we greatly appreciate any help keeping our docs translated and up-to-date in other languages. If you would like to help, translations can be contributed on the [Starship Crowdin](https://translate.starship.rs/). +あなたが英語以外の言語に堪能な場合、ドキュメントの翻訳と更新に協力していただけると嬉しいです。 協力してくれる場合、翻訳は [Starship Crowdin](https://translate.starship.rs/) から貢献できます。 -If you are interested in helping contribute to starship, please take a look at our [Contributing Guide](https://github.com/starship/starship/blob/master/CONTRIBUTING.md). Also, feel free to drop into our [Discord server](https://discord.gg/8Jzqu3T) and say hi. 👋 +もしあなたが Starship への貢献に興味がある場合は、我々の[貢献ガイド](https://github.com/starship/starship/blob/master/CONTRIBUTING.md)をご覧ください。 また、気軽に我々の[Discord サーバー](https://discord.gg/8Jzqu3T)へ顔を出してください。 👋 ## 💭影響を受けたプロダクト -Please check out these previous works that helped inspire the creation of starship. 🙏 +よければStarship の作成に影響を与えた、これまでのプロジェクトをチェックしてください 🙏 - **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** – A ZSH prompt for astronauts. @@ -423,4 +423,4 @@ Please check out these previous works that helped inspire the creation of starsh ## 📝 ライセンス -Copyright © 2019-present, [Starship Contributors](https://github.com/starship/starship/graphs/contributors).
This project is [ISC](https://github.com/starship/starship/blob/master/LICENSE) licensed. +Copyright © 2019-present, [Starship Contributors](https://github.com/starship/starship/graphs/contributors).
このプロジェクトは [ISC](https://github.com/starship/starship/blob/master/LICENSE) でライセンスされています。 diff --git a/docs/ja-JP/installing/README.md b/docs/ja-JP/installing/README.md index a2d76732..fee76b44 100644 --- a/docs/ja-JP/installing/README.md +++ b/docs/ja-JP/installing/README.md @@ -1,4 +1,4 @@ -# Advanced Installation +# 高度なインストール Starship をインストールするには、以下の2つのことを行う必要があります。 diff --git a/docs/ja-JP/presets/README.md b/docs/ja-JP/presets/README.md index f7738d28..72a474ef 100644 --- a/docs/ja-JP/presets/README.md +++ b/docs/ja-JP/presets/README.md @@ -1,4 +1,4 @@ -# 準備するもの +# プリセット 以下は、Starship用にコミュニティに提供された構成プリセットのコレクションです。 共有するプリセットがある場合は、このファイルを更新して[PR](https://github.com/starship/starship/edit/master/docs/presets/README.md)を送信してください！ 😊 diff --git a/docs/ko-KR/README.md b/docs/ko-KR/README.md index e5e04844..94c69835 100644 --- a/docs/ko-KR/README.md +++ b/docs/ko-KR/README.md @@ -120,7 +120,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p #### Elvish - ::: warning elvish v0.17 이상만 지원. ::: + ::: warning elvish v0.18 이상만 지원. ::: `~/.elvish/rc.elv` 의 끝부분에 아래 라인을 추가: @@ -171,7 +171,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p #### Cmd - Cmd를 이용하려면 [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) 를 사용해야 합니다. Add the following to a file `starship.lua` and place this file in Clink scripts directory: + Cmd를 이용하려면 [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) 를 사용해야 합니다. `starship.lua` 파일에 아래의 라인을 추가하고 파일을 Clink scripts 폴더에 저장합니다. ```lua -- starship.lua diff --git a/docs/ko-KR/advanced-config/README.md b/docs/ko-KR/advanced-config/README.md index ff39cf7c..f9981e38 100644 --- a/docs/ko-KR/advanced-config/README.md +++ b/docs/ko-KR/advanced-config/README.md @@ -131,7 +131,7 @@ Invoke-Expression (&starship init powershell) Some shells support a right prompt which renders on the same line as the input. Starship can set the content of the right prompt using the `right_format` option. Any module that can be used in `format` is also supported in `right_format`. The `$all` variable will only contain modules not explicitly used in either `format` or `right_format`. -Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [fill module](/config/#fill). +Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [`fill` module](/config/#fill). `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd. diff --git a/docs/ko-KR/config/README.md b/docs/ko-KR/config/README.md index db6eac3f..cefbec26 100644 --- a/docs/ko-KR/config/README.md +++ b/docs/ko-KR/config/README.md @@ -9,6 +9,9 @@ mkdir -p ~/.config && touch ~/.config/starship.toml All configuration for starship is done in this [TOML](https://github.com/toml-lang/toml) file: ```toml +# Get editor completions based on the config schema +"$schema" = 'https://starship.rs/config-schema.json' + # Inserts a blank line between shell prompts add_newline = true @@ -199,6 +202,7 @@ $hg_branch\ $docker_context\ $package\ $buf\ +$c\ $cmake\ $cobol\ $container\ @@ -235,6 +239,7 @@ $vagrant\ $zig\ $nix_shell\ $conda\ +$spack\ $memory_usage\ $aws\ $gcloud\ @@ -263,9 +268,9 @@ format = "$all$directory$character" ## AWS -The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file. This module also shows an expiration timer when using temporary credentials. +The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. Alternatively, you can force this module to show the region and profile even when the credentials have not been setup with the `force_display` option. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file. This module also shows an expiration timer when using temporary credentials. -The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. +The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if the conditions above are not respected. When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var. @@ -275,15 +280,16 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------- | -| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | The format for the module. | -| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. | -| `region_aliases` | | Table of region aliases to display in addition to the AWS name. | -| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | -| `style` | `"bold yellow"` | The style for the module. | -| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. | -| `disabled` | `false` | Disables the `AWS` module. | +| Option | Default | Description | +| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | +| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | The format for the module. | +| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. | +| `region_aliases` | | Table of region aliases to display in addition to the AWS name. | +| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | +| `style` | `"bold yellow"` | The style for the module. | +| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. | +| `disabled` | `false` | Disables the `AWS` module. | +| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. | ### Variables @@ -472,6 +478,52 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil symbol = "🦬 " ``` +## C + +The `c` module shows some information about your C compiler. By default the module will be shown if the current directory contains a `.c` or `.h` file. + +### Options + +| Option | Default | Description | +| ------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version(-$name) )]($style)"` | The format string for the module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"C "` | The symbol used before displaying the compiler details | +| `detect_extensions` | `["c", "h"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `commands` | [ [ "cc", "--version" ], [ "gcc", "--version" ], [ "clang", "--version" ] ] | How to detect what the compiler is | +| `style` | `"bold 149"` | The style for the module. | +| `disabled` | `false` | Disables the `c` module. | + +### Variables + +| Variable | Example | Description | +| -------- | ------- | ------------------------------------ | +| name | clang | The name of the compiler | +| version | 13.0.0 | The version of the compiler | +| symbol | | Mirrors the value of option `symbol` | +| style | | Mirrors the value of option `style` | + +NB that `version` is not in the default format. + +### Commands + +The `commands` option accepts a list of commands to determine the compiler version and name. + +Each command is represented as a list of the executable name, followed by its arguments, usually something like `["mycc", "--version"]`. Starship will try executing each command until it gets a result on STDOUT. + +If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). + +### Example + +```toml +# ~/.config/starship.toml + +[c] +format = "via [$name $version]($style)" +``` + ## Character The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. @@ -962,7 +1014,7 @@ You'll also need the .NET Core SDK installed in order to use it correctly. Internally, this module uses its own mechanism for version detection. Typically it is twice as fast as running `dotnet --version`, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting `heuristic = false` in the module options. -The module will also show the Target Framework Moniker () when there is a csproj file in the current directory. +The module will also show the Target Framework Moniker () when there is a `.csproj` file in the current directory. ### Options @@ -2969,6 +3021,39 @@ The `singularity` module shows the current [Singularity](https://sylabs.io/singu format = '[📦 \[$env\]]($style) ' ``` +## Spack + +The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set. + +### Options + +| Option | Default | Description | +| ------------------- | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | +| `truncation_length` | `1` | The number of directories the environment path should be truncated to. `0` means no truncation. Also see the [`directory`](#directory) module. | +| `symbol` | `"🅢 "` | The symbol used before the environment name. | +| `style` | `"bold blue"` | The style for the module. | +| `format` | `"via [$symbol$environment]($style) "` | The format for the module. | +| `disabled` | `false` | Disables the `spack` module. | + +### Variables + +| Variable | Example | Description | +| ----------- | ------------ | ------------------------------------ | +| environment | `astronauts` | The current spack environment | +| 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 + +[spack] +format = "[$symbol$environment](dimmed blue) " +``` + ## Status 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. @@ -3226,7 +3311,7 @@ time_range = "10:00:00-14:00:00" 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 +- The current user is root/admin - The current user isn't the same as the one that is logged in - The user is currently connected as an SSH session - The variable `show_always` is set to true @@ -3239,13 +3324,13 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, ` ### Options -| Option | Default | Description | -| ------------- | ----------------------- | ------------------------------------- | -| `style_root` | `"bold red"` | The style used when the user is root. | -| `style_user` | `"bold yellow"` | The style used for non-root users. | -| `format` | `"[$user]($style) in "` | The format for the module. | -| `show_always` | `false` | Always shows the `username` module. | -| `disabled` | `false` | Disables the `username` module. | +| Option | Default | 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 "` | The format for the module. | +| `show_always` | `false` | Always shows the `username` module. | +| `disabled` | `false` | Disables the `username` module. | ### Variables @@ -3417,9 +3502,9 @@ The `custom` modules show the output of some arbitrary commands. These modules will be shown if any of the following conditions are met: -- The current directory contains a file whose name is in `files` -- The current directory contains a directory whose name is in `directories` -- The current directory contains a file whose extension is in `extensions` +- The current directory contains a file whose name is in `detect_files` +- The current directory contains a directory whose name is in `detect_folders` +- The current directory contains a file whose extension is in `detect_extensions` - The `when` command returns 0 - The current Operating System (std::env::consts::OS) matchs with `os` field if defined. @@ -3451,20 +3536,22 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt ### Options -| Option | Default | Description | -| ------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `command` | `""` | The command whose output should be printed. The command will be passed on stdin to the shell. | -| `when` | | A shell command used as a condition to show the module. 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`. | -| `files` | `[]` | The files that will be searched in the working directory for a match. | -| `directories` | `[]` | The directories that will be searched in the working directory for a match. | -| `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"` | The style for the module. | -| `format` | `"[$symbol($output )]($style)"` | The format for the module. | -| `disabled` | `false` | Disables this `custom` module. | -| `os` | | Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) [See possible values](https://doc.rust-lang.org/std/env/consts/constant.OS.html). | +| Option | Default | Description | +| ------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `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"` | The style for the module. | +| `format` | `"[$symbol($output )]($style)"` | The format for the module. | +| `disabled` | `false` | Disables this `custom` module. | +| `os` | | Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) [See possible values](https://doc.rust-lang.org/std/env/consts/constant.OS.html). | +| `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 @@ -3487,7 +3574,7 @@ If unset, it will fallback to STARSHIP_SHELL and then to "sh" on Linux, and "cmd The `command` will be passed in on stdin. -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 -`. This behavior can be avoided by explicitly passing arguments to the shell, e.g. +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", "-"] @@ -3512,12 +3599,18 @@ Automatic detection of shells and proper parameters addition are currently imple [custom.foo] command = "echo foo" # shows output of command -files = ["foo"] # can specify filters but wildcards are not supported +detect_files = ["foo"] # can specify filters but wildcards are not supported when = """ test "$HOME" == "$PWD" """ format = " transcending [$output]($style)" [custom.time] command = "time /T" -extensions = ["pst"] # filters *.pst files +detect_extensions = ["pst"] # filters *.pst files shell = ["pwsh.exe", "-NoProfile", "-Command", "-"] + +[custom.time-as-arg] +command = "time /T" +detect_extensions = ["pst"] # filters *.pst files +shell = ["pwsh.exe", "-NoProfile", "-Command"] +use_stdin = false ``` diff --git a/docs/ko-KR/guide/README.md b/docs/ko-KR/guide/README.md index 2305c58e..fec6c1c2 100644 --- a/docs/ko-KR/guide/README.md +++ b/docs/ko-KR/guide/README.md @@ -160,7 +160,7 @@ - **Easy:** 빠른 설치 - 몇 분 안에 사용할 수 있습니다.

-Explore the Starship docs  ▶ +Starship 문서 보기  ▶

@@ -173,12 +173,12 @@ ### 1단계. Starship 설치하기 -Select your operating system from the list below to view installation instructions: +아래의 목록 중 해당하는 운영체제를 골라 설치 지침을 확인하세요:
Android -Install Starship using any of the following package managers: +다음 패키지 관리자 중 하나를 사용해 Starship 을 설치하세요: | Repository | Instructions | | --------------------------------------------------------------------------------- | ---------------------- | @@ -189,7 +189,7 @@ Install Starship using any of the following package managers:
BSD -Install Starship using any of the following package managers: +다음 패키지 관리자 중 하나를 사용해 Starship 을 설치하세요: | Distribution | Repository | Instructions | | ------------ | -------------------------------------------------------- | --------------------------------- | @@ -251,7 +251,7 @@ Alternatively, install Starship using any of the following package managers:
Windows -Install Starship using any of the following package managers: +다음 패키지 관리자 중 하나를 사용해 Starship 을 설치하세요: | Repository | Instructions | | -------------------------------------------------------------------------------- | --------------------------------------- | @@ -264,7 +264,7 @@ Install Starship using any of the following package managers: ### 2단계. 쉘에 Starship 적용하기 -Configure your shell to initialize starship. Select yours from the list below: +쉘에 Starship 초기 설정을 합니다. 아래의 리스트 중에 해당하는 것을 고르세요:
Bash @@ -297,7 +297,7 @@ load(io.popen('starship init cmd'):read("*a"))() eval (starship init elvish) ``` -Note: Only Elvish v0.17+ is supported +Note: Only Elvish v0.18+ is supported
@@ -347,7 +347,7 @@ Note: Only Nushell v0.60+ is supported
파워셀 -Add the following to the end of your PowerShell configuration (find it by running `$PROFILE`): +다음 내용을 PowerShell 설정파일 (찾으려면 `$PROFILE` 실행) 마지막 부분에 추가하세요: ```powershell Invoke-Expression (&starship init powershell) @@ -390,9 +390,9 @@ eval "$(starship init zsh)" ### 3단계. Starship 설정하기 -Start a new shell instance, and you should see your beautiful new shell prompt. If you're happy with the defaults, enjoy! +새로운 쉘 인스턴스를 시작하면 아름다운 새 쉘 프롬프트를 볼 수 있습니다. 기본 설정에 만족한다면, 즐기세요! -If you're looking to further customize Starship: +Starship을 추가로 커스터마이징 하고싶다면: - **[Configuration](https://starship.rs/config/)** – 원하는대로 프롬프트를 수정할 수 있도록 Starship 설정을 배울 수 있습니다. @@ -400,15 +400,15 @@ If you're looking to further customize Starship: ## 🤝 기여하기 -We are always looking for contributors of **all skill levels**! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). +우리는 언제나 **기술 수준에 관계없이** 기여자를 찾고 있습니다! 프로젝트에 참여하고자 한다면, [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue) 를 보내보세요. -If you are fluent in a non-English language, we greatly appreciate any help keeping our docs translated and up-to-date in other languages. If you would like to help, translations can be contributed on the [Starship Crowdin](https://translate.starship.rs/). +If you are fluent in a non-English language, we greatly appreciate any help keeping our docs translated and up-to-date in other languages. 번역에 도움을 주고자 한다면, [Starship Crowdin](https://translate.starship.rs/) 에서 기여할 수 있습니다. -If you are interested in helping contribute to starship, please take a look at our [Contributing Guide](https://github.com/starship/starship/blob/master/CONTRIBUTING.md). Also, feel free to drop into our [Discord server](https://discord.gg/8Jzqu3T) and say hi. 👋 +Starship 에 기여하는데 관심이 있다면, [Contributing Guide](https://github.com/starship/starship/blob/master/CONTRIBUTING.md) 를 한 번 살펴봐 주세요 그리고 부담갖지 말고 [Discord 서버](https://discord.gg/8Jzqu3T) 에 들러 인사 한 마디 남겨보세요 👋 ## 💭 Inspired By -Please check out these previous works that helped inspire the creation of starship. 🙏 +Starship 을 만드는 데에 영감이 되었던 이전 작업들도 살펴보세요. 🙏 - **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** – A ZSH prompt for astronauts. @@ -418,7 +418,7 @@ Please check out these previous works that helped inspire the creation of starsh


- Starship rocket icon + Starship 로켓 아이콘

## 📝라이선스 diff --git a/docs/nl-NL/README.md b/docs/nl-NL/README.md index 0be27077..c3fe7134 100644 --- a/docs/nl-NL/README.md +++ b/docs/nl-NL/README.md @@ -120,7 +120,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p #### Elvish - ::: warning Only elvish v0.17 or higher is supported. ::: + ::: warning Only elvish v0.18 or higher is supported. ::: Add the following to the end of `~/.elvish/rc.elv`: diff --git a/docs/nl-NL/advanced-config/README.md b/docs/nl-NL/advanced-config/README.md index 23d7282e..809dc9d0 100644 --- a/docs/nl-NL/advanced-config/README.md +++ b/docs/nl-NL/advanced-config/README.md @@ -131,7 +131,7 @@ Invoke-Expression (&starship init powershell) Some shells support a right prompt which renders on the same line as the input. Starship can set the content of the right prompt using the `right_format` option. Any module that can be used in `format` is also supported in `right_format`. The `$all` variable will only contain modules not explicitly used in either `format` or `right_format`. -Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [fill module](/config/#fill). +Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [`fill` module](/config/#fill). `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd. diff --git a/docs/nl-NL/config/README.md b/docs/nl-NL/config/README.md index db6eac3f..cefbec26 100644 --- a/docs/nl-NL/config/README.md +++ b/docs/nl-NL/config/README.md @@ -9,6 +9,9 @@ mkdir -p ~/.config && touch ~/.config/starship.toml All configuration for starship is done in this [TOML](https://github.com/toml-lang/toml) file: ```toml +# Get editor completions based on the config schema +"$schema" = 'https://starship.rs/config-schema.json' + # Inserts a blank line between shell prompts add_newline = true @@ -199,6 +202,7 @@ $hg_branch\ $docker_context\ $package\ $buf\ +$c\ $cmake\ $cobol\ $container\ @@ -235,6 +239,7 @@ $vagrant\ $zig\ $nix_shell\ $conda\ +$spack\ $memory_usage\ $aws\ $gcloud\ @@ -263,9 +268,9 @@ format = "$all$directory$character" ## AWS -The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file. This module also shows an expiration timer when using temporary credentials. +The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. Alternatively, you can force this module to show the region and profile even when the credentials have not been setup with the `force_display` option. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file. This module also shows an expiration timer when using temporary credentials. -The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. +The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if the conditions above are not respected. When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var. @@ -275,15 +280,16 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------- | -| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | The format for the module. | -| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. | -| `region_aliases` | | Table of region aliases to display in addition to the AWS name. | -| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | -| `style` | `"bold yellow"` | The style for the module. | -| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. | -| `disabled` | `false` | Disables the `AWS` module. | +| Option | Default | Description | +| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | +| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | The format for the module. | +| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. | +| `region_aliases` | | Table of region aliases to display in addition to the AWS name. | +| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | +| `style` | `"bold yellow"` | The style for the module. | +| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. | +| `disabled` | `false` | Disables the `AWS` module. | +| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. | ### Variables @@ -472,6 +478,52 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil symbol = "🦬 " ``` +## C + +The `c` module shows some information about your C compiler. By default the module will be shown if the current directory contains a `.c` or `.h` file. + +### Options + +| Option | Default | Description | +| ------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version(-$name) )]($style)"` | The format string for the module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"C "` | The symbol used before displaying the compiler details | +| `detect_extensions` | `["c", "h"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `commands` | [ [ "cc", "--version" ], [ "gcc", "--version" ], [ "clang", "--version" ] ] | How to detect what the compiler is | +| `style` | `"bold 149"` | The style for the module. | +| `disabled` | `false` | Disables the `c` module. | + +### Variables + +| Variable | Example | Description | +| -------- | ------- | ------------------------------------ | +| name | clang | The name of the compiler | +| version | 13.0.0 | The version of the compiler | +| symbol | | Mirrors the value of option `symbol` | +| style | | Mirrors the value of option `style` | + +NB that `version` is not in the default format. + +### Commands + +The `commands` option accepts a list of commands to determine the compiler version and name. + +Each command is represented as a list of the executable name, followed by its arguments, usually something like `["mycc", "--version"]`. Starship will try executing each command until it gets a result on STDOUT. + +If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). + +### Example + +```toml +# ~/.config/starship.toml + +[c] +format = "via [$name $version]($style)" +``` + ## Character The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. @@ -962,7 +1014,7 @@ You'll also need the .NET Core SDK installed in order to use it correctly. Internally, this module uses its own mechanism for version detection. Typically it is twice as fast as running `dotnet --version`, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting `heuristic = false` in the module options. -The module will also show the Target Framework Moniker () when there is a csproj file in the current directory. +The module will also show the Target Framework Moniker () when there is a `.csproj` file in the current directory. ### Options @@ -2969,6 +3021,39 @@ The `singularity` module shows the current [Singularity](https://sylabs.io/singu format = '[📦 \[$env\]]($style) ' ``` +## Spack + +The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set. + +### Options + +| Option | Default | Description | +| ------------------- | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | +| `truncation_length` | `1` | The number of directories the environment path should be truncated to. `0` means no truncation. Also see the [`directory`](#directory) module. | +| `symbol` | `"🅢 "` | The symbol used before the environment name. | +| `style` | `"bold blue"` | The style for the module. | +| `format` | `"via [$symbol$environment]($style) "` | The format for the module. | +| `disabled` | `false` | Disables the `spack` module. | + +### Variables + +| Variable | Example | Description | +| ----------- | ------------ | ------------------------------------ | +| environment | `astronauts` | The current spack environment | +| 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 + +[spack] +format = "[$symbol$environment](dimmed blue) " +``` + ## Status 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. @@ -3226,7 +3311,7 @@ time_range = "10:00:00-14:00:00" 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 +- The current user is root/admin - The current user isn't the same as the one that is logged in - The user is currently connected as an SSH session - The variable `show_always` is set to true @@ -3239,13 +3324,13 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, ` ### Options -| Option | Default | Description | -| ------------- | ----------------------- | ------------------------------------- | -| `style_root` | `"bold red"` | The style used when the user is root. | -| `style_user` | `"bold yellow"` | The style used for non-root users. | -| `format` | `"[$user]($style) in "` | The format for the module. | -| `show_always` | `false` | Always shows the `username` module. | -| `disabled` | `false` | Disables the `username` module. | +| Option | Default | 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 "` | The format for the module. | +| `show_always` | `false` | Always shows the `username` module. | +| `disabled` | `false` | Disables the `username` module. | ### Variables @@ -3417,9 +3502,9 @@ The `custom` modules show the output of some arbitrary commands. These modules will be shown if any of the following conditions are met: -- The current directory contains a file whose name is in `files` -- The current directory contains a directory whose name is in `directories` -- The current directory contains a file whose extension is in `extensions` +- The current directory contains a file whose name is in `detect_files` +- The current directory contains a directory whose name is in `detect_folders` +- The current directory contains a file whose extension is in `detect_extensions` - The `when` command returns 0 - The current Operating System (std::env::consts::OS) matchs with `os` field if defined. @@ -3451,20 +3536,22 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt ### Options -| Option | Default | Description | -| ------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `command` | `""` | The command whose output should be printed. The command will be passed on stdin to the shell. | -| `when` | | A shell command used as a condition to show the module. 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`. | -| `files` | `[]` | The files that will be searched in the working directory for a match. | -| `directories` | `[]` | The directories that will be searched in the working directory for a match. | -| `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"` | The style for the module. | -| `format` | `"[$symbol($output )]($style)"` | The format for the module. | -| `disabled` | `false` | Disables this `custom` module. | -| `os` | | Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) [See possible values](https://doc.rust-lang.org/std/env/consts/constant.OS.html). | +| Option | Default | Description | +| ------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `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"` | The style for the module. | +| `format` | `"[$symbol($output )]($style)"` | The format for the module. | +| `disabled` | `false` | Disables this `custom` module. | +| `os` | | Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) [See possible values](https://doc.rust-lang.org/std/env/consts/constant.OS.html). | +| `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 @@ -3487,7 +3574,7 @@ If unset, it will fallback to STARSHIP_SHELL and then to "sh" on Linux, and "cmd The `command` will be passed in on stdin. -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 -`. This behavior can be avoided by explicitly passing arguments to the shell, e.g. +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", "-"] @@ -3512,12 +3599,18 @@ Automatic detection of shells and proper parameters addition are currently imple [custom.foo] command = "echo foo" # shows output of command -files = ["foo"] # can specify filters but wildcards are not supported +detect_files = ["foo"] # can specify filters but wildcards are not supported when = """ test "$HOME" == "$PWD" """ format = " transcending [$output]($style)" [custom.time] command = "time /T" -extensions = ["pst"] # filters *.pst files +detect_extensions = ["pst"] # filters *.pst files shell = ["pwsh.exe", "-NoProfile", "-Command", "-"] + +[custom.time-as-arg] +command = "time /T" +detect_extensions = ["pst"] # filters *.pst files +shell = ["pwsh.exe", "-NoProfile", "-Command"] +use_stdin = false ``` diff --git a/docs/nl-NL/guide/README.md b/docs/nl-NL/guide/README.md index 88f5d656..91f3c5df 100644 --- a/docs/nl-NL/guide/README.md +++ b/docs/nl-NL/guide/README.md @@ -143,7 +143,7 @@ Starship with iTerm2 and the Snazzy theme @@ -158,7 +158,7 @@ - **Makkelijk:** snel te installeren - begin in een handomdraai met het te gebruiken.

-Explore the Starship docs  ▶ +Verken de Starship-documentatie  ▶

@@ -295,7 +295,7 @@ Add the following to the end of `~/.elvish/rc.elv`: eval (starship init elvish) ``` -Note: Only Elvish v0.17+ is supported +Note: Only Elvish v0.18+ is supported
diff --git a/docs/pl-PL/README.md b/docs/pl-PL/README.md index 0aec0d69..03267474 100644 --- a/docs/pl-PL/README.md +++ b/docs/pl-PL/README.md @@ -120,7 +120,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p #### Elvish - ::: warning Only elvish v0.17 or higher is supported. ::: + ::: warning Only elvish v0.18 or higher is supported. ::: Dodaj na koniec pliku `~/.elvish/rc.elv`: diff --git a/docs/pl-PL/advanced-config/README.md b/docs/pl-PL/advanced-config/README.md index e2c7a3b9..9513063f 100644 --- a/docs/pl-PL/advanced-config/README.md +++ b/docs/pl-PL/advanced-config/README.md @@ -131,7 +131,7 @@ Invoke-Expression (&starship init powershell) Some shells support a right prompt which renders on the same line as the input. Starship can set the content of the right prompt using the `right_format` option. Any module that can be used in `format` is also supported in `right_format`. The `$all` variable will only contain modules not explicitly used in either `format` or `right_format`. -Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [fill module](/config/#fill). +Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [`fill` module](/config/#fill). `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd. diff --git a/docs/pl-PL/config/README.md b/docs/pl-PL/config/README.md index ab260191..84230db8 100644 --- a/docs/pl-PL/config/README.md +++ b/docs/pl-PL/config/README.md @@ -9,6 +9,9 @@ mkdir -p ~/.config && touch ~/.config/starship.toml Cała konfiguracja starship jest wykonywana w tym pliku [TOML](https://github.com/toml-lang/toml): ```toml +# Get editor completions based on the config schema +"$schema" = 'https://starship.rs/config-schema.json' + # Inserts a blank line between shell prompts add_newline = true @@ -199,6 +202,7 @@ $hg_branch\ $docker_context\ $package\ $buf\ +$c\ $cmake\ $cobol\ $container\ @@ -235,6 +239,7 @@ $vagrant\ $zig\ $nix_shell\ $conda\ +$spack\ $memory_usage\ $aws\ $gcloud\ @@ -263,9 +268,9 @@ format = "$all$directory$character" ## AWS -The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file. This module also shows an expiration timer when using temporary credentials. +The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. Alternatively, you can force this module to show the region and profile even when the credentials have not been setup with the `force_display` option. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file. This module also shows an expiration timer when using temporary credentials. -The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. +The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if the conditions above are not respected. When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var. @@ -275,15 +280,16 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------- | -| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | The format for the module. | -| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. | -| `region_aliases` | | Table of region aliases to display in addition to the AWS name. | -| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | -| `style` | `"bold yellow"` | The style for the module. | -| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. | -| `disabled` | `false` | Disables the `AWS` module. | +| Option | Default | Description | +| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | +| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | The format for the module. | +| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. | +| `region_aliases` | | Table of region aliases to display in addition to the AWS name. | +| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | +| `style` | `"bold yellow"` | The style for the module. | +| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. | +| `disabled` | `false` | Disables the `AWS` module. | +| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. | ### Variables @@ -472,6 +478,52 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil symbol = "🦬 " ``` +## C + +The `c` module shows some information about your C compiler. By default the module will be shown if the current directory contains a `.c` or `.h` file. + +### Options + +| Option | Default | Description | +| ------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version(-$name) )]($style)"` | The format string for the module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"C "` | The symbol used before displaying the compiler details | +| `detect_extensions` | `["c", "h"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `commands` | [ [ "cc", "--version" ], [ "gcc", "--version" ], [ "clang", "--version" ] ] | How to detect what the compiler is | +| `style` | `"bold 149"` | The style for the module. | +| `disabled` | `false` | Disables the `c` module. | + +### Variables + +| Zmienne | Example | Description | +| ------- | ------- | ------------------------------------ | +| name | clang | The name of the compiler | +| version | 13.0.0 | The version of the compiler | +| symbol | | Mirrors the value of option `symbol` | +| style | | Mirrors the value of option `style` | + +NB that `version` is not in the default format. + +### Commands + +The `commands` option accepts a list of commands to determine the compiler version and name. + +Each command is represented as a list of the executable name, followed by its arguments, usually something like `["mycc", "--version"]`. Starship will try executing each command until it gets a result on STDOUT. + +If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). + +### Example + +```toml +# ~/.config/starship.toml + +[c] +format = "via [$name $version]($style)" +``` + ## Character The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. @@ -962,7 +1014,7 @@ You'll also need the .NET Core SDK installed in order to use it correctly. Internally, this module uses its own mechanism for version detection. Typically it is twice as fast as running `dotnet --version`, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting `heuristic = false` in the module options. -The module will also show the Target Framework Moniker () when there is a csproj file in the current directory. +The module will also show the Target Framework Moniker () when there is a `.csproj` file in the current directory. ### Options @@ -1106,7 +1158,7 @@ default = "unknown user" | Option | Default | Description | | ---------- | ------------------------------ | ---------------------------------------------------------------------------- | | `symbol` | `""` | The symbol used before displaying the variable value. | -| `variable` | | The environment variable to be displayed. | +| `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. | @@ -2969,6 +3021,39 @@ The `singularity` module shows the current [Singularity](https://sylabs.io/singu format = '[📦 \[$env\]]($style) ' ``` +## Spack + +The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set. + +### Options + +| Option | Default | Description | +| ------------------- | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | +| `truncation_length` | `1` | The number of directories the environment path should be truncated to. `0` means no truncation. Also see the [`directory`](#directory) module. | +| `symbol` | `"🅢 "` | The symbol used before the environment name. | +| `style` | `"bold blue"` | The style for the module. | +| `format` | `"via [$symbol$environment]($style) "` | The format for the module. | +| `disabled` | `false` | Disables the `spack` module. | + +### Variables + +| Zmienne | Example | Description | +| ----------- | ------------ | ------------------------------------ | +| environment | `astronauts` | The current spack environment | +| 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 + +[spack] +format = "[$symbol$environment](dimmed blue) " +``` + ## Status 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. @@ -3226,7 +3311,7 @@ time_range = "10:00:00-14:00:00" 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 +- The current user is root/admin - The current user isn't the same as the one that is logged in - The user is currently connected as an SSH session - The variable `show_always` is set to true @@ -3239,13 +3324,13 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, ` ### Options -| Option | Default | Description | -| ------------- | ----------------------- | ------------------------------------- | -| `style_root` | `"bold red"` | The style used when the user is root. | -| `style_user` | `"bold yellow"` | The style used for non-root users. | -| `format` | `"[$user]($style) in "` | The format for the module. | -| `show_always` | `false` | Always shows the `username` module. | -| `disabled` | `false` | Disables the `username` module. | +| Option | Default | 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 "` | The format for the module. | +| `show_always` | `false` | Always shows the `username` module. | +| `disabled` | `false` | Disables the `username` module. | ### Variables @@ -3417,9 +3502,9 @@ The `custom` modules show the output of some arbitrary commands. These modules will be shown if any of the following conditions are met: -- The current directory contains a file whose name is in `files` -- The current directory contains a directory whose name is in `directories` -- The current directory contains a file whose extension is in `extensions` +- The current directory contains a file whose name is in `detect_files` +- The current directory contains a directory whose name is in `detect_folders` +- The current directory contains a file whose extension is in `detect_extensions` - The `when` command returns 0 - The current Operating System (std::env::consts::OS) matchs with `os` field if defined. @@ -3451,20 +3536,22 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt ### Options -| Option | Default | Description | -| ------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `command` | `""` | The command whose output should be printed. The command will be passed on stdin to the shell. | -| `when` | | A shell command used as a condition to show the module. 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`. | -| `files` | `[]` | The files that will be searched in the working directory for a match. | -| `directories` | `[]` | The directories that will be searched in the working directory for a match. | -| `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"` | The style for the module. | -| `format` | `"[$symbol($output )]($style)"` | The format for the module. | -| `disabled` | `false` | Disables this `custom` module. | -| `os` | | Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) [See possible values](https://doc.rust-lang.org/std/env/consts/constant.OS.html). | +| Option | Default | Description | +| ------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `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"` | The style for the module. | +| `format` | `"[$symbol($output )]($style)"` | The format for the module. | +| `disabled` | `false` | Disables this `custom` module. | +| `os` | | Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) [See possible values](https://doc.rust-lang.org/std/env/consts/constant.OS.html). | +| `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 @@ -3487,7 +3574,7 @@ If unset, it will fallback to STARSHIP_SHELL and then to "sh" on Linux, and "cmd The `command` will be passed in on stdin. -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 -`. This behavior can be avoided by explicitly passing arguments to the shell, e.g. +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", "-"] @@ -3512,12 +3599,18 @@ Automatic detection of shells and proper parameters addition are currently imple [custom.foo] command = "echo foo" # shows output of command -files = ["foo"] # can specify filters but wildcards are not supported +detect_files = ["foo"] # can specify filters but wildcards are not supported when = """ test "$HOME" == "$PWD" """ format = " transcending [$output]($style)" [custom.time] command = "time /T" -extensions = ["pst"] # filters *.pst files +detect_extensions = ["pst"] # filters *.pst files shell = ["pwsh.exe", "-NoProfile", "-Command", "-"] + +[custom.time-as-arg] +command = "time /T" +detect_extensions = ["pst"] # filters *.pst files +shell = ["pwsh.exe", "-NoProfile", "-Command"] +use_stdin = false ``` diff --git a/docs/pl-PL/guide/README.md b/docs/pl-PL/guide/README.md index c7af02c4..8bf22d25 100644 --- a/docs/pl-PL/guide/README.md +++ b/docs/pl-PL/guide/README.md @@ -145,7 +145,7 @@ Starship with iTerm2 and the Snazzy theme @@ -160,7 +160,7 @@ - **Łatwy w obsłudze:** szybka instalacja - zacznij korzystać w kilka minut.

-Explore the Starship docs  ▶ +Przeglądaj dokumentację Starship  ▶

@@ -297,7 +297,7 @@ Dodaj na koniec pliku `~/.elvish/rc.elv`: eval (starship init elvish) ``` -Note: Only Elvish v0.17+ is supported +Note: Only Elvish v0.18+ is supported
@@ -400,15 +400,15 @@ If you're looking to further customize Starship: ## 🤝Wspomóż nas -We are always looking for contributors of **all skill levels**! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). +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). -If you are fluent in a non-English language, we greatly appreciate any help keeping our docs translated and up-to-date in other languages. If you would like to help, translations can be contributed on the [Starship Crowdin](https://translate.starship.rs/). +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/). -If you are interested in helping contribute to starship, please take a look at our [Contributing Guide](https://github.com/starship/starship/blob/master/CONTRIBUTING.md). Also, feel free to drop into our [Discord server](https://discord.gg/8Jzqu3T) and say hi. 👋 +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 -Please check out these previous works that helped inspire the creation of 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. diff --git a/docs/pl-PL/installing/README.md b/docs/pl-PL/installing/README.md index 8e060f62..9e52ba75 100644 --- a/docs/pl-PL/installing/README.md +++ b/docs/pl-PL/installing/README.md @@ -1,4 +1,4 @@ -# Advanced Installation +# Zaawansowana Instalacja Aby zainstalować starship, musisz zrobić dwie rzeczy: diff --git a/docs/pt-BR/README.md b/docs/pt-BR/README.md index 5234ee8a..8cc847f8 100644 --- a/docs/pt-BR/README.md +++ b/docs/pt-BR/README.md @@ -120,7 +120,7 @@ description: O Starship é o prompt minimalista, extremamente rápido e extremam #### Elvish - ::: warning Apenas a versão v0.17 ou superior do elvish é suportada. ::: + ::: warning Somente a versão v0.18 ou superior do elvish é suportada. ::: Adicione o comando a seguir ao final do arquivo `~/.elvish/rc.elv`: @@ -144,7 +144,7 @@ description: O Starship é o prompt minimalista, extremamente rápido e extremam #### Nushell - ::: Atenção Isto vai mudar no futuro. Only Nushell v0.60+ is supported. ::: Run the following: + ::: Atenção Isto vai mudar no futuro. Somente Nushell v0.60+ é suportado. ::: Execute os seguintes comandos: ```sh mkdir ~/.cache/starship starship init nu | save ~/.cache/starship/init.nu @@ -171,7 +171,7 @@ description: O Starship é o prompt minimalista, extremamente rápido e extremam #### Cmd - Você precisa do [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) com Cmd. Add the following to a file `starship.lua` and place this file in Clink scripts directory: + Você precisa do [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) com Cmd. Adicione o seguinte num arquivo `starship.lua` e coloque este arquivo no diretório scripts do Clink: ```lua -- starship.lua diff --git a/docs/pt-BR/advanced-config/README.md b/docs/pt-BR/advanced-config/README.md index 638099ba..66c80c64 100644 --- a/docs/pt-BR/advanced-config/README.md +++ b/docs/pt-BR/advanced-config/README.md @@ -131,7 +131,7 @@ Invoke-Expression (&starship init powershell) Alguns shells suportam um prompt no lado direito que renderiza na mesma linha do input. Starship consegue definir o conteúdo do prompt direito usando a opção `right_format`. Qualquer módulo pode ser usado no `format` é suportado o `right_format`. A variável `$all` só irá alterar os módulos que não usaram de forma explicita o `format` ou `right_format`. -Nota: O prompt direito é uma linha única seguindo o local de entrada. Para alinhar à direita os módulos acima a linha de entrada em um prompt de várias linhas, consulte o [módulo fill](/config/#fill). +Nota: O prompt direito é uma linha única seguindo o local de entrada. To right align modules above the input line in a multi-line prompt, see the [`fill` module](/config/#fill). `right_format` é atualmente compatível com os seguintes shells: elvish, fish, zsh, xonsh, cmd. diff --git a/docs/pt-BR/config/README.md b/docs/pt-BR/config/README.md index f7805ceb..f4347a55 100644 --- a/docs/pt-BR/config/README.md +++ b/docs/pt-BR/config/README.md @@ -9,14 +9,17 @@ mkdir -p ~/.config && touch ~/.config/starship.toml Todas as configurações do starship são feitas neste arquivo [TOML](https://github.com/toml-lang/toml): ```toml -# Insere uma quebra de linha entre os prompts do shell +# Get editor completions based on the config schema +"$schema" = 'https://starship.rs/config-schema.json' + +# Inserts a blank line between shell prompts add_newline = true -# Substitui o símbolo "❯" no prompt por "➜" -[character] # O nome do módulo que estamos configurando é "character" -success_symbol = "[➜](bold green)" # O segmento "success_symbol" está sendo definido como "➜" com a cor "verde em negrito" +# Replace the "❯" symbol in the prompt with "➜" +[character] # The name of the module we are configuring is "character" +success_symbol = "[➜](bold green)" # The "success_symbol" segment is being set to "➜" with the color "bold green" -# Desabilita o módulo do pacote, ocultando-o completamente do prompt +# Disable the package module, hiding it from the prompt completely [package] disabled = true ``` @@ -180,7 +183,7 @@ O `formato` padrão é usado para definir o formato do prompt, se um valor vazio ```toml format = "$all" -# Que é equivalente a: +# Which is equivalent to format = """ $username\ $hostname\ @@ -199,6 +202,7 @@ $hg_branch\ $docker_context\ $package\ $buf\ +$c\ $cmake\ $cobol\ $container\ @@ -235,6 +239,7 @@ $vagrant\ $zig\ $nix_shell\ $conda\ +$spack\ $memory_usage\ $aws\ $gcloud\ @@ -263,9 +268,9 @@ format = "$all$directory$character" ## AWS -O módulo `aws` exibe a região e perfil atual do AWS quando as credenciais, um `credential_process` ou um `sso_start_url` foram configurados. Isto é baseado nas variáveis de env `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` contidas no arquivo `~/.aws/config`. Este módulo exibe também o tempo de expiração de credenciais temporárias. +O módulo `aws` exibe a região e perfil atual do AWS quando as credenciais, um `credential_process` ou um `sso_start_url` foram configurados. Alternatively, you can force this module to show the region and profile even when the credentials have not been setup with the `force_display` option. Isto é baseado nas variáveis de env `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` contidas no arquivo `~/.aws/config`. Este módulo exibe também o tempo de expiração de credenciais temporárias. -O módulo vai exibir o perfil somente se as credenciais estiverem presentes em `~/.aws/credentials` ou se `credentials_process` constar no arquivo `~/.aws/config`. Como alternativa, basta ter uma ou mais das seguintes variáveis definidas: `AWS_ACCESS_KEY_ID`, `AWS_ACCESS_KEY` ou `AWS_SESSION_TOKEN`. +O módulo vai exibir o perfil somente se as credenciais estiverem presentes em `~/.aws/credentials` ou se `credentials_process` constar no arquivo `~/.aws/config`. Como alternativa, basta ter uma ou mais das seguintes variáveis definidas: `AWS_ACCESS_KEY_ID`, `AWS_ACCESS_KEY` ou `AWS_SESSION_TOKEN`. If the option `force_display` is set to `true`, all available information will be displayed even if the conditions above are not respected. Quando usar [aws-vault](https://github.com/99designs/aws-vault), o perfil é lido da variável de ambiente `AWS_VAULT` e o tempo de expiração de credenciais é lido da variável de ambiente `AWS_SESSION_EXPIRATION`. @@ -275,15 +280,16 @@ Quando usar [AWSume](https://awsu.me) o perfil é lido da variável `AWSUME_PROF ### Opções -| Opções | Padrão | Descrição | -| ------------------- | -------------------------------------------------------------------- | ------------------------------------------------------------------- | -| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | O formato do módulo. | -| `symbol` | `"☁️ "` | O símbolo usado antes de exibir o perfil atual da AWS. | -| `region_aliases` | | Tabela de aleases de regiões a serem exibidas, além do nome da AWS. | -| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | -| `style` | `"bold yellow"` | O estilo do módulo. | -| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. | -| `disabled` | `false` | Disables the `AWS` module. | +| Opções | Padrão | Descrição | +| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | +| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | O formato do módulo. | +| `symbol` | `"☁️ "` | O símbolo usado antes de exibir o perfil atual da AWS. | +| `region_aliases` | | Tabela de aleases de regiões a serem exibidas, além do nome da AWS. | +| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | +| `style` | `"bold yellow"` | O estilo do módulo. | +| `expiration_symbol` | `X` | O simbolo exibido quando as credenciais temporárias estão expiradas. | +| `disabled` | `false` | Desabilita o módulo `AWS`. | +| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. | ### Variáveis @@ -451,7 +457,7 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil | `detect_files` | `["buf.yaml", "buf.gen.yaml", "buf.work.yaml"]` | Quais nomes de arquivos devem ativar este módulo. | | `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | | `style` | `"bold blue"` | O estilo do módulo. | -| `disabled` | `false` | Disables the `elixir` module. | +| `disabled` | `false` | Desabilita o módulo `elixir`. | ### Variáveis @@ -472,16 +478,62 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil symbol = "🦬 " ``` +## C + +The `c` module shows some information about your C compiler. By default the module will be shown if the current directory contains a `.c` or `.h` file. + +### Opções + +| Opções | Padrão | Descrição | +| ------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | +| `format` | `"via [$symbol($version(-$name) )]($style)"` | A string de formato do módulo. | +| `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"C "` | The symbol used before displaying the compiler details | +| `detect_extensions` | `["c", "h"]` | 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. | +| `commands` | [ [ "cc", "--version" ], [ "gcc", "--version" ], [ "clang", "--version" ] ] | How to detect what the compiler is | +| `style` | `"bold 149"` | O estilo do módulo. | +| `disabled` | `false` | Disables the `c` module. | + +### Variáveis + +| Variável | Exemplo | Descrição | +| -------- | ------- | --------------------------------- | +| name | clang | The name of the compiler | +| version | 13.0.0 | The version of the compiler | +| symbol | | Espelha o valor da opção `symbol` | +| style | | Espelha o valor da opção `style` | + +NB that `version` is not in the default format. + +### Commands + +The `commands` option accepts a list of commands to determine the compiler version and name. + +Each command is represented as a list of the executable name, followed by its arguments, usually something like `["mycc", "--version"]`. Starship will try executing each command until it gets a result on STDOUT. + +If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). + +### Exemplo + +```toml +# ~/.config/starship.toml + +[c] +format = "via [$name $version]($style)" +``` + ## Caractere -The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. +O módulo `character` exibe um caracter (normalmente uma seta) ao lado de onde o texto começa a ser inserido no terminal. -The character will tell you whether the last command was successful or not. It can do this in two ways: +O caractere vai te dizer se o ultimo comando foi bem sucedido ou não. Você pode fazer isto de duas maneiras: -- changing color (`red`/`green`) -- changing shape (`❯`/`✖`) +- alterando a cor (`red`/`green`) +- alterando a forma (`❯`/`✖`) -By default it only changes color. If you also want to change its shape take a look at [this example](#with-custom-error-shape). +Por padrão ele apenas muda de cor. Se você deseja alterar o formato de uma olhada [neste exemplo](#with-custom-error-shape). ::: atenção @@ -491,19 +543,19 @@ By default it only changes color. If you also want to change its shape take a lo ### Opções -| Opções | Padrão | Descrição | -| ---------------- | ------------------- | -------------------------------------------------------------------------------- | -| `format` | `"$symbol "` | The format string used before the text input. | -| `success_symbol` | `"[❯](bold green)"` | The format string used before the text input if the previous command succeeded. | -| `error_symbol` | `"[❯](bold red)"` | The format string used before the text input if the previous command failed. | -| `vicmd_symbol` | `"[❮](bold green)"` | The format string used before the text input if the shell is in vim normal mode. | -| `disabled` | `false` | Disables the `character` module. | +| Opções | Padrão | Descrição | +| ---------------- | ------------------- | ------------------------------------------------------------------------------------------- | +| `format` | `"$symbol"` | O formato da string usado antes da entrada dos textos. | +| `success_symbol` | `"[❯](bold green)"` | O formato da string usado antes da entrada de texto se o comando anterior for bem-sucedido. | +| `error_symbol` | `"[❯](bold red)"` | O formato de string usado antes da entrada de texto se o comando anterior tiver falhado. | +| `vicmd_symbol` | `"[❮](bold green)"` | O fromato de string usado antes da entrada de texto se o shell esta no vim normal mode. | +| `disabled` | `false` | Desabilita o módulo `character`. | ### Variáveis -| Variável | Exemplo | Descrição | -| -------- | ------- | --------------------------------------------------------------------- | -| symbol | | A mirror of either `success_symbol`, `error_symbol` or `vicmd_symbol` | +| Variável | Exemplo | Descrição | +| -------- | ------- | ---------------------------------------------------------------- | +| symbol | | Um espelho de `success_symbol`, `error_symbol` ou `vicmd_symbol` | ### Exemplos @@ -538,10 +590,10 @@ vicmd_symbol = "[V](bold green) " ## CMake -The `cmake` module shows the currently installed version of [CMake](https://cmake.org/). By default the module will be activated if any of the following conditions are met: +O módulo `cmake` exibe a versão instalada do [CMake](https://cmake.org/). Por padrão o módulo será ativo se qualquer das condições a seguir for atendida: -- The current directory contains a `CMakeLists.txt` file -- The current directory contains a `CMakeCache.txt` file +- O diretorio atual cotem um arquivo `CMakeLists.txt` +- O diretorio atual tem um arquivo `CMakeCache.txt` ### Opções @@ -549,18 +601,18 @@ The `cmake` module shows the currently installed version of [CMake](https://cmak | ------------------- | -------------------------------------- | ------------------------------------------------------------------------------------ | | `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` | `"△ "` | The symbol used before the version of cmake. | -| `detect_extensions` | `[]` | Which extensions should trigger this module | -| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | -| `detect_folders` | `[]` | Which folders should trigger this module | +| `symbol` | `"△ "` | O simbolo usado antes da versão do cmake. | +| `detect_extensions` | `[]` | Quais extensões devem acionar este módulo | +| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | [] | +| `detect_folders` | `[]` | Quais pastas devem ativar este módulo | | `style` | `"bold blue"` | O estilo do módulo. | -| `disabled` | `false` | Disables the `cmake` module. | +| `disabled` | `false` | Desabilita o módulo `cmake`. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | --------- | --------------------------------- | -| version | `v3.17.3` | The version of cmake | +| version | `v3.17.3` | A versão do cmake | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -568,29 +620,29 @@ The `cmake` module shows the currently installed version of [CMake](https://cmak ## COBOL / GNUCOBOL -The `cobol` module shows the currently installed version of COBOL. By default, the module will be shown if any of the following conditions are met: +O módulo `cobol` exibe a versão instalada atual do COBOL. Por padrão, o módulo será exibido se qualquer das seguintes condições for atendida: -- The current directory contains any files ending in `.cob` or `.COB` -- The current directory contains any files ending in `.cbl` or `.CBL` +- O diretório atual tem qualquer arquivo com extensão `.cob` or `.COB` +- O diretório atual tenham qualquer arquivo com extensão `.cbl` or `.CBL` ### Opções | Opções | Padrão | Descrição | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ | -| `symbol` | `"⚙️ "` | The symbol used before displaying the version of COBOL. | +| `symbol` | `"⚙️ "` | O simbolo usado antes de exibir a versão do COBOL. | | `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` | | `style` | `"bold blue"` | O estilo do módulo. | | `detect_extensions` | `["cbl", "cob", "CBL", "COB"]` | 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 `cobol` module. | +| `disabled` | `false` | Desabilita o módulo `cobol`. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | ---------- | --------------------------------- | -| version | `v3.1.2.0` | The version of `cobol` | +| version | `v3.1.2.0` | A versão do `cobol` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -598,35 +650,35 @@ The `cobol` module shows the currently installed version of COBOL. By default, t ## Tempo de execução do comando -The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists. +O módulo `cmd_duration` exibi o tempo que o ultimo comando levou para executar. O módulo vai exibir somente se o comando levar mais de dois segundos, ou o valor de configuração `min_time` existir. -::: warning Do not hook the DEBUG trap in Bash +::: warning Não utilize o DEBUG-trap no Bash -If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. +Se você esta rodando o Starship no `bash`, você não deve ativar a armadilha `DEBUG` após rodar `eval $(starship init $0)`, ou este módulo **vai** quebrar. ::: -Bash users who need preexec-like functionality can use [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Simply define the arrays `preexec_functions` and `precmd_functions` before running `eval $(starship init $0)`, and then proceed as normal. +Usuários do bash que precisam de funções pre-executadas podem usar [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Simplesmente defina os arrays `preexec_functions` e `precmd_functions` antes de rodar `eval $(starship init $0)`, e depois pode proceder normalmente. ### Opções | Opções | Padrão | Descrição | | ---------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). | -| `show_milliseconds` | `false` | Show milliseconds in addition to seconds for the duration. | +| `min_time` | `2_000` | Duração mais curta para exibir o tempo (em milissegundos). | +| `show_milliseconds` | `false` | Exibir milissegundos ou invés de segundos para duração. | | `format` | `"took [$duration]($style) "` | O formato do módulo. | | `style` | `"bold yellow"` | O estilo do módulo. | -| `disabled` | `false` | Disables the `cmd_duration` module. | -| `show_notifications` | `false` | Show desktop notifications when command completes. | -| `min_time_to_notify` | `45_000` | Shortest duration for notification (in milliseconds). | +| `disabled` | `false` | Desabilita o módulo `cmd_duration`. | +| `show_notifications` | `false` | Exibi notificações no desktop quando o comando for concluído. | +| `min_time_to_notify` | `45_000` | Tempo minimo para notificação (em milissegundos). | | `notification_timeout` | | Duration to show notification for (in milliseconds). If unset, notification timeout will be determined by daemon. Not all notification daemons honor this option. | ### Variáveis -| Variável | Exemplo | Descrição | -| --------- | -------- | --------------------------------------- | -| duration | `16m40s` | The time it took to execute the command | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| --------- | -------- | ----------------------------------------- | +| duration | `16m40s` | O tempo que levou para executar o comando | +| style\* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo @@ -642,30 +694,30 @@ format = "underwent [$duration](bold yellow)" ## Conda -The `conda` module shows the current [Conda](https://docs.conda.io/en/latest/) environment, if `$CONDA_DEFAULT_ENV` is set. +O módulo `conda` exibe o ambiente atual do [Conda](https://docs.conda.io/en/latest/), se o `$CONDA_DEFAULT_ENV` estiver definido. ::: tip -This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. +Isso não suprime o modificador de prompt do conda, você pode executar `conda config --set changeps1 False`. ::: ### Opções -| Opções | Padrão | Descrição | -| ------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `truncation_length` | `1` | The number of directories the environment path should be truncated to, if the environment was created via `conda create -p [path]`. `0` means no truncation. Also see the [`directory`](#directory) module. | -| `symbol` | `"🅒 "` | The symbol used before the environment name. | -| `style` | `"bold green"` | O estilo do módulo. | -| `format` | `"via [$symbol$environment]($style) "` | O formato do módulo. | -| `ignore_base` | `true` | Ignores `base` environment when activated. | -| `disabled` | `false` | Disables the `conda` module. | +| Opções | Padrão | Descrição | +| ------------------- | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `truncation_length` | `1` | O número de diretórios do envirionment path deve ser truncado, se o environment foi criado via `conda create -p [path]`. `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 green"` | O estilo do módulo. | +| `format` | `"via [$symbol$environment]($style) "` | O formato do módulo. | +| `ignore_base` | `true` | Ignora o environment `base` quando ativado. | +| `disabled` | `false` | Desabilita o módulo `conda`. | ### Variáveis | Variável | Exemplo | Descrição | | ----------- | ------------ | --------------------------------- | -| environment | `astronauts` | The current conda environment | +| environment | `astronauts` | O environment atual do conda | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -691,7 +743,7 @@ The `container` module displays a symbol and container name, if inside a contain | `symbol` | `"⬢"` | The symbol shown, when inside a container | | `style` | `"bold red dimmed"` | O estilo do módulo. | | `format` | `"[$symbol \\[$name\\]]($style) "` | O formato do módulo. | -| `disabled` | `false` | Disables the `container` module. | +| `disabled` | `false` | Desabilita o módulo `container`. | ### Variáveis @@ -714,29 +766,29 @@ format = "[$symbol \\[$name\\]]($style) " ## Crystal -The `crystal` module shows the currently installed version of [Crystal](https://crystal-lang.org/). By default the module will be shown if any of the following conditions are met: +O módulo `crystal` exibe a versão instalada atual do [Crystal](https://crystal-lang.org/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: -- The current directory contains a `shard.yml` file -- The current directory contains a `.cr` file +- O diretório atual contem um arquivo `shard.yml` +- O diretório atual contem um arquivo `.cr` ### Opções | Opções | Padrão | Descrição | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ | -| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | +| `symbol` | `"🔮 "` | O simbolo usado antes de exibir a versão do crystal. | | `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` | | `style` | `"bold red"` | O estilo do módulo. | | `detect_extensions` | `["cr"]` | Quais extensões devem ativar este módulo. | | `detect_files` | `["shard.yml"]` | Quais nomes de arquivos devem ativar este módulo. | | `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | -| `disabled` | `false` | Disables the `crystal` module. | +| `disabled` | `false` | Desabilita o módulo `crystal`. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | --------- | --------------------------------- | -| version | `v0.32.1` | The version of `crystal` | +| version | `v0.32.1` | A versão do `crystal` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -753,11 +805,11 @@ format = "via [✨ $version](bold blue) " ## Dart -The `dart` module shows the currently installed version of [Dart](https://dart.dev/). By default the module will be shown if any of the following conditions are met: +O módulo `dart` exibe a versão atual instalada do [Dart](https://dart.dev/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: -- The current directory contains a file with `.dart` extension -- The current directory contains a `.dart_tool` directory -- The current directory contains a `pubspec.yaml`, `pubspec.yml` or `pubspec.lock` file +- O diretório atual contem algum arquivo com extensão `.dart` +- O diretório atual contem um diretório `.dart_tool` +- O diretório atual contem um arquivo `pubspec.yaml`, `pubspec.yml` ou `pubspec.lock` ### Opções @@ -765,12 +817,12 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d | ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | | `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | +| `symbol` | `"🎯 "` | Um formato de string que representa o simbolo do Dart | | `detect_extensions` | `["dart"]` | Quais extensões devem ativar este módulo. | | `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Quais nomes de arquivos devem ativar este módulo. | | `detect_folders` | `[".dart_tool"]` | Quais pastas devem ativar este módulo. | | `style` | `"bold blue"` | O estilo do módulo. | -| `disabled` | `false` | Disables the `dart` module. | +| `disabled` | `false` | Desabilita o módulo `dart`. | ### Variáveis @@ -793,9 +845,9 @@ format = "via [🔰 $version](bold red) " ## Deno -The `deno` module shows you your currently installed version of [Deno](https://deno.land/). By default the module will be shown if any of the following conditions are met: +O módulo `deno` exibe a versão instalada atual do [Deno](https://deno.land/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: -- The current directory contains a `deno.json`, `deno.jsonc`, `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file +- O diretório atual tenha um arquivo `deno.json`, `deno.jsonc`, `mod.ts`, `mod.js`, `deps.ts` or `deps.js` ### Opções @@ -803,18 +855,18 @@ The `deno` module shows you your currently installed version of [Deno](https://d | ------------------- | ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | | `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"🦕 "` | A format string representing the symbol of Deno | +| `symbol` | `"🦕 "` | Um formato de string que representa o simbolo do Deno | | `detect_extensions` | `[]` | Quais extensões devem ativar este módulo. | | `detect_files` | `["deno.json", "deno.jsonc", "mod.ts", "mod.js", "deps.ts", "deps.js"]` | Quais nomes de arquivos devem ativar este módulo. | | `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | | `style` | `"green bold"` | O estilo do módulo. | -| `disabled` | `false` | Disables the `deno` module. | +| `disabled` | `false` | Desabilita o módulo `deno`. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | -------- | --------------------------------- | -| version | `v1.8.3` | The version of `deno` | +| version | `v1.8.3` | A versão do `deno` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -829,39 +881,39 @@ format = "via [🦕 $version](green bold) " ## Diretório -The `directory` module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in. +O módulo `directory` exibe o caminho do diretório atual, truncando as três pastas pai. Seu diretório será truncando na raiz do repositório git que você estiver atualmente. -When using the fish style pwd option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option. +Quando usar a opção de estilo fish pwd, ao invés de esconder o caminho que é truncado, você vai ver um nome encurtado de cada diretório baseado no número que você habilitar para a opção. -For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, and the option set to `1`. You will now see `~/D/N/nixpkgs/pkgs`, whereas before it would have been `nixpkgs/pkgs`. +Por exemplo, dado `~/Dev/Nix/nixpkgs/pkgs` onde `nixpkgs` é o repositório raiz e a opção esta definida para `1`. Você verá `~/D/N/nixpkgs/pkgs`, enquanto antes seria `nixpkgs/pkgs`. ### Opções | Opções | Padrão | Descrição | | ------------------- | ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. | -| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. | +| `truncation_length` | `3` | O número de pastas pais do diretório atual que serão truncadas. | +| `truncate_to_repo` | `true` | Seu diretório será truncado ou não para a raiz do repositório git atual. | | `format` | `"[$path]($style)[$read_only]($read_only_style) "` | O formato do módulo. | | `style` | `"bold cyan"` | O estilo do módulo. | -| `disabled` | `false` | Disables the `directory` module. | -| `read_only` | `"🔒"` | The symbol indicating current directory is read only. | -| `read_only_style` | `"red"` | The style for the read only symbol. | -| `truncation_symbol` | `""` | The symbol to prefix to truncated paths. eg: "…/" | +| `disabled` | `false` | Desabilita o módulo `directory`. | +| `read_only` | `"🔒"` | O simbolo que indica que o diretório atual é somente leitura. | +| `read_only_style` | `"red"` | O estilo para o simbolo de somente leitura. | +| `truncation_symbol` | `""` | O simbolo para prefixo de caminhos truncados. ex: "…/" | | `repo_root_style` | `None` | The style for the root of the git repo. The default value is equivalent to `style`. | | `repo_root_format` | `"[$before_root_path]($style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) "` | The format of a git repo when `repo_root_style` is defined. | -| `home_symbol` | `"~"` | The symbol indicating home directory. | +| `home_symbol` | `"~"` | O simbolo para indicar o diretório home. | | `use_os_path_sep` | `true` | Use the OS specific path separator instead of always using `/` (e.g. `\` on Windows) |
-This module has a few advanced configuration options that control how the directory is displayed. +Este módulo tem algumas configurações avançadas que controlam como o diretório é exibido. -| Advanced Option | Padrão | Descrição | -| --------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `substitutions` | | A table of substitutions to be made to the path. | -| `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. | -| `use_logical_path` | `true` | If `true` render the logical path sourced from the shell via `PWD` or `--logical-path`. If `false` instead render the physical filesystem path with symlinks resolved. | +| Opções Avançadas | Padrão | Descrição | +| --------------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `substituições` | | Uma tabela de substituições para fazer no path. | +| `fish_style_pwd_dir_length` | `0` | O número de caracteres para usar quando aplicado no path logico do fish shell pwd. | +| `use_logical_path` | `true` | Se `true` exibe um caminho lógico originado do shell via `PWD` ou`--logical-path`. Se `false` em vez disso, exibe o caminho do filesystem com os symlinks resolvidos. | -`substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD. +`substitutions` aceita você definir substituições arbitrarias para strings literais que ocorra no path, por exemplo prefixos de rede longos ou diretórios de desenvolvimento (ex:. Java). Note isto irá desabilita o estilo PWD do fish. ```toml [directory.substitutions] @@ -869,7 +921,7 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an "src/com/long/java/path" = "mypath" ``` -`fish_style_pwd_dir_length` interacts with the standard truncation options in a way that can be surprising at first: if it's non-zero, the components of the path that would normally be truncated are instead displayed with that many characters. For example, the path `/built/this/city/on/rock/and/roll`, which would normally be displayed as as `rock/and/roll`, would be displayed as `/b/t/c/o/rock/and/roll` with `fish_style_pwd_dir_length = 1`--the path components that would normally be removed are displayed with a single character. For `fish_style_pwd_dir_length = 2`, it would be `/bu/th/ci/on/rock/and/roll`. +`fish_style_pwd_dir_length` interage com as opções de truncação padrão de uma forma que pode suprimir no começo: se não for zero, os componentes do path que normalmente seriam truncados são exibidos com todos caracteres. Por exemplo, o caminho `/built/this/city/on/rock/and/roll`, que normalmente seria exibido como`rock/and/roll`, seria exibido como `/b/t/c/o/rock/and/roll` com`fish_style_pwd_dir_length = 1`--os componentes de path que normalmente seriam removidos são exibidos com um único caractere. Para `fish_style_pwd_dir_length = 2`, seria `/bu/th/ci/on/rock/and/roll`.
@@ -877,7 +929,7 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an | Variável | Exemplo | Descrição | | --------- | --------------------- | -------------------------------- | -| path | `"D:/Projects"` | The current directory path | +| path | `"D:/Projects"` | O caminho do diretório atual | | style\* | `"black bold dimmed"` | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo @@ -909,26 +961,26 @@ truncation_symbol = "…/" ## Docker Context -The `docker_context` module shows the currently active [Docker context](https://docs.docker.com/engine/context/working-with-contexts/) if it's not set to `default` or if the `DOCKER_MACHINE_NAME`, `DOCKER_HOST` or `DOCKER_CONTEXT` environment variables are set (as they are meant to override the context in use). +O módulo `docker_context` exibe o [Docker context](https://docs.docker.com/engine/context/working-with-contexts/) ativo atualmente se não estiver definido como `default` ou se as variáveis de ambiente `DOCKER_MACHINE_NAME`, `DOCKER_HOST` ou `DOCKER_CONTEXT` estiverem definidas (iram sobrescrever o contexto atual). ### Opções -| Opções | Padrão | Descrição | -| ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `format` | `"via [$symbol$context]($style) "` | O formato do módulo. | -| `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. | -| `only_with_files` | `true` | Only show when there's a match | -| `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). | -| `detect_files` | `["docker-compose.yml", "docker-compose.yaml", "Dockerfile"]` | Which filenames should trigger this module (needs `only_with_files` to be true). | -| `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). | -| `style` | `"blue bold"` | O estilo do módulo. | -| `disabled` | `false` | Disables the `docker_context` module. | +| Opções | Padrão | Descrição | +| ------------------- | ------------------------------------------------------------- | ------------------------------------------------------------------------------------ | +| `format` | `"via [$symbol$context]($style) "` | O formato do módulo. | +| `symbol` | `"🐳 "` | O simbolo usado antes de exibir a versão do contexto docker. | +| `only_with_files` | `true` | Exibe somente quando houver um arquivo | +| `detect_extensions` | `[]` | Quais extensões devem acionar este módulo (precisa que `only_with_files` seja true). | +| `detect_files` | `["docker-compose.yml", "docker-compose.yaml", "Dockerfile"]` | Quais arquivos devem acionar este módulo (precisa que `only_with_files` seja true). | +| `detect_folders` | `[]` | Quais pastas devem acionar este módulo (precisa que `only_with_files` seja true). | +| `style` | `"blue bold"` | O estilo do módulo. | +| `disabled` | `false` | Desabilita o módulo `docker_context`. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | -------------- | --------------------------------- | -| context | `test_context` | The current docker context | +| context | `test_context` | O contexto atual do docker | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -945,9 +997,9 @@ format = "via [🐋 $context](blue bold)" ## Dotnet -The `dotnet` module shows the relevant version of the [.NET Core SDK](https://dotnet.microsoft.com/) for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. +O módulo `dotnet` exibe a versão relevante do [.NET Core SDK](https://dotnet.microsoft.com/) para a pasta atual. Se o SDK foi fixado na pasta atual, a versão será exibida. Caso contrario será exibida a ultima versão instalada do SDK. -By default this module will only be shown in your prompt when one or more of the following files are present in the current directory: +Por padrão o módulo vai apenas exibir no seu prompt quando um ou mais dos seguintes arquivos estiverem presente no diretório: - `global.json` - `project.json` @@ -958,11 +1010,11 @@ By default this module will only be shown in your prompt when one or more of the - `*.fsproj` - `*.xproj` -You'll also need the .NET Core SDK installed in order to use it correctly. +Você também precisa do .NET Core SDK instalado para usá-lo corretamente. -Internally, this module uses its own mechanism for version detection. Typically it is twice as fast as running `dotnet --version`, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting `heuristic = false` in the module options. +Internamente, este módulo usa seu próprio mecanismo de detecção de versão. Normalmente é duas vezes mais rápido que executar `dotnet --version`, mas pode exibir uma versão errado se o projeto .NET tiver o layout de diretório incomum. Se a precisão é mais importante que velocidade, você pode desabilitar o mecanismo definindo `heuristic = false` nas opções do modulo. -The module will also show the Target Framework Moniker () when there is a csproj file in the current directory. +The module will also show the Target Framework Moniker () when there is a `.csproj` file in the current directory. ### Opções @@ -970,22 +1022,22 @@ The module will also show the Target Framework Moniker ([\\w-]+)/.*" = "$var_cluster" -# Contexts from GKE, AWS and other cloud providers usually carry additional information, like the region/zone. -# The following entry matches on the GKE format (`gke_projectname_zone_cluster-name`) -# and renames every matching kube context into a more readable format (`gke-cluster-name`): +# Contextos do GKE, AWS e outros provedores de nuvem geralmente carregam informações adicionais, como a região/zona. +# A entrada a seguir corresponde ao formato do GKE (`gke_projectname_zone_cluster-name`) +# e renomeia cada contexto kube correspondente em um formato mais legível (`gke-cluster-name`): "gke_.*_(?P[\\w-]+)" = "gke-$var_cluster" ``` -## Line Break +## Quebra de linha -The `line_break` module separates the prompt into two lines. +O módulo `line_break` separa o prompt em duas linhas. ### Opções -| Opções | Padrão | Descrição | -| ---------- | ------- | ------------------------------------------------------------------ | -| `disabled` | `false` | Disables the `line_break` module, making the prompt a single line. | +| Opções | Padrão | Descrição | +| ---------- | ------- | ----------------------------------------------------------------------------------- | +| `disabled` | `false` | Desabilita o módulo `line_break`, fazendo com que o prompt seja em uma unica linha. | ### Exemplo @@ -1977,7 +2027,7 @@ The `localip` module shows the IPv4 address of the primary network interface. | `ssh_only` | `true` | Only show IP address when connected to an SSH session. | | `format` | `"[$localipv4]($style) "` | O formato do módulo. | | `style` | `"bold yellow"` | O estilo do módulo. | -| `disabled` | `true` | Disables the `localip` module. | +| `disabled` | `true` | Desabilita o módulo `localip`. | ### Variáveis @@ -2001,11 +2051,11 @@ disabled = false ## Lua -The `lua` module shows the currently installed version of [Lua](http://www.lua.org/). By default the module will be shown if any of the following conditions are met: +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 current directory contains a `.lua-version` file -- The current directory contains a `lua` directory -- The current directory contains a file with the `.lua` extension +- O diretório atual contém um arquivo `.lua-version` +- O diretório atual contém um diretório `lua` +- O diretório atual tem um arquivo com a extensão `.lua` ### Opções @@ -2013,19 +2063,19 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | | `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. | +| `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"` | Configures the lua binary that Starship executes when getting the version. | -| `disabled` | `false` | Disables the `lua` module. | +| `lua_binary` | `"lua"` | Configura o binário lua que o Starship executa para pegar a versão. | +| `disabled` | `false` | Desabilita o módulo `lua`. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | -------- | --------------------------------- | -| version | `v5.4.0` | The version of `lua` | +| version | `v5.4.0` | A versão do `lua` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -2040,40 +2090,40 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o format = "via [🌕 $version](bold blue) " ``` -## Memory Usage +## Uso de memória -The `memory_usage` module shows current system memory and swap usage. +O módulo `memory_usage` mostra a memória atual do sistema e o uso de troca. -By default the swap usage is displayed if the total system swap is non-zero. +Por padrão o uso do swap é exibido se o total de swap do sistema é diferente de zero. ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +Este módulo é desabilitado por padrão. Para habilitar, defina `disabled` para `false` no seu arquivo de configuração. ::: ### Opções -| 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. | +| 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`. | ### Variáveis -| 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` | +| 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` | -*: 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 +*: 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 ### Exemplo @@ -2089,24 +2139,24 @@ style = "bold dimmed green" ## Mercurial Branch -The `hg_branch` module shows the active branch of the repo in your current directory. +O módulo `hg_branch` exibe o braço atual do repositório no diretório atual. ### Opções -| 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]($style) "` | O formato do módulo. | -| `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. | +| 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`. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | -------- | --------------------------------- | -| branch | `master` | The active mercurial branch | +| branch | `master` | O braço mercurial ativo | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -2125,31 +2175,31 @@ truncation_symbol = "" ## Nim -The `nim` module shows the currently installed version of [Nim](https://nim-lang.org/). By default the module will be shown if any of the following conditions are met: +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 current directory contains a `nim.cfg` file -- The current directory contains a file with the `.nim` extension -- The current directory contains a file with the `.nims` extension -- The current directory contains a file with the `.nimble` extension +- O diretório atual contem um arquivo `nim.cfg` +- O diretório atual tenha um arquivo com a extensão `.nim` +- O diretório atual tenha um arquivo com a extensão `.nims` +- O diretório atual tenha um arquivo com a extensão `.nimble` ### Opções | Opções | Padrão | Descrição | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module | +| `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` | `"👑 "` | The symbol used before displaying the version of Nim. | +| `symbol` | `"👑 "` | O símbolo usado antes de exibir a versão do 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` | Disables the `nim` module. | +| `disabled` | `false` | Desabilita o módulo `nim`. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | -------- | --------------------------------- | -| version | `v1.2.0` | The version of `nimc` | +| version | `v1.2.0` | A versão do `nimc` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -2167,25 +2217,25 @@ symbol = "🎣 " ## 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. +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. ### Opções -| 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. | -| `disabled` | `false` | Disables the `nix_shell` module. | +| 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`. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | ------- | --------------------------------- | -| state | `pure` | The state of the nix-shell | -| name | `lorri` | The name of the nix-shell | +| state | `pure` | O estado do nix-shell | +| name | `lorri` | O nome do nix-shell | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -2205,34 +2255,34 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' ## Node.js -The `nodejs` module shows the currently installed version of [Node.js](https://nodejs.org/). By default the module will be shown if any of the following conditions are met: +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 current directory contains a `package.json` file -- The current directory contains a `.node-version` file -- The current directory contains a `.nvmrc` file -- The current directory contains a `node_modules` directory -- The current directory contains a file with the `.js`, `.mjs` or `.cjs` extension +- O diretório atual contem o arquivo `package.json` +- O diretório atual tenha um arquivo `.node-version` +- O diretório atual tenha um arquivo`.nvmrc` +- O diretório atual tenha um diretório `node_modules` +- O diretório atual tenha um arquivo com a extensão `.js`, `.mjs` or `.cjs` - The current directory contains a file with the `.ts`, `.mts` or `.cts` extension ### Opções -| Opções | Padrão | Descrição | -| ------------------- | ------------------------------------------ | ----------------------------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | -| `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `" "` | A format string representing the symbol of 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. | +| 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 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. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | ---------- | --------------------------------- | -| version | `v13.12.0` | The version of `node` | +| version | `v13.12.0` | A versão do `node` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -2249,14 +2299,14 @@ format = "via [🤖 $version](bold green) " ## OCaml -The `ocaml` module shows the currently installed version of [OCaml](https://ocaml.org/). By default the module will be shown if any of the following conditions are met: +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 current directory contains a file with `.opam` extension or `_opam` directory -- The current directory contains a `esy.lock` directory -- The current directory contains a `dune` or `dune-project` file -- The current directory contains a `jbuild` or `jbuild-ignore` file -- The current directory contains a `.merlin` file -- The current directory contains a file with `.ml`, `.mli`, `.re` or `.rei` extension +- 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` +- O diretório atual tenha um arquivo `dune` or `dune-project` +- O diretório atual tenha um arquivo `jbuild` or `jbuild-ignore` +- O diretório tenha um arquivo `.merlin` +- O diretório atual tenha um arquivo com a extensão `.ml`, `.mli`, `.re` ou `.rei` ### Opções @@ -2264,24 +2314,24 @@ The `ocaml` module shows the currently installed version of [OCaml](https://ocam | ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | | `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | A string de formato do módulo. | | `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"🐫 "` | 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. | +| `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. | | `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` | Disables the `ocaml` module. | +| `disabled` | `false` | Desabilita o módulo `ocaml`. | ### Variáveis -| 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` | +| 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` | *: Esta variável só pode ser usada como parte de uma string de estilo @@ -2296,23 +2346,23 @@ format = "via [🐪 $version]($style) " ## OpenStack -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. +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. ### Opções -| 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. | +| 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`. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | ------- | --------------------------------- | -| cloud | `corp` | The current OpenStack cloud | -| project | `dev` | The current OpenStack project | +| cloud | `corp` | O OpenStack cloud atual | +| project | `dev` | O projeto OpenStack atual | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -2331,24 +2381,24 @@ symbol = "☁️ " ## Package Version -The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards` and `dart` packages. +O módulo `package` é exibido quando o diretório atual é um repositorio para um pacote e exibe sua versão atual. O módulo atualmente suporta pacotes `npm`, `nimble`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards` e `dart`. -- [**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 -- [**Nimble**](https://github.com/nim-lang/nimble) - The `nimble` package version is extracted from the `*.nimble` file present in the current directory with the `nimble dump` command -- [**Poetry**](https://python-poetry.org/) – The `poetry` package version is extracted from the `pyproject.toml` present in the current directory -- [**Python**](https://www.python.org) - The `python` package version is extracted from the `setup.cfg` present in the current directory -- [**Composer**](https://getcomposer.org/) – The `composer` package version is extracted from the `composer.json` present in the current directory -- [**Gradle**](https://gradle.org/) – The `gradle` package version is extracted from the `build.gradle` present -- [**Julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - The package version is extracted from the `Project.toml` present -- [**Mix**](https://hexdocs.pm/mix/) - The `mix` package version is extracted from the `mix.exs` present -- [**Helm**](https://helm.sh/docs/helm/helm_package/) - The `helm` chart version is extracted from the `Chart.yaml` present -- [**Maven**](https://maven.apache.org/) - The `maven` package version is extracted from the `pom.xml` present -- [**Meson**](https://mesonbuild.com/) - The `meson` package version is extracted from the `meson.build` present -- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - The `shards` package version is extracted from the `shard.yml` present -- [**V**](https://vlang.io) - The `vlang` package version is extracted from the `v.mod` present -- [**SBT**](https://scala-sbt.org) - The `sbt` package version is extracted from the `build.sbt` present in the current directory -- [**Dart**](https://pub.dev/) - The `dart` package version is extracted from the `pubspec.yaml` present in the current directory +- [**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 +- [**Nimble**](https://github.com/nim-lang/nimble) - O versionamento de pacotes `nimble` é extraído do arquivo `*.nimble` presente no diretório atual com o comando`nimble dump` +- [**Poetry**](https://python-poetry.org/) – O versionamento de pacotes `poetry` é extraído do arquivo `pyproject.toml` presente no diretório atual +- [**Python**](https://www.python.org) - O versionamento de pacotes `python` é extraído do arquivo `setup.cfg` presente no diretório atual +- [**Composer**](https://getcomposer.org/) – O versionamento de pacotes `composer` é extraído do arquivo`composer.json` presente no diretório atual +- [**Gradle**](https://gradle.org/) – O versionamento de pacotes `gradle` é extraído do arquivo `build.gradle` presente no diretório atual +- [**Julia**](https://docs.julialang.org/en/v1/stdlib/Pkg/) - O versionamento de pacotes é extraído do arquivo `Project.toml` presente no diretório atual +- [**Mix**](https://hexdocs.pm/mix/) - O versionamento de pacotes `mix`é extraído do arquivo `mix.exs` presente no diretório atual +- [**Helm**](https://helm.sh/docs/helm/helm_package/) - O versionamento do gráfico `helm` é extraído do arquivo `Chart.yaml` presente no diretório atual +- [**Maven**](https://maven.apache.org/) - O versionamento de pacotes `maven` é extraído do arquivo`pom.xml` presente no diretório atual +- [**Meson**](https://mesonbuild.com/) - O versionamento de pacotes `meson` é extraído do arquivo`meson.build` presente no diretório atual +- [**Shards**](https://crystal-lang.org/reference/the_shards_command/index.html) - O versionamento de pacotes `shards` é extraído do arquivo `shard.yml` presente no diretório atual +- [**V**](https://vlang.io) - O versionamento de pacotes `vlang` é extraido do arquivo`v.mod` presente no diretório atual +- [**SBT**](https://scala-sbt.org) - O versionamento de pacotes `sbt` pé extraído do arquivo `build.sbt` presente no diretório atual +- [**Dart**](https://pub.dev/) - O versionamento de pacotes `dart` pé extraído do arquivo `pubspec.yaml` presente no diretório atual > ⚠️ A versão exibida é a que esta presente no código fonte do diretório atual e não do gerenciador de pacotes. @@ -2357,17 +2407,17 @@ The `package` module is shown when the current directory is the repository for a | Opções | Padrão | Descrição | | ----------------- | --------------------------------- | ------------------------------------------------------------------------------------ | | `format` | `"is [$symbol$version]($style) "` | O formato do módulo. | -| `symbol` | `"📦 "` | The symbol used before displaying the version the package. | +| `symbol` | `"📦 "` | O simbolo usado antes de exibir a versão do pacote. | | `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | | `style` | `"bold 208"` | O estilo do módulo. | -| `display_private` | `false` | Enable displaying version for packages marked as private. | -| `disabled` | `false` | Disables the `package` module. | +| `display_private` | `false` | Habilita a exibição da versão para os pacotes marcados como privado. | +| `disabled` | `false` | Desabilita o módulo `package`. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | -------- | --------------------------------- | -| version | `v1.0.0` | The version of your package | +| version | `v1.0.0` | A versão do seu pacote | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -2384,13 +2434,13 @@ format = "via [🎁 $version](208 bold) " ## Perl -The `perl` module shows the currently installed version of [Perl](https://www.perl.org/). By default the module will be shown if any of the following conditions are met: +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 current directory contains a `Makefile.PL` or `Build.PL` file -- The current directory contains a `cpanfile` or `cpanfile.snapshot` file -- The current directory contains a `META.json` file or `META.yml` file -- The current directory contains a `.perl-version` file -- The current directory contains a `.pl`, `.pm` or `.pod` +- O diretório atual tanha um aquivo `Makefile.PL` ou `Build.PL` +- O diretório atual tenha um arquivo `cpanfile` ou `cpanfile.snapshot` +- O diretório atual tenha um arquivo `META.json` ou `META.yml` +- O diretório atual tenha um arquivo `.perl-version` +- O diretório atual tenha um `.pl`, `.pm` ou `.pod` ### Opções @@ -2398,18 +2448,18 @@ The `perl` module shows the currently installed version of [Perl](https://www.pe | ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | | `format` | `"via [$symbol($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 Perl | +| `symbol` | `"🐪 "` | O simbolo usado ante de exibir a versão do 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` | Disables the `perl` module. | +| `disabled` | `false` | Desabilita o módulo `perl`. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | --------- | --------------------------------- | -| version | `v5.26.1` | The version of `perl` | +| version | `v5.26.1` | A versão do `perl` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -2424,11 +2474,11 @@ format = "via [🦪 $version]($style) " ## PHP -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: +O módulo `php` exibe a versão atual 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 current directory contains a `composer.json` file -- The current directory contains a `.php-version` file -- The current directory contains a `.php` extension +- O diretório atual contem um arquivo `composer.json` +- O diretório atual tenha um arquivo `.php-version` +- O diretório atual tenha um arquivo com extensão `.php` ### Opções @@ -2436,18 +2486,18 @@ The `php` module shows the currently installed version of [PHP](https://www.php. | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ | | `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` | `"🐘 "` | The symbol used before displaying the version of PHP. | +| `symbol` | `"🐘 "` | O simbolo usado antes de exibir a versão do PHP. | | `detect_extensions` | `["php"]` | Quais extensões devem ativar este módulo. | | `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` | Disables the `php` module. | +| `disabled` | `false` | Desabilita o módulo `php`. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | -------- | --------------------------------- | -| version | `v7.3.8` | The version of `php` | +| version | `v7.3.8` | A versão do `php` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -2468,14 +2518,14 @@ The `pulumi` module shows the current username, selected [Pulumi Stack](https:// ::: tip -By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, [follow the example shown below](#with-pulumi-version). +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 module will be shown if any of the following conditions are met: +Por padrão o módulo vai exibir se uma das condições a seguir for atendida: -- The current directory contains either `Pulumi.yaml` or `Pulumi.yml` -- A parent directory contains either `Pulumi.yaml` or `Pulumi.yml` +- O diretório atual tenha um arquivo `Pulumi.yaml` ou `Pulumi.yml` +- Um diretório pai que tenha um arquivo `Pulumi.yaml` ou `Pulumi.yml` ### Opções @@ -2483,16 +2533,16 @@ By default the module will be shown if any of the following conditions are met: | ---------------- | -------------------------------------------- | ------------------------------------------------------------------------------------ | | `format` | `"via [$symbol($username@)$stack]($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` | `" "` | A format string shown before the Pulumi stack. | +| `symbol` | `" "` | Uma string que é exibida antes do Pulumi stack. | | `style` | `"bold 5"` | O estilo do módulo. | -| `disabled` | `false` | Disables the `pulumi` module. | +| `disabled` | `false` | Desabilita o módulo `pulumi`. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | ---------- | --------------------------------- | -| version | `v0.12.24` | The version of `pulumi` | -| stack | `dev` | The current Pulumi stack | +| version | `v0.12.24` | A versão do `pulumi` | +| stack | `dev` | A stack Pulumi atual | | username | `alice` | The current Pulumi username | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -2521,10 +2571,10 @@ format = "[$symbol$stack]($style) " ## PureScript -The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. By default the module will be shown if any of the following conditions are met: +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 current directory contains a `spago.dhall` file -- The current directory contains a file with the `.purs` extension +- O diretório atual contem um arquivo `spago.dhall` +- O diretório atual tenha um arquivo com a extensão `.purs` ### Opções @@ -2532,18 +2582,18 @@ The `purescript` module shows the currently installed version of [PureScript](ht | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ | | `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` | `"<=> "` | The symbol used before displaying the version of PureScript. | +| `symbol` | `"<=> "` | O simbolo usado antes de exibir a versão do PureScript. | | `detect_extensions` | `["purs"]` | Quais extensões devem ativar este módulo. | | `detect_files` | `["spago.dhall"]` | Quais nomes de arquivos devem ativar este módulo. | | `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | | `style` | `"bold white"` | O estilo do módulo. | -| `disabled` | `false` | Disables the `purescript` module. | +| `disabled` | `false` | Desabilita o módulo `purescript`. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | -------- | --------------------------------- | -| version | `0.13.5` | The version of `purescript` | +| version | `0.13.5` | A versão do `purescript` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -2560,55 +2610,55 @@ format = "via [$symbol$version](bold white)" ## Python -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. +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. -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`. +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`. -By default the module will be shown if any of the following conditions are met: +Por padrão o módulo vai exibir se uma das condições a seguir for atendida: -- The current directory contains a `.python-version` file -- The current directory contains a `Pipfile` file -- The current directory contains a `__init__.py` file -- The current directory contains a `pyproject.toml` file -- The current directory contains a `requirements.txt` file -- The current directory contains a `setup.py` file -- The current directory contains a `tox.ini` file -- The current directory contains a file with the `.py` extension. -- A virtual environment is currently activated +- O diretório atual tenha um arquivo `.python-version` +- O diretório atual tenha um arquivo `Pipfile` +- O diretório atual tenha um arquivo `__init__.py` +- O diretório atual contem um arquivo `pyproject.toml` +- O diretório atual contem um arquivo `requirements.txt` +- O diretório atual contem um arquivo `setup.py` +- O diretório atual contem um arquivo `tox.ini` +- O diretório atual tenha um arquivo com a extensão `.py`. +- Um ambiente virtual está atualmente ativo ### 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` | `"🐍 "` | 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"]` | 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` | Disables the `python` module. | +| 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`. | ::: tip -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. +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 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. +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). Se você não trabalha mais com Python 2, mas não pode remover do sistema o Python 2, alterando este para `"python3"` vai esconder qualquer versão de Python 2, veja o exemplo abaixo. ::: ### Variáveis -| 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 | +| 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` | ### Exemplo @@ -2624,7 +2674,7 @@ pyenv_version_name = true # ~/.config/starship.toml [python] -# Only use the `python3` binary to get the version. +# Apenas use o binário `python3` para pegar a versão. python_binary = "python3" ``` @@ -2632,7 +2682,7 @@ python_binary = "python3" # ~/.config/starship.toml [python] -# Don't trigger for files with the py extension +#Não acione arquivos com a extensão py detect_extensions = [] ``` @@ -2640,24 +2690,24 @@ detect_extensions = [] # ~/.config/starship.toml [python] -# Display the version of python from inside a local venv. +# Exibe a versão do python dentro de um local venv. # -# 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? +# Observe que isso só funcionará quando o venv estiver dentro do projeto e somente +# funcionar no diretório que contém o venv dir mas talvez isso esteja ok? python_binary = ["./venv/bin/python", "python", "python3", "python2"] ``` ## R -The `rlang` module shows the currently installed version of [R](https://www.r-project.org/). The module will be shown if any of the following conditions are met: +O módulo `rlang` exibe a versão atual instalada do [R](https://www.r-project.org/). O módulo vai exibir se algumas das condições a seguir for atendida: -- The current directory contains a file with the `.R` extension. -- The current directory contains a file with the `.Rd` extension. -- The current directory contains a file with the `.Rmd` extension. -- The current directory contains a file with the `.Rproj` extension. -- The current directory contains a file with the `.Rsx` extension. -- The current directory contains a `.Rprofile` file -- The current directory contains a `.Rproj.user` folder +- O diretório atual tenha um arquivo com a extensão `.R`. +- O diretório atual tenha um arquivo com a extensão `.Rd`. +- O diretório atual tenha um arquivo com a extensão `.Rmd`. +- O diretório atual tenha um arquivo com a extensão `.Rproj`. +- O diretório atual tenha um arquivo com a extensão `.Rsx`. +- O diretório atual tenha um arquivo `.Rprofile` +- O diretório atual tenha uma pasta `.Rpoj.user` ### Opções @@ -2665,18 +2715,18 @@ The `rlang` module shows the currently installed version of [R](https://www.r-pr | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | | `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"📐"` | A format string representing the symbol of R. | +| `symbol` | `"📐"` | Uma string que representa o simbolo do R. | | `style` | `"blue bold"` | O estilo do módulo. | -| `detect_extensions` | `["R", "Rd", "Rmd", "Rproj", "Rsx"]` | Which extensions should trigger this module | -| `detect_files` | `[".Rprofile"]` | Which filenames should trigger this module | -| `detect_folders` | `[".Rproj.user"]` | Which folders should trigger this module | -| `disabled` | `false` | Disables the `r` module. | +| `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`. | ### Variáveis | Variável | Exemplo | Descrição | | -------- | ------------- | --------------------------------- | -| version | `v4.0.5` | The version of `R` | +| version | `v4.0.5` | A versão do `R` | | symbol | | Espelha o valor da opção `symbol` | | style | `"blue bold"` | Espelha o valor da opção `style` | @@ -2691,9 +2741,9 @@ format = "with [📐 $version](blue bold) " ## Red -By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). O módulo será mostrado se alguma das seguintes condições for atendida: +Por padrão o módulo `red` exibe a versão atual instalada do [Red](https://www.red-lang.org/). O módulo será mostrado se alguma das seguintes condições for atendida: -- The current directory contains a file with `.red` or `.reds` extension +- O diretório atual contenha um arquivo com a extensão `.red` or `.reds` ### Opções @@ -2701,18 +2751,18 @@ By default the `red` module shows the currently installed version of [Red](https | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | | `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"🔺 "` | A format string representing the symbol of Red. | +| `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` | Disables the `red` module. | +| `disabled` | `false` | Desabilita o módulo `red`. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | -------- | --------------------------------- | -| version | `v2.5.1` | The version of `red` | +| version | `v2.5.1` | A versão do `red` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -2729,14 +2779,14 @@ symbol = "🔴 " ## Ruby -By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). O módulo será mostrado se alguma das seguintes condições for atendida: +Por padrão o módulo `ruby` vai exibir a versão atual instalada do [Ruby](https://www.ruby-lang.org/). O módulo será mostrado se alguma das seguintes condições for atendida: -- The current directory contains a `Gemfile` file -- The current directory contains a `.ruby-version` file -- The current directory contains a `.rb` file -- The environment variables `RUBY_VERSION` or `RBENV_VERSION` are set +- 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 -Starship gets the current Ruby version by running `ruby -v`. +O Starship pega a versão atual do Ruby rodando `ruby -v`. ### Opções @@ -2744,19 +2794,19 @@ Starship gets the current Ruby version by running `ruby -v`. | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | | `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"💎 "` | A format string representing the symbol of Ruby. | +| `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"]` | Which environment variables should trigger this module. | +| `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` | Disables the `ruby` module. | +| `disabled` | `false` | Desabilita o módulo `ruby`. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | -------- | --------------------------------- | -| version | `v2.5.1` | The version of `ruby` | +| version | `v2.5.1` | A versão do `ruby` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -2773,10 +2823,10 @@ symbol = "🔺 " ## Rust -By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). O módulo será mostrado se alguma das seguintes condições for atendida: +Por padrão o módulo `rust` vai exibir a versão atual instalada do [Rust](https://www.rust-lang.org/). O módulo será mostrado se alguma das seguintes condições for atendida: -- The current directory contains a `Cargo.toml` file -- The current directory contains a file with the `.rs` extension +- O diretório atual contem um arquivo `Cargo.toml` +- O diretório atual tenha um arquivo com a extensão `.rs` ### Opções @@ -2784,18 +2834,18 @@ By default the `rust` module shows the currently installed version of [Rust](htt | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | | `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"🦀 "` | A format string representing the symbol of Rust | +| `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` | Disables the `rust` module. | +| `disabled` | `false` | Desabilita o módulo `rust`. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | ----------------- | --------------------------------- | -| version | `v1.43.0-nightly` | The version of `rustc` | +| version | `v1.43.0-nightly` | A versão do `rustc` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -2812,11 +2862,11 @@ format = "via [⚙️ $version](red bold)" ## Scala -The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). By default the module will be shown if any of the following conditions are met: +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 current directory contains a `build.sbt`, `.scalaenv` or `.sbtenv` file -- The current directory contains a file with the `.scala` or `.sbt` extension -- The current directory contains a directory named `.metals` +- 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` +- O diretório atual tenha um diretório chamado `.metals` ### Opções @@ -2827,15 +2877,15 @@ The `scala` module shows the currently installed version of [Scala](https://www. | `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. | +| `symbol` | `"🆂 "` | Uma string que representa o simbolo do Scala. | | `style` | `"red dimmed"` | O estilo do módulo. | -| `disabled` | `false` | Disables the `scala` module. | +| `disabled` | `false` | Desabilita o módulo `scala`. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | -------- | --------------------------------- | -| version | `2.13.5` | The version of `scala` | +| version | `2.13.5` | A versão do `scala` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -2852,39 +2902,39 @@ symbol = "🌟 " ## Shell -The `shell` module shows an indicator for currently used shell. +O módulo de `shell` exibe um indicador para o shell que esta sendo usado. ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +Este módulo é desabilitado por padrão. Para habilitar, defina `disabled` para `false` no seu arquivo de configuração. ::: ### Opções -| 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. | +| 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` | A format string used to represent 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`. | ### Variáveis -| Variável | Padrão | Descrição | -| --------- | ------ | ---------------------------------------------------------- | -| indicator | | Mirrors the value of `indicator` for currently used shell. | -| style\* | | Mirrors the value of option `style`. | +| 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`. | *: Esta variável só pode ser usada como parte de uma string de estilo @@ -2903,24 +2953,24 @@ disabled = false ## SHLVL -The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold. +O módulo `shlvl` exibe o atual [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ("shell level") variável de ambiente, se estiver definido um número e coincidir ou exceder o limite especificado. ### Opções -| 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. | +| 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`. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | ------- | --------------------------------- | -| shlvl | `3` | The current value of `SHLVL` | +| shlvl | `3` | O valor atual do `SHLVL` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -2939,22 +2989,22 @@ threshold = 3 ## Singularidade -The `singularity` module shows the current [Singularity](https://sylabs.io/singularity/) image, if inside a container and `$SINGULARITY_NAME` is set. +O módulo `singularity` exibe a imagem atual do [Singularity](https://sylabs.io/singularity/), se dentro de um contêiner e definido `$SINGULARITY_NAME`. ### Opções -| 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. | +| 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`. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | ------------ | --------------------------------- | -| env | `centos.img` | The current Singularity image | +| env | `centos.img` | A imagem atual do Singularity | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -2969,13 +3019,46 @@ The `singularity` module shows the current [Singularity](https://sylabs.io/singu format = '[📦 \[$env\]]($style) ' ``` +## Spack + +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` | 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` | The current spack environment | +| 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 + +[spack] +format = "[$symbol$environment](dimmed blue) " +``` + ## Status -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. +O módulo `status` exibe o código de saída do comando anterior. If $success_symbol is empty (default), the module will be shown only if the exit code is not `0`. The status code will cast to a signed 32-bit integer. ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +Este módulo é desabilitado por padrão. Para habilitar, defina `disabled` para `false` no seu arquivo de configuração. ::: @@ -2984,34 +3067,34 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | Opções | Padrão | Descrição | | ----------------------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------- | | `format` | `"[$symbol$status]($style) "` | O formato do módulo | -| `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 | +| `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 | | `style` | `"bold red"` | O estilo do 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 | +| `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 | | `pipestatus_separator` | `|` | | -| `pipestatus_format` | `\\[$pipestatus\\] => [$symbol$common_meaning$signal_name$maybe_int]($style)` | The format of the module when the command is a pipeline | -| `disabled` | `true` | Disables the `status` module. | +| `pipestatus_format` | `\\[$pipestatus\\] => [$symbol$common_meaning$signal_name$maybe_int]($style)` | O formato do módulo quando o comando é um pipeline | +| `disabled` | `true` | Desabilita o módulo `status`. | ### Variáveis -| 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` | +| 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` | *: Esta variável só pode ser usada como parte de uma string de estilo @@ -3031,23 +3114,23 @@ disabled = false ## Sudo -The `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached. +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. ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +Este módulo é desabilitado por padrão. Para habilitar, defina `disabled` para `false` no seu arquivo de configuração. ::: ### Opções -| Opções | Padrão | Descrição | -| --------------- | ----------------------- | ------------------------------------------------------- | -| `format` | `[as $symbol]($style)"` | O formato do módulo | -| `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. | +| 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`. | ### Variáveis @@ -3070,7 +3153,7 @@ disabled = false ``` ```toml -# On windows +# No windows # $HOME\.starship\config.toml [sudo] @@ -3080,10 +3163,10 @@ disabled = false ## Swift -By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). O módulo será mostrado se alguma das seguintes condições for atendida: +Por padrão o módulo `swift` vai exibir a versão atual instalada do [Swift](https://swift.org/). O módulo será mostrado se alguma das seguintes condições for atendida: -- The current directory contains a `Package.swift` file -- The current directory contains a file with the `.swift` extension +- O diretório atual tenha um arquivo `Package.swift` +- O diretório atual tenha um arquivo com a extensão `.swift` ### Opções @@ -3091,18 +3174,18 @@ By default the `swift` module shows the currently installed version of [Swift](h | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | | `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | +| `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` | Disables the `swift` module. | +| `disabled` | `false` | Desabilita o módulo `swift`. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | -------- | --------------------------------- | -| version | `v5.2.4` | The version of `swift` | +| version | `v5.2.4` | A versão do `swift` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -3119,18 +3202,18 @@ format = "via [🏎 $version](red bold)" ## Terraform -The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. +O módulo `terraform` exibe o [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) selecionado e sua versão. ::: tip -By default the Terraform version is not shown, since this is slow for current versions of Terraform when a lot of plugins are in use. If you still want to enable it, [follow the example shown below](#with-terraform-version). +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 module will be shown if any of the following conditions are met: +Por padrão o módulo vai exibir se uma das condições a seguir for atendida: -- The current directory contains a `.terraform` folder -- Current directory contains a file with the `.tf`, `.tfplan` or `.tfstate` extensions +- O diretório atual tenha uma pasta `.terraform` +- O diretório atual tenha arquivos com as extensões `.tf`, `.tfplan` or `.tfstate` ### Opções @@ -3138,19 +3221,19 @@ By default the module will be shown if any of the following conditions are met: | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ | | `format` | `"via [$symbol$workspace]($style) "` | A string de formato do módulo. | | `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"💠"` | A format string shown before the terraform workspace. | +| `symbol` | `"💠"` | Uma string que é exibida antes do workspace terraform. | | `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` | Disables the `terraform` module. | +| `disabled` | `false` | Desabilita o módulo `terraform`. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | ---------- | --------------------------------- | -| version | `v0.12.24` | The version of `terraform` | -| workspace | `default` | The current Terraform workspace | +| version | `v0.12.24` | A versão do `terraform` | +| workspace | `default` | O workspace atual do Terraform | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -3178,33 +3261,33 @@ format = "[🏎💨 $workspace]($style) " ## Horário -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. +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. ::: tip -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +Este módulo é desabilitado por padrão. Para habilitar, defina `disabled` para `false` no seu arquivo de configuração. ::: ### Opções -| 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 | +| 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 | -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. +Se `use_12hr` é `true`, então `time_format` tem o padrão `"%r"`. Caso contrário, o padrão é `"%T"`. Ajustes manuais no `time_format` irão sobrescrever a configuração `use_12hr`. ### Variáveis | Variável | Exemplo | Descrição | | --------- | ---------- | -------------------------------- | -| time | `13:08:10` | The current time. | +| time | `13:08:10` | A hora atual. | | style\* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo @@ -3224,35 +3307,35 @@ time_range = "10:00:00-14:00:00" ## Username -The `username` module shows active user's username. O módulo será mostrado se alguma das seguintes condições for atendida: +O módulo `username` exibe o username do usuário ativo. O módulo será mostrado se alguma das seguintes condições for atendida: -- The current user is root -- The current user isn't the same as the one that is logged in -- The user is currently connected as an SSH session -- The variable `show_always` is set to true +- The current user is root/admin +- O usuário atual não é o mesmo que está logado +- O usuário atual esta conectado em uma sessão SSH +- A variável `show_always` esta definida como true ::: tip -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. +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. ::: ### Opções -| Opções | Padrão | Descrição | -| ------------- | ----------------------- | ------------------------------------- | -| `style_root` | `"bold red"` | The style used when the user is root. | -| `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. | +| Opções | Padrão | Descrição | +| ------------- | ----------------------- | ------------------------------------------- | +| `style_root` | `"bold red"` | The style used when the user is root/admin. | +| `style_user` | `"bold yellow"` | O estilo usado para usuários não root. | +| `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`. | ### Variáveis -| 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. | +| 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` | `"matchai"` | O ID do usuário logado atualmente. | ### Exemplo @@ -3269,9 +3352,9 @@ show_always = true ## Vagrant -The `vagrant` module shows the currently installed version of [Vagrant](https://www.vagrantup.com/). By default the module will be shown if any of the following conditions are met: +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 current directory contains a `Vagrantfile` file +- O diretório atual contem um arquivo `Vagrantfile` ### Opções @@ -3279,18 +3362,18 @@ The `vagrant` module shows the currently installed version of [Vagrant](https:// | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | | `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | +| `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` | Disables the `vagrant` module. | +| `disabled` | `false` | Desabilita o módulo `vagrant`. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | ---------------- | --------------------------------- | -| version | `Vagrant 2.2.10` | The version of `Vagrant` | +| version | `Vagrant 2.2.10` | A versão do `Vagrant` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -3307,10 +3390,10 @@ format = "via [⍱ $version](bold white) " ## V -The `vlang` module shows you your currently installed version of [V](https://vlang.io/). By default the module will be shown if any of the following conditions are met: +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 current directory contains a file with `.v` extension -- The current directory contains a `v.mod`, `vpkg.json` or `.vpkg-lock.json` file +- 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` ### Opções @@ -3318,18 +3401,18 @@ The `vlang` module shows you your currently installed version of [V](https://vla | ------------------- | -------------------------------------------- | ------------------------------------------------------------------------------------ | | `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` | `"V "` | A format string representing the symbol of V | +| `symbol` | `"V "` | Um formato de string que representa o simbolo do 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` | Disables the `vlang` module. | +| `disabled` | `false` | Desabilita o módulo `vlang`. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | ------- | --------------------------------- | -| version | `v0.2` | The version of `v` | +| version | `v0.2` | A versão do `v` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -3343,22 +3426,22 @@ format = "via [V $version](blue bold) " ## VCSH -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. +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. ### Opções | Opções | Padrão | Descrição | | ---------- | -------------------------------- | ------------------------------------------------------ | -| `symbol` | | The symbol used before displaying the repository name. | +| `symbol` | | O simbolo usado antes de exibir o nome do repositório. | | `style` | `"bold yellow"` | O estilo do módulo. | | `format` | `"vcsh [$symbol$repo]($style) "` | O formato do módulo. | -| `disabled` | `false` | Disables the `vcsh` module. | +| `disabled` | `false` | Desabilita o módulo `vcsh`. | ### Variáveis | Variável | Exemplo | Descrição | | --------- | ------------------------------------------- | --------------------------------- | -| repo | `dotfiles` if in a VCSH repo named dotfiles | The active repository name | +| repo | `dotfiles` if in a VCSH repo named dotfiles | O nome do repositório ativo | | symbol | | Espelha o valor da opção `symbol` | | style\* | `black bold dimmed` | Espelha o valor da opção `style` | @@ -3375,9 +3458,9 @@ format = "[🆅 $repo](bold blue) " ## Zig -By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). O módulo será mostrado se alguma das seguintes condições for atendida: +Por padrão o módulo `zig` exibe a versão atual instalada do [Zig](https://ziglang.org/). O módulo será mostrado se alguma das seguintes condições for atendida: -- The current directory contains a `.zig` file +- O diretório atual contém arquivo com a extensão `.zig` ### Opções @@ -3385,9 +3468,9 @@ By default the the `zig` module shows the currently installed version of [Zig](h | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ | | `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` | `"↯ "` | The symbol used before displaying the version of Zig. | +| `symbol` | `"↯ "` | O simbolo usado antes de exibir a versão do Zig. | | `style` | `"bold yellow"` | O estilo do módulo. | -| `disabled` | `false` | Disables the `zig` module. | +| `disabled` | `false` | Desabilita o módulo `zig`. | | `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. | @@ -3396,7 +3479,7 @@ By default the the `zig` module shows the currently installed version of [Zig](h | Variável | Exemplo | Descrição | | --------- | -------- | --------------------------------- | -| version | `v0.6.0` | The version of `zig` | +| version | `v0.6.0` | A versão do `zig` | | symbol | | Espelha o valor da opção `symbol` | | style\* | | Espelha o valor da opção `style` | @@ -3411,97 +3494,99 @@ By default the the `zig` module shows the currently installed version of [Zig](h symbol = "⚡️ " ``` -## Custom commands +## Comandos Personalizados -The `custom` modules show the output of some arbitrary commands. +O módulo `custom` exibe a saída de alguns comandos arbitrários. -These modules will be shown if any of the following conditions are met: +Este módulo vai ser exibir se algumas das condições a seguir for atendida: -- The current directory contains a file whose name is in `files` -- The current directory contains a directory whose name is in `directories` -- The current directory contains a file whose extension is in `extensions` -- The `when` command returns 0 -- The current Operating System (std::env::consts::OS) matchs with `os` field if defined. +- The current directory contains a file whose name is in `detect_files` +- The current directory contains a directory whose name is in `detect_folders` +- The current directory contains a file whose extension is in `detect_extensions` +- O comando `when` retorna 0 +- O sistema operacional (std::env::consts::OS) corresponde com o `os` se definido. ::: tip -Multiple custom modules can be defined by using a `.`. +Vários módulos personalizados podem ser definidos usando `.`. ::: ::: tip -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. +A ordem em que o módulo custom é exibido pode ser definido individualmente incluindo `${custom.foo}` em nilve superior `format` (pois inclui um ponto, você precisa usar `${...}`). Por padrão, o módulo `custom` mostrará todos os módulos personalizados na ordem em que eles foram definidos. ::: ::: tip -[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! +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! ::: -::: warning Command output is printed unescaped to the prompt +::: warning A saída do comando é exibido unescaped no prompt -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. +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. -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). +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). ::: ### Opções -| 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` | | A shell command used as a condition to show the module. 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`. | -| `files` | `[]` | The files that will be searched in the working directory for a match. | -| `directories` | `[]` | The directories that will be searched in the working directory for a match. | -| `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). | +| 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` | Either a boolean value (`true` or `false`, without quotes) or a string shell command used as a condition to show the module. In case of a string, the module will be shown if the command returns a `0` status code. | +| `shell` | | [Veja abaixo](#custom-command-shell) | +| `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` | | 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 | The output of shell command in `shell` | -| symbol | Espelha o valor da opção `symbol` | -| style\* | Espelha o valor da opção `style` | +| 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` | *: Esta variável só pode ser usada como parte de uma string de estilo #### Comandos personalizados de shell -`shell` accepts a non-empty list of strings, where: +`shell` aceita uma lista não vazia de string, onde: -- The first string is the path to the shell to use to execute the command. -- Other following arguments are passed to the shell. +- 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. +Se não definido, ele retornará para o STARSHIP_SHELl e então para o "sh" no Linux e "cmd/C" no Windows. -The `command` will be passed in on stdin. +O `command` será passado no stdin. -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 -`. This behavior can be avoided by explicitly passing arguments to the shell, e.g. +Se o `shell` não for dado ou apenas conter um elemento e o Starship detectar PowerShell ele será usado, os seguintes argumentos serão automaticamente adicionados: `-NoProfile -Command -`. 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 Make sure your custom shell configuration exits gracefully +::: warning Tenha certeza que tenha uma configuração de 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). +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). -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. +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. -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. +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. -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. +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. ::: @@ -3512,12 +3597,18 @@ Automatic detection of shells and proper parameters addition are currently imple [custom.foo] command = "echo foo" # shows output of command -files = ["foo"] # can specify filters but wildcards are not supported +detect_files = ["foo"] # can specify filters but wildcards are not supported when = """ test "$HOME" == "$PWD" """ format = " transcending [$output]($style)" [custom.time] command = "time /T" -extensions = ["pst"] # filters *.pst files +detect_extensions = ["pst"] # filters *.pst files shell = ["pwsh.exe", "-NoProfile", "-Command", "-"] + +[custom.time-as-arg] +command = "time /T" +detect_extensions = ["pst"] # filters *.pst files +shell = ["pwsh.exe", "-NoProfile", "-Command"] +use_stdin = false ``` diff --git a/docs/pt-BR/faq/README.md b/docs/pt-BR/faq/README.md index 23522422..6f502999 100644 --- a/docs/pt-BR/faq/README.md +++ b/docs/pt-BR/faq/README.md @@ -1,4 +1,4 @@ -# Frequently Asked Questions +# Perguntas Frequentes ## Qual é a configuração usada no GIF de demonstração? diff --git a/docs/pt-BR/guide/README.md b/docs/pt-BR/guide/README.md index 4ab0a2d8..17581155 100644 --- a/docs/pt-BR/guide/README.md +++ b/docs/pt-BR/guide/README.md @@ -145,7 +145,7 @@ Starship with iTerm2 and the Snazzy theme @@ -160,7 +160,7 @@ - **Fácil:**Instalação rápida – comece a usar em minutos.

-Explore the Starship docs  ▶ +Consulte a documentação  ▶

@@ -173,12 +173,12 @@ ### 1º passo. Instalar o Starship -Select your operating system from the list below to view installation instructions: +Selecione seu sistema operacional na lista abaixo para ver as instruções de instalação:
Android -Install Starship using any of the following package managers: +Instale o Starship usando qualquer um dos seguintes gerenciadores de pacotes: | Repositório | Instruções | | --------------------------------------------------------------------------------- | ---------------------- | @@ -189,7 +189,7 @@ Install Starship using any of the following package managers:
BSD -Install Starship using any of the following package managers: +Instale o Starship usando qualquer um dos seguintes gerenciadores de pacotes: | Distribuição | Repositório | Instruções | | -------------- | -------------------------------------------------------- | --------------------------------- | @@ -202,13 +202,13 @@ Install Starship using any of the following package managers:
Linux -Install the latest version for your system: +Instale a versão mais recente no seu sistema: ```sh curl -sS https://starship.rs/install.sh | sh ``` -Alternatively, install Starship using any of the following package managers: +Ou instale o Starship usando qualquer um dos seguintes gerenciadores de pacotes: | Distribuição | Repositório | Instruções | | ------------------ | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | @@ -231,13 +231,13 @@ Alternatively, install Starship using any of the following package managers:
macOS -Install the latest version for your system: +Instale a versão mais recente no seu sistema: ```sh curl -sS https://starship.rs/install.sh | sh ``` -Alternatively, install Starship using any of the following package managers: +Ou instale o Starship usando qualquer um dos seguintes gerenciadores de pacotes: | Repositório | Instruções | | -------------------------------------------------------- | --------------------------------------- | @@ -251,7 +251,7 @@ Alternatively, install Starship using any of the following package managers:
Windows -Install Starship using any of the following package managers: +Instale o Starship usando qualquer um dos seguintes gerenciadores de pacotes: | Repositório | Instruções | | -------------------------------------------------------------------------------- | --------------------------------------- | @@ -264,7 +264,7 @@ Install Starship using any of the following package managers: ### 2º passo. Configure seu shell para usar o Starship -Configure your shell to initialize starship. Select yours from the list below: +Configure seu shell para inicializar o starship. Selecione o seu na lista abaixo:
Bash @@ -280,7 +280,7 @@ eval "$(starship init bash)"
Cmd -Você precisa do [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) com Cmd. Create a file at this path `%LocalAppData%\clink\starship.lua` with the following contents: +Você precisa do [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) com Cmd. Crie um arquivo neste caminho `%LocalAppData%\clink\starship.lua` com o seguinte conteúdo: ```lua load(io.popen('starship init cmd'):read("*a"))() @@ -297,7 +297,7 @@ Adicione o comando a seguir ao final do arquivo `~/.elvish/rc.elv`: eval (starship init elvish) ``` -Note: Only Elvish v0.17+ is supported +Nota: Somente Elvish v0.18+ é suportado
@@ -347,7 +347,7 @@ Note: Only Nushell v0.60+ is supported
PowerShell -Add the following to the end of your PowerShell configuration (find it by running `$PROFILE`): +Adicione o seguinte no final da sua configuração PowerShell (encontre executando `$PROFILE`): ```powershell Invoke-Expression (&starship init powershell) @@ -390,9 +390,9 @@ eval "$(starship init zsh)" ### 3º passo. Configurar o Starship -Start a new shell instance, and you should see your beautiful new shell prompt. If you're happy with the defaults, enjoy! +Inicie uma nova instância de shell e você deverá ver seu belo novo prompt de shell. Se você estiver feliz com as configurações padrões, aproveite! -If you're looking to further customize Starship: +Se você estiver procurando personalizar ainda mais a Starship: - **[Configuração](https://starship.rs/config/)** – saiba como configurar o Starship para ajustar seu prompt ao seu gosto @@ -400,15 +400,15 @@ If you're looking to further customize Starship: ## 🤝 Contribuindo -We are always looking for contributors of **all skill levels**! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). +Nós estamos sempre procurando contribuidores de **todos os níveis de conhecimento**! Se você está buscando um caminho mais fácil para começar no projeto, veja essas [boas issues para começar](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). -If you are fluent in a non-English language, we greatly appreciate any help keeping our docs translated and up-to-date in other languages. If you would like to help, translations can be contributed on the [Starship Crowdin](https://translate.starship.rs/). +Se você é fluente em uma linguá não inglesa, nos ficaríamos gratos por qualquer ajuda em manter nossas documentações traduzidas e atualizadas em outras linguás. Se você deseja ajudar nas traduções, você pode contribuir no [Crowdin do Starship](https://translate.starship.rs/). -If you are interested in helping contribute to starship, please take a look at our [Contributing Guide](https://github.com/starship/starship/blob/master/CONTRIBUTING.md). Also, feel free to drop into our [Discord server](https://discord.gg/8Jzqu3T) and say hi. 👋 +Se você está interessado em ajudar contribuindo com o projeto, dê uma olhada no nosso [Guia de Contribuição](https://github.com/starship/starship/blob/master/CONTRIBUTING.md). Além disso, sinta-se à vontade para entrar no nosso [servidor no Discord](https://discord.gg/8Jzqu3T) e dizer oi. 👋 ## 💭 Inspirado por -Please check out these previous works that helped inspire the creation of starship. 🙏 +Por favor, confira estes projetos anteriores que ajudaram a inspirar a criação do startship. 🙏 - **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** – Um prompt ZSH para astronautas. @@ -418,9 +418,9 @@ Please check out these previous works that helped inspire the creation of starsh


- Starship rocket icon + Ícone de foguete do Starship

## 📝 Licença -Copyright © 2019-present, [Starship Contributors](https://github.com/starship/starship/graphs/contributors).
This project is [ISC](https://github.com/starship/starship/blob/master/LICENSE) licensed. +Todos os direitos reservados © 2019-Presente, [Contribuidores Starship](https://github.com/starship/starship/graphs/contributors).
Este projeto está licenciado pelo [ISC](https://github.com/starship/starship/blob/master/LICENSE). diff --git a/docs/pt-BR/installing/README.md b/docs/pt-BR/installing/README.md index fb18a784..fef3543a 100644 --- a/docs/pt-BR/installing/README.md +++ b/docs/pt-BR/installing/README.md @@ -1,4 +1,4 @@ -# Advanced Installation +# Instalação Avançada Para instalar o starship, você precisa de duas coisas: diff --git a/docs/pt-BR/migrating-to-0.45.0/README.md b/docs/pt-BR/migrating-to-0.45.0/README.md index 9a9e1872..eb24a566 100644 --- a/docs/pt-BR/migrating-to-0.45.0/README.md +++ b/docs/pt-BR/migrating-to-0.45.0/README.md @@ -1,4 +1,4 @@ -# Migrando para V0.45.0 +# Migrando para v0.45.0 Starship v0.45.0 é o lançamento com grandes mudanças, em preparação para a grande versão v1.0.0. Nos fizemos algumas grandes mudanças em como é feita as configurações do prompt. para aceitar uma customização maior. diff --git a/docs/pt-BR/presets/README.md b/docs/pt-BR/presets/README.md index 5c9cd20a..e097f5fc 100644 --- a/docs/pt-BR/presets/README.md +++ b/docs/pt-BR/presets/README.md @@ -1,41 +1,41 @@ -# Configurações +# Personalizações -Aqui tem uma coleção de predefinições de configuração criadas pela comunidade de Starship. Se você tem uma configuração para compartilhar, por favor, [envie uma PR](https://github.com/starship/starship/edit/master/docs/presets/README.md) atualizando este arquivo! 😊 +Aqui tem uma coleção de personalizações desenvolvidas pela comunidade para usar com Starship. Se você tem uma personalização para compartilhar, por favor, [envie uma PR](https://github.com/starship/starship/edit/master/docs/presets/README.md) atualizando este arquivo! 😊 -To get details on how to use a preset, simply click on the image. +Para mais detalhes sobre como usar uma personalização, clique na imagem. ## [Símbolos Nerd Font](./nerd-font.md) -This preset changes the symbols for each module to use Nerd Font symbols. +Essa personalização altera os símbolos para cada módulo usar Nerd Font. -[![Captura de tela da predefinição Nerd Font Symbols](/presets/img/nerd-font-symbols.png "Click to view Nerd Font Symbols preset")](./nerd-font) +[![Captura de tela da personalização com símbolos usando Nerd Font](/presets/img/nerd-font-symbols.png "Clique para ver as personalizações para Nerd Font")](./nerd-font) ## [Seguimentos entre colchetes](./bracketed-segments.md) -Está configuração altera o formato de todos os módulos integrados para que usem colchetes ao mostrar o seguimento ao invés de usar texto padrão do Starship ("via", "on", etc.). +Está personalização altera o formato de todos os módulos integrados para que usem colchetes ao mostrar o seguimento ao invés de usar texto convencional do Starship ("via", "on", etc.). -[![Captura de tela de segmentos predefinidos](/presets/img/bracketed-segments.png "Click to view Bracketed Segments preset")](./bracketed-segments) +[![Captura de tela de segmentos predefinidos](/presets/img/bracketed-segments.png "Clique para ver as personalizações de seguimentos entre colchetes")](./bracketed-segments) ## [Símbolos de texto simples](./plain-text.md) -This preset changes the symbols for each module into plain text. Great if you don't have access to Unicode. +Essa personalização converte os símbolos para cada módulo em texto simples. Importante para quando não tiver suporte para caracteres Unicode. -[![Captura de tela da predefinição de símbolos de texto simples](/presets/img/plain-text-symbols.png "Click to view Plain Text Symbols preset")](./plain-text) +[![Captura de tela de personalização de símbolos de texto simples](/presets/img/plain-text-symbols.png "Clique para ver as personalizações para símbolos de texto simples")](./plain-text) -## [No Runtime Versions](./no-runtimes.md) +## [Runtime Ausente](./no-runtimes.md) Está predefinição oculta a versão do runtime da linguagem. Se você trabalha com containers ou ambientes virtualizados, este é para você! -[![Captura de tela de ajustes de ocultar versão de runtime](/presets/img/no-runtime-versions.png "Click to view No Runtime Versions preset")](./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) -## [Pure Prompt](./pure-preset.md) +## [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 configuração emulando Pure](/presets/img/pure-preset.png "Click to view Pure Prompt preset")](./pure-preset) +[![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) ## [Pastel Powerline](./pastel-powerline.md) -This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). It also shows how path substitution works in starship. +Esta personalização é inspirada em [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). Mostra também como a substituição de segmentos do caminho completo do diretório funciona no starship. -[![Screenshot of Pastel Powerline preset](/presets/img/pastel-powerline.png "Click to view Pure Prompt preset")](./pastel-powerline) +[![Capture de tela das personalizações com Pastel Powerline](/presets/img/pastel-powerline.png "Clique para ver as personalização para usar no prompt do terminal com Pure")](./pastel-powerline) diff --git a/docs/pt-BR/presets/bracketed-segments.md b/docs/pt-BR/presets/bracketed-segments.md index f767fdb3..cd0c0091 100644 --- a/docs/pt-BR/presets/bracketed-segments.md +++ b/docs/pt-BR/presets/bracketed-segments.md @@ -1,13 +1,13 @@ -[Return to Presets](./README.md#bracketed-segments) +[Retornar para Personalizações](./README.md#bracketed-segments) -# Bracketed Segments Preset +# Predefinições entre colchetes -Está configuração altera o formato de todos os módulos integrados para que usem colchetes ao mostrar o seguimento ao invés de usar texto padrão do Starship ("via", "on", etc.). +Esta configuração altera o formato de todos os módulos internos para mostrar seus respectivos segmentos entre colchetes em vez de usar o texto convencional do Starship ("via", "on", etc.). ![Captura de tela de segmentos predefinidos](/presets/img/bracketed-segments.png) ### Configuração -[Click to download TOML](/presets/toml/bracketed-segments.toml) +[Clique para baixar o TOML](/presets/toml/bracketed-segments.toml) <<< @/.vuepress/public/presets/toml/bracketed-segments.toml diff --git a/docs/pt-BR/presets/nerd-font.md b/docs/pt-BR/presets/nerd-font.md index 7e751610..4b5096e9 100644 --- a/docs/pt-BR/presets/nerd-font.md +++ b/docs/pt-BR/presets/nerd-font.md @@ -1,8 +1,8 @@ -[Return to Presets](./README.md#nerd-font-symbols) +[Retornar para Personalizações](./README.md#nerd-font-symbols) -# Nerd Font Symbols Preset +# Símbolos Nerd Font -This preset changes the symbols for each module to use Nerd Font symbols. +Essa predefinição altera os símbolos para cada módulo usar símbolos com Nerd Font. ![Captura de tela da predefinição Nerd Font Symbols](/presets/img/nerd-font-symbols.png) @@ -12,6 +12,6 @@ This preset changes the symbols for each module to use Nerd Font symbols. ### Configuração -[Click to download TOML](/presets/toml/nerd-font-symbols.toml) +[Clique para baixar o TOML](/presets/toml/nerd-font-symbols.toml) <<< @/.vuepress/public/presets/toml/nerd-font-symbols.toml diff --git a/docs/pt-BR/presets/no-runtimes.md b/docs/pt-BR/presets/no-runtimes.md index 60d66062..af8d200a 100644 --- a/docs/pt-BR/presets/no-runtimes.md +++ b/docs/pt-BR/presets/no-runtimes.md @@ -1,13 +1,13 @@ -[Return to Presets](./README.md#no-runtime-versions) +[Retornar para Predefinições](./README.md#no-runtime-versions) -# No Runtime Versions Preset +# Remover versão do runtime -Está predefinição oculta a versão do runtime da linguagem. Se você trabalha com containers ou ambientes virtualizados, este é para você! +Está personalização oculta a versão do runtime da linguagem. Se você trabalha com containers ou ambientes virtualizados, este é para você! ![Captura de tela de ajustes de ocultar versão de runtime](/presets/img/no-runtime-versions.png) ### Configuração -[Click to download TOML](/presets/toml/no-runtime-versions.toml) +[Clique para baixar o TOML](/presets/toml/no-runtime-versions.toml) <<< @/.vuepress/public/presets/toml/no-runtime-versions.toml diff --git a/docs/pt-BR/presets/pastel-powerline.md b/docs/pt-BR/presets/pastel-powerline.md index 40f08d6d..6d7bca56 100644 --- a/docs/pt-BR/presets/pastel-powerline.md +++ b/docs/pt-BR/presets/pastel-powerline.md @@ -1,17 +1,17 @@ -[Return to Presets](./README.md#pastel-powerline) +[Retornar para Predefinições](./README.md#pastel-powerline) -# Pastel Powerline Preset +# Pastel Powerline -This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). It also shows how path substitution works in starship. +Esta personalização é inspirada em [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). Mostra também como a substituição de segmentos do caminho completo do diretório funciona no starship. -![Screenshot of Pastel Powerline preset](/presets/img/pastel-powerline.png) +![Screenshot do preset Pastel Powerline](/presets/img/pastel-powerline.png) ### Pré-requisitos -- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (the example uses Caskaydia Cove Nerd Font) +- Uma [Nerd Font](https://www.nerdfonts.com/) instalada e funcionando no seu terminal (o exemplo utiliza Fira Code Nerd Font) ### Configuração -[Click to download TOML](/presets/toml/pastel-powerline.toml) +[Clique para baixar o TOML](/presets/toml/pastel-powerline.toml) <<< @/.vuepress/public/presets/toml/pastel-powerline.toml diff --git a/docs/pt-BR/presets/plain-text.md b/docs/pt-BR/presets/plain-text.md index b0f57986..195a45ce 100644 --- a/docs/pt-BR/presets/plain-text.md +++ b/docs/pt-BR/presets/plain-text.md @@ -1,13 +1,13 @@ -[Return to Presets](./README.md#plain-text-symbols) +[Retornar para Personalizações](./README.md#plain-text-symbols) -## Plain Text Symbols Preset +## Personalização de símbolos de texto simples -This preset changes the symbols for each module into plain text. Great if you don't have access to Unicode. +Essa personalização converte os símbolos para cada módulo em texto simples. Importante para quando não tiver suporte para caracteres Unicode. ![Captura de tela da predefinição de símbolos de texto simples](/presets/img/plain-text-symbols.png) ### Configuração -[Click to download TOML](/presets/toml/plain-text-symbols.toml) +[Clique para baixar o TOML](/presets/toml/plain-text-symbols.toml) <<< @/.vuepress/public/presets/toml/plain-text-symbols.toml diff --git a/docs/pt-BR/presets/pure-preset.md b/docs/pt-BR/presets/pure-preset.md index 6246c1e5..f0b63373 100644 --- a/docs/pt-BR/presets/pure-preset.md +++ b/docs/pt-BR/presets/pure-preset.md @@ -1,13 +1,13 @@ -[Return to Presets](./README.md#pure) +[Retornar para Personalizações](./README.md#pure) -# Pure Preset +# Personalização do prompt do terminal com Pure -Essa configuração simula a aparência e o comportamento do [Pure](https://github.com/sindresorhus/pure). +Essa personalização simula o comportamento e aparência do [Pure](https://github.com/sindresorhus/pure). ![Captura de tela da configuração emulando Pure](/presets/img/pure-preset.png) ### Configuração -[Click to download TOML](/presets/toml/pure-preset.toml) +[Clique para baixar o TOML](/presets/toml/pure-preset.toml) <<< @/.vuepress/public/presets/toml/pure-preset.toml diff --git a/docs/pt-PT/README.md b/docs/pt-PT/README.md index 3cd24a56..460fa439 100644 --- a/docs/pt-PT/README.md +++ b/docs/pt-PT/README.md @@ -120,7 +120,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p #### Elvish - ::: warning Only elvish v0.17 or higher is supported. ::: + ::: warning Only elvish v0.18 or higher is supported. ::: Add the following to the end of `~/.elvish/rc.elv`: diff --git a/docs/pt-PT/advanced-config/README.md b/docs/pt-PT/advanced-config/README.md index 23d7282e..809dc9d0 100644 --- a/docs/pt-PT/advanced-config/README.md +++ b/docs/pt-PT/advanced-config/README.md @@ -131,7 +131,7 @@ Invoke-Expression (&starship init powershell) Some shells support a right prompt which renders on the same line as the input. Starship can set the content of the right prompt using the `right_format` option. Any module that can be used in `format` is also supported in `right_format`. The `$all` variable will only contain modules not explicitly used in either `format` or `right_format`. -Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [fill module](/config/#fill). +Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [`fill` module](/config/#fill). `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd. diff --git a/docs/pt-PT/config/README.md b/docs/pt-PT/config/README.md index db6eac3f..cefbec26 100644 --- a/docs/pt-PT/config/README.md +++ b/docs/pt-PT/config/README.md @@ -9,6 +9,9 @@ mkdir -p ~/.config && touch ~/.config/starship.toml All configuration for starship is done in this [TOML](https://github.com/toml-lang/toml) file: ```toml +# Get editor completions based on the config schema +"$schema" = 'https://starship.rs/config-schema.json' + # Inserts a blank line between shell prompts add_newline = true @@ -199,6 +202,7 @@ $hg_branch\ $docker_context\ $package\ $buf\ +$c\ $cmake\ $cobol\ $container\ @@ -235,6 +239,7 @@ $vagrant\ $zig\ $nix_shell\ $conda\ +$spack\ $memory_usage\ $aws\ $gcloud\ @@ -263,9 +268,9 @@ format = "$all$directory$character" ## AWS -The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file. This module also shows an expiration timer when using temporary credentials. +The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. Alternatively, you can force this module to show the region and profile even when the credentials have not been setup with the `force_display` option. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file. This module also shows an expiration timer when using temporary credentials. -The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. +The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if the conditions above are not respected. When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var. @@ -275,15 +280,16 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------- | -| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | The format for the module. | -| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. | -| `region_aliases` | | Table of region aliases to display in addition to the AWS name. | -| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | -| `style` | `"bold yellow"` | The style for the module. | -| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. | -| `disabled` | `false` | Disables the `AWS` module. | +| Option | Default | Description | +| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | +| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | The format for the module. | +| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. | +| `region_aliases` | | Table of region aliases to display in addition to the AWS name. | +| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | +| `style` | `"bold yellow"` | The style for the module. | +| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. | +| `disabled` | `false` | Disables the `AWS` module. | +| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. | ### Variables @@ -472,6 +478,52 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil symbol = "🦬 " ``` +## C + +The `c` module shows some information about your C compiler. By default the module will be shown if the current directory contains a `.c` or `.h` file. + +### Options + +| Option | Default | Description | +| ------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version(-$name) )]($style)"` | The format string for the module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"C "` | The symbol used before displaying the compiler details | +| `detect_extensions` | `["c", "h"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `commands` | [ [ "cc", "--version" ], [ "gcc", "--version" ], [ "clang", "--version" ] ] | How to detect what the compiler is | +| `style` | `"bold 149"` | The style for the module. | +| `disabled` | `false` | Disables the `c` module. | + +### Variables + +| Variable | Example | Description | +| -------- | ------- | ------------------------------------ | +| name | clang | The name of the compiler | +| version | 13.0.0 | The version of the compiler | +| symbol | | Mirrors the value of option `symbol` | +| style | | Mirrors the value of option `style` | + +NB that `version` is not in the default format. + +### Commands + +The `commands` option accepts a list of commands to determine the compiler version and name. + +Each command is represented as a list of the executable name, followed by its arguments, usually something like `["mycc", "--version"]`. Starship will try executing each command until it gets a result on STDOUT. + +If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). + +### Example + +```toml +# ~/.config/starship.toml + +[c] +format = "via [$name $version]($style)" +``` + ## Character The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. @@ -962,7 +1014,7 @@ You'll also need the .NET Core SDK installed in order to use it correctly. Internally, this module uses its own mechanism for version detection. Typically it is twice as fast as running `dotnet --version`, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting `heuristic = false` in the module options. -The module will also show the Target Framework Moniker () when there is a csproj file in the current directory. +The module will also show the Target Framework Moniker () when there is a `.csproj` file in the current directory. ### Options @@ -2969,6 +3021,39 @@ The `singularity` module shows the current [Singularity](https://sylabs.io/singu format = '[📦 \[$env\]]($style) ' ``` +## Spack + +The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set. + +### Options + +| Option | Default | Description | +| ------------------- | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | +| `truncation_length` | `1` | The number of directories the environment path should be truncated to. `0` means no truncation. Also see the [`directory`](#directory) module. | +| `symbol` | `"🅢 "` | The symbol used before the environment name. | +| `style` | `"bold blue"` | The style for the module. | +| `format` | `"via [$symbol$environment]($style) "` | The format for the module. | +| `disabled` | `false` | Disables the `spack` module. | + +### Variables + +| Variable | Example | Description | +| ----------- | ------------ | ------------------------------------ | +| environment | `astronauts` | The current spack environment | +| 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 + +[spack] +format = "[$symbol$environment](dimmed blue) " +``` + ## Status 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. @@ -3226,7 +3311,7 @@ time_range = "10:00:00-14:00:00" 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 +- The current user is root/admin - The current user isn't the same as the one that is logged in - The user is currently connected as an SSH session - The variable `show_always` is set to true @@ -3239,13 +3324,13 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, ` ### Options -| Option | Default | Description | -| ------------- | ----------------------- | ------------------------------------- | -| `style_root` | `"bold red"` | The style used when the user is root. | -| `style_user` | `"bold yellow"` | The style used for non-root users. | -| `format` | `"[$user]($style) in "` | The format for the module. | -| `show_always` | `false` | Always shows the `username` module. | -| `disabled` | `false` | Disables the `username` module. | +| Option | Default | 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 "` | The format for the module. | +| `show_always` | `false` | Always shows the `username` module. | +| `disabled` | `false` | Disables the `username` module. | ### Variables @@ -3417,9 +3502,9 @@ The `custom` modules show the output of some arbitrary commands. These modules will be shown if any of the following conditions are met: -- The current directory contains a file whose name is in `files` -- The current directory contains a directory whose name is in `directories` -- The current directory contains a file whose extension is in `extensions` +- The current directory contains a file whose name is in `detect_files` +- The current directory contains a directory whose name is in `detect_folders` +- The current directory contains a file whose extension is in `detect_extensions` - The `when` command returns 0 - The current Operating System (std::env::consts::OS) matchs with `os` field if defined. @@ -3451,20 +3536,22 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt ### Options -| Option | Default | Description | -| ------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `command` | `""` | The command whose output should be printed. The command will be passed on stdin to the shell. | -| `when` | | A shell command used as a condition to show the module. 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`. | -| `files` | `[]` | The files that will be searched in the working directory for a match. | -| `directories` | `[]` | The directories that will be searched in the working directory for a match. | -| `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"` | The style for the module. | -| `format` | `"[$symbol($output )]($style)"` | The format for the module. | -| `disabled` | `false` | Disables this `custom` module. | -| `os` | | Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) [See possible values](https://doc.rust-lang.org/std/env/consts/constant.OS.html). | +| Option | Default | Description | +| ------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `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"` | The style for the module. | +| `format` | `"[$symbol($output )]($style)"` | The format for the module. | +| `disabled` | `false` | Disables this `custom` module. | +| `os` | | Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) [See possible values](https://doc.rust-lang.org/std/env/consts/constant.OS.html). | +| `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 @@ -3487,7 +3574,7 @@ If unset, it will fallback to STARSHIP_SHELL and then to "sh" on Linux, and "cmd The `command` will be passed in on stdin. -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 -`. This behavior can be avoided by explicitly passing arguments to the shell, e.g. +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", "-"] @@ -3512,12 +3599,18 @@ Automatic detection of shells and proper parameters addition are currently imple [custom.foo] command = "echo foo" # shows output of command -files = ["foo"] # can specify filters but wildcards are not supported +detect_files = ["foo"] # can specify filters but wildcards are not supported when = """ test "$HOME" == "$PWD" """ format = " transcending [$output]($style)" [custom.time] command = "time /T" -extensions = ["pst"] # filters *.pst files +detect_extensions = ["pst"] # filters *.pst files shell = ["pwsh.exe", "-NoProfile", "-Command", "-"] + +[custom.time-as-arg] +command = "time /T" +detect_extensions = ["pst"] # filters *.pst files +shell = ["pwsh.exe", "-NoProfile", "-Command"] +use_stdin = false ``` diff --git a/docs/pt-PT/guide/README.md b/docs/pt-PT/guide/README.md index c2975840..4effe7ff 100644 --- a/docs/pt-PT/guide/README.md +++ b/docs/pt-PT/guide/README.md @@ -297,7 +297,7 @@ Add the following to the end of `~/.elvish/rc.elv`: eval (starship init elvish) ``` -Note: Only Elvish v0.17+ is supported +Note: Only Elvish v0.18+ is supported
diff --git a/docs/ru-RU/README.md b/docs/ru-RU/README.md index dca0f4a9..aefc43d8 100644 --- a/docs/ru-RU/README.md +++ b/docs/ru-RU/README.md @@ -120,7 +120,7 @@ description: Starship - минимальная, быстрая и бесконе #### Elvish - ::: warning Поддерживается только elvish v0.17 или выше. ::: + ::: warning Поддерживается только elvish v0.18 или выше. ::: Добавьте следующую строку в конец `~/.elvish/rc.elv`: diff --git a/docs/ru-RU/advanced-config/README.md b/docs/ru-RU/advanced-config/README.md index 365a6367..5045030e 100644 --- a/docs/ru-RU/advanced-config/README.md +++ b/docs/ru-RU/advanced-config/README.md @@ -131,7 +131,7 @@ Invoke-Expression (&starship init powershell) Some shells support a right prompt which renders on the same line as the input. Starship can set the content of the right prompt using the `right_format` option. Any module that can be used in `format` is also supported in `right_format`. The `$all` variable will only contain modules not explicitly used in either `format` or `right_format`. -Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [fill module](/config/#fill). +Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [`fill` module](/config/#fill). `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd. diff --git a/docs/ru-RU/config/README.md b/docs/ru-RU/config/README.md index 45f47dd9..e1aaeebe 100644 --- a/docs/ru-RU/config/README.md +++ b/docs/ru-RU/config/README.md @@ -9,6 +9,9 @@ mkdir -p ~/.config && touch ~/.config/starship.toml Вся конфигурация Starship выполняется в этом файле [TOML](https://github.com/toml-lang/toml): ```toml +# Get editor completions based on the config schema +"$schema" = 'https://starship.rs/config-schema.json' + # Inserts a blank line between shell prompts add_newline = true @@ -199,6 +202,7 @@ $hg_branch\ $docker_context\ $package\ $buf\ +$c\ $cmake\ $cobol\ $container\ @@ -235,6 +239,7 @@ $vagrant\ $zig\ $nix_shell\ $conda\ +$spack\ $memory_usage\ $aws\ $gcloud\ @@ -263,9 +268,9 @@ format = "$all$directory$character" ## AWS -The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. Основано на `AWS_REGION`, `AWS_DEFAULT_REGION`, и `AWS_PROFILE` переменных окружения и файле`~/.aws/config`. This module also shows an expiration timer when using temporary credentials. +The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. Alternatively, you can force this module to show the region and profile even when the credentials have not been setup with the `force_display` option. Основано на `AWS_REGION`, `AWS_DEFAULT_REGION`, и `AWS_PROFILE` переменных окружения и файле`~/.aws/config`. This module also shows an expiration timer when using temporary credentials. -The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. +The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if the conditions above are not respected. When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var. @@ -275,15 +280,16 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL ### Опции -| Параметр | По умолчанию | Описание | -| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------- | -| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | Формат модуля. | -| `symbol` | `"☁️ "` | Символ перед отображением текущего профиля AWS. | -| `region_aliases` | | Таблица региона псевдонимов, отображаемая вместе с именем AWS. | -| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | -| `style` | `"bold yellow"` | Стиль модуля. | -| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. | -| `disabled` | `false` | Disables the `AWS` module. | +| Параметр | По умолчанию | Описание | +| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | +| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | Формат модуля. | +| `symbol` | `"☁️ "` | Символ перед отображением текущего профиля AWS. | +| `region_aliases` | | Таблица региона псевдонимов, отображаемая вместе с именем AWS. | +| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | +| `style` | `"bold yellow"` | Стиль модуля. | +| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. | +| `disabled` | `false` | Отключение модуля `AWS`. | +| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. | ### Переменные @@ -451,7 +457,7 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil | `detect_files` | `["buf.yaml", "buf.gen.yaml", "buf.work.yaml"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this modules. | | `style` | `"bold blue"` | Стиль модуля. | -| `disabled` | `false` | Disables the `elixir` module. | +| `disabled` | `false` | Отключает модуль `elixir`. | ### Переменные @@ -472,11 +478,57 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil symbol = "🦬 " ``` +## C + +The `c` module shows some information about your C compiler. By default the module will be shown if the current directory contains a `.c` or `.h` file. + +### Опции + +| Параметр | По умолчанию | Описание | +| ------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version(-$name) )]($style)"` | The format string for the module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"C "` | The symbol used before displaying the compiler details | +| `detect_extensions` | `["c", "h"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `commands` | [ [ "cc", "--version" ], [ "gcc", "--version" ], [ "clang", "--version" ] ] | How to detect what the compiler is | +| `style` | `"bold 149"` | Стиль модуля. | +| `disabled` | `false` | Disables the `c` module. | + +### Переменные + +| Переменная | Пример | Описание | +| ---------- | ------ | ------------------------------------ | +| name | clang | The name of the compiler | +| version | 13.0.0 | The version of the compiler | +| symbol | | Отражает значение параметра `symbol` | +| style | | Отражает значение параметра `style` | + +NB that `version` is not in the default format. + +### Commands + +The `commands` option accepts a list of commands to determine the compiler version and name. + +Each command is represented as a list of the executable name, followed by its arguments, usually something like `["mycc", "--version"]`. Starship will try executing each command until it gets a result on STDOUT. + +If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). + +### Пример + +```toml +# ~/.config/starship.toml + +[c] +format = "via [$name $version]($style)" +``` + ## Символ -The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. +Модуль `character` показывает символ (обычно, стрелка) рядом с вводимым текстом в терминале. -The character will tell you whether the last command was successful or not. It can do this in two ways: +Символ показывает, была ли последняя команда успешной или нет. It can do this in two ways: - changing color (`red`/`green`) - changing shape (`❯`/`✖`) @@ -497,7 +549,7 @@ By default it only changes color. If you also want to change its shape take a lo | `success_symbol` | `"[❯](bold green)"` | The format string used before the text input if the previous command succeeded. | | `error_symbol` | `"[❯](bold red)"` | The format string used before the text input if the previous command failed. | | `vicmd_symbol` | `"[❮](bold green)"` | The format string used before the text input if the shell is in vim normal mode. | -| `disabled` | `false` | Disables the `character` module. | +| `disabled` | `false` | Отключает модуль `character`. | ### Переменные @@ -598,25 +650,25 @@ The `cobol` module shows the currently installed version of COBOL. By default, t ## Длительность команды -The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists. +Модуль `cmd_duration` показывает время исполнения последней команды. Модуль будет показан только, если команда заняла более двух секунд, или если задан параметр `min_time`. -::: warning Do not hook the DEBUG trap in Bash +::: warning Не подключайте ловушку DEBUG к Bash -If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. +Если вы испоьзуете Starship в `bash`, не подключайте ловушку `DEBUG` после запуска `eval $(starship init $0)`, иначе этот модуль сломается. ::: -Bash users who need preexec-like functionality can use [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Simply define the arrays `preexec_functions` and `precmd_functions` before running `eval $(starship init $0)`, and then proceed as normal. +Пользователи Bash, которым нужна функциональность, подобная preexec, могут использовать [фреймворк bash_preexec от rcaloras](https://github.com/rcaloras/bash-preexec). Просто определите массивы `preexec_functions` и `precmd_functions` перед запуском `eval $(starship init $0)`, а затем продолжайте нормально. ### Опции | Параметр | По умолчанию | Описание | | ---------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). | -| `show_milliseconds` | `false` | Show milliseconds in addition to seconds for the duration. | +| `min_time` | `2_000` | Кратчайшая продолжительность для показа времени (в миллисекундах). | +| `show_milliseconds` | `false` | Показывать миллисекунды в дополнение к секундам в продолжительности. | | `format` | `"took [$duration]($style) "` | Формат модуля. | | `style` | `"bold yellow"` | Стиль модуля. | -| `disabled` | `false` | Disables the `cmd_duration` module. | +| `disabled` | `false` | Отключает модуль `cmd_duration`. | | `show_notifications` | `false` | Show desktop notifications when command completes. | | `min_time_to_notify` | `45_000` | Shortest duration for notification (in milliseconds). | | `notification_timeout` | | Duration to show notification for (in milliseconds). If unset, notification timeout will be determined by daemon. Not all notification daemons honor this option. | @@ -640,26 +692,26 @@ min_time = 500 format = "underwent [$duration](bold yellow)" ``` -## Conda +## Конда The `conda` module shows the current [Conda](https://docs.conda.io/en/latest/) environment, if `$CONDA_DEFAULT_ENV` is set. -::: tip +::: tip Подсказка -This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. +Это не подавляет модификатор командной строки самой conda. Возможно, вы захотите запустить `conda config --set changeps1 False`. ::: ### Опции -| Параметр | По умолчанию | Описание | -| ------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `truncation_length` | `1` | The number of directories the environment path should be truncated to, if the environment was created via `conda create -p [path]`. `0` means no truncation. Also see the [`directory`](#directory) module. | -| `symbol` | `"🅒 "` | The symbol used before the environment name. | -| `style` | `"bold green"` | Стиль модуля. | -| `format` | `"via [$symbol$environment]($style) "` | Формат модуля. | -| `ignore_base` | `true` | Ignores `base` environment when activated. | -| `disabled` | `false` | Disables the `conda` module. | +| Параметр | По умолчанию | Описание | +| ------------------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | +| `truncation_length` | `1` | Количество каталогов, в которых путь к окружению должен быть усечен, если окружение было создано через `conda create -p [path]`. `0` означает без усечения. Также смотрите модуль [`directory`](#directory). | +| `symbol` | `"🅒 "` | Символ перед названием окружения. | +| `style` | `"bold green"` | Стиль модуля. | +| `format` | `"via [$symbol$environment]($style) "` | Формат модуля. | +| `ignore_base` | `true` | Ignores `base` environment when activated. | +| `disabled` | `false` | Отключает модуль `conda`. | ### Переменные @@ -716,21 +768,21 @@ format = "[$symbol \\[$name\\]]($style) " The `crystal` module shows the currently installed version of [Crystal](https://crystal-lang.org/). By default the module will be shown if any of the following conditions are met: -- The current directory contains a `shard.yml` file -- The current directory contains a `.cr` file +- Текущий каталог содержит файл `shard.yml` +- Текущий каталог содержит файл `.cr` ### Опции | Параметр | По умолчанию | Описание | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | +| `symbol` | `"🔮 "` | Символ, используемый перед отображением версии crystal. | | `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `style` | `"bold red"` | Стиль модуля. | | `detect_extensions` | `["cr"]` | Which extensions should trigger this module. | | `detect_files` | `["shard.yml"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | -| `disabled` | `false` | Disables the `crystal` module. | +| `disabled` | `false` | Отключает модуль `crystal`. | ### Переменные @@ -829,21 +881,21 @@ format = "via [🦕 $version](green bold) " ## Каталог -The `directory` module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in. +Модуль `directory` показывает путь к вашей текущей директории, усеченной до трех родительских папок. Ваш каталог также будет отсечен до корня git репозитория, в котором вы находитесь. -When using the fish style pwd option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option. +При использовании стиля оболочки fish, вместо скрытия усеченного каталога, вы увидите укороченное имя каталога, зависимое от числа символов вы установите для этой опции. -For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, and the option set to `1`. You will now see `~/D/N/nixpkgs/pkgs`, whereas before it would have been `nixpkgs/pkgs`. +Например, возьмем `~/Dev/Nix/nixpkgs/pkgs` где `nixpkgs` является корневым репозиторием, и в опции установлено `1`. Вы увидите `~/D/N/nixpkgs/pkgs`, а до этого было бы `nixpkgs/pkgs`. ### Опции | Параметр | По умолчанию | Описание | | ------------------- | ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. | -| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. | +| `truncation_length` | `3` | Количество родительских папок, к которым должен быть усечен текущий каталог. | +| `truncate_to_repo` | `true` | Следует или нет обрезать до корня репозитория git, в котором вы находитесь. | | `format` | `"[$path]($style)[$read_only]($read_only_style) "` | Формат модуля. | | `style` | `"bold cyan"` | Стиль модуля. | -| `disabled` | `false` | Disables the `directory` module. | +| `disabled` | `false` | Отключает модуль `directory`. | | `read_only` | `"🔒"` | The symbol indicating current directory is read only. | | `read_only_style` | `"red"` | The style for the read only symbol. | | `truncation_symbol` | `""` | The symbol to prefix to truncated paths. eg: "…/" | @@ -853,12 +905,12 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an | `use_os_path_sep` | `true` | Use the OS specific path separator instead of always using `/` (e.g. `\` on Windows) |
-This module has a few advanced configuration options that control how the directory is displayed. +Этот модуль имеет несколько расширенных опций конфигурации, которые контролируют отображение каталога. | Advanced Option | По умолчанию | Описание | | --------------------------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `substitutions` | | A table of substitutions to be made to the path. | -| `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. | +| `fish_style_pwd_dir_length` | `0` | Количество символов, используемых при использовании логики создания пути из fish. | | `use_logical_path` | `true` | If `true` render the logical path sourced from the shell via `PWD` or `--logical-path`. If `false` instead render the physical filesystem path with symlinks resolved. | `substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD. @@ -869,7 +921,7 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an "src/com/long/java/path" = "mypath" ``` -`fish_style_pwd_dir_length` interacts with the standard truncation options in a way that can be surprising at first: if it's non-zero, the components of the path that would normally be truncated are instead displayed with that many characters. For example, the path `/built/this/city/on/rock/and/roll`, which would normally be displayed as as `rock/and/roll`, would be displayed as `/b/t/c/o/rock/and/roll` with `fish_style_pwd_dir_length = 1`--the path components that would normally be removed are displayed with a single character. For `fish_style_pwd_dir_length = 2`, it would be `/bu/th/ci/on/rock/and/roll`. +`fish_style_pwd_dir_length` взаимодействует со стандартными параметрами усечения, которые могут сначала показаться странными: если он не равен нулю, элементы пути, который обычно усекается, вместо этого отображаются с указанным количеством символов. For example, the path `/built/this/city/on/rock/and/roll`, which would normally be displayed as as `rock/and/roll`, would be displayed as `/b/t/c/o/rock/and/roll` with `fish_style_pwd_dir_length = 1`--the path components that would normally be removed are displayed with a single character. For `fish_style_pwd_dir_length = 2`, it would be `/bu/th/ci/on/rock/and/roll`.
@@ -907,7 +959,7 @@ truncation_length = 8 truncation_symbol = "…/" ``` -## Docker Context +## Контекст Docker The `docker_context` module shows the currently active [Docker context](https://docs.docker.com/engine/context/working-with-contexts/) if it's not set to `default` or if the `DOCKER_MACHINE_NAME`, `DOCKER_HOST` or `DOCKER_CONTEXT` environment variables are set (as they are meant to override the context in use). @@ -945,7 +997,7 @@ format = "via [🐋 $context](blue bold)" ## Dotnet -The `dotnet` module shows the relevant version of the [.NET Core SDK](https://dotnet.microsoft.com/) for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. +The `dotnet` module shows the relevant version of the [.NET Core SDK](https://dotnet.microsoft.com/) for the current directory. Если SDK был закреплен в текущей директории, будет показана закрепленная версия. В противном случае модуль отображает последнюю установленную версию SDK. By default this module will only be shown in your prompt when one or more of the following files are present in the current directory: @@ -960,9 +1012,9 @@ By default this module will only be shown in your prompt when one or more of the You'll also need the .NET Core SDK installed in order to use it correctly. -Internally, this module uses its own mechanism for version detection. Typically it is twice as fast as running `dotnet --version`, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting `heuristic = false` in the module options. +Внутренне этот модуль использует свой собственный механизм определения версий. Обычно он в два раза быстрее, чем `dotnet --version`, но он может показывать неправильную версию, если ваш .NET проект имеет необычный формат каталога. Если точность важнее, чем скорость, вы можете отключить механизм опцией `heuristic = false` в настройках модуля. -The module will also show the Target Framework Moniker () when there is a csproj file in the current directory. +The module will also show the Target Framework Moniker () when there is a `.csproj` file in the current directory. ### Опции @@ -970,13 +1022,13 @@ The module will also show the Target Framework Moniker ([\\w-]+)" = "gke-$var_cluster" ``` -## Line Break +## Перевод Строки -The `line_break` module separates the prompt into two lines. +Модуль `line_break` разделяет командную строку на две строки. ### Опции -| Параметр | По умолчанию | Описание | -| ---------- | ------------ | ------------------------------------------------------------------ | -| `disabled` | `false` | Disables the `line_break` module, making the prompt a single line. | +| Параметр | По умолчанию | Описание | +| ---------- | ------------ | ------------------------------------------------------------------------ | +| `disabled` | `false` | Отключает модуль `line_break`, отображая командную строку в одну строку. | ### Пример @@ -2040,27 +2092,27 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o format = "via [🌕 $version](bold blue) " ``` -## Memory Usage +## Использование памяти -The `memory_usage` module shows current system memory and swap usage. +Модуль `memory_usage` отображает текущую системную память и использование подкачки. -By default the swap usage is displayed if the total system swap is non-zero. +По умолчанию использование подкачки отображается, если общая сумма подкачки системы не равна нулю. -::: tip +::: tip Подсказка -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +По умолчанию этот модуль отключен. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. ::: ### Опции -| Параметр | По умолчанию | Описание | -| ----------- | ----------------------------------------------- | -------------------------------------------------------- | -| `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. | +| Параметр | По умолчанию | Описание | +| ----------- | ----------------------------------------------- | ------------------------------------------------------------------ | +| `threshold` | `75` | Скрывать использование памяти, если она не превышает этот процент. | +| `format` | `"via $symbol [${ram}( \| ${swap})]($style) "` | Формат модуля. | +| `symbol` | `"🐏"` | Символ, используемый перед отображением использования памяти. | +| `style` | `"bold dimmed white"` | Стиль модуля. | +| `disabled` | `true` | Отключает модуль `memory_usage`. | ### Переменные @@ -2087,20 +2139,20 @@ symbol = " " style = "bold dimmed green" ``` -## Mercurial Branch +## Ветка Mercurial -The `hg_branch` module shows the active branch of the repo in your current directory. +Модуль `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]($style) "` | Формат модуля. | -| `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. | +| Параметр | По умолчанию | Описание | +| ------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | +| `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`. | ### Переменные @@ -2127,7 +2179,7 @@ truncation_symbol = "" The `nim` module shows the currently installed version of [Nim](https://nim-lang.org/). By default the module will be shown if any of the following conditions are met: -- The current directory contains a `nim.cfg` file +- Текущий каталог содержит файл `nim.cfg` - The current directory contains a file with the `.nim` extension - The current directory contains a file with the `.nims` extension - The current directory contains a file with the `.nimble` extension @@ -2136,7 +2188,7 @@ The `nim` module shows the currently installed version of [Nim](https://nim-lang | Параметр | По умолчанию | Описание | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module | +| `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 Nim. | | `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this module. | @@ -2167,7 +2219,7 @@ symbol = "🎣 " ## 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. +The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html) environment. Модуль будет показываться внутри среды nix-shell. ### Опции @@ -2178,7 +2230,7 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/ | `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` | Disables the `nix_shell` module. | +| `disabled` | `false` | Отключает модуль `nix_shell`. | ### Переменные @@ -2207,10 +2259,10 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' The `nodejs` module shows the currently installed version of [Node.js](https://nodejs.org/). By default the module will be shown if any of the following conditions are met: -- The current directory contains a `package.json` file +- Текущий каталог содержит файл `package.json` - The current directory contains a `.node-version` file - The current directory contains a `.nvmrc` file -- The current directory contains a `node_modules` directory +- Текущий каталог содержит каталог `node_modules` - The current directory contains a file with the `.js`, `.mjs` or `.cjs` extension - The current directory contains a file with the `.ts`, `.mts` or `.cts` extension @@ -2225,7 +2277,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` | Disables the `nodejs` module. | +| `disabled` | `false` | Отключает модуль `nodejs`. | | `not_capable_style` | `bold red` | The style for the module when an engines property in package.json does not match the Node.js version. | ### Переменные @@ -2329,9 +2381,9 @@ style = "bold yellow" symbol = "☁️ " ``` -## Package Version +## Версия пакета -The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards` and `dart` packages. +Модуль `package` отображается, когда текущий каталог является репозиторием для пакета и показывает его текущую версию. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards` and `dart` packages. - [**npm**](https://docs.npmjs.com/cli/commands/npm) – The `npm` package version is extracted from the `package.json` present in the current directory - [**Cargo**](https://doc.rust-lang.org/cargo/) – The `cargo` package version is extracted from the `Cargo.toml` present in the current directory @@ -2357,11 +2409,11 @@ The `package` module is shown when the current directory is the repository for a | Параметр | По умолчанию | Описание | | ----------------- | --------------------------------- | ------------------------------------------------------------------------- | | `format` | `"is [$symbol$version]($style) "` | Формат модуля. | -| `symbol` | `"📦 "` | The symbol used before displaying the version the package. | +| `symbol` | `"📦 "` | Символ, используемый перед отображением версии пакета. | | `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` | Disables the `package` module. | +| `disabled` | `false` | Отключает модуль `package`. | ### Переменные @@ -2426,8 +2478,8 @@ 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 -- The current directory contains a `.php-version` file +- Текущий каталог содержит файл `composer.json` +- Текущий каталог содержит файл `.php-version` - The current directory contains a `.php` extension ### Опции @@ -2436,12 +2488,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` | `"🐘 "` | The symbol used before displaying the version of PHP. | +| `symbol` | `"🐘 "` | Символ, используемый перед отображением версии 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` | Disables the `php` module. | +| `disabled` | `false` | Отключает модуль `php`. | ### Переменные @@ -2466,7 +2518,7 @@ format = "via [🔹 $version](147 bold) " The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. -::: tip +::: tip Подсказка By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, [follow the example shown below](#with-pulumi-version). @@ -2489,13 +2541,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 | -| username | `alice` | The current Pulumi username | -| symbol | | Отражает значение параметра `symbol` | -| style\* | | Отражает значение параметра `style` | +| Переменная | Пример | Описание | +| ---------------- | ---------- | ------------------------------------ | +| version | `v0.12.24` | The version of `pulumi` | +| stack | `dev` | The current Pulumi stack | +| имя пользователя | `alice` | The current Pulumi username | +| symbol | | Отражает значение параметра `symbol` | +| style\* | | Отражает значение параметра `style` | *: Эта переменная может использоваться только в качестве части строки style @@ -2523,7 +2575,7 @@ format = "[$symbol$stack]($style) " The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. By default the module will be shown if any of the following conditions are met: -- The current directory contains a `spago.dhall` file +- Текущий каталог содержит файл `spago.dhall` - The current directory contains a file with the `.purs` extension ### Опции @@ -2566,15 +2618,15 @@ If `pyenv_version_name` is set to `true`, it will display the pyenv version name By default the module will be shown if any of the following conditions are met: -- The current directory contains a `.python-version` file -- The current directory contains a `Pipfile` file +- Текущий каталог содержит файл `.python-version` +- Текущий каталог содержит файл `Pipfile` - The current directory contains a `__init__.py` file -- The current directory contains a `pyproject.toml` file -- The current directory contains a `requirements.txt` file -- The current directory contains a `setup.py` file -- The current directory contains a `tox.ini` file -- The current directory contains a file with the `.py` extension. -- A virtual environment is currently activated +- Текущий каталог содержит файл `pyproject.toml` +- Текущий каталог содержит файл `requirements.txt` +- Текущий каталог содержит файл `setup.py` +- Текущий каталог содержит файл `tox.ini` +- Текущий каталог содержит файл с расширением `.py`. +- Виртуальная среда в данный момент активирована ### Опции @@ -2584,7 +2636,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` | Use pyenv to get Python version | +| `pyenv_version_name` | `false` | Использовать pyenv для получения версии Python | | `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 | @@ -2592,7 +2644,7 @@ By default the module will be shown if any of the following conditions are met: | `detect_folders` | `[]` | Which folders should trigger this module | | `disabled` | `false` | Disables the `python` module. | -::: tip +::: tip Подсказка 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. @@ -2731,9 +2783,9 @@ symbol = "🔴 " By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). Модуль будет показан, если любое из следующих условий соблюдено: -- The current directory contains a `Gemfile` file -- The current directory contains a `.ruby-version` file -- The current directory contains a `.rb` file +- Текущий каталог содержит файл `Gemfile` +- Текущий каталог содержит файл `.ruby-version` +- Текущий каталог содержит файл `.rb` - The environment variables `RUBY_VERSION` or `RBENV_VERSION` are set Starship gets the current Ruby version by running `ruby -v`. @@ -2750,7 +2802,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` | Disables the `ruby` module. | +| `disabled` | `false` | Отключает модуль `ruby`. | ### Переменные @@ -2775,8 +2827,8 @@ symbol = "🔺 " By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). Модуль будет показан, если любое из следующих условий соблюдено: -- The current directory contains a `Cargo.toml` file -- The current directory contains a file with the `.rs` extension +- Текущий каталог содержит файл `Cargo.toml` +- Текущий каталог содержит файл с расширением `.rs` ### Опции @@ -2789,7 +2841,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` | Disables the `rust` module. | +| `disabled` | `false` | Отключает модуль `rust`. | ### Переменные @@ -2854,9 +2906,9 @@ symbol = "🌟 " The `shell` module shows an indicator for currently used shell. -::: tip +::: tip Подсказка -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +По умолчанию этот модуль отключен. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. ::: @@ -2884,7 +2936,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | Переменная | По умолчанию | Описание | | ---------- | ------------ | ---------------------------------------------------------- | | indicator | | Mirrors the value of `indicator` for currently used shell. | -| style\* | | Mirrors the value of option `style`. | +| style\* | | Отражает значение параметра `style`. | *: Эта переменная может использоваться только в качестве части строки style @@ -2969,13 +3021,46 @@ The `singularity` module shows the current [Singularity](https://sylabs.io/singu format = '[📦 \[$env\]]($style) ' ``` +## Spack + +The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set. + +### Опции + +| Параметр | По умолчанию | Описание | +| ------------------- | -------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------- | +| `truncation_length` | `1` | The number of directories the environment path should be truncated to. `0` означает без усечения. Также смотрите модуль [`directory`](#directory). | +| `symbol` | `"🅢 "` | Символ перед названием окружения. | +| `style` | `"bold blue"` | Стиль модуля. | +| `format` | `"via [$symbol$environment]($style) "` | Формат модуля. | +| `disabled` | `false` | Disables the `spack` module. | + +### Переменные + +| Переменная | Пример | Описание | +| ----------- | ------------ | ------------------------------------ | +| environment | `astronauts` | The current spack environment | +| symbol | | Отражает значение параметра `symbol` | +| style\* | | Отражает значение параметра `style` | + +*: Эта переменная может использоваться только в качестве части строки style + +### Пример + +```toml +# ~/.config/starship.toml + +[spack] +format = "[$symbol$environment](dimmed blue) " +``` + ## Status The `status` module displays the exit code of the previous command. If $success_symbol is empty (default), the module will be shown only if the exit code is not `0`. The status code will cast to a signed 32-bit integer. -::: tip +::: tip Подсказка -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +По умолчанию этот модуль отключен. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. ::: @@ -3033,9 +3118,9 @@ disabled = false The `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached. -::: tip +::: tip Подсказка -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +По умолчанию этот модуль отключен. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. ::: @@ -3121,7 +3206,7 @@ format = "via [🏎 $version](red bold)" The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. -::: tip +::: tip Подсказка By default the Terraform version is not shown, since this is slow for current versions of Terraform when a lot of plugins are in use. If you still want to enable it, [follow the example shown below](#with-terraform-version). @@ -3129,7 +3214,7 @@ By default the Terraform version is not shown, since this is slow for current ve By default the module will be shown if any of the following conditions are met: -- The current directory contains a `.terraform` folder +- Текущий каталог содержит папку `.terraform` - Current directory contains a file with the `.tf`, `.tfplan` or `.tfstate` extensions ### Опции @@ -3143,7 +3228,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` | Disables the `terraform` module. | +| `disabled` | `false` | Отключает модуль `terraform`. | ### Переменные @@ -3178,33 +3263,33 @@ format = "[🏎💨 $workspace]($style) " ## Время -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. +Модуль `time` показывает текущее **локальное** время. Значение конфигурации `format` используется пакетом [`chrono`](https://crates.io/crates/chrono) для контроля того, как отображается время. Ознакомьтесь с [документацией chrono strftime](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html), чтобы увидеть доступные параметры. -::: tip +::: tip Подсказка -This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. +По умолчанию этот модуль отключен. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. ::: ### Опции -| Параметр | По умолчанию | Описание | -| ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `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 | +| Параметр | По умолчанию | Описание | +| ----------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `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 | -If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Otherwise, it defaults to `"%T"`. Manually setting `time_format` will override the `use_12hr` setting. +If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Иначе по умолчанию используется `"%T"`. Manually setting `time_format` will override the `use_12hr` setting. ### Переменные | Переменная | Пример | Описание | | ---------- | ---------- | ----------------------------------- | -| time | `13:08:10` | The current time. | +| время | `13:08:10` | The current time. | | style\* | | Отражает значение параметра `style` | *: Эта переменная может использоваться только в качестве части строки style @@ -3222,16 +3307,16 @@ utc_time_offset = "-5" time_range = "10:00:00-14:00:00" ``` -## Username +## Имя пользователя -The `username` module shows active user's username. Модуль будет показан, если любое из следующих условий соблюдено: +Модуль `username` показывает имя активного пользователя. Модуль будет показан, если любое из следующих условий соблюдено: -- The current user is root -- The current user isn't the same as the one that is logged in -- The user is currently connected as an SSH session -- The variable `show_always` is set to true +- The current user is root/admin +- Текущий пользователь отличается от залогиненного +- Пользователь подключен к SSH-сессии +- Переменная `show_always` равна true -::: tip +::: tip Подсказка 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. @@ -3239,13 +3324,13 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, ` ### Опции -| Параметр | По умолчанию | Описание | -| ------------- | ----------------------- | ------------------------------------- | -| `style_root` | `"bold red"` | The style used when the user is root. | -| `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. | +| Параметр | По умолчанию | Описание | +| ------------- | ----------------------- | ------------------------------------------------------- | +| `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`. | ### Переменные @@ -3417,25 +3502,25 @@ The `custom` modules show the output of some arbitrary commands. These modules will be shown if any of the following conditions are met: -- The current directory contains a file whose name is in `files` -- The current directory contains a directory whose name is in `directories` -- The current directory contains a file whose extension is in `extensions` +- The current directory contains a file whose name is in `detect_files` +- The current directory contains a directory whose name is in `detect_folders` +- The current directory contains a file whose extension is in `detect_extensions` - The `when` command returns 0 - The current Operating System (std::env::consts::OS) matchs with `os` field if defined. -::: tip +::: tip Подсказка Multiple custom modules can be defined by using a `.`. ::: -::: tip +::: tip Подсказка The order in which custom modules are shown can be individually set by including `${custom.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `custom` module will simply show all custom modules in the order they were defined. ::: -::: tip +::: tip Подсказка [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! @@ -3451,20 +3536,22 @@ 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` | | A shell command used as a condition to show the module. 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`. | -| `files` | `[]` | The files that will be searched in the working directory for a match. | -| `directories` | `[]` | The directories that will be searched in the working directory for a match. | -| `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"` | Стиль модуля. | -| `format` | `"[$symbol($output )]($style)"` | Формат модуля. | -| `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). | +| Параметр | По умолчанию | Описание | +| ------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `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`. | +| `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"` | Стиль модуля. | +| `format` | `"[$symbol($output )]($style)"` | Формат модуля. | +| `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. | ### Переменные @@ -3487,7 +3574,7 @@ If unset, it will fallback to STARSHIP_SHELL and then to "sh" on Linux, and "cmd The `command` will be passed in on stdin. -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 -`. This behavior can be avoided by explicitly passing arguments to the shell, e.g. +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", "-"] @@ -3512,12 +3599,18 @@ Automatic detection of shells and proper parameters addition are currently imple [custom.foo] command = "echo foo" # shows output of command -files = ["foo"] # can specify filters but wildcards are not supported +detect_files = ["foo"] # can specify filters but wildcards are not supported when = """ test "$HOME" == "$PWD" """ format = " transcending [$output]($style)" [custom.time] command = "time /T" -extensions = ["pst"] # filters *.pst files +detect_extensions = ["pst"] # filters *.pst files shell = ["pwsh.exe", "-NoProfile", "-Command", "-"] + +[custom.time-as-arg] +command = "time /T" +detect_extensions = ["pst"] # filters *.pst files +shell = ["pwsh.exe", "-NoProfile", "-Command"] +use_stdin = false ``` diff --git a/docs/ru-RU/guide/README.md b/docs/ru-RU/guide/README.md index 5282e706..bb503d23 100644 --- a/docs/ru-RU/guide/README.md +++ b/docs/ru-RU/guide/README.md @@ -145,7 +145,7 @@ Starship with iTerm2 and the Snazzy theme @@ -160,7 +160,7 @@ - **Легкая:** быстрая установка - начните использовать ее в считанные минуты.

-Explore the Starship docs  ▶ +Изучите документацию Starship  ▶

@@ -297,7 +297,7 @@ load(io.popen('starship init cmd'):read("*a"))() eval (starship init elvish) ``` -Note: Only Elvish v0.17+ is supported +Note: Only Elvish v0.18+ is supported
@@ -400,15 +400,15 @@ If you're looking to further customize Starship: ## 🤝 Помощь -We are always looking for contributors of **all skill levels**! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). +Мы всегда ищем помощников **всех уровней навыков**! Если вы хотите облегчить свой путь к проекту, попробуйте [хорошие первые задачи](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). -If you are fluent in a non-English language, we greatly appreciate any help keeping our docs translated and up-to-date in other languages. If you would like to help, translations can be contributed on the [Starship Crowdin](https://translate.starship.rs/). +Если Вы свободно владеете иностранным языком отличным от английского, мы высоко оценим любую помощь в переводе нашей документации на другие языки и поддержании ее в актуальном состоянии. Если вы хотите помочь, переводы могут быть сделаны на платформе [Starship Crowdin](https://translate.starship.rs/). -If you are interested in helping contribute to starship, please take a look at our [Contributing Guide](https://github.com/starship/starship/blob/master/CONTRIBUTING.md). Also, feel free to drop into our [Discord server](https://discord.gg/8Jzqu3T) and say hi. 👋 +Если вы хотите помочь в создании Starship, пожалуйста, ознакомьтесь с нашим [Руководством по содействию](https://github.com/starship/starship/blob/master/CONTRIBUTING.md). Кроме того, заходите на наш [Discord сервер](https://discord.gg/8Jzqu3T) и поздоровайтесь. 👋 ## 💭 Вдохновение -Please check out these previous works that helped inspire the creation of starship. 🙏 +Пожалуйста, ознакомьтесь с этими предыдущими работами, которые помогли вдохновить создание Starship. 🙏 - **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** – A ZSH prompt for astronauts. @@ -418,9 +418,9 @@ Please check out these previous works that helped inspire the creation of starsh


- Starship rocket icon + Иконка ракеты Starship

## 📝 Лицензия -Copyright © 2019-present, [Starship Contributors](https://github.com/starship/starship/graphs/contributors).
This project is [ISC](https://github.com/starship/starship/blob/master/LICENSE) licensed. +Авторское право © 2019-настоящее, [Starship Contributors](https://github.com/starship/starship/graphs/contributors).
Этот проект [ISC](https://github.com/starship/starship/blob/master/LICENSE) лицензирован. diff --git a/docs/tr-TR/README.md b/docs/tr-TR/README.md index a0d83e8b..f7911ce9 100644 --- a/docs/tr-TR/README.md +++ b/docs/tr-TR/README.md @@ -120,7 +120,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p #### Elvish - ::: warning Only elvish v0.17 or higher is supported. ::: + ::: warning Only elvish v0.18 or higher is supported. ::: Add the following to the end of `~/.elvish/rc.elv`: diff --git a/docs/tr-TR/advanced-config/README.md b/docs/tr-TR/advanced-config/README.md index fbeef1ea..b84777ce 100644 --- a/docs/tr-TR/advanced-config/README.md +++ b/docs/tr-TR/advanced-config/README.md @@ -130,7 +130,7 @@ Invoke-Expression (&starship init powershell) Some shells support a right prompt which renders on the same line as the input. Starship can set the content of the right prompt using the `right_format` option. Any module that can be used in `format` is also supported in `right_format`. The `$all` variable will only contain modules not explicitly used in either `format` or `right_format`. -Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [fill module](/config/#fill). +Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [`fill` module](/config/#fill). `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd. diff --git a/docs/tr-TR/config/README.md b/docs/tr-TR/config/README.md index 1c0a72fe..54ffe1ce 100644 --- a/docs/tr-TR/config/README.md +++ b/docs/tr-TR/config/README.md @@ -9,6 +9,9 @@ mkdir -p ~/.config && touch ~/.config/starship.toml All configuration for starship is done in this [TOML](https://github.com/toml-lang/toml) file: ```toml +# Get editor completions based on the config schema +"$schema" = 'https://starship.rs/config-schema.json' + # Inserts a blank line between shell prompts add_newline = true @@ -199,6 +202,7 @@ $hg_branch\ $docker_context\ $package\ $buf\ +$c\ $cmake\ $cobol\ $container\ @@ -235,6 +239,7 @@ $vagrant\ $zig\ $nix_shell\ $conda\ +$spack\ $memory_usage\ $aws\ $gcloud\ @@ -263,9 +268,9 @@ format = "$all$directory$character" ## AWS -The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file. This module also shows an expiration timer when using temporary credentials. +The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. Alternatively, you can force this module to show the region and profile even when the credentials have not been setup with the `force_display` option. This is based on `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` env var with `~/.aws/config` file. This module also shows an expiration timer when using temporary credentials. -The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. +The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if the conditions above are not respected. When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var. @@ -275,15 +280,16 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------- | -| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | The format for the module. | -| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. | -| `region_aliases` | | Table of region aliases to display in addition to the AWS name. | -| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | -| `style` | `"bold yellow"` | The style for the module. | -| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. | -| `disabled` | `false` | Disables the `AWS` module. | +| Option | Default | Description | +| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | +| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | The format for the module. | +| `symbol` | `"☁️ "` | The symbol used before displaying the current AWS profile. | +| `region_aliases` | | Table of region aliases to display in addition to the AWS name. | +| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | +| `style` | `"bold yellow"` | The style for the module. | +| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. | +| `disabled` | `false` | Disables the `AWS` module. | +| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. | ### Variables @@ -472,6 +478,52 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil symbol = "🦬 " ``` +## C + +The `c` module shows some information about your C compiler. By default the module will be shown if the current directory contains a `.c` or `.h` file. + +### Options + +| Option | Default | Description | +| ------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version(-$name) )]($style)"` | The format string for the module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"C "` | The symbol used before displaying the compiler details | +| `detect_extensions` | `["c", "h"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `commands` | [ [ "cc", "--version" ], [ "gcc", "--version" ], [ "clang", "--version" ] ] | How to detect what the compiler is | +| `style` | `"bold 149"` | The style for the module. | +| `disabled` | `false` | Disables the `c` module. | + +### Variables + +| Variable | Example | Description | +| -------- | ------- | ------------------------------------ | +| name | clang | The name of the compiler | +| version | 13.0.0 | The version of the compiler | +| symbol | | Mirrors the value of option `symbol` | +| style | | Mirrors the value of option `style` | + +NB that `version` is not in the default format. + +### Commands + +The `commands` option accepts a list of commands to determine the compiler version and name. + +Each command is represented as a list of the executable name, followed by its arguments, usually something like `["mycc", "--version"]`. Starship will try executing each command until it gets a result on STDOUT. + +If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). + +### Example + +```toml +# ~/.config/starship.toml + +[c] +format = "via [$name $version]($style)" +``` + ## Character The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. @@ -962,7 +1014,7 @@ You'll also need the .NET Core SDK installed in order to use it correctly. Internally, this module uses its own mechanism for version detection. Typically it is twice as fast as running `dotnet --version`, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting `heuristic = false` in the module options. -The module will also show the Target Framework Moniker () when there is a csproj file in the current directory. +The module will also show the Target Framework Moniker () when there is a `.csproj` file in the current directory. ### Options @@ -2969,6 +3021,39 @@ The `singularity` module shows the current [Singularity](https://sylabs.io/singu format = '[📦 \[$env\]]($style) ' ``` +## Spack + +The `spack` module shows the current [Spack](https://spack.readthedocs.io/en/latest/) environment, if `$SPACK_ENV` is set. + +### Options + +| Option | Default | Description | +| ------------------- | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | +| `truncation_length` | `1` | The number of directories the environment path should be truncated to. `0` means no truncation. Also see the [`directory`](#directory) module. | +| `symbol` | `"🅢 "` | The symbol used before the environment name. | +| `style` | `"bold blue"` | The style for the module. | +| `format` | `"via [$symbol$environment]($style) "` | The format for the module. | +| `disabled` | `false` | Disables the `spack` module. | + +### Variables + +| Variable | Example | Description | +| ----------- | ------------ | ------------------------------------ | +| environment | `astronauts` | The current spack environment | +| 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 + +[spack] +format = "[$symbol$environment](dimmed blue) " +``` + ## Status 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. @@ -3226,7 +3311,7 @@ time_range = "10:00:00-14:00:00" 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 +- The current user is root/admin - The current user isn't the same as the one that is logged in - The user is currently connected as an SSH session - The variable `show_always` is set to true @@ -3239,13 +3324,13 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, ` ### Options -| Option | Default | Description | -| ------------- | ----------------------- | ------------------------------------- | -| `style_root` | `"bold red"` | The style used when the user is root. | -| `style_user` | `"bold yellow"` | The style used for non-root users. | -| `format` | `"[$user]($style) in "` | The format for the module. | -| `show_always` | `false` | Always shows the `username` module. | -| `disabled` | `false` | Disables the `username` module. | +| Option | Default | 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 "` | The format for the module. | +| `show_always` | `false` | Always shows the `username` module. | +| `disabled` | `false` | Disables the `username` module. | ### Variables @@ -3417,9 +3502,9 @@ The `custom` modules show the output of some arbitrary commands. These modules will be shown if any of the following conditions are met: -- The current directory contains a file whose name is in `files` -- The current directory contains a directory whose name is in `directories` -- The current directory contains a file whose extension is in `extensions` +- The current directory contains a file whose name is in `detect_files` +- The current directory contains a directory whose name is in `detect_folders` +- The current directory contains a file whose extension is in `detect_extensions` - The `when` command returns 0 - The current Operating System (std::env::consts::OS) matchs with `os` field if defined. @@ -3451,20 +3536,22 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt ### Options -| Option | Default | Description | -| ------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `command` | `""` | The command whose output should be printed. The command will be passed on stdin to the shell. | -| `when` | | A shell command used as a condition to show the module. 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`. | -| `files` | `[]` | The files that will be searched in the working directory for a match. | -| `directories` | `[]` | The directories that will be searched in the working directory for a match. | -| `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"` | The style for the module. | -| `format` | `"[$symbol($output )]($style)"` | The format for the module. | -| `disabled` | `false` | Disables this `custom` module. | -| `os` | | Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) [See possible values](https://doc.rust-lang.org/std/env/consts/constant.OS.html). | +| Option | Default | Description | +| ------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `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"` | The style for the module. | +| `format` | `"[$symbol($output )]($style)"` | The format for the module. | +| `disabled` | `false` | Disables this `custom` module. | +| `os` | | Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) [See possible values](https://doc.rust-lang.org/std/env/consts/constant.OS.html). | +| `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 @@ -3487,7 +3574,7 @@ If unset, it will fallback to STARSHIP_SHELL and then to "sh" on Linux, and "cmd The `command` will be passed in on stdin. -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 -`. This behavior can be avoided by explicitly passing arguments to the shell, e.g. +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", "-"] @@ -3512,12 +3599,18 @@ Automatic detection of shells and proper parameters addition are currently imple [custom.foo] command = "echo foo" # shows output of command -files = ["foo"] # can specify filters but wildcards are not supported +detect_files = ["foo"] # can specify filters but wildcards are not supported when = """ test "$HOME" == "$PWD" """ format = " transcending [$output]($style)" [custom.time] command = "time /T" -extensions = ["pst"] # filters *.pst files +detect_extensions = ["pst"] # filters *.pst files shell = ["pwsh.exe", "-NoProfile", "-Command", "-"] + +[custom.time-as-arg] +command = "time /T" +detect_extensions = ["pst"] # filters *.pst files +shell = ["pwsh.exe", "-NoProfile", "-Command"] +use_stdin = false ``` diff --git a/docs/tr-TR/guide/README.md b/docs/tr-TR/guide/README.md index f4086033..0dc57795 100644 --- a/docs/tr-TR/guide/README.md +++ b/docs/tr-TR/guide/README.md @@ -297,7 +297,7 @@ Add the following to the end of `~/.elvish/rc.elv`: eval (starship init elvish) ``` -Note: Only Elvish v0.17+ is supported +Note: Only Elvish v0.18+ is supported
diff --git a/docs/tr-TR/installing/README.md b/docs/tr-TR/installing/README.md index d4bed53b..e75d921f 100644 --- a/docs/tr-TR/installing/README.md +++ b/docs/tr-TR/installing/README.md @@ -1,4 +1,4 @@ -# Advanced Installation +# Gelişmiş Kurulum Starship'i kurmak için, 2 şeye ihtiyacınız var: diff --git a/docs/vi-VN/README.md b/docs/vi-VN/README.md index 3dd37d2f..56fa5d7c 100644 --- a/docs/vi-VN/README.md +++ b/docs/vi-VN/README.md @@ -120,7 +120,7 @@ description: Starship là prompt nhỏ, cực nhanh, và khả năng tuỳ biế #### Elvish - ::: warning Chỉ elvish v0.17 hoặc cao hơn được hỗ trợ. ::: + ::: warning Chỉ elvish v0.18 hoặc cao hơn được hỗ trợ. ::: Thêm đoạn sau vào cuối tệp tin `~/.elvish/rc.elv`: diff --git a/docs/vi-VN/advanced-config/README.md b/docs/vi-VN/advanced-config/README.md index 304eb3d8..a2c17a47 100644 --- a/docs/vi-VN/advanced-config/README.md +++ b/docs/vi-VN/advanced-config/README.md @@ -131,7 +131,7 @@ Invoke-Expression (&starship init powershell) Some shells support a right prompt which renders on the same line as the input. Starship can set the content of the right prompt using the `right_format` option. Any module that can be used in `format` is also supported in `right_format`. The `$all` variable will only contain modules not explicitly used in either `format` or `right_format`. -Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [fill module](/config/#fill). +Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [`fill` module](/config/#fill). `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd. diff --git a/docs/vi-VN/config/README.md b/docs/vi-VN/config/README.md index 43fa7000..b00c883d 100644 --- a/docs/vi-VN/config/README.md +++ b/docs/vi-VN/config/README.md @@ -9,6 +9,9 @@ mkdir -p ~/.config && touch ~/.config/starship.toml Tất cả cấu hình của starship đã xong trong tập tin này: [TOML](https://github.com/toml-lang/toml): ```toml +# Get editor completions based on the config schema +"$schema" = 'https://starship.rs/config-schema.json' + # Inserts a blank line between shell prompts add_newline = true @@ -199,6 +202,7 @@ $hg_branch\ $docker_context\ $package\ $buf\ +$c\ $cmake\ $cobol\ $container\ @@ -235,6 +239,7 @@ $vagrant\ $zig\ $nix_shell\ $conda\ +$spack\ $memory_usage\ $aws\ $gcloud\ @@ -263,9 +268,9 @@ format = "$all$directory$character" ## AWS -The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. Cái này dựa trên các biến môi trường `AWS_REGION`, `AWS_DEFAULT_REGION`, và `AWS_PROFILE` với tập tin `~/.aws/config`. This module also shows an expiration timer when using temporary credentials. +The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. Alternatively, you can force this module to show the region and profile even when the credentials have not been setup with the `force_display` option. Cái này dựa trên các biến môi trường `AWS_REGION`, `AWS_DEFAULT_REGION`, và `AWS_PROFILE` với tập tin `~/.aws/config`. This module also shows an expiration timer when using temporary credentials. -The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. +The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if the conditions above are not respected. When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var. @@ -275,15 +280,16 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL ### Các tuỳ chọn -| Tuỳ chọn | Mặc định | Mô tả | -| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------- | -| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | Định dạng cho module. | -| `symbol` | `"☁️ "` | Kí hiệu sử dụng hiển thị trước profile AWS hiện tại. | -| `region_aliases` | | Bảng của các region alias để hiển thị ngoài tên AWS. | -| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | -| `style` | `"bold yellow"` | Kiểu cho module. | -| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. | -| `disabled` | `false` | Disables the `AWS` module. | +| Tuỳ chọn | Mặc định | Mô tả | +| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | +| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | Định dạng cho module. | +| `symbol` | `"☁️ "` | Kí hiệu sử dụng hiển thị trước profile AWS hiện tại. | +| `region_aliases` | | Bảng của các region alias để hiển thị ngoài tên AWS. | +| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | +| `style` | `"bold yellow"` | Kiểu cho module. | +| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. | +| `disabled` | `false` | Vô hiệu `AWS` module. | +| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. | ### Các biến @@ -451,7 +457,7 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil | `detect_files` | `["buf.yaml", "buf.gen.yaml", "buf.work.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. | | `style` | `"bold blue"` | Kiểu cho module. | -| `disabled` | `false` | Disables the `elixir` module. | +| `disabled` | `false` | Vô hiệu mô đun `elixir`. | ### Các biến @@ -472,16 +478,62 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil symbol = "🦬 " ``` +## C + +The `c` module shows some information about your C compiler. By default the module will be shown if the current directory contains a `.c` or `.h` file. + +### Các tuỳ chọn + +| Tuỳ chọn | Mặc định | Mô tả | +| ------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version(-$name) )]($style)"` | The format string for the module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"C "` | The symbol used before displaying the compiler details | +| `detect_extensions` | `["c", "h"]` | 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 sẽ kích hoạt mô-đun này. | +| `commands` | [ [ "cc", "--version" ], [ "gcc", "--version" ], [ "clang", "--version" ] ] | How to detect what the compiler is | +| `style` | `"bold 149"` | Kiểu cho module. | +| `disabled` | `false` | Disables the `c` module. | + +### Các biến + +| Biến | Ví dụ | Mô tả | +| ------- | ------ | -------------------------------- | +| name | clang | The name of the compiler | +| version | 13.0.0 | The version of the compiler | +| symbol | | Giá trị ghi đè tuỳ chọn `symbol` | +| style | | Giá trị ghi đè của `style` | + +NB that `version` is not in the default format. + +### Commands + +The `commands` option accepts a list of commands to determine the compiler version and name. + +Each command is represented as a list of the executable name, followed by its arguments, usually something like `["mycc", "--version"]`. Starship will try executing each command until it gets a result on STDOUT. + +If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). + +### Ví dụ + +```toml +# ~/.config/starship.toml + +[c] +format = "via [$name $version]($style)" +``` + ## Character -The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. +Module `character` cho biết một kí tự (thường là một mũi tên) bên cạnh nơi văn bản được nhập trong terminal của bạn. -The character will tell you whether the last command was successful or not. It can do this in two ways: +Kí tự sẽ nói cho bạn câu lệnh cuối liệu thành công hay thất bại. Nó có thể làm điều này bằng hai cách: -- changing color (`red`/`green`) -- changing shape (`❯`/`✖`) +- thay đổi màu(`đỏ`/`xanh lá`) +- thay đổi hình dạng (`❯`/`✖`) -By default it only changes color. If you also want to change its shape take a look at [this example](#with-custom-error-shape). +Mặc định, nó chỉ thay đổi màu. If you also want to change its shape take a look at [this example](#with-custom-error-shape). ::: cảnh báo @@ -491,19 +543,19 @@ By default it only changes color. If you also want to change its shape take a lo ### Các tuỳ chọn -| Tuỳ chọn | Mặc định | Mô tả | -| ---------------- | ------------------- | -------------------------------------------------------------------------------- | -| `format` | `"$symbol "` | The format string used before the text input. | -| `success_symbol` | `"[❯](bold green)"` | The format string used before the text input if the previous command succeeded. | -| `error_symbol` | `"[❯](bold red)"` | The format string used before the text input if the previous command failed. | -| `vicmd_symbol` | `"[❮](bold green)"` | The format string used before the text input if the shell is in vim normal mode. | -| `disabled` | `false` | Disables the `character` module. | +| Tuỳ chọn | Mặc định | Mô tả | +| ---------------- | ------------------- | ------------------------------------------------------------------------------------ | +| `format` | `"$symbol "` | Định dạng chuỗi sử dụng trước văn bản nhập vào. | +| `success_symbol` | `"[❯](bold green)"` | Định dạng chuỗi sửa dụng trước văn bản nhập vào nếu câu lệnh trước đó đã thành công. | +| `error_symbol` | `"[❯](bold red)"` | Định dạng chuỗi sửa dụng trước văn bản nhập vào nếu câu lệnh trước đó đã thất bại. | +| `vicmd_symbol` | `"[❮](bold green)"` | Định dạng chuỗi sửa dụng trước văn bản nhập vào nếu shell trong chế độ vim normal. | +| `disabled` | `false` | Vô hiệu module `character`. | ### Các biến -| Biến | Ví dụ | Mô tả | -| ------ | ----- | --------------------------------------------------------------------- | -| symbol | | A mirror of either `success_symbol`, `error_symbol` or `vicmd_symbol` | +| Biến | Ví dụ | Mô tả | +| ------ | ----- | ----------------------------------------------------------------------------- | +| symbol | | Một phản ánh của một trong `success_symbol`, `error_symbol` or `vicmd_symbol` | ### Các ví dụ @@ -538,10 +590,10 @@ vicmd_symbol = "[V](bold green) " ## CMake -The `cmake` module shows the currently installed version of [CMake](https://cmake.org/). By default the module will be activated if any of the following conditions are met: +The `cmake` module shows the currently installed version of [CMake](https://cmake.org/). Mặc định module sẽ được kích hoạt nếu thoả mãn bất kì điều kiện nào dưới đây: -- The current directory contains a `CMakeLists.txt` file -- The current directory contains a `CMakeCache.txt` file +- Đường dẫn hiện tại chứa một tập tin `CmakeLists.txt` +- Đường dẫn hiện tại chứa một tập tin `CMakeCache.txt` ### Các tuỳ chọn @@ -549,18 +601,18 @@ The `cmake` module shows the currently installed version of [CMake](https://cmak | ------------------- | -------------------------------------- | ------------------------------------------------------------------------- | | `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 the version of cmake. | -| `detect_extensions` | `[]` | Which extensions should trigger this module | -| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Which filenames should trigger this module | -| `detect_folders` | `[]` | Which folders should trigger this module | +| `symbol` | `"△ "` | Kí hiệu sử dụng trước phiên bản của cmake. | +| `detect_extensions` | `[]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này | +| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | Tên tệp nào sẽ kích hoạt mô-đun này | +| `detect_folders` | `[]` | Thư mục nào sẽ kích hoạt mô-đun này | | `style` | `"bold blue"` | Kiểu cho module. | -| `disabled` | `false` | Disables the `cmake` module. | +| `disabled` | `false` | Vô hiệu module `cmake`. | ### Các biến | Biến | Ví dụ | Mô tả | | --------- | --------- | -------------------------------- | -| version | `v3.17.3` | The version of cmake | +| version | `v3.17.3` | Phiên bản của cmake | | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | @@ -598,35 +650,35 @@ The `cobol` module shows the currently installed version of COBOL. By default, t ## Command Duration -The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists. +Module `cmd_duration`. cho biết câu lệnh cuối cùng thực thi trong bao lâu. Module sẽ được hiện chỉ khi câu lệnh lấy nhiều hơn 2 giây, hoặc giá trị cấu hình `min_time`, nếu nó tồn tại. -::: warning Do not hook the DEBUG trap in Bash +::: warning Không thể hook DEBUG trap trong Bash -If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. +Nếu bạn đang chạy Starship trong `bash`, không thể hook `DEBUG` trap sau khi chạy `eval $(starship init $0)`, hoặc module này **sẽ** ngắt. ::: -Bash users who need preexec-like functionality can use [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Simply define the arrays `preexec_functions` and `precmd_functions` before running `eval $(starship init $0)`, and then proceed as normal. +Người dùng Bash, những người cần chức năng giống preexec có thể sử dụng [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Đơn giản là định nghĩa các mảng `preexec_functions` và `precmd_functions` trước khi chạy `eval $(starship init $0)`, và sau đó thực thi như bình thường. ### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ---------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). | -| `show_milliseconds` | `false` | Show milliseconds in addition to seconds for the duration. | +| `min_time` | `2_000` | Khoảng thời gian ngắn nhất để hiện thời gian (tính bằng milliseconds). | +| `show_milliseconds` | `false` | Hiện milliseconds. | | `format` | `"took [$duration]($style) "` | Định dạng cho module. | | `style` | `"bold yellow"` | Kiểu cho module. | -| `disabled` | `false` | Disables the `cmd_duration` module. | -| `show_notifications` | `false` | Show desktop notifications when command completes. | -| `min_time_to_notify` | `45_000` | Shortest duration for notification (in milliseconds). | +| `disabled` | `false` | Vô hiệu module `cmd_duration`. | +| `show_notifications` | `false` | Hiện thông báo desktop khi câu lệnh hoàn thành. | +| `min_time_to_notify` | `45_000` | Khoảng thời gian ngắn nhất để thông báo (tính bằng milliseconds). | | `notification_timeout` | | Duration to show notification for (in milliseconds). If unset, notification timeout will be determined by daemon. Not all notification daemons honor this option. | ### Các biến -| Biến | Ví dụ | Mô tả | -| --------- | -------- | --------------------------------------- | -| duration | `16m40s` | The time it took to execute the command | -| style\* | | Giá trị ghi đè của `style` | +| Biến | Ví dụ | Mô tả | +| --------- | -------- | ------------------------------------- | +| duration | `16m40s` | Thời gian nó lấy để thực thi câu lệnh | +| 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 @@ -646,7 +698,7 @@ The `conda` module shows the current [Conda](https://docs.conda.io/en/latest/) e ::: tip -This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. +Cái này không loại bỏ conda's prompt mà nó sở hữu, bạn có thể muốn chạy `conda config --set changeps1 False`. ::: @@ -654,20 +706,20 @@ This does not suppress conda's own prompt modifier, you may want to run `conda c | Tuỳ chọn | Mặc định | Mô tả | | ------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `truncation_length` | `1` | The number of directories the environment path should be truncated to, if the environment was created via `conda create -p [path]`. `0` means no truncation. Also see the [`directory`](#directory) module. | -| `symbol` | `"🅒 "` | The symbol used before the environment name. | +| `truncation_length` | `1` | Số lượng đường dẫn của biến môi trường nên được cắt bớt, nếu biến môi trường được tạo thông qua via `conda create -p [path]`. `0` nghĩa là không cắt bớt. Cũng thấy trong module [`directory`](#directory). | +| `symbol` | `"🅒 "` | Kí hiệu sử dụng trước tên biến môi trường. | | `style` | `"bold green"` | Kiểu cho module. | | `format` | `"via [$symbol$environment]($style) "` | Định dạng cho module. | -| `ignore_base` | `true` | Ignores `base` environment when activated. | -| `disabled` | `false` | Disables the `conda` module. | +| `ignore_base` | `true` | Bỏ qua biến môi trường `base` khi đã kích hoạt. | +| `disabled` | `false` | Vô hiệu module `conda`. | ### Các biến -| Biến | Ví dụ | Mô tả | -| ----------- | ------------ | -------------------------------- | -| environment | `astronauts` | The current conda environment | -| symbol | | Giá trị ghi đè tuỳ chọn `symbol` | -| style\* | | Giá trị ghi đè của `style` | +| Biến | Ví dụ | Mô tả | +| ----------- | ------------ | ---------------------------------- | +| environment | `astronauts` | Biến môi trường hiện tại của conda | +| 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 @@ -714,29 +766,29 @@ format = "[$symbol \\[$name\\]]($style) " ## Crystal -The `crystal` module shows the currently installed version of [Crystal](https://crystal-lang.org/). By default the module will be shown if any of the following conditions are met: +The `crystal` module shows the currently installed version of [Crystal](https://crystal-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 `shard.yml` file -- The current directory contains a `.cr` file +- Đường dẫn hiện tại chứa một tập tin `shard.yml` +- Đường dẫn hiện tại chứa một tập tin `.cr` ### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | +| `symbol` | `"🔮 "` | Kí hiệu sử dụng trước phiên bản hiển thị của crystal. | | `format` | `"via [$symbol($version )]($style)"` | Định dạng cho module. | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `style` | `"bold red"` | Kiểu cho module. | | `detect_extensions` | `["cr"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | | `detect_files` | `["shard.yml"]` | Những tên tệp nào sẽ kích hoạt mô-đun này. | | `detect_folders` | `[]` | Những thư mục nào sẽ kích hoạt mô-đun này. | -| `disabled` | `false` | Disables the `crystal` module. | +| `disabled` | `false` | Vô hiệu hoá module `crystal`. | ### Các biến | Biến | Ví dụ | Mô tả | | --------- | --------- | -------------------------------- | -| version | `v0.32.1` | The version of `crystal` | +| version | `v0.32.1` | Phiên bản của `crystal` | | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | @@ -753,11 +805,11 @@ format = "via [✨ $version](bold blue) " ## Dart -The `dart` module shows the currently installed version of [Dart](https://dart.dev/). By default the module will be shown if any of the following conditions are met: +The `dart` module shows the currently installed version of [Dart](https://dart.dev/). Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn: -- The current directory contains a file with `.dart` extension -- The current directory contains a `.dart_tool` directory -- The current directory contains a `pubspec.yaml`, `pubspec.yml` or `pubspec.lock` file +- Đường dẫn hiện tại chứa một tập tin với phần mở rộng `.dart` +- Đường dẫn hiện tại chứa một đường dẫn `.dart_tool` +- Đường dẫn hiện tại chứa một tệp tin `pubspec.yaml`, `pubspec.yml` hoặc `pubspec.lock` ### Các tuỳ chọn @@ -765,18 +817,18 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d | ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------- | | `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 Dart | +| `symbol` | `"🎯 "` | Một chuỗi định dạng hiển thị biểu tượng của Dart | | `detect_extensions` | `["dart"]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | | `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Những tên tệp nào sẽ kích hoạt mô-đun này. | | `detect_folders` | `[".dart_tool"]` | Những thư mục nào sẽ kích hoạt mô-đun này. | | `style` | `"bold blue"` | Kiểu cho module. | -| `disabled` | `false` | Disables the `dart` module. | +| `disabled` | `false` | Vô hiệu `dart` module. | ### Các biến | Biến | Ví dụ | Mô tả | | --------- | -------- | -------------------------------- | -| version | `v2.8.4` | The version of `dart` | +| version | `v2.8.4` | Phiên bản của `dart` | | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | @@ -793,7 +845,7 @@ format = "via [🔰 $version](bold red) " ## Deno -The `deno` module shows you your currently installed version of [Deno](https://deno.land/). By default the module will be shown if any of the following conditions are met: +The `deno` module shows you your currently installed version of [Deno](https://deno.land/). 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 `deno.json`, `deno.jsonc`, `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file @@ -829,33 +881,33 @@ format = "via [🦕 $version](green bold) " ## Đường dẫn -The `directory` module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in. +`directory` module hiển thị đường dẫn thư mục hiện hành của bạn,, cắt ngắn ba thư mục cha. Đường dẫn của bạn cũng sẽ được cắt ngắn tới đường dẫn gốc của git repo hiện tại của bạn. -When using the fish style pwd option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option. +Khi sử dụng fish style pwd option, thay vì ẩn đường dẫn được rút gọn, bạn sẽ thấy một tên ngắn cho mỗi thư mục dựa trên số bạn cho phép trng tùy chọn. -For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, and the option set to `1`. You will now see `~/D/N/nixpkgs/pkgs`, whereas before it would have been `nixpkgs/pkgs`. +Cho ví dụ, `~/Dev/Nix/nixpkgs/pkgs` nơi `nixpkgs` là gốc của repo, và tuỳ chọn thiết lập sang `1`. Bây giờ bạn sẽ thấy `~/D/N/nixpkgs/pkgs`, trong khi trước nó là `nixpkgs/pkgs`. ### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ------------------- | ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. | -| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. | +| `truncation_length` | `3` | Số lượng thư mục cha của thư mục hiện tại nên được rút gọn. | +| `truncate_to_repo` | `true` | Có hoặc không rút gọn đường dẫn gốc của git repo hiện tại của bạn. | | `format` | `"[$path]($style)[$read_only]($read_only_style) "` | Định dạng cho module. | | `style` | `"bold cyan"` | Kiểu cho module. | -| `disabled` | `false` | Disables the `directory` module. | -| `read_only` | `"🔒"` | The symbol indicating current directory is read only. | -| `read_only_style` | `"red"` | The style for the read only symbol. | -| `truncation_symbol` | `""` | The symbol to prefix to truncated paths. eg: "…/" | +| `disabled` | `false` | Vô hiệu mô đun `directory`. | +| `read_only` | `"🔒"` | Biểu tượng để nhận biết thư mục hiện tại là chỉ đọc. | +| `read_only_style` | `"red"` | Style cho biểu tượng chỉ đọc. | +| `truncation_symbol` | `""` | Biểu tượng tiền tố cho các đường dẫn rút gọn. ví dụ: "…/" | | `repo_root_style` | `None` | The style for the root of the git repo. The default value is equivalent to `style`. | | `repo_root_format` | `"[$before_root_path]($style)[$repo_root]($repo_root_style)[$path]($style)[$read_only]($read_only_style) "` | The format of a git repo when `repo_root_style` is defined. | -| `home_symbol` | `"~"` | The symbol indicating home directory. | +| `home_symbol` | `"~"` | Biểu tượng nhận biết thư mục home. | | `use_os_path_sep` | `true` | Use the OS specific path separator instead of always using `/` (e.g. `\` on Windows) |
-This module has a few advanced configuration options that control how the directory is displayed. +Mô đun này có một vài tùy chọn nâng cao để điều khiển cách thư mục được hiển thị. -| Advanced Option | Mặc định | Mô tả | +| Tùy chọn nâng cao | Mặc định | Mô tả | | --------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `substitutions` | | A table of substitutions to be made to the path. | | `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. | @@ -877,7 +929,7 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an | Biến | Ví dụ | Mô tả | | --------- | --------------------- | -------------------------- | -| path | `"D:/Projects"` | The current directory path | +| path | `"D:/Projects"` | Đường dẫn thư mục hiện tại | | style\* | `"black bold dimmed"` | 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 @@ -913,22 +965,22 @@ The `docker_context` module shows the currently active [Docker context](https:// ### Các tuỳ chọn -| Tuỳ chọn | Mặc định | Mô tả | -| ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- | -| `format` | `"via [$symbol$context]($style) "` | Định dạng cho module. | -| `symbol` | `"🐳 "` | The symbol used before displaying the Docker context. | -| `only_with_files` | `true` | Only show when there's a match | -| `detect_extensions` | `[]` | Which extensions should trigger this module (needs `only_with_files` to be true). | -| `detect_files` | `["docker-compose.yml", "docker-compose.yaml", "Dockerfile"]` | Which filenames should trigger this module (needs `only_with_files` to be true). | -| `detect_folders` | `[]` | Which folders should trigger this module (needs `only_with_files` to be true). | -| `style` | `"blue bold"` | Kiểu cho module. | -| `disabled` | `false` | Disables the `docker_context` module. | +| Tuỳ chọn | Mặc định | Mô tả | +| ------------------- | ------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | +| `format` | `"via [$symbol$context]($style) "` | Định dạng cho module. | +| `symbol` | `"🐳 "` | Biểu tượng sử dụng để hiển thị trước Docker context. | +| `only_with_files` | `true` | Chỉ hiển thị khi có một tệp tin khớp | +| `detect_extensions` | `[]` | Các mở rộng nào nên kích hoạt mô đun này (cần `only_with_files` thiết lập là true). | +| `detect_files` | `["docker-compose.yml", "docker-compose.yaml", "Dockerfile"]` | Tên tệp tin nào nên kích hoạt mô đun này (cần `only_with_files` được thiết lập là true). | +| `detect_folders` | `[]` | Thư mục nào nên kích hoạt mô đun này (cần `only_with_files` được thiết lập là true). | +| `style` | `"blue bold"` | Kiểu cho module. | +| `disabled` | `false` | Vô hiệu mô đun `docker_context`. | ### Các biến | Biến | Ví dụ | Mô tả | | --------- | -------------- | -------------------------------- | -| context | `test_context` | The current docker context | +| context | `test_context` | Docker context hiện tại | | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | @@ -945,9 +997,9 @@ format = "via [🐋 $context](blue bold)" ## Dotnet -The `dotnet` module shows the relevant version of the [.NET Core SDK](https://dotnet.microsoft.com/) for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. +The `dotnet` module shows the relevant version of the [.NET Core SDK](https://dotnet.microsoft.com/) for the current directory. Nếu SDK được ghim trong thư mục hiện tại, phiên bản ghim đó được hiển thị. Ngược lại, mô đun hiển thị phiên bản cuối cùng của SDK được cài đặt. -By default this module will only be shown in your prompt when one or more of the following files are present in the current directory: +Mặc định, mô đun này sẽ chỉ được hiển thị trong dấu nhắc lệnh của bạn khi một hoặc nhiều tệp tin dưới đây xuất hiện trong thư mục hiện tại: - `global.json` - `project.json` @@ -958,11 +1010,11 @@ By default this module will only be shown in your prompt when one or more of the - `*.fsproj` - `*.xproj` -You'll also need the .NET Core SDK installed in order to use it correctly. +Bạn cũng sẽ cần cài đặt .NET Core SDK đúng cách để sử dụng một cách chính xác. -Internally, this module uses its own mechanism for version detection. Typically it is twice as fast as running `dotnet --version`, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting `heuristic = false` in the module options. +Mô đun này sử dụng cơ chế của bản thân để phát hiện phiên bản của chính nó. Thông thường, nó nhanh gấp đôi nếu chạy `dotnet --version`, nhưng nó có thể hiện sai phiên bản nếu dự án .NET của bạn có một cấu trúc thư mục bất thường. Nếu độ chính xác quan trọng hơn tốc độ, bạn có thể vô hiệu cơ chế bằng cài đặt `heuristic = false` trong các tùy chọn mô đun. -The module will also show the Target Framework Moniker () when there is a csproj file in the current directory. +The module will also show the Target Framework Moniker () when there is a `.csproj` file in the current directory. ### Các tuỳ chọn @@ -970,22 +1022,22 @@ The module will also show the Target Framework Moniker ("` | The description of the module that is shown when running `starship explain`. | -| `files` | `[]` | The files that will be searched in the working directory for a match. | -| `directories` | `[]` | The directories that will be searched in the working directory for a match. | -| `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"` | Kiểu cho module. | -| `format` | `"[$symbol($output )]($style)"` | Định dạng cho module. | -| `disabled` | `false` | Disables this `custom` module. | -| `os` | | Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) [See possible values](https://doc.rust-lang.org/std/env/consts/constant.OS.html). | +| 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`. | +| `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"` | Kiểu cho module. | +| `format` | `"[$symbol($output )]($style)"` | Định dạng cho module. | +| `disabled` | `false` | Disables this `custom` module. | +| `os` | | Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) [See possible values](https://doc.rust-lang.org/std/env/consts/constant.OS.html). | +| `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. | ### Các biến @@ -3487,7 +3574,7 @@ If unset, it will fallback to STARSHIP_SHELL and then to "sh" on Linux, and "cmd The `command` will be passed in on stdin. -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 -`. This behavior can be avoided by explicitly passing arguments to the shell, e.g. +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", "-"] @@ -3512,12 +3599,18 @@ Automatic detection of shells and proper parameters addition are currently imple [custom.foo] command = "echo foo" # shows output of command -files = ["foo"] # can specify filters but wildcards are not supported +detect_files = ["foo"] # can specify filters but wildcards are not supported when = """ test "$HOME" == "$PWD" """ format = " transcending [$output]($style)" [custom.time] command = "time /T" -extensions = ["pst"] # filters *.pst files +detect_extensions = ["pst"] # filters *.pst files shell = ["pwsh.exe", "-NoProfile", "-Command", "-"] + +[custom.time-as-arg] +command = "time /T" +detect_extensions = ["pst"] # filters *.pst files +shell = ["pwsh.exe", "-NoProfile", "-Command"] +use_stdin = false ``` diff --git a/docs/vi-VN/guide/README.md b/docs/vi-VN/guide/README.md index 6cea74be..1ed81317 100644 --- a/docs/vi-VN/guide/README.md +++ b/docs/vi-VN/guide/README.md @@ -145,7 +145,7 @@ Starship with iTerm2 and the Snazzy theme @@ -160,7 +160,7 @@ - **Dễ dàng:** cài đặt nhanh chóng – bắt đầu sử dụng nó trong vài phút.

-Explore the Starship docs  ▶ +Khám phá tài liệu của Starship  ▶

@@ -297,7 +297,7 @@ Thêm đoạn sau vào cuối tệp tin `~/.elvish/rc.elv`: eval (starship init elvish) ``` -Note: Only Elvish v0.17+ is supported +Note: Only Elvish v0.18+ is supported
@@ -400,15 +400,15 @@ If you're looking to further customize Starship: ## 🤝 Đóng góp -We are always looking for contributors of **all skill levels**! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). +Chúng tôi luôn luôn tìm kiếm những cộng tác viên ở **tất cả các các mức độ về kĩ năng**! Nếu bạn đang tìm kiếm cách dễ dàng để tham gia vào dự án, thử một [good issue đầu tiên](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). -If you are fluent in a non-English language, we greatly appreciate any help keeping our docs translated and up-to-date in other languages. If you would like to help, translations can be contributed on the [Starship Crowdin](https://translate.starship.rs/). +Nếu bạn thành thạo một ngôn ngữ không phải Tiếng Anh, chúng tôi đánh giá cao mọi sự giúp đỡ của bạn trong việc dịch tài liệu của chúng tôi và cập nhật các ngôn ngữ khác. Nếu bạn muốn giúp đỡ, những bản dịch có thể được đóng góp trên [Starship Crowdin](https://translate.starship.rs/). -If you are interested in helping contribute to starship, please take a look at our [Contributing Guide](https://github.com/starship/starship/blob/master/CONTRIBUTING.md). Also, feel free to drop into our [Discord server](https://discord.gg/8Jzqu3T) and say hi. 👋 +Nếu bạn thích thú trong việc giúp đỡ đóng góp cho starship, xin hãy xem [Hướng dẫn đóng góp](https://github.com/starship/starship/blob/master/CONTRIBUTING.md) của chúng tôi. Ngoài ra, vui lòng truy cập vào [máy chủ Discord](https://discord.gg/8Jzqu3T) và nói xin chào. 👋 ## Cảm hứng -Please check out these previous works that helped inspire the creation of starship. 🙏 +Xin hãy xem qua những công việc này trước đây, những thứ đã giúp truyền cảm hứng để tạo ra starship. 🙏 - **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** – A ZSH prompt for astronauts. @@ -423,4 +423,4 @@ Please check out these previous works that helped inspire the creation of starsh ## 📝 Giấy phép -Copyright © 2019-present, [Starship Contributors](https://github.com/starship/starship/graphs/contributors).
This project is [ISC](https://github.com/starship/starship/blob/master/LICENSE) licensed. +Bản quyền © 2019-nay, [Starship Contributors](https://github.com/starship/starship/graphs/contributors).
Dự án này được [ISC](https://github.com/starship/starship/blob/master/LICENSE) cấp phép. diff --git a/docs/vi-VN/installing/README.md b/docs/vi-VN/installing/README.md index e93980e6..240ad73d 100644 --- a/docs/vi-VN/installing/README.md +++ b/docs/vi-VN/installing/README.md @@ -1,4 +1,4 @@ -# Advanced Installation +# Cài đặt nâng cao Để cài đặt starship, bạn cần làm 2 thứ: diff --git a/docs/zh-CN/README.md b/docs/zh-CN/README.md index 890e7d47..57acc5ad 100644 --- a/docs/zh-CN/README.md +++ b/docs/zh-CN/README.md @@ -120,7 +120,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p #### Elvish - ::: warning Only elvish v0.17 or higher is supported. ::: + ::: warning 警告 只支持 elvish v0.18 及以上。 ::: 在 `~/.config/fish/rc.elv` 的最后，添加以下内容： @@ -144,7 +144,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p #### Nushell - ::: warning This will change in the future. Only Nushell v0.60+ is supported. ::: Run the following: + ::: warning 警告 将来可能会改变。 Only Nushell v0.60+ is supported. ::: Run the following: ```sh mkdir ~/.cache/starship starship init nu | save ~/.cache/starship/init.nu @@ -171,7 +171,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p #### Cmd - 您需要使用 [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) 与 Cmd. Add the following to a file `starship.lua` and place this file in Clink scripts directory: + 您需要使用 [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) 与 Cmd. 将以下文件添加到文件 `starship.lua` 中，并将此文件放置在 Clink脚本目录中： ```lua -- starship.lua diff --git a/docs/zh-CN/advanced-config/README.md b/docs/zh-CN/advanced-config/README.md index bd0f5b67..4ae67117 100644 --- a/docs/zh-CN/advanced-config/README.md +++ b/docs/zh-CN/advanced-config/README.md @@ -131,7 +131,7 @@ Invoke-Expression (&starship init powershell) 一些 Shell 支持右侧提示, 它与输入区渲染在同一行。 Starship 可以设置右侧提示的内容，使用 `right_format` 选项。 Any module that can be used in `format` is also supported in `right_format`. The `$all` variable will only contain modules not explicitly used in either `format` or `right_format`. -Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [fill module](/config/#fill). +Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [`fill` module](/config/#fill). `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd. diff --git a/docs/zh-CN/config/README.md b/docs/zh-CN/config/README.md index 40a30799..e60fe46d 100644 --- a/docs/zh-CN/config/README.md +++ b/docs/zh-CN/config/README.md @@ -9,6 +9,9 @@ mkdir -p ~/.config && touch ~/.config/starship.toml Starship 的所有配置都在此 [TOML](https://github.com/toml-lang/toml) 配置文件中完成： ```toml +# Get editor completions based on the config schema +"$schema" = 'https://starship.rs/config-schema.json' + # Inserts a blank line between shell prompts add_newline = true @@ -199,6 +202,7 @@ $hg_branch\ $docker_context\ $package\ $buf\ +$c\ $cmake\ $cobol\ $container\ @@ -235,6 +239,7 @@ $vagrant\ $zig\ $nix_shell\ $conda\ +$spack\ $memory_usage\ $aws\ $gcloud\ @@ -263,9 +268,9 @@ format = "$all$directory$character" ## AWS -The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. 各组件基于 `AWS_REGION`，`AWS_DEFAULT_REGION` 和 `AWS_PROFILE` 环境变量与 `~/.aws/config` 文件。 This module also shows an expiration timer when using temporary credentials. +The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. Alternatively, you can force this module to show the region and profile even when the credentials have not been setup with the `force_display` option. 各组件基于 `AWS_REGION`，`AWS_DEFAULT_REGION` 和 `AWS_PROFILE` 环境变量与 `~/.aws/config` 文件。 This module also shows an expiration timer when using temporary credentials. -The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. +The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if the conditions above are not respected. When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var. @@ -275,15 +280,16 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL ### 配置项 -| Option | 默认值 | 描述 | -| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------- | -| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | 组件格式化模板。 | -| `symbol` | `"☁️ "` | 这个字段的内容会显示在当前 AWS 配置信息之前。 | -| `region_aliases` | | 地区缩写列表，用来显示在 AWS 主机名之后。 | -| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | -| `style` | `"bold yellow"` | 此组件的样式。 | -| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. | -| `disabled` | `false` | Disables the `AWS` module. | +| Option | 默认值 | 描述 | +| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | +| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | 组件格式化模板。 | +| `symbol` | `"☁️ "` | 这个字段的内容会显示在当前 AWS 配置信息之前。 | +| `region_aliases` | | 地区缩写列表，用来显示在 AWS 主机名之后。 | +| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | +| `style` | `"bold yellow"` | 此组件的样式。 | +| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. | +| `disabled` | `false` | 禁用 `AWS` 组件。 | +| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. | ### Variables @@ -472,11 +478,57 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil symbol = "🦬 " ``` +## C + +The `c` module shows some information about your C compiler. By default the module will be shown if the current directory contains a `.c` or `.h` file. + +### 配置项 + +| Option | 默认值 | 描述 | +| ------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version(-$name) )]($style)"` | The format string for the module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"C "` | The symbol used before displaying the compiler details | +| `detect_extensions` | `["c", "h"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `commands` | [ [ "cc", "--version" ], [ "gcc", "--version" ], [ "clang", "--version" ] ] | How to detect what the compiler is | +| `style` | `"bold 149"` | 此组件的样式。 | +| `disabled` | `false` | Disables the `c` module. | + +### Variables + +| 字段 | 示例 | 描述 | +| ------- | ------ | --------------------------- | +| name | clang | The name of the compiler | +| version | 13.0.0 | The version of the compiler | +| symbol | | `symbol`对应值 | +| style | | `style`对应值 | + +NB that `version` is not in the default format. + +### Commands + +The `commands` option accepts a list of commands to determine the compiler version and name. + +Each command is represented as a list of the executable name, followed by its arguments, usually something like `["mycc", "--version"]`. Starship will try executing each command until it gets a result on STDOUT. + +If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). + +### 示例 + +```toml +# ~/.config/starship.toml + +[c] +format = "via [$name $version]($style)" +``` + ## Character -The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. +`character` 组件用于在您输入终端的文本旁显示一个字符（通常是一个箭头）。 -The character will tell you whether the last command was successful or not. It can do this in two ways: +这个字符可以告诉您最后一个命令是否执行成功。 It can do this in two ways: - changing color (`red`/`green`) - changing shape (`❯`/`✖`) @@ -497,7 +549,7 @@ By default it only changes color. If you also want to change its shape take a lo | `success_symbol` | `"[❯](bold green)"` | The format string used before the text input if the previous command succeeded. | | `error_symbol` | `"[❯](bold red)"` | The format string used before the text input if the previous command failed. | | `vicmd_symbol` | `"[❮](bold green)"` | The format string used before the text input if the shell is in vim normal mode. | -| `disabled` | `false` | Disables the `character` module. | +| `disabled` | `false` | 禁用 `character` 组件。 | ### Variables @@ -598,25 +650,25 @@ The `cobol` module shows the currently installed version of COBOL. By default, t ## Command Duration -The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists. +`cmd_duration` 组件显示上一个命令执行的时间。 此组件只在命令执行时间长于两秒时显示，或者当其 `min_time` 字段被设置时，按此值为执行时间的显示下限。 -::: warning Do not hook the DEBUG trap in Bash +::: warning 不要在 Bash 里捕获 DEBUG 信号 -If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. +如果您正在 `bash` 上使用 Starship，在运行 `eval $(starship)` 后，不要捕获 `DEBUG` 信号，否则此组件**将会**坏掉。 ::: -Bash users who need preexec-like functionality can use [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Simply define the arrays `preexec_functions` and `precmd_functions` before running `eval $(starship init $0)`, and then proceed as normal. +需要在自动每一条命令前执行某些操作的 Bash 用户可以使用 [rcaloras 的 bash_preexec 框架](https://github.com/rcaloras/bash-preexec)。 只需要在执行 `eval $(starship init $0)` 前简单地定义 `preexec_functions` 和 `precmd_functions` 两个列表，就可以照常运行了。 ### 配置项 | Option | 默认值 | 描述 | | ---------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). | -| `show_milliseconds` | `false` | Show milliseconds in addition to seconds for the duration. | +| `min_time` | `2_000` | 显示此组件所需的最短执行时长（单位：毫秒）。 | +| `show_milliseconds` | `false` | 除了秒数外在执行时长中额外显示毫秒。 | | `format` | `"took [$duration]($style) "` | 组件格式化模板。 | | `style` | `"bold yellow"` | 此组件的样式。 | -| `disabled` | `false` | Disables the `cmd_duration` module. | +| `disabled` | `false` | 禁用 `cmd_duration` 组件。 | | `show_notifications` | `false` | Show desktop notifications when command completes. | | `min_time_to_notify` | `45_000` | Shortest duration for notification (in milliseconds). | | `notification_timeout` | | Duration to show notification for (in milliseconds). If unset, notification timeout will be determined by daemon. Not all notification daemons honor this option. | @@ -646,20 +698,20 @@ The `conda` module shows the current [Conda](https://docs.conda.io/en/latest/) e ::: tip -This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. +此组件没有禁用 conda 自带的提示符修改，您可能需要执行 `conda config --set changeps1 False`。 ::: ### 配置项 -| Option | 默认值 | 描述 | -| ------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `truncation_length` | `1` | The number of directories the environment path should be truncated to, if the environment was created via `conda create -p [path]`. `0` means no truncation. Also see the [`directory`](#directory) module. | -| `symbol` | `"🅒 "` | The symbol used before the environment name. | -| `style` | `"bold green"` | 此组件的样式。 | -| `format` | `"via [$symbol$environment]($style) "` | 组件格式化模板。 | -| `ignore_base` | `true` | Ignores `base` environment when activated. | -| `disabled` | `false` | Disables the `conda` module. | +| Option | 默认值 | 描述 | +| ------------------- | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | +| `truncation_length` | `1` | 如果这个 conda 环境是通过 `conda create -p [path]` 创建的，环境路径的目录深度应该被截断到此数量。 `0` 表示不用截断。 另请参阅 [`directory`](#directory) 组件。 | +| `symbol` | `"🅒 "` | 在环境名之前显示的符号。 | +| `style` | `"bold green"` | 此组件的样式。 | +| `format` | `"via [$symbol$environment]($style) "` | 组件格式化模板。 | +| `ignore_base` | `true` | Ignores `base` environment when activated. | +| `disabled` | `false` | 禁用 `conda` 组件。 | ### Variables @@ -716,7 +768,7 @@ format = "[$symbol \\[$name\\]]($style) " The `crystal` module shows the currently installed version of [Crystal](https://crystal-lang.org/). By default the module will be shown if any of the following conditions are met: -- The current directory contains a `shard.yml` file +- 当前目录包含 `shard.yml` 文件 - The current directory contains a `.cr` file ### 配置项 @@ -757,7 +809,7 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d - The current directory contains a file with `.dart` extension - The current directory contains a `.dart_tool` directory -- The current directory contains a `pubspec.yaml`, `pubspec.yml` or `pubspec.lock` file +- 当前目录包含 `pubspec.yaml`，`pubspec.yml` 或 `pubspec.lock` 文件 ### 配置项 @@ -829,21 +881,21 @@ format = "via [🦕 $version](green bold) " ## Directory -The `directory` module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in. +`directory` 组件显示当前目录的路径，显示的路径会截断到三个父目录以内。 如果您处于一个 git 仓库中，显示的路径则最多会截断到该仓库的根目录。 -When using the fish style pwd option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option. +当使用 fish 风格的当前目录显示样式时，您会看到基于您的设置的每个上级目录的短名称，而不是隐藏被截断的上级目录。 -For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, and the option set to `1`. You will now see `~/D/N/nixpkgs/pkgs`, whereas before it would have been `nixpkgs/pkgs`. +例如，对于 `~/Dev/Nix/nixpkgs/pkgs`，其中 `nixpkgs` 是 git 仓库根目录，fish 风格相关选项设置为 `1`。 您将会看到 `~/D/N/nixpkgs/pkgs`，而在设置 fish 风格之前，当前路径将显示成 `nixpkgs/pkgs`。 ### 配置项 | Option | 默认值 | 描述 | | ------------------- | ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. | -| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. | +| `truncation_length` | `3` | 当前目录路径被截断后最多保留的父目录数量。 | +| `truncate_to_repo` | `true` | 是否只截断到您当前处于的 git 仓库根目录下。 | | `format` | `"[$path]($style)[$read_only]($read_only_style) "` | 组件格式化模板。 | | `style` | `"bold cyan"` | 此组件的样式。 | -| `disabled` | `false` | Disables the `directory` module. | +| `disabled` | `false` | 禁用 `directory` 组件。 | | `read_only` | `"🔒"` | The symbol indicating current directory is read only. | | `read_only_style` | `"red"` | The style for the read only symbol. | | `truncation_symbol` | `""` | The symbol to prefix to truncated paths. eg: "…/" | @@ -853,12 +905,12 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an | `use_os_path_sep` | `true` | Use the OS specific path separator instead of always using `/` (e.g. `\` on Windows) |
-This module has a few advanced configuration options that control how the directory is displayed. +此组件有几个高级配置选项来控制当前目录路径的显示方式。 | Advanced Option | 默认值 | 描述 | | --------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `substitutions` | | A table of substitutions to be made to the path. | -| `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. | +| `fish_style_pwd_dir_length` | `0` | 使用 fish shell 当前目录路径逻辑时每个省略目录名使用的字符数。 | | `use_logical_path` | `true` | If `true` render the logical path sourced from the shell via `PWD` or `--logical-path`. If `false` instead render the physical filesystem path with symlinks resolved. | `substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD. @@ -945,7 +997,7 @@ format = "via [🐋 $context](blue bold)" ## Dotnet -The `dotnet` module shows the relevant version of the [.NET Core SDK](https://dotnet.microsoft.com/) for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. +The `dotnet` module shows the relevant version of the [.NET Core SDK](https://dotnet.microsoft.com/) for the current directory. 如果当前目录已被绑定了一个版本的 SDK，则显示被帮定的版本。 否则此组件将显示最新安装的 SDK 版本。 By default this module will only be shown in your prompt when one or more of the following files are present in the current directory: @@ -960,9 +1012,9 @@ By default this module will only be shown in your prompt when one or more of the You'll also need the .NET Core SDK installed in order to use it correctly. -Internally, this module uses its own mechanism for version detection. Typically it is twice as fast as running `dotnet --version`, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting `heuristic = false` in the module options. +在内部，此组件使用自己的版本检测机制。 一般来说此组件是直接执行 `dotnet --version` 的两倍快，但当你的 .NET 项目使用了不常见的目录布局时此组件可能显示一个错误的版本。 如果相比于速度您更需要正确的版本号，您可以在组件设置中设置 `heuristic = false` 来禁用该机制。 -The module will also show the Target Framework Moniker () when there is a csproj file in the current directory. +The module will also show the Target Framework Moniker () when there is a `.csproj` file in the current directory. ### 配置项 @@ -970,13 +1022,13 @@ The module will also show the Target Framework Moniker ("` | The description of the module that is shown when running `starship explain`. | -| `files` | `[]` | The files that will be searched in the working directory for a match. | -| `directories` | `[]` | The directories that will be searched in the working directory for a match. | -| `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"` | 此组件的样式。 | -| `format` | `"[$symbol($output )]($style)"` | 组件格式化模板。 | -| `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). | +| Option | 默认值 | 描述 | +| ------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `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`. | +| `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"` | 此组件的样式。 | +| `format` | `"[$symbol($output )]($style)"` | 组件格式化模板。 | +| `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 @@ -3487,7 +3574,7 @@ If unset, it will fallback to STARSHIP_SHELL and then to "sh" on Linux, and "cmd The `command` will be passed in on stdin. -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 -`. This behavior can be avoided by explicitly passing arguments to the shell, e.g. +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", "-"] @@ -3512,12 +3599,18 @@ Automatic detection of shells and proper parameters addition are currently imple [custom.foo] command = "echo foo" # shows output of command -files = ["foo"] # can specify filters but wildcards are not supported +detect_files = ["foo"] # can specify filters but wildcards are not supported when = """ test "$HOME" == "$PWD" """ format = " transcending [$output]($style)" [custom.time] command = "time /T" -extensions = ["pst"] # filters *.pst files +detect_extensions = ["pst"] # filters *.pst files shell = ["pwsh.exe", "-NoProfile", "-Command", "-"] + +[custom.time-as-arg] +command = "time /T" +detect_extensions = ["pst"] # filters *.pst files +shell = ["pwsh.exe", "-NoProfile", "-Command"] +use_stdin = false ``` diff --git a/docs/zh-CN/guide/README.md b/docs/zh-CN/guide/README.md index 8925ad4c..0b5a3727 100644 --- a/docs/zh-CN/guide/README.md +++ b/docs/zh-CN/guide/README.md @@ -145,7 +145,7 @@ Starship with iTerm2 and the Snazzy theme @@ -160,7 +160,7 @@ - **易用：** 安装快速 —— 几分钟就可上手。

-Explore the Starship docs  ▶ +探索 Starship 文档

@@ -173,12 +173,12 @@ ### 步骤 1. 安装 Starship -Select your operating system from the list below to view installation instructions: +从下面的列表中选择您的操作系统以查看安装指令：
Android -Install Starship using any of the following package managers: +使用下列软件包管理器安装Starship： | 软件包来源 | 指令 | | --------------------------------------------------------------------------------- | ---------------------- | @@ -189,7 +189,7 @@ Install Starship using any of the following package managers:
BSD -Install Starship using any of the following package managers: +使用下列软件包管理器安装Starship： | 发行版 | 软件包来源 | 指令 | | ----------- | -------------------------------------------------------- | --------------------------------- | @@ -202,13 +202,13 @@ Install Starship using any of the following package managers:
Linux -Install the latest version for your system: +安装最新版本： ```sh curl -sS https://starship.rs/install.sh | sh ``` -Alternatively, install Starship using any of the following package managers: +或者，使用以下任一软件包管理器安装Starship： | 发行版 | 软件包来源 | 指令 | | ------------------ | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | @@ -231,13 +231,13 @@ Alternatively, install Starship using any of the following package managers:
macOS -Install the latest version for your system: +安装最新版本： ```sh curl -sS https://starship.rs/install.sh | sh ``` -Alternatively, install Starship using any of the following package managers: +或者，使用以下任一软件包管理器安装Starship： | 软件包来源 | 指令 | | -------------------------------------------------------- | --------------------------------------- | @@ -251,7 +251,7 @@ Alternatively, install Starship using any of the following package managers:
Windows -Install Starship using any of the following package managers: +使用下列软件包管理器安装Starship： | 软件包来源 | 指令 | | -------------------------------------------------------------------------------- | --------------------------------------- | @@ -264,7 +264,7 @@ Install Starship using any of the following package managers: ### 步骤 2. 设置你的终端以使用 Starship -Configure your shell to initialize starship. Select yours from the list below: +配置你的终端来初始化 starship。 请从下面列表选择你的终端：
Bash @@ -280,7 +280,7 @@ eval "$(starship init bash)"
Cmd -您需要使用 [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) 与 Cmd. Create a file at this path `%LocalAppData%\clink\starship.lua` with the following contents: +您需要使用 [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) 与 Cmd. 在路径 `%LocalAppData%\clink\starship.lua` 下创建文件，输入以下内容 ```lua load(io.popen('starship init cmd'):read("*a"))() @@ -297,7 +297,7 @@ load(io.popen('starship init cmd'):read("*a"))() eval (starship init elvish) ``` -Note: Only Elvish v0.17+ is supported +注意：仅支持 v0.18 及以上版本的 Elvish
@@ -347,7 +347,7 @@ Note: Only Nushell v0.60+ is supported
PowerShell -Add the following to the end of your PowerShell configuration (find it by running `$PROFILE`): +将以下内容添加到您 PowerShell 配置文件的末尾（通过运行 `$PROFILE` 来获取配置文件的路径） ```powershell Invoke-Expression (&starship init powershell) @@ -390,9 +390,9 @@ eval "$(starship init zsh)" ### 步骤 3. 配置 Starship -Start a new shell instance, and you should see your beautiful new shell prompt. If you're happy with the defaults, enjoy! +打开一个新的 Shell 实例，你应该就能看到漂亮的 Shell 新提示符了。 如果你对默认配置感到满意，就可以开始享用了！ -If you're looking to further customize Starship: +如果你想进一步配置 Starship，查阅下列内容： - **[配置](https://starship.rs/config/)**：学习如何配置 Starship 来调节提示符到你喜欢的样子。 @@ -400,15 +400,15 @@ If you're looking to further customize Starship: ## 🤝 贡献 -We are always looking for contributors of **all skill levels**! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). +我们一直在寻找贡献者！**不论你的技能如何**你都可以参与贡献 。 如果您希望快速为项目作出贡献，请尝试解决 [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue)。 -If you are fluent in a non-English language, we greatly appreciate any help keeping our docs translated and up-to-date in other languages. If you would like to help, translations can be contributed on the [Starship Crowdin](https://translate.starship.rs/). +如果你能流利地使用非英语语种，我们非常感谢你帮助翻译我们的文件并将其更新到其他语言。 如果您想要帮助，可以在 [Starship Crowdin](https://translate.starship.rs/) 上贡献翻译。 -If you are interested in helping contribute to starship, please take a look at our [Contributing Guide](https://github.com/starship/starship/blob/master/CONTRIBUTING.md). Also, feel free to drop into our [Discord server](https://discord.gg/8Jzqu3T) and say hi. 👋 +如果您有兴趣贡献于 Starship，请查看我们的[贡献指南](https://github.com/starship/starship/blob/master/CONTRIBUTING.md)。 另外，你可以自由加入我们的 [Discord 服务器](https://discord.gg/8Jzqu3T) 。 👋 ## 💭该项目受以下项目启发 -Please check out these previous works that helped inspire the creation of starship. 🙏 +请参考这些曾经为 Starship 提供启发的工程。 🙏 - **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** – A ZSH prompt for astronauts. @@ -418,7 +418,7 @@ Please check out these previous works that helped inspire the creation of starsh


- Starship rocket icon + Starship 图标

## 📝 License diff --git a/docs/zh-CN/installing/README.md b/docs/zh-CN/installing/README.md index d672c9ea..c33cc030 100644 --- a/docs/zh-CN/installing/README.md +++ b/docs/zh-CN/installing/README.md @@ -1,4 +1,4 @@ -# Advanced Installation +# 高级安装 安装Starship有以下两个步骤： diff --git a/docs/zh-TW/README.md b/docs/zh-TW/README.md index 4690e3f5..f911bca2 100644 --- a/docs/zh-TW/README.md +++ b/docs/zh-TW/README.md @@ -120,7 +120,7 @@ description: Starship 是適合任何 shell 的最小、極速、高度客製化 #### Elvish - ::: warning 只有 elvish v0.17 或以上版本才有支援 ::: + ::: warning 只有 elvish v0.18 或以上版本才有支援 ::: 將以下內容放到 `~/.elvish/rc.elv` 的結尾： diff --git a/docs/zh-TW/advanced-config/README.md b/docs/zh-TW/advanced-config/README.md index fc63a3c2..1acae637 100644 --- a/docs/zh-TW/advanced-config/README.md +++ b/docs/zh-TW/advanced-config/README.md @@ -131,7 +131,7 @@ Invoke-Expression (&starship init powershell) Some shells support a right prompt which renders on the same line as the input. Starship can set the content of the right prompt using the `right_format` option. Any module that can be used in `format` is also supported in `right_format`. The `$all` variable will only contain modules not explicitly used in either `format` or `right_format`. -Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [fill module](/config/#fill). +Note: The right prompt is a single line following the input location. To right align modules above the input line in a multi-line prompt, see the [`fill` module](/config/#fill). `right_format` is currently supported for the following shells: elvish, fish, zsh, xonsh, cmd. diff --git a/docs/zh-TW/config/README.md b/docs/zh-TW/config/README.md index b8e270a6..0f9057b9 100644 --- a/docs/zh-TW/config/README.md +++ b/docs/zh-TW/config/README.md @@ -9,6 +9,9 @@ mkdir -p ~/.config && touch ~/.config/starship.toml 所有關於 Starship 的設定都在這個 [TOML](https://github.com/toml-lang/toml) 檔案內： ```toml +# Get editor completions based on the config schema +"$schema" = 'https://starship.rs/config-schema.json' + # Inserts a blank line between shell prompts add_newline = true @@ -199,6 +202,7 @@ $hg_branch\ $docker_context\ $package\ $buf\ +$c\ $cmake\ $cobol\ $container\ @@ -235,6 +239,7 @@ $vagrant\ $zig\ $nix_shell\ $conda\ +$spack\ $memory_usage\ $aws\ $gcloud\ @@ -263,9 +268,9 @@ format = "$all$directory$character" ## AWS -The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. 這是根據 `AWS_REGION`、`AWS_DEFAULT_REGION` 與 `AWS_PROFILE` 環境變數及 `~/.aws/config` 檔案。 This module also shows an expiration timer when using temporary credentials. +The `aws` module shows the current AWS region and profile when credentials, a `credential_process` or a `sso_start_url` have been setup. Alternatively, you can force this module to show the region and profile even when the credentials have not been setup with the `force_display` option. 這是根據 `AWS_REGION`、`AWS_DEFAULT_REGION` 與 `AWS_PROFILE` 環境變數及 `~/.aws/config` 檔案。 This module also shows an expiration timer when using temporary credentials. -The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. +The module will display a profile only if its credentials are present in `~/.aws/credentials` or a `credential_process` is defined in `~/.aws/config`. Alternatively, having any of the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY`, or `AWS_SESSION_TOKEN` env vars defined will also suffice. If the option `force_display` is set to `true`, all available information will be displayed even if the conditions above are not respected. When using [aws-vault](https://github.com/99designs/aws-vault) the profile is read from the `AWS_VAULT` env var and the credentials expiration date is read from the `AWS_SESSION_EXPIRATION` env var. @@ -275,15 +280,16 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL ### 選項 -| Option | 預設 | 說明 | -| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------- | -| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | The format for the module. | -| `symbol` | `"☁️ "` | 顯示在目前 AWS 配置之前的符號。 | -| `region_aliases` | | 除了AWS名稱外，顯示區域別名表 | -| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | -| `style` | `"bold yellow"` | 這個模組的風格。 | -| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. | -| `disabled` | `false` | Disables the `AWS` module. | +| Option | 預設 | 說明 | +| ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | +| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | The format for the module. | +| `symbol` | `"☁️ "` | 顯示在目前 AWS 配置之前的符號。 | +| `region_aliases` | | 除了AWS名稱外，顯示區域別名表 | +| `profile_aliases` | | Table of profile aliases to display in addition to the AWS name. | +| `style` | `"bold yellow"` | 這個模組的風格。 | +| `expiration_symbol` | `X` | The symbol displayed when the temporary credentials have expired. | +| `disabled` | `false` | 停用 `AWS` 模組。 | +| `force_display` | `false` | If `true` displays info even if `credentials`, `credential_process` or `sso_start_url` have not been setup. | ### Variables @@ -472,11 +478,57 @@ The `buf` module shows the currently installed version of [Buf](https://buf.buil symbol = "🦬 " ``` +## C + +The `c` module shows some information about your C compiler. By default the module will be shown if the current directory contains a `.c` or `.h` file. + +### 選項 + +| Option | 預設 | 說明 | +| ------------------- | --------------------------------------------------------------------------- | ------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version(-$name) )]($style)"` | The format string for the module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `"C "` | The symbol used before displaying the compiler details | +| `detect_extensions` | `["c", "h"]` | Which extensions should trigger this module. | +| `detect_files` | `[]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `commands` | [ [ "cc", "--version" ], [ "gcc", "--version" ], [ "clang", "--version" ] ] | How to detect what the compiler is | +| `style` | `"bold 149"` | 這個模組的風格。 | +| `disabled` | `false` | Disables the `c` module. | + +### Variables + +| 變數 | 範例 | 說明 | +| ------- | ------ | ------------------------------------ | +| name | clang | The name of the compiler | +| version | 13.0.0 | The version of the compiler | +| symbol | | Mirrors the value of option `symbol` | +| style | | Mirrors the value of option `style` | + +NB that `version` is not in the default format. + +### Commands + +The `commands` option accepts a list of commands to determine the compiler version and name. + +Each command is represented as a list of the executable name, followed by its arguments, usually something like `["mycc", "--version"]`. Starship will try executing each command until it gets a result on STDOUT. + +If a C compiler is not supported by this module, you can request it by [raising an issue on GitHub](https://github.com/starship/starship/). + +### 範例 + +```toml +# ~/.config/starship.toml + +[c] +format = "via [$name $version]($style)" +``` + ## 字元 -The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. +`character` 模組在你的文字輸入處旁顯示一個字元 (通常是箭頭)。 -The character will tell you whether the last command was successful or not. It can do this in two ways: +這個字元會告訴你最後的指令是成功還是失敗。 It can do this in two ways: - changing color (`red`/`green`) - changing shape (`❯`/`✖`) @@ -497,7 +549,7 @@ By default it only changes color. If you also want to change its shape take a lo | `success_symbol` | `"[❯](bold green)"` | The format string used before the text input if the previous command succeeded. | | `error_symbol` | `"[❯](bold red)"` | The format string used before the text input if the previous command failed. | | `vicmd_symbol` | `"[❮](bold green)"` | The format string used before the text input if the shell is in vim normal mode. | -| `disabled` | `false` | Disables the `character` module. | +| `disabled` | `false` | 停用 `character` 模組。 | ### Variables @@ -598,25 +650,25 @@ The `cobol` module shows the currently installed version of COBOL. By default, t ## 指令持續時間 -The `cmd_duration` module shows how long the last command took to execute. The module will be shown only if the command took longer than two seconds, or the `min_time` config value, if it exists. +`cmd_duration` 模組顯示最後一個指令執行所花費的時間。 這個模組只會在指令花費超過兩秒或是有設定 `min_time` 時，超過設定值時出現。 -::: warning Do not hook the DEBUG trap in Bash +::: warning 不要在 Bash 中設置 DEBUG trap -If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. +如果你在 `bash` 中使用 Starship，不要在執行 `eval $(starship init $0)` 之後設置 `DEBUG` trap，不然這個模組**會**壞掉。 ::: -Bash users who need preexec-like functionality can use [rcaloras's bash_preexec framework](https://github.com/rcaloras/bash-preexec). Simply define the arrays `preexec_functions` and `precmd_functions` before running `eval $(starship init $0)`, and then proceed as normal. +想使用類似 preexec 功能的 Bash 使用者可以 [rcaloras 的 bash_preexec 框架](https://github.com/rcaloras/bash-preexec)。 只要在 `eval $(starship init $0)` 之前簡單地定義 `preexec_functions` 與 `precmd_functions` 兩個陣列，然後就可以照常進行。 ### 選項 | Option | 預設 | 說明 | | ---------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). | -| `show_milliseconds` | `false` | Show milliseconds in addition to seconds for the duration. | +| `show_milliseconds` | `false` | 顯示時間除了以秒為單位外，亦以毫秒顯示 | | `format` | `"took [$duration]($style) "` | The format for the module. | | `style` | `"bold yellow"` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `cmd_duration` module. | +| `disabled` | `false` | 停用 `cmd_duration` 模組。 | | `show_notifications` | `false` | Show desktop notifications when command completes. | | `min_time_to_notify` | `45_000` | Shortest duration for notification (in milliseconds). | | `notification_timeout` | | Duration to show notification for (in milliseconds). If unset, notification timeout will be determined by daemon. Not all notification daemons honor this option. | @@ -652,14 +704,14 @@ This does not suppress conda's own prompt modifier, you may want to run `conda c ### 選項 -| Option | 預設 | 說明 | -| ------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `truncation_length` | `1` | The number of directories the environment path should be truncated to, if the environment was created via `conda create -p [path]`. `0` means no truncation. Also see the [`directory`](#directory) module. | -| `symbol` | `"🅒 "` | The symbol used before the environment name. | -| `style` | `"bold green"` | 這個模組的風格。 | -| `format` | `"via [$symbol$environment]($style) "` | The format for the module. | -| `ignore_base` | `true` | Ignores `base` environment when activated. | -| `disabled` | `false` | Disables the `conda` module. | +| Option | 預設 | 說明 | +| ------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------- | +| `truncation_length` | `1` | 如果環境變數由所`conda create -p [path]`產生時，環境變數的資料夾需要截斷的數目。 `0` 表示不截斷 也請參考 [`directory`](#directory)模組 | +| `symbol` | `"🅒 "` | 環境名稱前使用的符號。 | +| `style` | `"bold green"` | 這個模組的風格。 | +| `format` | `"via [$symbol$environment]($style) "` | The format for the module. | +| `ignore_base` | `true` | Ignores `base` environment when activated. | +| `disabled` | `false` | 停用 `conda` 模組。 | ### Variables @@ -716,8 +768,8 @@ format = "[$symbol \\[$name\\]]($style) " The `crystal` module shows the currently installed version of [Crystal](https://crystal-lang.org/). By default the module will be shown if any of the following conditions are met: -- The current directory contains a `shard.yml` file -- The current directory contains a `.cr` file +- 現在資料夾中含有一個 `shard.yml` 檔案 +- 現在資料夾中含有一個`.cr`檔案 ### 選項 @@ -757,7 +809,7 @@ The `dart` module shows the currently installed version of [Dart](https://dart.d - The current directory contains a file with `.dart` extension - The current directory contains a `.dart_tool` directory -- The current directory contains a `pubspec.yaml`, `pubspec.yml` or `pubspec.lock` file +- 現在資料夾中包含一個 `pubspec.yaml`、`pubspec.yml` 或 `pubspec.lock` 檔案 ### 選項 @@ -829,21 +881,21 @@ format = "via [🦕 $version](green bold) " ## 資料夾 -The `directory` module shows the path to your current directory, truncated to three parent folders. Your directory will also be truncated to the root of the git repo that you're currently in. +`directory` 模組顯示到現在資料夾的路徑，並裁減到前三層資料夾。 你的資料夾也會被裁減到你所在的 git 儲存庫的根目錄。 -When using the fish style pwd option, instead of hiding the path that is truncated, you will see a shortened name of each directory based on the number you enable for the option. +如果正在使用 fish 風格的 pwd 選項，將不會隱藏被裁減的資料夾，而是會根據你在選項中設定的數字看到每一層資料夾的縮寫。 -For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, and the option set to `1`. You will now see `~/D/N/nixpkgs/pkgs`, whereas before it would have been `nixpkgs/pkgs`. +例如，給定一個右列的路徑 `~/Dev/Nix/nixpkgs/pkgs` 其中 `nixpkgs` 是儲存庫的根目錄，而且該選項被設定為 `1`。 你會看到 `~/D/N/nixpkgs/pkgs`，而在這個設定之前則是 `nixpkgs/pkgs`。 ### 選項 | Option | 預設 | 說明 | | ------------------- | ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `truncation_length` | `3` | The number of parent folders that the current directory should be truncated to. | -| `truncate_to_repo` | `true` | Whether or not to truncate to the root of the git repo that you're currently in. | +| `truncation_length` | `3` | 到達現在資料夾的路徑中，要被裁減掉的資料夾數目。 | +| `truncate_to_repo` | `true` | 是否要裁減到你現在所在的 git 儲存庫的根目錄。 | | `format` | `"[$path]($style)[$read_only]($read_only_style) "` | The format for the module. | | `style` | `"bold cyan"` | 這個模組的風格。 | -| `disabled` | `false` | Disables the `directory` module. | +| `disabled` | `false` | 停用 `directory` 模組。 | | `read_only` | `"🔒"` | The symbol indicating current directory is read only. | | `read_only_style` | `"red"` | The style for the read only symbol. | | `truncation_symbol` | `""` | The symbol to prefix to truncated paths. eg: "…/" | @@ -853,12 +905,12 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an | `use_os_path_sep` | `true` | Use the OS specific path separator instead of always using `/` (e.g. `\` on Windows) |
-This module has a few advanced configuration options that control how the directory is displayed. +這個模組有些進階設定選項可以控制顯示資料夾。 | Advanced Option | 預設 | 說明 | | --------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `substitutions` | | A table of substitutions to be made to the path. | -| `fish_style_pwd_dir_length` | `0` | The number of characters to use when applying fish shell pwd path logic. | +| `fish_style_pwd_dir_length` | `0` | 當使用 fish shell 的 pwd 路徑邏輯時使用的字元數量。 | | `use_logical_path` | `true` | If `true` render the logical path sourced from the shell via `PWD` or `--logical-path`. If `false` instead render the physical filesystem path with symlinks resolved. | `substitutions` allows you to define arbitrary replacements for literal strings that occur in the path, for example long network prefixes or development directories (i.e. Java). Note that this will disable the fish style PWD. @@ -945,7 +997,7 @@ format = "via [🐋 $context](blue bold)" ## Dotnet -The `dotnet` module shows the relevant version of the [.NET Core SDK](https://dotnet.microsoft.com/) for the current directory. If the SDK has been pinned in the current directory, the pinned version is shown. Otherwise the module shows the latest installed version of the SDK. +The `dotnet` module shows the relevant version of the [.NET Core SDK](https://dotnet.microsoft.com/) for the current directory. 如果這個資料夾已經選定一個 SDK，則顯示這個 SDK 的版本。 如果沒有的話，則顯示最新安裝的 SDK 版本。 By default this module will only be shown in your prompt when one or more of the following files are present in the current directory: @@ -960,9 +1012,9 @@ By default this module will only be shown in your prompt when one or more of the You'll also need the .NET Core SDK installed in order to use it correctly. -Internally, this module uses its own mechanism for version detection. Typically it is twice as fast as running `dotnet --version`, but it may show an incorrect version if your .NET project has an unusual directory layout. If accuracy is more important than speed, you can disable the mechanism by setting `heuristic = false` in the module options. +這個模組內部是使用它自己的機制來偵測版本。 一般來說這個模組有 `dotnet --version` 的兩倍快，但是它可能會在你的 .NET 專案有不尋常的資料夾結構時顯示不正確的版本。 如果精確度比速度更重要的話，你可以藉由設定模組中的 `heuristic = false` 選項來停用這個功能。 -The module will also show the Target Framework Moniker () when there is a csproj file in the current directory. +The module will also show the Target Framework Moniker () when there is a `.csproj` file in the current directory. ### 選項 @@ -970,13 +1022,13 @@ The module will also show the Target Framework Moniker ("` | The description of the module that is shown when running `starship explain`. | -| `files` | `[]` | The files that will be searched in the working directory for a match. | -| `directories` | `[]` | The directories that will be searched in the working directory for a match. | -| `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"` | 這個模組的風格。 | -| `format` | `"[$symbol($output )]($style)"` | The format for the module. | -| `disabled` | `false` | Disables this `custom` module. | -| `os` | | Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) [See possible values](https://doc.rust-lang.org/std/env/consts/constant.OS.html). | +| Option | 預設 | 說明 | +| ------------------- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `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`. | +| `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"` | 這個模組的風格。 | +| `format` | `"[$symbol($output )]($style)"` | The format for the module. | +| `disabled` | `false` | Disables this `custom` module. | +| `os` | | Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) [See possible values](https://doc.rust-lang.org/std/env/consts/constant.OS.html). | +| `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 @@ -3487,7 +3574,7 @@ If unset, it will fallback to STARSHIP_SHELL and then to "sh" on Linux, and "cmd The `command` will be passed in on stdin. -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 -`. This behavior can be avoided by explicitly passing arguments to the shell, e.g. +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", "-"] @@ -3512,12 +3599,18 @@ Automatic detection of shells and proper parameters addition are currently imple [custom.foo] command = "echo foo" # shows output of command -files = ["foo"] # can specify filters but wildcards are not supported +detect_files = ["foo"] # can specify filters but wildcards are not supported when = """ test "$HOME" == "$PWD" """ format = " transcending [$output]($style)" [custom.time] command = "time /T" -extensions = ["pst"] # filters *.pst files +detect_extensions = ["pst"] # filters *.pst files shell = ["pwsh.exe", "-NoProfile", "-Command", "-"] + +[custom.time-as-arg] +command = "time /T" +detect_extensions = ["pst"] # filters *.pst files +shell = ["pwsh.exe", "-NoProfile", "-Command"] +use_stdin = false ``` diff --git a/docs/zh-TW/guide/README.md b/docs/zh-TW/guide/README.md index 84200007..aba3e13b 100644 --- a/docs/zh-TW/guide/README.md +++ b/docs/zh-TW/guide/README.md @@ -160,7 +160,7 @@ - **易用：**安裝快速 —— 幾分鐘內就可以開始使用。

-Explore the Starship docs  ▶ +探索 Starship 文件  ▶

@@ -297,7 +297,7 @@ load(io.popen('starship init cmd'):read("*a"))() eval (starship init elvish) ``` -Note: Only Elvish v0.17+ is supported +Note: Only Elvish v0.18+ is supported
@@ -400,15 +400,15 @@ If you're looking to further customize Starship: ## 🤝 貢獻 -We are always looking for contributors of **all skill levels**! If you're looking to ease your way into the project, try out a [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). +我們歡迎具有**各式各樣能力**的貢獻者！ 如果你正在尋找容易加入的方法，試試看標註為「[good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue)」的 issue。 -If you are fluent in a non-English language, we greatly appreciate any help keeping our docs translated and up-to-date in other languages. If you would like to help, translations can be contributed on the [Starship Crowdin](https://translate.starship.rs/). +如果您精通非英語語言，並能協助我們在文檔上的翻譯保持最新狀態，我們會非常感謝！ 如果你想要提供翻譯，可以到 [Starship Crowdin](https://translate.starship.rs/) 上提交您的翻譯。 -If you are interested in helping contribute to starship, please take a look at our [Contributing Guide](https://github.com/starship/starship/blob/master/CONTRIBUTING.md). Also, feel free to drop into our [Discord server](https://discord.gg/8Jzqu3T) and say hi. 👋 +如果你對貢獻 Starship 有興趣，請看我們的 [貢獻指南](https://github.com/starship/starship/blob/master/CONTRIBUTING.md) 。 另外，請不用客氣加入我們的 [Discord 伺服器](https://discord.gg/8Jzqu3T) 並來問候一下。 👋 ## 💭 發想來自 -Please check out these previous works that helped inspire the creation of starship. 🙏 +請看之前這些幫助我們創造 Starship 的前任作品。 🙏 - **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** – A ZSH prompt for astronauts. @@ -423,4 +423,4 @@ Please check out these previous works that helped inspire the creation of starsh ## 📝 許可 -Copyright © 2019-present, [Starship Contributors](https://github.com/starship/starship/graphs/contributors).
This project is [ISC](https://github.com/starship/starship/blob/master/LICENSE) licensed. +Copyright © 2019-present, [Starship Contributors](https://github.com/starship/starship/graphs/contributors).
這個專案使用 [ISC](https://github.com/starship/starship/blob/master/LICENSE) 許可。 diff --git a/docs/zh-TW/installing/README.md b/docs/zh-TW/installing/README.md index a26f9726..17293bd8 100644 --- a/docs/zh-TW/installing/README.md +++ b/docs/zh-TW/installing/README.md @@ -1,4 +1,4 @@ -# Advanced Installation +# 進階安裝 要安裝 starship，你必須做兩件事：