diff --git a/docs/ar-SA/README.md b/docs/ar-SA/README.md index b939c00e..9091f2c9 100644 --- a/docs/ar-SA/README.md +++ b/docs/ar-SA/README.md @@ -62,7 +62,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p scoop install starship ``` -1. أضف البرنامج النصي إلى ملف تهيئة موجه الأوامر: +1. أضف ما يلي إلى ملف تكوين موجه الأوامر الخاص بك: #### Bash @@ -120,7 +120,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p #### Elvish - ::: تحذير يدعم فقط elvish v0.17 أو أعلى. ::: + ::: warning يدعم فقط elvish v0.17 أو أعلى. ::: أضف ما يلي إلى نهاية `~/.elvish/rc.elv`: @@ -144,17 +144,19 @@ description: Starship is the minimal, blazing fast, and extremely customizable p #### Nushell - ::: تحذير هذا سوف يتغير في المستقبل. فقط إصدار nu v0.33 أو أعلى مدعوم. ::: أضف ما يلي إلى ملف تكوين nu الخاص بك. يمكنك التحقق من موقع هذا الملف عن طريق تشغيل `config path` في nu. - - ```toml - startup = [ - "mkdir ~/.cache/starship", - "starship init nu | save ~/.cache/starship/init.nu", - "source ~/.cache/starship/init.nu", - ] - prompt = "starship_prompt" + ::: تحذير هذا سوف يتغير في المستقبل. Only Nushell v0.60+ is supported. ::: Run the following: + ```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`): + + ```sh + mkdir ~/.cache/starship + starship init nu | save ~/.cache/starship/init.nu + source ~/.cache/starship/init.nu + ``` #### Xonsh diff --git a/docs/ar-SA/config/README.md b/docs/ar-SA/config/README.md index af64191a..4204ae37 100644 --- a/docs/ar-SA/config/README.md +++ b/docs/ar-SA/config/README.md @@ -198,6 +198,7 @@ $git_status\ $hg_branch\ $docker_context\ $package\ +$buf\ $cmake\ $cobol\ $container\ @@ -208,6 +209,7 @@ $elixir\ $elm\ $erlang\ $golang\ +$haskell\ $helm\ $java\ $julia\ @@ -261,7 +263,7 @@ format = "$all$directory$character" ## AWS -The `aws` module shows the current AWS region and profile when credentials or a `credential_process` 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. 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. @@ -278,6 +280,7 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL | `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. | @@ -308,6 +311,8 @@ symbol = "🅰 " [aws.region_aliases] ap-southeast-2 = "au" us-east-1 = "va" +[aws.profile_aliases] +CompanyGroupFrobozzOnCallAccess = 'Frobozz' ``` #### Display region @@ -333,6 +338,8 @@ us-east-1 = "va" format = "on [$symbol$profile]($style) " style = "bold blue" symbol = "🅰 " +[aws.profile_aliases] +Enterprise_Naming_Scheme-voidstars = 'void**' ``` ## Azure @@ -426,6 +433,45 @@ discharging_symbol = "💦" # when capacity is over 30%, the battery indicator will not be displayed ``` +## 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: + +- 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. + +### Options + +| Option | الافتراضي | الوصف | +| ------------------- | ------------------------------------------------------------ | ----------------------------------------------------- | +| `format` | `'with [$symbol($version \(Buf $buf_version\) )]($style)'` | The format for the `buf` module. | +| `version_format` | `"v${raw}"` | The version format. | +| `symbol` | `"🦬 "` | The symbol used before displaying the version of Buf. | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["buf.yaml", "buf.gen.yaml", "buf.work.yaml"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `style` | `"bold blue"` | The style for the module. | +| `disabled` | `false` | Disables the `elixir` module. | + +### Variables + +| Variable | مثال | الوصف | +| ------------- | -------- | ------------------------------------ | +| `buf_version` | `v1.0.0` | The version of `buf` | +| `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 + +[buf] +symbol = "🦬 " +``` + ## Character The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. @@ -439,12 +485,6 @@ By default it only changes color. If you also want to change its shape take a lo ::: تحذير -`error_symbol` is not supported on nu shell. - -::: - -::: تحذير - `vicmd_symbol` is only supported in cmd, fish and zsh. ::: @@ -646,12 +686,12 @@ The `container` module displays a symbol and container name, if inside a contain ### Options -| Option | الافتراضي | الوصف | -| ---------- | ------------------------------------ | ----------------------------------------- | -| `symbol` | `"⬢"` | The symbol shown, when inside a container | -| `style` | `"bold red dimmed"` | The style for the module. | -| `format` | "[$symbol \\[$name\\]]($style) " | The format for the module. | -| `disabled` | `false` | Disables the `container` module. | +| Option | الافتراضي | الوصف | +| ---------- | -------------------------------------- | ----------------------------------------- | +| `symbol` | `"⬢"` | The symbol shown, when inside a container | +| `style` | `"bold red dimmed"` | The style for the module. | +| `format` | `"[$symbol \\[$name\\]]($style) "` | The format for the module. | +| `disabled` | `false` | Disables the `container` module. | ### Variables @@ -1007,7 +1047,7 @@ The `elm` module shows the currently installed version of [Elm](https://elm-lang - 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 -- The current directory contains a `*.elm` files +- The current directory contains `*.elm` files ### Options @@ -1063,13 +1103,13 @@ default = "unknown user" ### Options -| Option | الافتراضي | الوصف | -| ----------- | ------------------------------ | ---------------------------------------------------------------------------- | -| `symbol` | `""` | The symbol used before displaying the variable value. | -| `variable` | | The environment variable to be displayed. | -| `الافتراضي` | | The default value to be displayed when the selected variable is not defined. | -| `format` | `"with [$env_value]($style) "` | The format for the module. | -| `disabled` | `false` | Disables the `env_var` module. | +| Option | الافتراضي | الوصف | +| ---------- | ------------------------------ | ---------------------------------------------------------------------------- | +| `symbol` | `""` | The symbol used before displaying the variable value. | +| `variable` | | The environment variable to be displayed. | +| `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. | ### Variables @@ -1194,7 +1234,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 | `الافتراضي` | The active config name written in `~/.config/gcloud/active_config` | +| active | `default` | The active config name written in `~/.config/gcloud/active_config` | | symbol | | Mirrors the value of option `symbol` | | style\* | | Mirrors the value of option `style` | @@ -1259,6 +1299,7 @@ The `git_branch` module shows the active branch of the repo in your current dire | `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | | `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. | | `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | +| `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for "master" or "main". | | `disabled` | `false` | Disables the `git_branch` module. | ### Variables @@ -1282,6 +1323,7 @@ The `git_branch` module shows the active branch of the repo in your current dire symbol = "🌱 " truncation_length = 4 truncation_symbol = "" +ignore_branches = ["master", "main"] ``` ## Git Commit @@ -1547,6 +1589,39 @@ The `golang` module shows the currently installed version of [Go](https://golang format = "via [🏎💨 $version](bold cyan) " ``` +## Haskell + +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 +- The current directory contains any `.hs`, `.cabal`, or `.hs-boot` file + +### Options + +| Option | الافتراضي | الوصف | +| ------------------- | ------------------------------------ | -------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `symbol` | `"λ "` | A format string representing the symbol of Haskell | +| `detect_extensions` | `["hs", "cabal", "hs-boot"]` | Which extensions should trigger this module. | +| `detect_files` | `["stack.yaml", "cabal.project"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"bold purple"` | The style for the module. | +| `disabled` | `false` | Disables the `haskell` module. | + +### Variables + +| Variable | مثال | الوصف | +| -------------- | ----------- | --------------------------------------------------------------------------------------- | +| version | | `ghc_version` or `snapshot` depending on whether the current project is a Stack project | +| snapshot | `lts-18.12` | Currently selected Stack snapshot | +| ghc\_version | `9.2.1` | Currently installed GHC version | +| symbol | | 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 + ## 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: @@ -2137,21 +2212,21 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n - 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` extension +- The current directory contains a file with the `.ts`, `.mts` or `.cts` extension ### Options -| Option | الافتراضي | الوصف | -| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `" "` | A format string representing the symbol of Node.js. | -| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this module. | -| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. | -| `style` | `"bold green"` | The style for the module. | -| `disabled` | `false` | Disables the `nodejs` module. | -| `not_capable_style` | `bold red` | The style for the module when an engines property in package.json does not match the Node.js version. | +| Option | الافتراضي | الوصف | +| ------------------- | ------------------------------------------ | ----------------------------------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `" "` | A format string representing the symbol of Node.js. | +| `detect_extensions` | `["js", "mjs", "cjs", "ts", "mts", "cts"]` | Which extensions should trigger this module. | +| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. | +| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. | +| `style` | `"bold green"` | The style for the module. | +| `disabled` | `false` | Disables the `nodejs` module. | +| `not_capable_style` | `bold red` | The style for the module when an engines property in package.json does not match the Node.js version. | ### Variables @@ -2896,7 +2971,7 @@ format = '[📦 \[$env\]]($style) ' ## Status -The `status` module displays the exit code of the previous command. The module will be shown only if the exit code is not `0`. The status code will cast to a signed 32-bit integer. +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 @@ -2904,15 +2979,13 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y ::: -::: warning This module is not supported on nu shell. ::: - ### Options | Option | الافتراضي | الوصف | | ----------------------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------- | | `format` | `"[$symbol$status]($style) "` | The format of the module | | `symbol` | `"✖"` | The symbol displayed on program error | -| `success_symbol` | `"✔️"` | The symbol displayed on program success | +| `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) | @@ -2949,8 +3022,9 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y [status] style = "bg:blue" -symbol = "🔴" -format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) ' +symbol = "🔴 " +success_symbol = "🟢 SUCCESS" +format = '[\[$symbol$common_meaning$signal_name$maybe_int\]]($style) ' map_symbol = true disabled = false ``` @@ -3073,12 +3147,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 | `الافتراضي` | 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 | `default` | 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 @@ -3382,7 +3456,7 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt | `command` | `""` | The command whose output should be printed. The command will be passed on stdin to the shell. | | `when` | | 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) | -| `الوصف` | `""` | The description of the module that is shown when running `starship explain`. | +| `description` | `""` | The description of the module that is shown when running `starship explain`. | | `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. | diff --git a/docs/ar-SA/faq/README.md b/docs/ar-SA/faq/README.md index 19d26683..c3c797e7 100644 --- a/docs/ar-SA/faq/README.md +++ b/docs/ar-SA/faq/README.md @@ -1,4 +1,4 @@ -# FAQ +# Frequently Asked Questions ## What is the configuration used in the demo GIF? diff --git a/docs/ar-SA/guide/README.md b/docs/ar-SA/guide/README.md index f4126269..3b1c8969 100644 --- a/docs/ar-SA/guide/README.md +++ b/docs/ar-SA/guide/README.md @@ -139,6 +139,8 @@ />

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

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

@@ -324,17 +326,22 @@ eval $(starship init ion)
Nushell -Add the following to the end of your Nushell configuration (find it by running `config path`): +Run the following: -```toml -startup = [ - "mkdir ~/.cache/starship", - "starship init nu | save ~/.cache/starship/init.nu", - "source ~/.cache/starship/init.nu", -] -prompt = "starship_prompt" +```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`): + +```sh +starship init nu | save ~/.cache/starship/init.nu +source ~/.cache/starship/init.nu +``` + +Note: Only Nushell v0.60+ is supported +
@@ -393,15 +400,15 @@ If you're looking to further customize Starship: ## 🤝 المساهمة -نبحث دائماً عن مساهمين من **جميع المستويات**! إذا كنت تتطلع إلى تسهيل طريقك إلى المشروع، جرب [إنشاء اول مشكلة](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). +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). -إذا كنت تتحدث بطلاقة بلغة غير إنجليزية، فإننا نقدر أي مساعدة للحفاظ على ترجمة المستندات وتحديثها بلغات أخرى. إذا كنت ترغب في المساعدة، يمكن المساهمة بالترجمة على [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. If you would like to help, translations can be contributed on the [Starship Crowdin](https://translate.starship.rs/). -إذا كنت مهتما بالمساهمة في starship، يرجى إلقاء نظرة على [دليل المساهمة](https://github.com/starship/starship/blob/master/CONTRIBUTING.md) لدينا. أيضا، لا تتردد في أن تنضم لنا في [Discord](https://discord.gg/8Jzqu3T) وقُل مرحبا. 👋 +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. 🙏 +Please check out these previous works that helped inspire the creation of 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 88373eca..fa88ca8d 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/ar-SA/presets/README.md b/docs/ar-SA/presets/README.md index 12f5d20b..26c2314b 100644 --- a/docs/ar-SA/presets/README.md +++ b/docs/ar-SA/presets/README.md @@ -4,32 +4,38 @@ Here is a collection of community-submitted configuration presets for Starship. To get details on how to use a preset, simply click on the image. -## [Nerd Font Symbols](./nerd-font) +## [Nerd Font Symbols](./nerd-font.md) This preset changes the symbols for each module to use Nerd Font symbols. [![Screenshot of Nerd Font Symbols preset](/presets/img/nerd-font-symbols.png "Click to view Nerd Font Symbols preset")](./nerd-font) -## [Bracketed Segments](./bracketed-segments) +## [Bracketed Segments](./bracketed-segments.md) This preset changes the format of all the built-in modules to show their segment in brackets instead of using the default Starship wording ("via", "on", etc.). [![Screenshot of Bracketed Segments preset](/presets/img/bracketed-segments.png "Click to view Bracketed Segments preset")](./bracketed-segments) -## [Plain Text Symbols](./plain-text) +## [Plain Text Symbols](./plain-text.md) This preset changes the symbols for each module into plain text. Great if you don't have access to Unicode. [![Screenshot of Plain Text Symbols preset](/presets/img/plain-text-symbols.png "Click to view Plain Text Symbols preset")](./plain-text) -## [No Runtime Versions](./no-runtimes) +## [No Runtime Versions](./no-runtimes.md) This preset hides the version of language runtimes. If you work in containers or virtualized environments, this one is for you! [![Screenshot of Hide Runtime Versions preset](/presets/img/no-runtime-versions.png "Click to view No Runtime Versions preset")](./no-runtimes) -## [Pure Prompt](./pure-preset) +## [Pure Prompt](./pure-preset.md) This preset emulates the look and behavior of [Pure](https://github.com/sindresorhus/pure). [![Screenshot of Pure preset](/presets/img/pure-preset.png "Click to view Pure Prompt preset")](./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. + +[![Screenshot of Pastel Powerline preset](/presets/img/pastel-powerline.png "Click to view Pure Prompt preset")](./pastel-powerline) diff --git a/docs/ar-SA/presets/bracketed-segments.md b/docs/ar-SA/presets/bracketed-segments.md index 9b236714..9271a036 100644 --- a/docs/ar-SA/presets/bracketed-segments.md +++ b/docs/ar-SA/presets/bracketed-segments.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#bracketed-segments) +[Return to Presets](./README.md#bracketed-segments) # Bracketed Segments Preset diff --git a/docs/ar-SA/presets/nerd-font.md b/docs/ar-SA/presets/nerd-font.md index adf7498a..17891aea 100644 --- a/docs/ar-SA/presets/nerd-font.md +++ b/docs/ar-SA/presets/nerd-font.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#nerd-font-symbols) +[Return to Presets](./README.md#nerd-font-symbols) # Nerd Font Symbols Preset diff --git a/docs/ar-SA/presets/no-runtimes.md b/docs/ar-SA/presets/no-runtimes.md index 1815872d..fd305051 100644 --- a/docs/ar-SA/presets/no-runtimes.md +++ b/docs/ar-SA/presets/no-runtimes.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#no-runtime-versions) +[Return to Presets](./README.md#no-runtime-versions) # No Runtime Versions Preset diff --git a/docs/ar-SA/presets/pastel-powerline.md b/docs/ar-SA/presets/pastel-powerline.md new file mode 100644 index 00000000..e2bdd579 --- /dev/null +++ b/docs/ar-SA/presets/pastel-powerline.md @@ -0,0 +1,17 @@ +[Return to Presets](./README.md#pastel-powerline) + +# Pastel Powerline Preset + +This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). It also shows how path substitution works in starship. + +![Screenshot of Pastel Powerline preset](/presets/img/pastel-powerline.png) + +### المتطلبات الأساسية + +- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (the example uses Caskaydia Cove Nerd Font) + +### Configuration + +[Click to download TOML](/presets/toml/pastel-powerline.toml) + +<<< @/.vuepress/public/presets/toml/pastel-powerline.toml diff --git a/docs/ar-SA/presets/plain-text.md b/docs/ar-SA/presets/plain-text.md index 12cb453e..49607e9a 100644 --- a/docs/ar-SA/presets/plain-text.md +++ b/docs/ar-SA/presets/plain-text.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#plain-text-symbols) +[Return to Presets](./README.md#plain-text-symbols) ## Plain Text Symbols Preset diff --git a/docs/ar-SA/presets/pure-preset.md b/docs/ar-SA/presets/pure-preset.md index 96a1b6a2..ad61b499 100644 --- a/docs/ar-SA/presets/pure-preset.md +++ b/docs/ar-SA/presets/pure-preset.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#pure) +[Return to Presets](./README.md#pure) # Pure Preset diff --git a/docs/ckb-IR/README.md b/docs/ckb-IR/README.md index ad1c3950..be456879 100644 --- a/docs/ckb-IR/README.md +++ b/docs/ckb-IR/README.md @@ -120,7 +120,7 @@ description: 'Starship: یەکێ لە promptـە سوکەڵە، خێرا، و ب #### Elvish - ::: ئاگادارکردنەوە تەنها elvish v0.17 یان بەرزتر پشتگیری کراوە. ::: + ::: warning تەنها elvish v0.17 یان بەرزتر پشتگیری کراوە. ::: ئەمەی خوارەوە زیادبکە لە کۆتایی `~/.elvish/rc.elv`: @@ -144,17 +144,19 @@ description: 'Starship: یەکێ لە promptـە سوکەڵە، خێرا، و ب #### Nushell - ::: warning This will change in the future. تەنها وەشانی v0.33 یان بەرزتری nu پشتگیریکراوە. ::: Add the following to your nu config file. ئەتوانی شوێنی ئەم پەڕگەیە بپشکنی بە جێبەجێکردنی `config path` لە nu دا. - - ```toml - startup = [ - "mkdir ~/.cache/starship", - "starship init nu | save ~/.cache/starship/init.nu", - "source ~/.cache/starship/init.nu", - ] - prompt = "starship_prompt" + ::: warning This will change in the future. Only Nushell v0.60+ is supported. ::: Run the following: + ```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`): + + ```sh + mkdir ~/.cache/starship + starship init nu | save ~/.cache/starship/init.nu + source ~/.cache/starship/init.nu + ``` #### Xonsh diff --git a/docs/ckb-IR/config/README.md b/docs/ckb-IR/config/README.md index c9f046a2..a6588c41 100644 --- a/docs/ckb-IR/config/README.md +++ b/docs/ckb-IR/config/README.md @@ -198,6 +198,7 @@ $git_status\ $hg_branch\ $docker_context\ $package\ +$buf\ $cmake\ $cobol\ $container\ @@ -208,6 +209,7 @@ $elixir\ $elm\ $erlang\ $golang\ +$haskell\ $helm\ $java\ $julia\ @@ -261,7 +263,7 @@ format = "$all$directory$character" ## AWS -The `aws` module shows the current AWS region and profile when credentials or a `credential_process` 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. 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. @@ -278,6 +280,7 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL | `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. | @@ -308,6 +311,8 @@ symbol = "🅰 " [aws.region_aliases] ap-southeast-2 = "au" us-east-1 = "va" +[aws.profile_aliases] +CompanyGroupFrobozzOnCallAccess = 'Frobozz' ``` #### Display region @@ -333,6 +338,8 @@ us-east-1 = "va" format = "on [$symbol$profile]($style) " style = "bold blue" symbol = "🅰 " +[aws.profile_aliases] +Enterprise_Naming_Scheme-voidstars = 'void**' ``` ## Azure @@ -426,6 +433,45 @@ discharging_symbol = "💦" # when capacity is over 30%, the battery indicator will not be displayed ``` +## 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: + +- 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. + +### Options + +| Option | Default | Description | +| ------------------- | ------------------------------------------------------------ | ----------------------------------------------------- | +| `format` | `'with [$symbol($version \(Buf $buf_version\) )]($style)'` | The format for the `buf` module. | +| `version_format` | `"v${raw}"` | The version format. | +| `symbol` | `"🦬 "` | The symbol used before displaying the version of Buf. | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["buf.yaml", "buf.gen.yaml", "buf.work.yaml"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `style` | `"bold blue"` | The style for the module. | +| `disabled` | `false` | Disables the `elixir` module. | + +### Variables + +| گۆڕاو | نموونە | Description | +| ------------- | -------- | ------------------------------------ | +| `buf_version` | `v1.0.0` | The version of `buf` | +| `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 + +[buf] +symbol = "🦬 " +``` + ## Character The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. @@ -439,12 +485,6 @@ By default it only changes color. If you also want to change its shape take a lo ::: ئاگادارکردنەوە -`error_symbol` is not supported on nu shell. - -::: - -::: ئاگادارکردنەوە - `vicmd_symbol` is only supported in cmd, fish and zsh. ::: @@ -646,12 +686,12 @@ The `container` module displays a symbol and container name, if inside a contain ### Options -| Option | Default | Description | -| ---------- | ------------------------------------ | ----------------------------------------- | -| `symbol` | `"⬢"` | The symbol shown, when inside a container | -| `style` | `"bold red dimmed"` | The style for the module. | -| `format` | "[$symbol \\[$name\\]]($style) " | The format for the module. | -| `disabled` | `false` | Disables the `container` module. | +| Option | Default | Description | +| ---------- | -------------------------------------- | ----------------------------------------- | +| `symbol` | `"⬢"` | The symbol shown, when inside a container | +| `style` | `"bold red dimmed"` | The style for the module. | +| `format` | `"[$symbol \\[$name\\]]($style) "` | The format for the module. | +| `disabled` | `false` | Disables the `container` module. | ### Variables @@ -1007,7 +1047,7 @@ The `elm` module shows the currently installed version of [Elm](https://elm-lang - 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 -- The current directory contains a `*.elm` files +- The current directory contains `*.elm` files ### Options @@ -1066,7 +1106,7 @@ default = "unknown user" | Option | Default | Description | | ---------- | ------------------------------ | ---------------------------------------------------------------------------- | | `symbol` | `""` | The symbol used before displaying the variable value. | -| `گۆڕاو` | | The environment variable to be displayed. | +| `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. | @@ -1259,6 +1299,7 @@ The `git_branch` module shows the active branch of the repo in your current dire | `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | | `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. | | `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | +| `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for "master" or "main". | | `disabled` | `false` | Disables the `git_branch` module. | ### Variables @@ -1282,6 +1323,7 @@ The `git_branch` module shows the active branch of the repo in your current dire symbol = "🌱 " truncation_length = 4 truncation_symbol = "" +ignore_branches = ["master", "main"] ``` ## Git Commit @@ -1547,6 +1589,39 @@ The `golang` module shows the currently installed version of [Go](https://golang format = "via [🏎💨 $version](bold cyan) " ``` +## Haskell + +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 +- The current directory contains any `.hs`, `.cabal`, or `.hs-boot` file + +### Options + +| Option | Default | Description | +| ------------------- | ------------------------------------ | -------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `symbol` | `"λ "` | A format string representing the symbol of Haskell | +| `detect_extensions` | `["hs", "cabal", "hs-boot"]` | Which extensions should trigger this module. | +| `detect_files` | `["stack.yaml", "cabal.project"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"bold purple"` | The style for the module. | +| `disabled` | `false` | Disables the `haskell` module. | + +### Variables + +| گۆڕاو | نموونە | Description | +| -------------- | ----------- | --------------------------------------------------------------------------------------- | +| version | | `ghc_version` or `snapshot` depending on whether the current project is a Stack project | +| snapshot | `lts-18.12` | Currently selected Stack snapshot | +| ghc\_version | `9.2.1` | Currently installed GHC version | +| 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 + ## 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: @@ -2107,12 +2182,12 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/ ### Variables -| گۆڕاو | نموونە | Description | -| --------- | -------- | ------------------------------------ | -| state | `بێخەوش` | The state of the nix-shell | -| name | `lorri` | The name of the nix-shell | -| symbol | | Mirrors the value of option `symbol` | -| style\* | | Mirrors the value of option `style` | +| گۆڕاو | نموونە | Description | +| --------- | ------- | ------------------------------------ | +| state | `pure` | The state of the nix-shell | +| name | `lorri` | The name of the nix-shell | +| symbol | | Mirrors the value of option `symbol` | +| style\* | | Mirrors the value of option `style` | *: This variable can only be used as a part of a style string @@ -2137,21 +2212,21 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n - 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` extension +- The current directory contains a file with the `.ts`, `.mts` or `.cts` extension ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `" "` | A format string representing the symbol of Node.js. | -| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this module. | -| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. | -| `style` | `"bold green"` | The style for the module. | -| `disabled` | `false` | Disables the `nodejs` module. | -| `not_capable_style` | `bold red` | The style for the module when an engines property in package.json does not match the Node.js version. | +| Option | Default | Description | +| ------------------- | ------------------------------------------ | ----------------------------------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `" "` | A format string representing the symbol of Node.js. | +| `detect_extensions` | `["js", "mjs", "cjs", "ts", "mts", "cts"]` | Which extensions should trigger this module. | +| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. | +| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. | +| `style` | `"bold green"` | The style for the module. | +| `disabled` | `false` | Disables the `nodejs` module. | +| `not_capable_style` | `bold red` | The style for the module when an engines property in package.json does not match the Node.js version. | ### Variables @@ -2896,7 +2971,7 @@ format = '[📦 \[$env\]]($style) ' ## Status -The `status` module displays the exit code of the previous command. The module will be shown only if the exit code is not `0`. The status code will cast to a signed 32-bit integer. +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 @@ -2904,15 +2979,13 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y ::: -::: warning This module is not supported on nu shell. ::: - ### Options | Option | Default | Description | | ----------------------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------- | | `format` | `"[$symbol$status]($style) "` | The format of the module | | `symbol` | `"✖"` | The symbol displayed on program error | -| `success_symbol` | `"✔️"` | The symbol displayed on program success | +| `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) | @@ -2949,8 +3022,9 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y [status] style = "bg:blue" -symbol = "🔴" -format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) ' +symbol = "🔴 " +success_symbol = "🟢 SUCCESS" +format = '[\[$symbol$common_meaning$signal_name$maybe_int\]]($style) ' map_symbol = true disabled = false ``` diff --git a/docs/ckb-IR/faq/README.md b/docs/ckb-IR/faq/README.md index 6f06ba9f..1869269f 100644 --- a/docs/ckb-IR/faq/README.md +++ b/docs/ckb-IR/faq/README.md @@ -1,4 +1,4 @@ -# FAQ +# Frequently Asked Questions ## ئەو ڕێکخستنە چییە لە GIF پێشاندانەکەدا بەکارهاتووە؟ diff --git a/docs/ckb-IR/guide/README.md b/docs/ckb-IR/guide/README.md index 317a1038..6302c572 100644 --- a/docs/ckb-IR/guide/README.md +++ b/docs/ckb-IR/guide/README.md @@ -135,11 +135,13 @@ />

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

Starship لەگەڵ iTerm2 و ڕووکاری Snazzy @@ -154,7 +156,7 @@ - **ئاسان:** خێرا لە دامەزراندن – دەست ئەکەیت بە بەکارهێنانی لە چەند خولەکێکدا.

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

@@ -320,17 +322,22 @@ eval $(starship init ion)
Nushell -Add the following to the end of your Nushell configuration (find it by running `config path`): +Run the following: -```toml -startup = [ - "mkdir ~/.cache/starship", - "starship init nu | save ~/.cache/starship/init.nu", - "source ~/.cache/starship/init.nu", -] -prompt = "starship_prompt" +```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`): + +```sh +starship init nu | save ~/.cache/starship/init.nu +source ~/.cache/starship/init.nu +``` + +Note: Only Nushell v0.60+ is supported +
@@ -389,15 +396,15 @@ If you're looking to further customize Starship: ## 🤝 بەژداریکردن -ئێمە هەموو کات ئەگەڕێین بۆ بەژداریکەرێک لە هەر **ئاست و توانایەکدا بێت**! ئەگەر بەدوای ئەوەوەی کە بێیتە ئەم پڕۆژەیەوە [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue) تاقیبکەرەوە. +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). -ئەگەر پاراویت لە زمانێک جگە لە ئینگلیزی، ئێمە زۆر خۆشحاڵدەبین بە هەر یارمەتییەک کە بەڵگەنامەکانمان بە وەرگێڕدراوی بهێڵێتەوە و نوێکراوی بهێڵێتەوە بە زمانەکانی دیکە. ئەگەر نیازت هەیە یارمەتی بدەیت، ئەتوانی بەژداری لە وەرگێڕاندا بکەیت لەسەر [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. If you would like to help, translations can be contributed on the [Starship Crowdin](https://translate.starship.rs/). -ئەگەر حەزئەکەیت یارمەتی بدەیت بە بەژداریکردن لە starship، تکایە سەیری [ڕێبەری بەژداریکردن](https://github.com/starship/starship/blob/master/CONTRIBUTING.md)ـەکەمان بکە. هەروەها، شەرم مەکە وەرە نێوە [ڕاژەی Discord](https://discord.gg/8Jzqu3T)ـەکەمانەوە و سڵاوێک بکە. 👋 +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 دا. 🙏 +Please check out these previous works that helped inspire the creation of starship. 🙏 - **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** – A ZSH prompt for astronauts. @@ -407,9 +414,9 @@ If you're looking to further customize Starship:


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

## 📝 مۆڵەتنامە -هەموو مافێکی پارێزراوە © 2019-ئێستا، [بەژداریکەرانی Starship](https://github.com/starship/starship/graphs/contributors).
ئەم پڕۆژەیە لە ژێر مۆڵەتنامەی [ISC](https://github.com/starship/starship/blob/master/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. diff --git a/docs/ckb-IR/installing/README.md b/docs/ckb-IR/installing/README.md index 015b5662..b5ecf298 100644 --- a/docs/ckb-IR/installing/README.md +++ b/docs/ckb-IR/installing/README.md @@ -1,4 +1,4 @@ -# 🚀 Advanced Installation +# Advanced Installation To install starship, you need to do two things: diff --git a/docs/ckb-IR/presets/README.md b/docs/ckb-IR/presets/README.md index c7b2dd80..ee980d1f 100644 --- a/docs/ckb-IR/presets/README.md +++ b/docs/ckb-IR/presets/README.md @@ -4,32 +4,38 @@ To get details on how to use a preset, simply click on the image. -## [هێماکانی Nerd Font](./nerd-font) +## [هێماکانی Nerd Font](./nerd-font.md) This preset changes the symbols for each module to use Nerd Font symbols. [![ڕوونماوێنەیەکی پێش ڕێکخستنی هێماکانی فۆنتی Nerd](/presets/img/nerd-font-symbols.png "Click to view Nerd Font Symbols preset")](./nerd-font) -## [پارچە کەوانەکراوەکان](./bracketed-segments) +## [پارچە کەوانەکراوەکان](./bracketed-segments.md) This preset changes the format of all the built-in modules to show their segment in brackets instead of using the default Starship wording ("via", "on", etc.). [![ڕوونماوێنەی پێشڕێکخستنی Bracketed Segments](/presets/img/bracketed-segments.png "Click to view Bracketed Segments preset")](./bracketed-segments) -## [هێما نووسینەکییە ئاساییەکان](./plain-text) +## [هێما نووسینەکییە ئاساییەکان](./plain-text.md) This preset changes the symbols for each module into plain text. Great if you don't have access to Unicode. [![Screenshot of Plain Text Symbols preset](/presets/img/plain-text-symbols.png "Click to view Plain Text Symbols preset")](./plain-text) -## [No Runtime Versions](./no-runtimes) +## [No Runtime Versions](./no-runtimes.md) ئەم پێش ڕێکخستنە وەشانی کاتی جێبەجێکردنی زمانەکان دەشارێتەوە. ئەگەر کاردەکەیت لەگەڵ containerو ژینگە خەیاڵییەکان، ئەمە بۆ تۆیە! [![Screenshot of Hide Runtime Versions preset](/presets/img/no-runtime-versions.png "Click to view No Runtime Versions preset")](./no-runtimes) -## [Pure Prompt](./pure-preset) +## [Pure Prompt](./pure-preset.md) ئەم پێش ڕێکخستنە لاسایی شێواز و ڕەفتاری [Pure](https://github.com/sindresorhus/pure) دەکاتەوە. [![Screenshot of Pure preset](/presets/img/pure-preset.png "Click to view Pure Prompt preset")](./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. + +[![Screenshot of Pastel Powerline preset](/presets/img/pastel-powerline.png "Click to view Pure Prompt preset")](./pastel-powerline) diff --git a/docs/ckb-IR/presets/bracketed-segments.md b/docs/ckb-IR/presets/bracketed-segments.md index 90bd6e3a..50905169 100644 --- a/docs/ckb-IR/presets/bracketed-segments.md +++ b/docs/ckb-IR/presets/bracketed-segments.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#bracketed-segments) +[Return to Presets](./README.md#bracketed-segments) # Bracketed Segments Preset diff --git a/docs/ckb-IR/presets/nerd-font.md b/docs/ckb-IR/presets/nerd-font.md index b5fd8d5d..5a589d2a 100644 --- a/docs/ckb-IR/presets/nerd-font.md +++ b/docs/ckb-IR/presets/nerd-font.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#nerd-font-symbols) +[Return to Presets](./README.md#nerd-font-symbols) # Nerd Font Symbols Preset diff --git a/docs/ckb-IR/presets/no-runtimes.md b/docs/ckb-IR/presets/no-runtimes.md index 80dc6c42..39e50cf2 100644 --- a/docs/ckb-IR/presets/no-runtimes.md +++ b/docs/ckb-IR/presets/no-runtimes.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#no-runtime-versions) +[Return to Presets](./README.md#no-runtime-versions) # No Runtime Versions Preset diff --git a/docs/ckb-IR/presets/pastel-powerline.md b/docs/ckb-IR/presets/pastel-powerline.md new file mode 100644 index 00000000..67e79a80 --- /dev/null +++ b/docs/ckb-IR/presets/pastel-powerline.md @@ -0,0 +1,17 @@ +[Return to Presets](./README.md#pastel-powerline) + +# Pastel Powerline Preset + +This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). It also shows how path substitution works in starship. + +![Screenshot of Pastel Powerline preset](/presets/img/pastel-powerline.png) + +### پێشمەرجەکان + +- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (the example uses Caskaydia Cove Nerd Font) + +### ڕێکخستن + +[Click to download TOML](/presets/toml/pastel-powerline.toml) + +<<< @/.vuepress/public/presets/toml/pastel-powerline.toml diff --git a/docs/ckb-IR/presets/plain-text.md b/docs/ckb-IR/presets/plain-text.md index ebb1a438..c562caec 100644 --- a/docs/ckb-IR/presets/plain-text.md +++ b/docs/ckb-IR/presets/plain-text.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#plain-text-symbols) +[Return to Presets](./README.md#plain-text-symbols) ## Plain Text Symbols Preset diff --git a/docs/ckb-IR/presets/pure-preset.md b/docs/ckb-IR/presets/pure-preset.md index caeb6ccc..38b26207 100644 --- a/docs/ckb-IR/presets/pure-preset.md +++ b/docs/ckb-IR/presets/pure-preset.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#pure) +[Return to Presets](./README.md#pure) # Pure Preset diff --git a/docs/de-DE/README.md b/docs/de-DE/README.md index 741820f9..7bd5d543 100644 --- a/docs/de-DE/README.md +++ b/docs/de-DE/README.md @@ -62,12 +62,12 @@ description: Starship ist eine minimale, super schnelle, und extrem anpassbare P scoop install starship ``` -1. Füge das init-Skript zur Konfigurationsdatei deiner Shell hinzu: +1. Führe den init Befehl zum Start der Shell aus: #### Bash - Trage folgendes am Ende der `~/.bashrc` ein: + Füge dies ans Ende von `~/.bashrc`: ```sh # ~/.bashrc @@ -89,7 +89,7 @@ description: Starship ist eine minimale, super schnelle, und extrem anpassbare P #### Zsh - Trage folgendes am Ende der `~/.zshrc` ein: + Füge dies ans Ende von `~/.zshrc`: ```sh # ~/.zshrc @@ -144,17 +144,19 @@ description: Starship ist eine minimale, super schnelle, und extrem anpassbare P #### Nushell - ::: warning Dies wird sich in der Zukunft ändern. Es wird nur nu Version v0.33 oder höher unterstützt. ::: Füge Folgendes zu deiner nu Konfigurationsdatei hinzu. Du kannst den Speicherort dieser Datei überprüfen, indem du `config path` in nu ausführst. - - ```toml - startup = [ - "mkdir ~/.cache/starship", - "starship init nu | save ~/.cache/starship/init.nu", - "source ~/.cache/starship/init.nu", - ] - prompt = "starship_prompt" + ::: warning Dies wird sich in der Zukunft ändern. Only Nushell v0.60+ is supported. ::: Run the following: + ```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`): + + ```sh + mkdir ~/.cache/starship + starship init nu | save ~/.cache/starship/init.nu + source ~/.cache/starship/init.nu + ``` #### Xonsh diff --git a/docs/de-DE/advanced-config/README.md b/docs/de-DE/advanced-config/README.md index 383924ca..3a3a996a 100644 --- a/docs/de-DE/advanced-config/README.md +++ b/docs/de-DE/advanced-config/README.md @@ -2,7 +2,7 @@ Auch wenn Starship eine vielseitige Shell ist, reichen manche Konfigurationen in der `starship.toml` nicht aus, um erweiterte Einstellungen vorzunehmen. Diese Seite beschreibt einige fortgeschrittene Konfigurationen für Starship. -::: Warnung +::: warning Die hier beschriebenen Konfigurationen werden sich mit kommenden Updates von Starship verändern. diff --git a/docs/de-DE/config/README.md b/docs/de-DE/config/README.md index 9d3f8b1e..0f912b95 100644 --- a/docs/de-DE/config/README.md +++ b/docs/de-DE/config/README.md @@ -27,7 +27,7 @@ Die voreingestellte Konfigurations-Datei kann mit der `STARSHIP_CONFIG` Umgebung export STARSHIP_CONFIG=~/example/non/default/path/starship.toml ``` -Für die Windows PowerShell diese Zeile zum `$PROFILE` hinzufügen: +Äquivalent ist in der Windows PowerShell diese Zeile zum `$PROFILE` hinzuzufügen: ```powershell $ENV:STARSHIP_CONFIG = "$HOME\example\non\default\path\starship.toml" @@ -198,6 +198,7 @@ $git_status\ $hg_branch\ $docker_context\ $package\ +$buf\ $cmake\ $cobol\ $container\ @@ -208,6 +209,7 @@ $elixir\ $elm\ $erlang\ $golang\ +$haskell\ $helm\ $java\ $julia\ @@ -261,7 +263,7 @@ format = "$all$directory$character" ## AWS -The `aws` module shows the current AWS region and profile when credentials or a `credential_process` 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. 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. @@ -273,14 +275,15 @@ 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. | -| `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. | +| 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. | ### Variables @@ -308,6 +311,8 @@ symbol = "🅰 " [aws.region_aliases] ap-southeast-2 = "au" us-east-1 = "va" +[aws.profile_aliases] +CompanyGroupFrobozzOnCallAccess = 'Frobozz' ``` #### Region anzeigen @@ -333,6 +338,8 @@ us-east-1 = "va" format = "on [$symbol$profile]($style) " style = "bold blue" symbol = "🅰 " +[aws.profile_aliases] +Enterprise_Naming_Scheme-voidstars = 'void**' ``` ## Azure @@ -341,7 +348,7 @@ The `azure` module shows the current Azure Subscription. This is based on showin ### Optionen -| Variable | Standartwert | Beschreibung | +| Variable | Standardwert | Beschreibung | | ---------- | ---------------------------------------- | ------------------------------------------ | | `format` | `"on [$symbol($subscription)]($style) "` | The format for the Azure module to render. | | `symbol` | `"ﴃ "` | The symbol used in the format. | @@ -426,24 +433,57 @@ discharging_symbol = "💦" # when capacity is over 30%, the battery indicator will not be displayed ``` +## 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: + +- 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. + +### Optionen + +| Option | Standardwert | Beschreibung | +| ------------------- | ------------------------------------------------------------ | ----------------------------------------------------- | +| `format` | `'with [$symbol($version \(Buf $buf_version\) )]($style)'` | The format for the `buf` module. | +| `version_format` | `"v${raw}"` | The version format. | +| `symbol` | `"🦬 "` | The symbol used before displaying the version of Buf. | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["buf.yaml", "buf.gen.yaml", "buf.work.yaml"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `style` | `"bold blue"` | Stil für dieses Modul. | +| `disabled` | `false` | Disables the `elixir` module. | + +### Variables + +| Variable | Beispiel | Beschreibung | +| ------------- | -------- | ------------------------------------- | +| `buf_version` | `v1.0.0` | The version of `buf` | +| `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 + +[buf] +symbol = "🦬 " +``` + ## Zeichen -Das `character` Modul zeigt ein Zeichen ( meistens einen Pfeil "❯") vor der Texteingabe an. +The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. -Das Zeichen zeigt an ob der letzte Befehl erfolgreich war, oder einen Fehler erzeugt hat. It can do this in two ways: +The character will tell you whether the last command was successful or not. It can do this in two ways: - 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). -::: Warnung - -`error_symbol` is not supported on nu shell. - -::: - -::: Warnung +::: warning `vicmd_symbol` is only supported in cmd, fish and zsh. @@ -457,7 +497,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` | Deaktiviert das `character`-Modul. | +| `disabled` | `false` | Disables the `character` module. | ### Variables @@ -558,25 +598,25 @@ The `cobol` module shows the currently installed version of COBOL. By default, t ## Befehlsdauer -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. +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. -::: warning Nicht die DEBUG-trap in der Bash hooken +::: warning Do not hook the DEBUG trap in Bash -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. +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 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. +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. ### Optionen | Option | Standardwert | Beschreibung | | ---------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `min_time` | `2_000` | Schwellwert für kleinste anzuzeigende Laufzeit (in Millisekunden). | -| `show_milliseconds` | `false` | Zeige Millisekunden zusätzlich zu Sekunden. | +| `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) "` | Das Format für das Modul. | | `style` | `"bold yellow"` | Stil für dieses Modul. | -| `disabled` | `false` | Deaktiviert das `cmd_duration`-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). | | `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. | @@ -606,20 +646,20 @@ The `conda` module shows the current [Conda](https://docs.conda.io/en/latest/) e ::: tip -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. +This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. ::: ### Optionen -| 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. | +| 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. | ### Variables @@ -646,12 +686,12 @@ The `container` module displays a symbol and container name, if inside a contain ### Optionen -| Option | Standardwert | Beschreibung | -| ---------- | ------------------------------------ | ----------------------------------------- | -| `symbol` | `"⬢"` | The symbol shown, when inside a container | -| `style` | `"bold red dimmed"` | Stil für dieses Modul. | -| `format` | "[$symbol \\[$name\\]]($style) " | Das Format für das Modul. | -| `disabled` | `false` | Disables the `container` module. | +| Option | Standardwert | Beschreibung | +| ---------- | -------------------------------------- | ----------------------------------------- | +| `symbol` | `"⬢"` | The symbol shown, when inside a container | +| `style` | `"bold red dimmed"` | Stil für dieses Modul. | +| `format` | `"[$symbol \\[$name\\]]($style) "` | Das Format für das Modul. | +| `disabled` | `false` | Disables the `container` module. | ### Variables @@ -676,7 +716,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: -- Das aktuelle Verzeichnis enthält eine `shard.yml`-Datei +- The current directory contains a `shard.yml` file - The current directory contains a `.cr` file ### Optionen @@ -717,7 +757,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 -- Das aktuelle Verzeichnis enthält `pubspec.yaml`, `pubspec.yml` oder `pubspec.lock` +- The current directory contains a `pubspec.yaml`, `pubspec.yml` or `pubspec.lock` file ### Optionen @@ -789,7 +829,7 @@ format = "via [🦕 $version](green bold) " ## Verzeichnis -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. +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. 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. @@ -799,11 +839,11 @@ For example, given `~/Dev/Nix/nixpkgs/pkgs` where `nixpkgs` is the repo root, an | Option | Standardwert | Beschreibung | | ------------------- | ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `truncation_length` | `3` | Die Anzahl der übergeordneten Ordner, die angezeigt werden. | +| `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) "` | Das Format für das Modul. | | `style` | `"bold cyan"` | Stil für dieses Modul. | -| `disabled` | `false` | Deaktiviert das `directory`-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: "…/" | @@ -813,7 +853,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) |
-Dieses Modul hat einige erweiterte Konfigurationsoptionen, welche die Darstellung von Verzeichnissen steuern. +This module has a few advanced configuration options that control how the directory is displayed. | Advanced Option | Standardwert | Beschreibung | | --------------------------- | ------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -930,13 +970,13 @@ The module will also show the Target Framework Moniker ([\\w-]+)" = "gke-$var_cluster" ``` -## Zeilenumbruch +## Line Break -Das `line_break`-Modul unterteilt den Prompt in zwei Zeilen. +The `line_break` module separates the prompt into two lines. ### Optionen -| Option | Standardwert | Beschreibung | -| ---------- | ------------ | ---------------------------------------------------------------------- | -| `disabled` | `false` | Deaktiviert das `line_break`-Modul, wodurch der Prompt einzeilig wird. | +| Option | Standardwert | Beschreibung | +| ---------- | ------------ | ------------------------------------------------------------------ | +| `disabled` | `false` | Disables the `line_break` module, making the prompt a single line. | ### Beispiel @@ -1965,27 +2040,27 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o format = "via [🌕 $version](bold blue) " ``` -## Speicherauslastung +## Memory Usage -Das `memory_usage` Modul zeigt den aktuellen Systemspeicher und die swap-Nutzung an. +The `memory_usage` module shows current system memory and swap usage. -Standardmäßig wird die swap-Nutzung angezeigt, wenn der gesamte System-swap nicht Null ist. +By default the swap usage is displayed if the total system swap is non-zero. ::: tip -Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### Optionen -| Option | 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. | +| 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. | ### Variables @@ -2052,7 +2127,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: -- Das aktuelle Verzeichnis enthält eine `nim.cfg`-Datei +- 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 @@ -2061,7 +2136,7 @@ The `nim` module shows the currently installed version of [Nim](https://nim-lang | Option | Standardwert | Beschreibung | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | Das Format für das Modul | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. | | `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this module. | @@ -2090,9 +2165,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. Das Modul wird angezeigt, wenn es sich in einer nix-Shell-Umgebung befindet. +The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html) environment. The module will be shown when inside a nix-shell environment. ### Optionen @@ -2103,7 +2178,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` | Deaktiviert das `nix_shell`-Modul. | +| `disabled` | `false` | Disables the `nix_shell` module. | ### Variables @@ -2132,26 +2207,26 @@ 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: -- Das aktuelle Verzeichnis enthält eine `package.json`-Datei +- The current directory contains a `package.json` file - The current directory contains a `.node-version` file - The current directory contains a `.nvmrc` file -- Das aktuelle Verzeichnis enthält ein `node_modules`-Verzeichnis +- 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` extension +- The current directory contains a file with the `.ts`, `.mts` or `.cts` extension ### Optionen -| Option | Standardwert | Beschreibung | -| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | Das Format für das Modul. | -| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `" "` | A format string representing the symbol of Node.js. | -| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this module. | -| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. | -| `style` | `"bold green"` | Stil für dieses Modul. | -| `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. | +| Option | Standardwert | Beschreibung | +| ------------------- | ------------------------------------------ | ----------------------------------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Das Format für das Modul. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `" "` | A format string representing the symbol of Node.js. | +| `detect_extensions` | `["js", "mjs", "cjs", "ts", "mts", "cts"]` | Which extensions should trigger this module. | +| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. | +| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. | +| `style` | `"bold green"` | Stil für dieses Modul. | +| `disabled` | `false` | Disables the `nodejs` module. | +| `not_capable_style` | `bold red` | The style for the module when an engines property in package.json does not match the Node.js version. | ### Variables @@ -2254,9 +2329,9 @@ style = "bold yellow" symbol = "☁️ " ``` -## Paketversion +## Package Version -Das `Package` Modul wird angezeigt, wenn das aktuelle Verzeichnis das Repository für ein Paket ist, und zeigt dessen aktuelle Version an. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards` and `dart` packages. +The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `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 @@ -2282,11 +2357,11 @@ Das `Package` Modul wird angezeigt, wenn das aktuelle Verzeichnis das Repository | Option | Standardwert | Beschreibung | | ----------------- | --------------------------------- | ------------------------------------------------------------------------- | | `format` | `"is [$symbol$version]($style) "` | Das Format für das Modul. | -| `symbol` | `"📦 "` | Symbol das vor der Paketversion angezeigt wird. | +| `symbol` | `"📦 "` | The symbol used before displaying the version the package. | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `style` | `"bold 208"` | Stil für dieses Modul. | | `display_private` | `false` | Enable displaying version for packages marked as private. | -| `disabled` | `false` | Deaktiviert das `package`-Modul. | +| `disabled` | `false` | Disables the `package` module. | ### Variables @@ -2351,7 +2426,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: -- Das aktuelle Verzeichnis enthält eine `composer.json`-Datei +- The current directory contains a `composer.json` file - The current directory contains a `.php-version` file - The current directory contains a `.php` extension @@ -2361,12 +2436,12 @@ The `php` module shows the currently installed version of [PHP](https://www.php. | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | Das Format für das Modul. | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"🐘 "` | Symbol das vor der PHP-Version angezeigt wird. | +| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | | `detect_extensions` | `["php"]` | Which extensions should trigger this module. | | `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"147 bold"` | Stil für dieses Modul. | -| `disabled` | `false` | Deaktiviert das `php`-Modul. | +| `disabled` | `false` | Disables the `php` module. | ### Variables @@ -2414,13 +2489,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 | -| benutzername | `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 | +| username | `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 @@ -2448,7 +2523,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: -- Das aktuelle Verzeichnis enthält eine `spago.dhall`-Datei +- The current directory contains a `spago.dhall` file - The current directory contains a file with the `.purs` extension ### Optionen @@ -2491,15 +2566,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: -- Das aktuelle Verzeichnis enthält eine `.python-version`-Datei -- Das aktuelle Verzeichnis enthält eine `Pipfile`-Datei +- The current directory contains a `.python-version` file +- The current directory contains a `Pipfile` file - The current directory contains a `__init__.py` file -- 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 +- 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 ### Optionen @@ -2509,13 +2584,13 @@ By default the module will be shown if any of the following conditions are met: | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `symbol` | `"🐍 "` | A format string representing the symbol of Python | | `style` | `"yellow bold"` | Stil für dieses Modul. | -| `pyenv_version_name` | `false` | Verwende `pyenv` um die Python-Versionzu beziehen. | +| `pyenv_version_name` | `false` | Use pyenv to get Python version | | `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `python_binary` | `["python", "python3", "python2"]` | Configures the python binaries that Starship should executes when getting the version. | | `detect_extensions` | `["py"]` | Which extensions should trigger this module | | `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | Which filenames should trigger this module | | `detect_folders` | `[]` | Which folders should trigger this module | -| `disabled` | `false` | Deaktiviert das `python`-Modul. | +| `disabled` | `false` | Disables the `python` module. | ::: tip @@ -2656,9 +2731,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: -- Das aktuelle Verzeichnis enthält eine `Gemfile`-Datei +- The current directory contains a `Gemfile` file - The current directory contains a `.ruby-version` file -- Das aktuelle Verzeichnis enthält eine `.rb`-Datei +- The current directory contains a `.rb` file - The environment variables `RUBY_VERSION` or `RBENV_VERSION` are set Starship gets the current Ruby version by running `ruby -v`. @@ -2675,7 +2750,7 @@ Starship gets the current Ruby version by running `ruby -v`. | `detect_folders` | `[]` | Which folders should trigger this module. | | `detect_variables` | `["RUBY_VERSION", "RBENV_VERSION"]` | Which environment variables should trigger this module. | | `style` | `"bold red"` | Stil für dieses Modul. | -| `disabled` | `false` | Deaktiviert das `ruby`-Modul. | +| `disabled` | `false` | Disables the `ruby` module. | ### Variables @@ -2700,8 +2775,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: -- Das aktuelle Verzeichnis enthält eine `Cargo.toml`-Datei -- Das aktuelle Verzeichnis enthält eine Datei mit der `.rs`-Erweiterung +- The current directory contains a `Cargo.toml` file +- The current directory contains a file with the `.rs` extension ### Optionen @@ -2714,7 +2789,7 @@ By default the `rust` module shows the currently installed version of [Rust](htt | `detect_files` | `["Cargo.toml"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"bold red"` | Stil für dieses Modul. | -| `disabled` | `false` | Deaktiviert das `rust`-Modul. | +| `disabled` | `false` | Disables the `rust` module. | ### Variables @@ -2781,7 +2856,7 @@ The `shell` module shows an indicator for currently used shell. ::: tip -Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -2809,7 +2884,7 @@ Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `dis | Variable | Standardwert | Beschreibung | | --------- | ------------ | ---------------------------------------------------------- | | indicator | | Mirrors the value of `indicator` for currently used shell. | -| style\* | | Spiegelt den Wert der Option `style`. | +| style\* | | Mirrors the value of option `style`. | *: This variable can only be used as a part of a style string @@ -2896,23 +2971,21 @@ format = '[📦 \[$env\]]($style) ' ## Status -The `status` module displays the exit code of the previous command. The module will be shown only if the exit code is not `0`. The status code will cast to a signed 32-bit integer. +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 -Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: -::: warning This module is not supported on nu shell. ::: - ### Optionen | Option | Standardwert | Beschreibung | | ----------------------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------- | | `format` | `"[$symbol$status]($style) "` | The format of the module | | `symbol` | `"✖"` | The symbol displayed on program error | -| `success_symbol` | `"✔️"` | The symbol displayed on program success | +| `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) | @@ -2949,8 +3022,9 @@ Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `dis [status] style = "bg:blue" -symbol = "🔴" -format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) ' +symbol = "🔴 " +success_symbol = "🟢 SUCCESS" +format = '[\[$symbol$common_meaning$signal_name$maybe_int\]]($style) ' map_symbol = true disabled = false ``` @@ -2961,7 +3035,7 @@ The `sudo` module displays if sudo credentials are currently cached. The module ::: tip -Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -3055,7 +3129,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: -- Das aktuelle Verzeichnis enthält eine `.terraform`-Datei +- The current directory contains a `.terraform` folder - Current directory contains a file with the `.tf`, `.tfplan` or `.tfstate` extensions ### Optionen @@ -3069,7 +3143,7 @@ By default the module will be shown if any of the following conditions are met: | `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_folders` | `[".terraform"]` | Which folders should trigger this module. | | `style` | `"bold 105"` | Stil für dieses Modul. | -| `disabled` | `false` | Deaktiviert das `terraform` Modul. | +| `disabled` | `false` | Disables the `terraform` module. | ### Variables @@ -3102,35 +3176,35 @@ format = "[🏎💨 $version$workspace]($style) " format = "[🏎💨 $workspace]($style) " ``` -## Zeit +## Uhrzeit -Das `time` Modul zeigt die aktuelle **lokale** Zeit an. Der `format` Wert wird von der crate [`chrono`](https://crates.io/crates/chrono) benutzt um die Zeit zu formatieren. Schau dir [die chrono strftime Dokumentation](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) an, um die möglichen Optionen zu sehen. +The `time` module shows the current **local** time. The `format` configuration value is used by the [`chrono`](https://crates.io/crates/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) to see what options are available. ::: tip -Dieses Modul ist standardmäßig deaktiviert. Setze in deiner Konfiguration `disabled` auf `false` um es zu aktivieren. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### Optionen -| Option | 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 | +| 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 | -If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Ansonsten ist der Standardwert hierfür `"%T"`. Manually setting `time_format` will override the `use_12hr` setting. +If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Otherwise, it defaults to `"%T"`. Manually setting `time_format` will override the `use_12hr` setting. ### Variables | Variable | Beispiel | Beschreibung | | --------- | ---------- | ------------------------------------ | -| uhrzeit | `13:08:10` | The current time. | +| time | `13:08:10` | The current time. | | style\* | | Spiegelt den Wert der Option `style` | *: This variable can only be used as a part of a style string @@ -3148,14 +3222,14 @@ utc_time_offset = "-5" time_range = "10:00:00-14:00:00" ``` -## Benutzername +## Username -Das Modul `username` zeigt den Benutzernamen des aktiven Benutzers. Das Modul wird nur dann angezeigt, wenn eine der folgenden Bedingungen zutrifft: +The `username` module shows active user's username. Das Modul wird nur dann angezeigt, wenn eine der folgenden Bedingungen zutrifft: -- Der aktuelle Benutzer ist root -- 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 +- 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 ::: tip @@ -3165,13 +3239,13 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, ` ### Optionen -| Option | Standardwert | Beschreibung | -| ------------- | ----------------------- | --------------------------------- | -| `style_root` | `"bold red"` | Stil beim root-Benutzer. | -| `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. | +| 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. | ### Variables @@ -3377,20 +3451,20 @@ 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) | -| `beschreibung` | `""` | 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` | | 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). | ### Variables diff --git a/docs/de-DE/faq/README.md b/docs/de-DE/faq/README.md index e589d560..c2b31ee5 100644 --- a/docs/de-DE/faq/README.md +++ b/docs/de-DE/faq/README.md @@ -1,4 +1,4 @@ -# FAQ +# Frequently Asked Questions ## Wie ist die Konfiguration im Demo GIF? diff --git a/docs/de-DE/guide/README.md b/docs/de-DE/guide/README.md index 77324666..e5ee25cb 100644 --- a/docs/de-DE/guide/README.md +++ b/docs/de-DE/guide/README.md @@ -15,7 +15,7 @@ Crates.io-Version

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

Starship mit iTem2 und dem Theme „Snazzy“ -**Der minimalistische, super schnelle und unendlich anpassbare Prompt für jede Shell!** +**Minimale, super schnelle und unendlich anpassbare Prompt für jede Shell!** - **Schnell:** sie ist schnell – _sehr, sehr_ schnell! 🚀 - **Konfigurierbar:** konfiguriere jedes Detail der Prompt. @@ -158,7 +160,7 @@ - **Einfach:** schnell zu installieren – Betriebsbereit in nur wenigen Minuten.

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

@@ -169,7 +171,7 @@ - Eine [Nerd Schriftart](https://www.nerdfonts.com/) installiert und im Terminal aktiviert (zum Beispiel [Fira Code Nerd Font](https://www.nerdfonts.com/font-downloads)). -### Step 1. Install Starship +### Schritt 1. Installiere Starship Select your operating system from the list below to view installation instructions: @@ -260,14 +262,14 @@ Install Starship using any of the following package managers:
-### Step 2. Setup your shell to use Starship +### Schritt 2. Richte deine Shell für die Nutzung von Starship ein Configure your shell to initialize starship. Select yours from the list below:
Bash -Trage folgendes am Ende der `~/.bashrc` ein: +Füge dies ans Ende von `~/.bashrc`: ```sh eval "$(starship init bash)" @@ -324,17 +326,22 @@ eval $(starship init ion)
Nushell -Add the following to the end of your Nushell configuration (find it by running `config path`): +Run the following: -```toml -startup = [ - "mkdir ~/.cache/starship", - "starship init nu | save ~/.cache/starship/init.nu", - "source ~/.cache/starship/init.nu", -] -prompt = "starship_prompt" +```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`): + +```sh +starship init nu | save ~/.cache/starship/init.nu +source ~/.cache/starship/init.nu +``` + +Note: Only Nushell v0.60+ is supported +
@@ -373,7 +380,7 @@ execx($(starship init xonsh))
Zsh -Trage folgendes am Ende der `~/.zshrc` ein: +Füge dies ans Ende von `~/.zshrc`: ```sh eval "$(starship init zsh)" @@ -381,27 +388,27 @@ eval "$(starship init zsh)"
-### Step 3. Configure Starship +### 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! If you're looking to further customize Starship: -- **[Configuration](https://starship.rs/config/)** – learn how to configure Starship to tweak your prompt to your liking +- **[Konfiguration](https://starship.rs/config/)** - Lerne, wie du Starship deinen Bedürfnissen nach anpassen kannst -- **[Presets](https://starship.rs/presets/)** – get inspired by the pre-built configuration of others +- **[Voreinstellungen](https://starship.rs/presets/)** - lasse dich von vorgefertigter Konfigurationen anderer Benutzenden inspirieren ## 🤝 Mitwirken -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). +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). -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 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/). -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. 👋 +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. 👋 ## 💭 Inspiriert durch -Checkt bitte diese älteren Projekte, die das Entstehen von Starhip inspiriert haben. 🙏 +Please check out these previous works that helped inspire the creation of starship. 🙏 - **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** – A ZSH prompt for astronauts. @@ -411,9 +418,9 @@ Checkt bitte diese älteren Projekte, die das Entstehen von Starhip inspiriert h


- Starship Raketen Icon + Starship rocket icon

## 📝 Lizenz -Copyright © 2019-present, [Starship Contributors](https://github.com/starship/starship/graphs/contributors).
Unter der [ISC](https://github.com/starship/starship/blob/master/LICENSE) Lizens. +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. diff --git a/docs/de-DE/installing/README.md b/docs/de-DE/installing/README.md index 31a04b4c..97e10c99 100644 --- a/docs/de-DE/installing/README.md +++ b/docs/de-DE/installing/README.md @@ -1,4 +1,4 @@ -# 🚀 Erweiterte Installation +# Advanced Installation Um Starship zu installieren, musst du zwei Dinge tun: diff --git a/docs/de-DE/migrating-to-0.45.0/README.md b/docs/de-DE/migrating-to-0.45.0/README.md index 8e3d8db7..6b390b4f 100644 --- a/docs/de-DE/migrating-to-0.45.0/README.md +++ b/docs/de-DE/migrating-to-0.45.0/README.md @@ -235,7 +235,7 @@ behind = "⇣${count}" ++ format = '[$symbol\[$env\]]($style) ' ``` -#### Zeit +#### Uhrzeit | Removed Property | Replacement | | ---------------- | ------------- | diff --git a/docs/de-DE/presets/README.md b/docs/de-DE/presets/README.md index 94723b3d..6933f974 100644 --- a/docs/de-DE/presets/README.md +++ b/docs/de-DE/presets/README.md @@ -4,32 +4,38 @@ Here is a collection of community-submitted configuration presets for Starship. To get details on how to use a preset, simply click on the image. -## [Nerd Font Symbole](./nerd-font) +## [Nerd Font Symbole](./nerd-font.md) This preset changes the symbols for each module to use Nerd Font symbols. [![Screenshot of Nerd Font Symbols preset](/presets/img/nerd-font-symbols.png "Click to view Nerd Font Symbols preset")](./nerd-font) -## [Bracketed Segments](./bracketed-segments) +## [Bracketed Segments](./bracketed-segments.md) This preset changes the format of all the built-in modules to show their segment in brackets instead of using the default Starship wording ("via", "on", etc.). [![Screenshot of Bracketed Segments preset](/presets/img/bracketed-segments.png "Click to view Bracketed Segments preset")](./bracketed-segments) -## [Plain Text Symbols](./plain-text) +## [Plain Text Symbols](./plain-text.md) This preset changes the symbols for each module into plain text. Great if you don't have access to Unicode. [![Screenshot of Plain Text Symbols preset](/presets/img/plain-text-symbols.png "Click to view Plain Text Symbols preset")](./plain-text) -## [No Runtime Versions](./no-runtimes) +## [No Runtime Versions](./no-runtimes.md) This preset hides the version of language runtimes. If you work in containers or virtualized environments, this one is for you! [![Screenshot of Hide Runtime Versions preset](/presets/img/no-runtime-versions.png "Click to view No Runtime Versions preset")](./no-runtimes) -## [Pure Prompt](./pure-preset) +## [Pure Prompt](./pure-preset.md) This preset emulates the look and behavior of [Pure](https://github.com/sindresorhus/pure). [![Screenshot of Pure preset](/presets/img/pure-preset.png "Click to view Pure Prompt preset")](./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. + +[![Screenshot of Pastel Powerline preset](/presets/img/pastel-powerline.png "Click to view Pure Prompt preset")](./pastel-powerline) diff --git a/docs/de-DE/presets/bracketed-segments.md b/docs/de-DE/presets/bracketed-segments.md index fae3a450..7ebf3472 100644 --- a/docs/de-DE/presets/bracketed-segments.md +++ b/docs/de-DE/presets/bracketed-segments.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#bracketed-segments) +[Return to Presets](./README.md#bracketed-segments) # Bracketed Segments Preset diff --git a/docs/de-DE/presets/nerd-font.md b/docs/de-DE/presets/nerd-font.md index f076354f..6c9d3af8 100644 --- a/docs/de-DE/presets/nerd-font.md +++ b/docs/de-DE/presets/nerd-font.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#nerd-font-symbols) +[Return to Presets](./README.md#nerd-font-symbols) # Nerd Font Symbols Preset diff --git a/docs/de-DE/presets/no-runtimes.md b/docs/de-DE/presets/no-runtimes.md index 9cffba39..184e063b 100644 --- a/docs/de-DE/presets/no-runtimes.md +++ b/docs/de-DE/presets/no-runtimes.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#no-runtime-versions) +[Return to Presets](./README.md#no-runtime-versions) # No Runtime Versions Preset diff --git a/docs/de-DE/presets/pastel-powerline.md b/docs/de-DE/presets/pastel-powerline.md new file mode 100644 index 00000000..3abd4bc2 --- /dev/null +++ b/docs/de-DE/presets/pastel-powerline.md @@ -0,0 +1,17 @@ +[Return to Presets](./README.md#pastel-powerline) + +# Pastel Powerline Preset + +This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). It also shows how path substitution works in starship. + +![Screenshot of Pastel Powerline preset](/presets/img/pastel-powerline.png) + +### Voraussetzungen + +- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (the example uses Caskaydia Cove Nerd Font) + +### Konfiguration + +[Click to download TOML](/presets/toml/pastel-powerline.toml) + +<<< @/.vuepress/public/presets/toml/pastel-powerline.toml diff --git a/docs/de-DE/presets/plain-text.md b/docs/de-DE/presets/plain-text.md index 81a79158..9bb02a27 100644 --- a/docs/de-DE/presets/plain-text.md +++ b/docs/de-DE/presets/plain-text.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#plain-text-symbols) +[Return to Presets](./README.md#plain-text-symbols) ## Plain Text Symbols Preset diff --git a/docs/de-DE/presets/pure-preset.md b/docs/de-DE/presets/pure-preset.md index 43358b6a..5783b47a 100644 --- a/docs/de-DE/presets/pure-preset.md +++ b/docs/de-DE/presets/pure-preset.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#pure) +[Return to Presets](./README.md#pure) # Pure Preset diff --git a/docs/es-ES/README.md b/docs/es-ES/README.md index 2555e85d..e4d17e12 100644 --- a/docs/es-ES/README.md +++ b/docs/es-ES/README.md @@ -34,7 +34,7 @@ description: '¡Starship es el prompt minimalista, ultrarápido e infinitamente ### Instalación rápida -1. Instalar el binario de **Starship**: +1. Instala el binario de **Starship**: #### Instalar la última versión @@ -48,9 +48,9 @@ description: '¡Starship es el prompt minimalista, ultrarápido e infinitamente Para actualizar Starship, vuelve a ejecutar el guión anterior. Reemplazará la versión actual sin tocar la configuración de Starship. - #### Instalar con un gestor de paquetes + #### Instalar vía un gestor de paquetes - Con [Homebrew](https://brew.sh/): + Con [Homebew](https://brew.sh/): ```sh brew install starship @@ -67,7 +67,7 @@ description: '¡Starship es el prompt minimalista, ultrarápido e infinitamente #### Bash - Añade el siguiente código al final de `~/.bashrc`: + Añade la siguiente línea al final de `~/.bashrc`: ```sh # ~/.bashrc @@ -120,7 +120,7 @@ description: '¡Starship es el prompt minimalista, ultrarápido e infinitamente #### Elvish - ::: advertencia Solo se admite Elvish v0.17 o superior. ::: + ::: warning Solo se admite Elvish v0.17 o superior. ::: Añade el siguiente código al final de `~/.elvish/rc.elv`: @@ -144,17 +144,19 @@ description: '¡Starship es el prompt minimalista, ultrarápido e infinitamente #### Nushell - ::: advertencia Esto cambiará en el futuro. Sólo se admite la versión nu v0.33 o superior. ::: Añade lo siguiente a tu archivo de configuración nu. Puedes comprobar la ubicación de este archivo ejecutando `ruta de configuración` en nu. - - ```toml - startup = [ - "mkdir ~/.cache/starship", - "starship init nu | save ~/.cache/starship/init.nu", - "source ~/.cache/starship/init.nu", - ] - prompt = "starship_prompt" + ::: advertencia Esto cambiará en el futuro. Only Nushell v0.60+ is supported. ::: Run the following: + ```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`): + + ```sh + mkdir ~/.cache/starship + starship init nu | save ~/.cache/starship/init.nu + source ~/.cache/starship/init.nu + ``` #### Xonsh @@ -169,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. Añade lo siguiente a un archivo `starship.lua` y coloca este archivo en el directorio de scripts de Clink: + 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: ```lua -- starship.lua diff --git a/docs/es-ES/advanced-config/README.md b/docs/es-ES/advanced-config/README.md index fe277881..647c0567 100644 --- a/docs/es-ES/advanced-config/README.md +++ b/docs/es-ES/advanced-config/README.md @@ -2,7 +2,7 @@ Mientras que Starship es un prompt versátil, a veces necesitas más que editar `starhip.toml` para que haga ciertas cosas. Esta página detalla algunas de las técnicas de configuración más avanzadas en Starship. -::: aviso +::: warning Las configuraciones de esta sección están sujetos a cambios en futuras versiones de Starship. @@ -69,7 +69,7 @@ function Invoke-Starship-PreCommand { } ``` -## Cambiar título de la ventana +## Cambiar el Título de la Ventana Algunos intérpretes de comandos van a cambiar automáticamente el título de la ventana por ti (p. ej., para mostrar tu directorio actual). Fish incluso lo hace por defecto. Starship no hace esto, pero es bastante sencillo añadir esta funcionalidad a `bash`, `zsh`, `cmd` o `powershell`. @@ -176,19 +176,19 @@ Nota: Los prompts de continuación solo están disponibles en los siguientes int continuation_prompt = "▶▶" ``` -## Cadenas de estilo +## Cadenas de Estilo Las cadenas de estilo son una lista de palabras, separadas por espacios en blanco. Las palabras no son sensibles a mayúsculas (es decir, `negrita` y `NeGriTa` se consideran la misma cadena). Cada palabra puede ser una de las siguientes: -- `negrita` -- `cursiva` -- `subrayado` -- `atenuado` -- `invertido` +- `bold` +- `italic` +- `underline` +- `dimmed` +- `inverted` - `bg:` - `fg:` - `` -- `ninguno` +- `none` donde `` es un especificador de color (discutido a continuación). `fg:` y `` hacen actualmente lo mismo, aunque esto puede cambiar en el futuro. `inverted` cambia el fondo y los colores de primer plano. El orden de las palabras en la cadena no importa. diff --git a/docs/es-ES/config/README.md b/docs/es-ES/config/README.md index 6d7d492c..502eaf7a 100644 --- a/docs/es-ES/config/README.md +++ b/docs/es-ES/config/README.md @@ -1,12 +1,12 @@ # Configuración -Para comenzar a configurar Starship, crea el siguiente archivo: `~/.config/starship.toml`. +Para iniciar la configuración de starship, crea el siguiente fichero: `~/.config.toml`. ```sh mkdir -p ~/.config && touch ~/.config/starship.toml ``` -Toda la configuración de Starship se realiza en este archivo [TOML](https://github.com/toml-lang/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 @@ -95,7 +95,7 @@ Por ejemplo: - `[⌘ $version](bold green)` imprimirá un símbolo `⌘` seguido por el contenido de la variable `version`, con texto en negrita color verde. - `[a [b](red) c](green)` imprimirá `a b c` con `b` en rojo, `a` y `c` en verde. -#### Cadenas de estilo +#### Cadenas de Estilo La mayoría de los módulos de starship permiten configurar los estilos de su cadenas texto. Esto se consigue con una entrada (normalmente llamada `style` - estilo) que no es más que un texto donde se especifica la configuración. A continuación mostramos algunos ejemplos de textos estilados junto con su funcionalidad. Para más detalles sobre la sintaxis completa, consulta [la guía de configuración avanzada](/advanced-config/). @@ -147,13 +147,13 @@ Esta es la lista de opciones de configuración. ### Opciones -| Opción | Por defecto | Descripción | -| ----------------- | ---------------------------------- | ------------------------------------------------------------------------------ | -| `format` | [ver aquí](#default-prompt-format) | Configura el formato del prompt. | -| `right_format` | `""` | Ver [Habilitar prompt derecho](/advanced-config/#enable-right-prompt) | -| `scan_timeout` | `30` | Tiempo de espera tras el que Starship escanea archivos (en milisegundos). | -| `command_timeout` | `500` | Tiempo de espera para los comandos ejecutados por Starship (en milisegundos). | -| `add_newline` | `true` | Inserta un línea en blanco entre las instrucciones del intérprete de comandos. | +| Opción | Predeterminado | Descripción | +| ----------------- | ------------------------------ | ------------------------------------------------------------------------------ | +| `format` | [link](#default-prompt-format) | Configura el formato del prompt. | +| `right_format` | `""` | Ver [Habilitar prompt derecho](/advanced-config/#enable-right-prompt) | +| `scan_timeout` | `30` | Tiempo de espera tras el que starship escanea archivos (en milisegundos). | +| `command_timeout` | `500` | Tiempo de espera para los comandos ejecutados por starship (en milisegundos). | +| `add_newline` | `true` | Inserta un línea en blanco entre las instrucciones del intérprete de comandos. | ### Ejemplo @@ -198,6 +198,7 @@ $git_status\ $hg_branch\ $docker_context\ $package\ +$buf\ $cmake\ $cobol\ $container\ @@ -208,6 +209,7 @@ $elixir\ $elm\ $erlang\ $golang\ +$haskell\ $helm\ $java\ $julia\ @@ -252,7 +254,7 @@ $shell\ $character""" ``` -Si solo quieres extender el formato predeterminado, puedes usar `$all`; los módulos que se añaden explícitamente al formato no serán duplicados. Ej. +Si solo quieres extender el formato predeterminado, puedes usar `$all`; los módulos que se añaden explícitamente al formato no serán duplicados. Por ejemplo. ```toml # Mueve el módulo directorio a la segunda línea @@ -261,26 +263,27 @@ format="$all$directory$character" ## AWS -El módulo `aws` muestra la región y el perfil actual de AWS cuando se han configurado credenciales o un `credential_process`. É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. +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 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`. -Cuando se utiliza [aws-vault](https://github.com/99designs/aws-vault), el perfil se obtiene de la variable de entorno `AWS_VAULT` y la fecha de expiración de credenciales se obtiene de la variable de entorno `AWS_SESSION_EXPIRATION`. +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`. Cuando uses [awsu](https://github.com/kreuzwerker/awsu) el perfil se obtiene de la variable de entorno `AWSU_PROFILE`. -Cuando se utiliza [AWSume](https://awsu.me), el perfil se obtiene de la variable de entorno `AWSUME_PROFILE` y la fecha de expiración de credenciales se obtiene de la variable de entorno `AWSUME_EXPIRATION`. +Cuando se utiliza [AWSume](https://awsu.me), el perfil se lee de la variable de entorno `AWSUME_PROFILE` y la fecha de expiración de credenciales se lee de la variable de entorno `AWSUME_EXPIRATION`. ### 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. | -| `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. | +| 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. | ### Variables @@ -292,7 +295,7 @@ Cuando se utiliza [AWSume](https://awsu.me), el perfil se obtiene de la variable | 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 ### Ejemplos @@ -308,6 +311,8 @@ symbol = "🅰 " [aws.region_aliases] ap-southeast-2 = "au" us-east-1 = "va" +[aws.profile_aliases] +CompanyGroupFrobozzOnCallAccess = 'Frobozz' ``` #### Mostrar región @@ -333,6 +338,8 @@ us-east-1 = "va" format = "on [$symbol$profile]($style) " style = "bold blue" symbol = "🅰 " +[aws.profile_aliases] +Enterprise_Naming_Scheme-voidstars = 'void**' ``` ## Azure @@ -362,7 +369,7 @@ style = "blue bold" ## Battery -El módulo `battery` muestra qué tan cargada está la batería del dispositivo y su estado de carga actual. El módulo solamente es visible cuando la batería del dispositivo está por debajo del 10%. +El módulo `battery` muestra la cantidad de batería y si está cargando o no. El módulo es solo visible cuando la batería está por debajo del 10%. ### Opciones @@ -374,7 +381,7 @@ El módulo `battery` muestra qué tan cargada está la batería del dispositivo | `unknown_symbol` | `" "` | El símbolo que se muestra cuando el estado de la batería es desconocido. | | `empty_symbol` | `" "` | El símbolo que se muestra cuando el estado de la batería está vacío. | | `format` | `"[$symbol$percentage]($style) "` | El formato del módulo. | -| `display` | [ver aquí](#battery-display) | Define cuándo mostrar el indicador y el estilo. | +| `display` | [link](#battery-display) | Define cuándo mostrar el indicador y el estilo. | | `disabled` | `false` | Desactiva el módulo `battery`. | ### Ejemplo @@ -426,44 +433,77 @@ discharging_symbol = "💦" # cuando la capacidad está sobre el 30%, el indicador de batería no se visualizara ``` -## Carácter +## Buf -El módulo `character` muestra un carater (normalmente una flecha) tras el texto que introduces en el terminal. +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 carácter te dirá si el último comando funcionó o no. Se puede hacer de dos maneras: +- 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. -- Cambiando el color (`red`/`green`) -- Cambiando la forma (`.`/`✖`) +### Opciones -Por defecto sólo cambia el color. Si también se quiere cambiar su forma, ver [este ejemplo](#with-custom-error-shape). +| 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. | -::: aviso +### Variables -`error_symbol` no es compatible con el intérprete de comandos nu. +| Variable | Ejemplo | Descripción | +| ------------- | -------- | -------------------------------------- | +| `buf_version` | `v1.0.0` | The version of `buf` | +| `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 -::: aviso +### Ejemplo -`vicmd_symbol` solo es compatible con cmd, fish y zsh. +```toml +# ~/.config/starship.toml + +[buf] +symbol = "🦬 " +``` + +## Character + +The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. + +The character will tell you whether the last command was successful or not. It can do this in two ways: + +- 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). + +::: warning + +`vicmd_symbol` is only supported in cmd, fish and zsh. ::: ### Opciones -| Opción | Por defecto | Descripción | -| ---------------- | ------------------- | ------------------------------------------------------------------------------------------------------- | -| `format` | `"$symbol "` | La cadena de formato usada antes de la entrada de texto. | -| `success_symbol` | `"[❯](bold green)"` | La cadena de formato usada antes de la entrada de texto si el comando anterior tuvo éxito. | -| `error_symbol` | `"[❯](bold red)"` | La cadena de formato usada antes de la entrada de texto si el comando anterior falló. | -| `vicmd_symbol` | `"[❮](bold green)"` | El cadena de formato antes de la entrada de texto si el intérprete de comandos está en modo vim normal. | -| `disabled` | `false` | Desactiva el módulo `character`. | +| Opción | Por defecto | Descripción | +| ---------------- | ------------------- | -------------------------------------------------------------------------------- | +| `format` | `"$symbol "` | 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. | ### Variables -| Variable | Ejemplo | Descripción | -| -------- | ------- | -------------------------------------------------------------- | -| symbol | | Un espejo de `success_symbol`, `error_symbol` o `vicmd_symbol` | +| Variable | Ejemplo | Descripción | +| -------- | ------- | --------------------------------------------------------------------- | +| symbol | | A mirror of either `success_symbol`, `error_symbol` or `vicmd_symbol` | ### Ejemplos @@ -498,10 +538,10 @@ vicmd_symbol = "[V](bold green) " ## CMake -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 `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 directorio actual contiene un archivo `CMakeLists.txt` -- El directorio actual contiene un archivo `CMakeCache.txt` +- The current directory contains a `CMakeLists.txt` file +- The current directory contains a `CMakeCache.txt` file ### Opciones @@ -509,86 +549,86 @@ El módulo `cmake` muestra la versión actualmente instalada de [CMake](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` | `"△ "` | 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 | +| `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 | | `style` | `"bold blue"` | El estilo del módulo. | -| `disabled` | `false` | Desactiva el módulo `cmake`. | +| `disabled` | `false` | Disables the `cmake` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | --------- | -------------------------------------- | -| version | `v3.17.3` | La versión de cmake | +| version | `v3.17.3` | The version of cmake | | 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 ## COBOL / GNUCOBOL -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 `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 directorio actual contiene cualquier archivo que termine en `.cob` o `.COB` -- El directorio actual contiene cualquier archivo que termine en `.cbl` o `.CBL` +- The current directory contains any files ending in `.cob` or `.COB` +- The current directory contains any files ending in `.cbl` or `.CBL` ### Opciones | Opción | Por defecto | Descripción | | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | -| `symbol` | `"⚙️ "` | El símbolo usado antes de mostrar la versión de COBOL. | +| `symbol` | `"⚙️ "` | The symbol used before displaying the version of 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` | Deshabilita el módulo `cobol`. | +| `disabled` | `false` | Disables the `cobol` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | ---------- | -------------------------------------- | -| version | `v3.1.2.0` | La versión de `cobol` | +| version | `v3.1.2.0` | The version of `cobol` | | 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 ## Tiempo de ejecución -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. +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. -::: warning No utilizar DEBUG en Bash +::: warning Do not hook the DEBUG trap in Bash -Si estás usando Starship con `bash`, no uses `DEBUG` después de ejecutar `eval $(starship init $0)`, o el módulo **se romperá**. +If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. ::: -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. +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. ### Opciones -| 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. | +| 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. | ### Variables -| Variable | Ejemplo | Descripción | -| --------- | -------- | ------------------------------------------ | -| duration | `16m40s` | El tiempo que tardó en ejecutar el comando | -| style\* | | Refleja el valor de la opción `style` | +| Variable | Ejemplo | Descripción | +| --------- | -------- | --------------------------------------- | +| duration | `16m40s` | The time it took to execute the command | +| 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 @@ -602,34 +642,34 @@ format = "underwent [$duration](bold yellow)" ## Conda -El módulo `conda` muestra el entorno actual [Conda](https://docs.conda.io/en/latest/), si `$CONDA_DEFAULT_ENV` está configurado. +The `conda` module shows the current [Conda](https://docs.conda.io/en/latest/) environment, if `$CONDA_DEFAULT_ENV` is set. -::: consejo +::: tip -Esto no modifica el propio símbolo de sistema de conda. En caso de querer suprimirlo, ejecuta `conda config --set changeps1 False`. +This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. ::: ### Opciones -| 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`. | +| 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. | ### Variables | Variable | Ejemplo | Descripción | | ----------- | ------------ | -------------------------------------- | -| environment | `astronauts` | El entorno conda actual | +| environment | `astronauts` | The current conda environment | | 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 @@ -640,28 +680,28 @@ Esto no modifica el propio símbolo de sistema de conda. En caso de querer supri format = "[$symbol$environment](dimmed green) " ``` -## Contenedor +## Container -El módulo `container` muestra el símbolo y nombre del contenedor, si está dentro de un contenedor. +The `container` module displays a symbol and container name, if inside a container. ### Opciones -| Opción | Predeterminado | 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`. | +| 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. | ### Variables | Variable | Ejemplo | Descripción | | --------- | ------------------- | -------------------------------------- | -| name | `fedora-toolbox:35` | El nombre del contenedor | +| name | `fedora-toolbox:35` | The name of the container | | 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 @@ -674,33 +714,33 @@ format = "[$symbol \\[$name\\]]($style) " ## Crystal -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 `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 directorio actual contiene un fichero `shard.yml` -- El directorio actual contiene un fichero `.cr` +- The current directory contains a `shard.yml` file +- The current directory contains a `.cr` file ### Opciones | Opción | Por defecto | Descripción | | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | -| `symbol` | `"🔮 "` | Símbolo usado antes de la versión de Crystal. | +| `symbol` | `"🔮 "` | The symbol used before displaying the version of 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` | Desactiva el módulo `crystal`. | +| `disabled` | `false` | Disables the `crystal` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | --------- | -------------------------------------- | -| version | `v0.32.1` | La versión de `crystal` | +| version | `v0.32.1` | The version of `crystal` | | 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 @@ -713,11 +753,11 @@ format = "via [✨ $version](bold blue) " ## Dart -El módulo `dart` muestra la versión instalada de [Dart](https://dart.dev/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +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 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` +- 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 ### Opciones @@ -725,22 +765,22 @@ El módulo `dart` muestra la versión instalada de [Dart](https://dart.dev/). Po | ------------------- | ------------------------------------------------- | --------------------------------------------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | | `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"🎯 "` | Una cadena de formato que representa el símbolo de Dart | +| `symbol` | `"🎯 "` | A format string representing the symbol of 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` | Desactiva el módulo `dart`. | +| `disabled` | `false` | Disables the `dart` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `v2.8.4` | La versión de `dart` | +| version | `v2.8.4` | The version of `dart` | | 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 @@ -753,9 +793,9 @@ format = "via [🔰 $version](bold red) " ## Deno -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 `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 directorio actual contiene un archivo `deno.json`, `deno.jsonc`, `mod.ts`, `mod.js`, `deps.ts` o `deps.js` +- The current directory contains a `deno.json`, `deno.jsonc`, `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file ### Opciones @@ -763,18 +803,18 @@ El módulo `deno` le muestra la versión instalada de [Deno](https://deno.land/) | ------------------- | ----------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | | `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 Deno | +| `symbol` | `"🦕 "` | A format string representing the symbol of 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` | Deshabilita el módulo `deno`. | +| `disabled` | `false` | Disables the `deno` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `v1.8.3` | La versión de `deno` | +| version | `v1.8.3` | The version of `deno` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -789,39 +829,39 @@ format = "via [🦕 $version](green bold) " ## Directory -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. +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. -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. +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. -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`. +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`. ### Opciones | 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. | +| `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` | 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: "…/" | +| `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` | `"~"` | El símbolo que indica el directorio personal. | +| `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) |
-Este módulo tiene algunas opciones avanzadas de configuración que controlan cómo se muestra el directorio. +This module has a few advanced configuration options that control how the directory is displayed. -| Opciones avanzadas | Por defecto | 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. | +| 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. | -`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. +`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. ```toml [directory.substitutions] @@ -829,7 +869,7 @@ Por ejemplo, dado `~/Dev/Nix/nixpkgs/pkgs` donde `nixpkgs` es la raíz del repos "src/com/long/java/path" = "mypath" ``` -`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`. +`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`.
@@ -837,10 +877,10 @@ Por ejemplo, dado `~/Dev/Nix/nixpkgs/pkgs` donde `nixpkgs` es la raíz del repos | Variable | Ejemplo | Descripción | | --------- | --------------------- | ------------------------------------- | -| path | `"D:/Projects"` | La ruta de directorio actual | +| path | `"D:/Projects"` | The current directory path | | style\* | `"black bold dimmed"` | Refleja el valor de la opción `style` | -*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo +*: Esta variable sólo puede ser usada como parte de una cadena de estilo
The git repos have additional variables. @@ -867,32 +907,32 @@ 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). ### Opciones -| 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`. | +| 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. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------------- | -------------------------------------- | -| context | `test_context` | El contexto actual de docker | +| context | `test_context` | The current docker context | | 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 @@ -905,9 +945,9 @@ format = "via [🐋 $context](blue bold)" ## Dotnet -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. +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. -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: +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` @@ -918,11 +958,11 @@ Por defecto, este módulo solo se mostrará en tu prompt cuando uno o más de de - `*.fsproj` - `*.xproj` -También necesitará tener instalado .NET Core SDK para poder usarlo correctamente. +You'll also need the .NET Core SDK installed in order to use it correctly. -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. +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. -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-framework-versions)) cuando exista un archivo csproj en el directorio actual. +The module will also show the Target Framework Moniker () when there is a csproj file in the current directory. ### Opciones @@ -930,24 +970,24 @@ El módulo también mostrará el Target Framework Moniker ([https://docs.microso | ------------------- | ------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | | `format` | `"via [$symbol($version )(🎯 $tfm )]($style)"` | El formato del módulo. | | `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `".NET "` | Símbolo usado antes de mostrar la versión de .NET | -| `heuristic` | `true` | Usa una detección de versiones más rápida para mantener a starship veloz. | +| `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"]` | Qué extensiones deberían activar este módulo. | | `detect_files` | `["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]` | 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` | Deshabilita el módulo `dotnet`. | +| `disabled` | `false` | Disables the `dotnet` module. | ### Variables -| Variable | Ejemplo | Descripción | -| --------- | ---------------- | --------------------------------------------------------------- | -| version | `v3.1.201` | La version del sdk de `dotnet` | -| tfm | `netstandard2.0` | El Target Framework Moniker al que se dirige el proyecto actual | -| symbol | | Refleja el valor de la opción `symbol` | -| style\* | | Refleja el valor de la opción `style` | +| Variable | Ejemplo | Descripción | +| --------- | ---------------- | ------------------------------------------------------------------ | +| version | `v3.1.201` | The version of `dotnet` sdk | +| tfm | `netstandard2.0` | The Target Framework Moniker that the current project is targeting | +| 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 @@ -962,33 +1002,33 @@ heuristic = false ## Elixir -El módulo `elixir` muestra la versión instalada de [Elixir](https://elixir-lang.org/) y [Erlang/OTP](https://erlang.org/doc/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +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: -- El directorio actual contiene un archivo `mix.exs`. +- The current directory contains a `mix.exs` file. ### Opciones | Opción | Por defecto | Descripción | | ------------------- | ----------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | El formato para el módulo elixir. | +| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. | | `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"💧 "` | El símbolo usado antes de mostrar la version de Elixir/Erlang. | +| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. | | `detect_extensions` | `[]` | Qué extensiones deberían activar este módulo. | | `detect_files` | `["mix.exs"]` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `[]` | Qué carpetas deberían activar estos módulos. | | `style` | `"bold purple"` | El estilo del módulo. | -| `disabled` | `false` | Desactiva el módulo `elixir`. | +| `disabled` | `false` | Disables the `elixir` module. | ### Variables | Variable | Ejemplo | Descripción | | ----------- | ------- | -------------------------------------- | -| version | `v1.10` | La version de `elixir` | -| otp_version | | La version de otp de `elixir` | +| version | `v1.10` | The version of `elixir` | +| otp_version | | The otp version of `elixir` | | 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 @@ -1001,13 +1041,13 @@ symbol = "🔮 " ## Elm -El módulo `elm` muestra la versión instalada de [Elm](https://elm-lang.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +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: -- El directorio actual contiene un archivo `elm.json` -- El directorio actual contiene un archivo `elm-package.json` -- El directorio actual contiene un archivo `.elm-version` -- El directorio actual contiene una carpeta `elm-stuff` -- El directorio actual contiene archivos `*.elm` +- 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 +- The current directory contains `*.elm` files ### Opciones @@ -1015,22 +1055,22 @@ El módulo `elm` muestra la versión instalada de [Elm](https://elm-lang.org/). | ------------------- | -------------------------------------------------- | --------------------------------------------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | | `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"🌳 "` | Una cadena de formato que representa el símbolo de Elm. | +| `symbol` | `"🌳 "` | A format string representing the symbol of Elm. | | `detect_extensions` | `["elm"]` | Qué extensiones deberían activar este módulo. | | `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `["elm-stuff"]` | Qué carpetas deberían activar estos módulos. | | `style` | `"cyan bold"` | El estilo del módulo. | -| `disabled` | `false` | Desactiva el módulo `elm`. | +| `disabled` | `false` | Disables the `elm` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | --------- | -------------------------------------- | -| version | `v0.19.1` | La versión de `elm` | +| version | `v0.19.1` | The version of `elm` | | 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 @@ -1043,14 +1083,14 @@ format = "via [ $version](cyan bold) " ## Variable de entorno -El módulo `env_var` muestra el valor actual de una variable de entorno seleccionada. El módulo se mostrará sólo si se cumplen cualquiera de las siguientes condiciones: +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: -- La opción de configuración de `variable` coincide con una variable de entorno existente -- La opción de configuración de `variable` no está definida, pero la opción de configuración se encuentra `por defecto` +- The `variable` configuration option matches an existing environment variable +- The `variable` configuration option is not defined, but the `default` configuration option is -::: consejo Múltiples variables de entorno pueden mostrarse usando un `.`. (ver ejemplo) Si la opción de configuración de la `variable` no está definida, el módulo mostrará el valor de la variable bajo el nombre del texto después del caracter `.`. +::: tip 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. -Ejemplo: la siguiente configuración mostrará el valor de la variable de entorno USER +Example: following configuration will display value of USER environment variable ```toml # ~/.config/starship.toml @@ -1063,23 +1103,23 @@ default = "unknown user" ### Opciones -| Opción | Por defecto | Descripción | -| ---------- | ------------------------------ | -------------------------------------------------------------------------------------- | -| `symbol` | `""` | El símbolo usado antes de mostrar el valor de la variable. | -| `variable` | | La variable de entorno a mostrar. | -| `default` | | El valor por defecto que se mostrará cuando la variable seleccionada no está definida. | -| `format` | `"with [$env_value]($style) "` | El formato del módulo. | -| `disabled` | `false` | Desactiva el módulo `env_var`. | +| Opción | Por defecto | Descripción | +| ---------- | ------------------------------ | ---------------------------------------------------------------------------- | +| `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) "` | El formato del módulo. | +| `disabled` | `false` | Disables the `env_var` module. | ### Variables -| Variable | Ejemplo | Descripción | -| --------- | ------------------------------------- | ------------------------------------------- | -| env_value | `Windows NT` (si _variable_ es `$OS`) | El valor de entorno de la opción `variable` | -| 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 | +| --------- | ------------------------------------------- | ------------------------------------------ | +| env_value | `Windows NT` (if _variable_ would be `$OS`) | The environment value of option `variable` | +| symbol | | Refleja el valor de la opción `symbol` | +| style\* | `black bold dimmed` | Refleja el valor de la opción `style` | -*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo +*: Esta variable sólo puede ser usada como parte de una cadena de estilo ### Ejemplo @@ -1091,7 +1131,7 @@ variable = "SHELL" default = "unknown shell" ``` -Mostrando múltiples variables de entorno: +Displaying multiple environmental variables: ```toml # ~/.config/starship.toml @@ -1105,10 +1145,10 @@ default = "unknown user" ## Erlang -El módulo `erlang` muestra la versión instalada de [Erlang/OTP](https://erlang.org/doc/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +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: -- El directorio actual contiene un fichero `rebar.config`. -- El directorio actual contiene un fichero `erlang.mk`. +- The current directory contains a `rebar.config` file. +- The current directory contains a `erlang.mk` file. ### Opciones @@ -1116,22 +1156,22 @@ El módulo `erlang` muestra la versión instalada de [Erlang/OTP](https://erlang | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | | `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `" "` | El símbolo usado antes de mostrar la versión de Erlang. | +| `symbol` | `" "` | The symbol used before displaying the version of erlang. | | `style` | `"bold red"` | El estilo del módulo. | | `detect_extensions` | `[]` | Qué extensiones deberían activar este módulo. | | `detect_files` | `["rebar.config", "elang.mk"]` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `[]` | Qué carpetas deberían activar estos módulos. | -| `disabled` | `false` | Desactiva el módulo `erlang`. | +| `disabled` | `false` | Disables the `erlang` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | --------- | -------------------------------------- | -| version | `v22.1.3` | La versión de `erlang` | +| version | `v22.1.3` | The version of `erlang` | | 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 @@ -1142,17 +1182,17 @@ El módulo `erlang` muestra la versión instalada de [Erlang/OTP](https://erlang format = "via [e $version](bold red) " ``` -## Llenar +## Fill -El módulo `fill` llena cualquier espacio extra en la línea con un símbolo. Si múltiples módulos `fill` están presentes en una línea, dividirán el espacio equitativamente entre ellos. Esto es útil para alinear otros módulos. +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. ### Opciones -| Opción | Por defecto | Descripción | -| ---------- | -------------- | ------------------------------------------ | -| `symbol` | `"."` | El símbolo utilizado para llenar la línea. | -| `style` | `"bold black"` | El estilo del módulo. | -| `disabled` | `false` | Deshabilita el módulo `fill` | +| Opción | Predeterminado | Descripción | +| ---------- | -------------- | --------------------------------- | +| `symbol` | `"."` | The symbol used to fill the line. | +| `style` | `"bold black"` | El estilo del módulo. | +| `disabled` | `false` | Disables the `fill` module | ### Ejemplo @@ -1165,7 +1205,7 @@ symbol = "-" style = "bold green" ``` -Produce un prompt que se ve como: +Produces a prompt that looks like: ``` AA -------------------------------------------- BB -------------------------------------------- CC @@ -1173,32 +1213,32 @@ AA -------------------------------------------- BB ----------------------------- ## Google Cloud (`gcloud`) -El módulo `gcloud` muestra la configuración actual para el CLI de [`gcloud`](https://cloud.google.com/sdk/gcloud). Esto se basa en el archivo `~/.config/gcloud/active_config`, el archivo `~/.config/gcloud/configurations/config_{CONFIG NAME}` y la variable de entorno `CLOUDSDK_CONFIG`. +The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var. ### Opciones | Opción | Por defecto | Descripción | | ----------------- | ---------------------------------------------------------- | ---------------------------------------------------------------- | | `format` | `'on [$symbol$account(@$domain)(\($region\))]($style) '` | El formato del módulo. | -| `symbol` | `"☁️ "` | El símbolo usado antes de mostrar el perfil actual de GCP. | -| `region_aliases` | | Tabla de alias de región a mostrar además del nombre GCP. | +| `symbol` | `"☁️ "` | The symbol used before displaying the current GCP profile. | +| `region_aliases` | | Table of region aliases to display in addition to the GCP name. | | `project_aliases` | | Table of project aliases to display in addition to the GCP name. | | `style` | `"bold blue"` | El estilo del módulo. | -| `disabled` | `false` | Desactiva el módulo `gcloud`. | +| `disabled` | `false` | Disables the `gcloud` module. | ### Variables -| Variable | Ejemplo | Descripción | -| --------- | ------------- | ----------------------------------------------------------------------------- | -| region | `us-central1` | La región GCP actual | -| account | `foo` | El perfil actual de GCP | -| dominio | `ejemplo.com` | El dominio actual del perfil GCP | -| project | | El proyecto GCP actual | -| active | `default` | El nombre de configuración activo escrito en `~/.config/gcloud/active_config` | -| symbol | | Refleja el valor de la opción `symbol` | -| style\* | | Refleja el valor de la opción `style` | +| Variable | Ejemplo | Descripción | +| --------- | ------------- | ------------------------------------------------------------------ | +| region | `us-central1` | The current GCP region | +| account | `foo` | The current GCP profile | +| domain | `example.com` | The current GCP profile domain | +| project | | The current GCP project | +| active | `default` | The active config name written in `~/.config/gcloud/active_config` | +| symbol | | Refleja el valor de la opción `symbol` | +| style\* | | Refleja el valor de la opción `style` | -*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo +*: Esta variable sólo puede ser usada como parte de una cadena de estilo ### Ejemplos @@ -1246,32 +1286,33 @@ very-long-project-name = "vlpn" ## Git Branch -El módulo `git_branch` muestra la rama activa del repositorio en tu directorio actual. +The `git_branch` module shows the active branch of the repo in your current directory. ### Opciones -| Opción | Por defecto | Descripción | -| -------------------- | -------------------------------- | ------------------------------------------------------------------------------------------------------- | -| `always_show_remote` | `false` | Muestra el nombre de la rama de seguimiento remoto, incluso si es igual al nombre de la rama local. | -| `format` | `"on [$symbol$branch]($style) "` | El formato del módulo. Use `"$branch"` para referirse al nombre de la rama actual. | -| `symbol` | `" "` | Una cadena de formato que representa el símbolo de la rama git. | -| `style` | `"bold purple"` | El estilo del módulo. | -| `truncation_length` | `2^63 - 1` | Trunca una rama git a grafemas `N`. | -| `truncation_symbol` | `"…"` | El símbolo usado para indicar que un nombre de rama fue truncado. Puedes usar `""` para ningún símbolo. | -| `only_attached` | `false` | Mostrar solo el nombre de la rama cuando no esté en un estado `HEAD`. | -| `disabled` | `false` | Desactiva el módulo `git_branch`. | +| Opción | Por defecto | Descripción | +| -------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | +| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | +| `format` | `"on [$symbol$branch]($style) "` | El formato del módulo. Use `"$branch"` to refer to the current branch name. | +| `symbol` | `" "` | A format string representing the symbol of git branch. | +| `style` | `"bold purple"` | El estilo del módulo. | +| `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | +| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. | +| `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | +| `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for "master" or "main". | +| `disabled` | `false` | Disables the `git_branch` module. | ### Variables -| Variable | Ejemplo | Descripción | -| ------------- | -------- | -------------------------------------------------------------------------------------------------------------- | -| branch | `master` | El nombre de la rama actual, vuelve a `HEAD` si no hay ninguna rama actual (por ejemplo, git detached `HEAD`). | -| remote_name | `origin` | El nombre remoto. | -| remote_branch | `master` | El nombre de la rama rastreada en `remote_name`. | -| symbol | | Refleja el valor de la opción `symbol` | -| style\* | | Refleja el valor de la opción `style` | +| Variable | Ejemplo | Descripción | +| ------------- | -------- | ------------------------------------------------------------------------------------------------------ | +| branch | `master` | The current branch name, falls back to `HEAD` if there's no current branch (e.g. git detached `HEAD`). | +| remote_name | `origin` | The remote name. | +| remote_branch | `master` | The name of the branch tracked on `remote_name`. | +| symbol | | Refleja el valor de la opción `symbol` | +| style\* | | Refleja el valor de la opción `style` | -*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo +*: Esta variable sólo puede ser usada como parte de una cadena de estilo ### Ejemplo @@ -1282,32 +1323,33 @@ El módulo `git_branch` muestra la rama activa del repositorio en tu directorio symbol = "🌱 " truncation_length = 4 truncation_symbol = "" +ignore_branches = ["master", "main"] ``` ## Git commit -El módulo `git_commit` muestra el hash de la confirmación actual y también la etiqueta (si existe) del repositorio en su directorio actual. +The `git_commit` module shows the current commit hash and also the tag (if any) of the repo in your current directory. ### Opciones -| Opción | Por defecto | Descripción | -| -------------------- | ---------------------------------- | -------------------------------------------------------------------------------------- | -| `commit_hash_length` | `7` | La longitud del hash del commit de git mostrado. | -| `format` | `"[\\($hash$tag\\)]($style) "` | El formato del módulo. | -| `style` | `"bold green"` | El estilo del módulo. | -| `only_detached` | `true` | Mostrar solo el hash de la confirmación de git cuando esté en estado "detached `HEAD`" | -| `tag_disabled` | `true` | Deshabilita mostrar información de etiquetas en el módulo `git_commit`. | -| `tag_symbol` | `" 🏷 "` | Símbolo de etiqueta prefijando la información mostrada | -| `disabled` | `false` | Desactiva el módulo `git_commit`. | +| Opción | Por defecto | Descripción | +| -------------------- | ---------------------------------- | ------------------------------------------------------- | +| `commit_hash_length` | `7` | The length of the displayed git commit hash. | +| `format` | `"[\\($hash$tag\\)]($style) "` | El formato del módulo. | +| `style` | `"bold green"` | El estilo del módulo. | +| `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state | +| `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. | +| `tag_symbol` | `" 🏷 "` | Tag symbol prefixing the info shown | +| `disabled` | `false` | Disables the `git_commit` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | --------- | ------------------------------------- | -| hash | `b703eb3` | El hash actual del commit de git | +| hash | `b703eb3` | The current git commit hash | | 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 @@ -1319,35 +1361,35 @@ commit_hash_length = 4 tag_symbol = "🔖 " ``` -## Git state +## Git State -El módulo `git_state` se mostrará en directorios que son parte de un repositorio git, y donde hay una operación en curso, tales como: _REBASING_, _BISECTING_, etc. Si hay información de progreso (por ejemplo, REBASING 3/10), esa información será mostrada también. +The `git_state` module will show in directories which are part of a git repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. If there is progress information (e.g., REBASING 3/10), that information will be shown too. ### Opciones -| Opción | Por defecto | Descripción | -| -------------- | --------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | -| `rebase` | `"REBASING"` | Una cadena de formato que se muestra cuando un `rebase` está en progreso. | -| `merge` | `"MERGING"` | Una cadena de formato que se muestra cuando un `merge` está en progreso. | -| `revert` | `"REVERTING"` | Una cadena de formato mostrada cuando un `revert` está en progreso. | -| `cherry_pick` | `"CHERRY-PICKING"` | Una cadena de formato que se muestra cuando un `cherry-pick` está en progreso. | -| `bisect` | `"BISECTING"` | Una cadena de formato que se muestra cuando un `bisect` está en progreso. | -| `am` | `"AM"` | Una cadena de formato que se muestra cuando un `apply-mailbox` (`git am`) está en progeso. | -| `am_or_rebase` | `"AM/REBASE"` | Una cadena de formato que se muestra cuando un ambiguo `apply-builbox` o `rebase` está en progreso. | -| `style` | `"bold yellow"` | El estilo del módulo. | -| `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | El formato del módulo. | -| `disabled` | `false` | Desactiva el módulo `git_state`. | +| Opción | Por defecto | Descripción | +| -------------- | --------------------------------------------------------------- | --------------------------------------------------------------------------------------- | +| `rebase` | `"REBASING"` | A format string displayed when a `rebase` is in progress. | +| `merge` | `"MERGING"` | A format string displayed when a `merge` is in progress. | +| `revert` | `"REVERTING"` | A format string displayed when a `revert` is in progress. | +| `cherry_pick` | `"CHERRY-PICKING"` | A format string displayed when a `cherry-pick` is in progress. | +| `bisect` | `"BISECTING"` | A format string displayed when a `bisect` is in progress. | +| `am` | `"AM"` | A format string displayed when an `apply-mailbox` (`git am`) is in progress. | +| `am_or_rebase` | `"AM/REBASE"` | A format string displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. | +| `style` | `"bold yellow"` | El estilo del módulo. | +| `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | El formato del módulo. | +| `disabled` | `false` | Disables the `git_state` module. | ### Variables | Variable | Ejemplo | Descripción | | ---------------- | ---------- | ------------------------------------- | -| state | `REBASING` | El estado actual del repositorio | -| progress_current | `1` | El progreso de la operación actual | -| progress_total | `2` | El progreso total de la operación | +| state | `REBASING` | The current state of the repo | +| progress_current | `1` | The current operation progress | +| progress_total | `2` | The total operation progress | | style\* | | Refleja el valor de la opción `style` | -*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo +*: Esta variable sólo puede ser usada como parte de una cadena de estilo ### Ejemplo @@ -1359,36 +1401,36 @@ format = '[\($state( $progress_current of $progress_total)\)]($style) ' cherry_pick = "[🍒 PICKING](bold red)" ``` -## Métricas de Git +## Git Metrics -El módulo `git_metrics` mostrará el número de líneas añadidas y eliminadas en el repositorio git actual. +The `git_metrics` module will show the number of added and deleted lines in the current git repository. -::: consejo +::: tip -Este módulo está deshabilitado por defecto. Para habilitarlo, establece `disabled` a `false` en tu archivo de configuración. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### Opciones -| Opción | Por defecto | Descripción | -| -------------------- | ------------------------------------------------------------ | -------------------------------------------------- | -| `added_style` | `"bold green"` | El estilo para el recuento añadido. | -| `deleted_style` | `"bold red"` | El estilo para el recuento eliminado. | -| `only_nonzero_diffs` | `true` | Mostrar sólo el estado de los elementos cambiados. | -| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | El formato del módulo. | -| `disabled` | `true` | Deshabilita el módulo `git_metrics`. | +| Opción | Por defecto | Descripción | +| -------------------- | ------------------------------------------------------------ | ------------------------------------- | +| `added_style` | `"bold green"` | The style for the added count. | +| `deleted_style` | `"bold red"` | The style for the deleted count. | +| `only_nonzero_diffs` | `true` | Render status only for changed items. | +| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | El formato del módulo. | +| `disabled` | `true` | Disables the `git_metrics` module. | ### Variables -| Variable | Ejemplo | Descripción | -| ----------------- | ------- | --------------------------------------------- | -| added | `1` | El número actual de líneas añadidas | -| deleted | `2` | El número actual de líneas eliminadas | -| added_style\* | | Refleja el valor de la opción `added_style` | -| deleted_style\* | | Refleja el valor de la opción `deleted_style` | +| Variable | Ejemplo | Descripción | +| ----------------- | ------- | ------------------------------------------- | +| added | `1` | The current number of added lines | +| deleted | `2` | The current number of deleted lines | +| added_style\* | | Mirrors the value of option `added_style` | +| deleted_style\* | | Mirrors the value of option `deleted_style` | -*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo +*: Esta variable sólo puede ser usada como parte de una cadena de estilo ### Ejemplo @@ -1402,9 +1444,9 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) ' ## Git status -El módulo `git_status` muestra símbolos que representan el estado del repositorio en su directorio actual. +The `git_status` module shows symbols representing the state of the repo in your current directory. -::: consejo +::: tip The Git Status module is very slow in Windows directories (for example under `/mnt/c/`) when in a WSL environment. You can disable the module or use the `windows_starship` option to use a Windows-native Starship executable to compute `git_status` for those paths. @@ -1412,56 +1454,56 @@ The Git Status module is very slow in Windows directories (for example under `/m ### Opciones -| Opción | Por defecto | Descripción | +| Opción | Predeterminado | Descripción | | ------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | El formato por defecto para `git_status` | -| `conflicted` | `"="` | Esta rama tiene conflictos de fusión. | -| `ahead` | `"⇡"` | El formato de `ahead` | -| `behind` | `"⇣"` | El formato de `behind` | -| `diverged` | `"⇕"` | El formato de `diverged` | -| `up_to_date` | `""` | El formato de `up_to_date` | -| `untracked` | `"?"` | El formato de `untracked` | -| `stashed` | `"$"` | El formato de `stashed` | -| `modified` | `"!"` | El formato de `modified` | -| `staged` | `"+"` | El formato de `staged` | -| `renamed` | `"»"` | El formato de `renamed` | -| `deleted` | `"✘"` | El formato de `deleted` | +| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | The default format for `git_status` | +| `conflicted` | `"="` | This branch has merge conflicts. | +| `ahead` | `"⇡"` | The format of `ahead` | +| `behind` | `"⇣"` | The format of `behind` | +| `diverged` | `"⇕"` | The format of `diverged` | +| `up_to_date` | `""` | The format of `up_to_date` | +| `untracked` | `"?"` | The format of `untracked` | +| `stashed` | `"$"` | The format of `stashed` | +| `modified` | `"!"` | The format of `modified` | +| `staged` | `"+"` | The format of `staged` | +| `renamed` | `"»"` | The format of `renamed` | +| `deleted` | `"✘"` | The format of `deleted` | | `style` | `"bold red"` | El estilo del módulo. | -| `ignore_submodules` | `false` | Ignorar cambios a los submódulos. | -| `disabled` | `false` | Desactiva el módulo `git_status`. | +| `ignore_submodules` | `false` | Ignore changes to submodules. | +| `disabled` | `false` | Disables the `git_status` module. | | `windows_starship` | | Use this (Linux) path to a Windows Starship executable to render `git_status` when on Windows paths in WSL. | ### Variables -Las siguientes variables se pueden utilizar en `format`: +The following variables can be used in `format`: -| Variable | Descripción | -| -------------- | ------------------------------------------------------------------------------------------------------------------------ | -| `all_status` | Atajo para `$conflicted$stashed$deleted$renamed$modified$staged$untracked` | -| `ahead_behind` | Muestra la cadena de formato de `diverged` `ahead` o `behind` o `up_to_date` basado en el estado actual del repositorio. | -| `conflicted` | Muestra `conflicted` cuando esta rama tiene conflictos de fusión. | -| `untracked` | Muestra `untracked` cuando hay archivos sin rastrear en el directorio de trabajo. | -| `stashed` | Muestra `stashed` cuando existe un "stash" para el repositorio local. | -| `modified` | Muestra `modified` cuando hay modificaciones de archivo en el directorio de trabajo. | -| `staged` | Muestra `staged` cuando se ha añadido un nuevo archivo al área de "stash". | -| `renamed` | Muestra `renamed` cuando un archivo renombrado ha sido añadido al área de "stash". | -| `deleted` | Muestra `deleted` cuando un archivo ha sido añadido al área de "stash". | -| style\* | Refleja el valor de la opción `style` | +| Variable | Descripción | +| -------------- | ------------------------------------------------------------------------------------------------------------- | +| `all_status` | Shortcut for`$conflicted$stashed$deleted$renamed$modified$staged$untracked` | +| `ahead_behind` | Displays `diverged`, `ahead`, `behind` or `up_to_date` format string based on the current status of the repo. | +| `conflicted` | Displays `conflicted` when this branch has merge conflicts. | +| `untracked` | Displays `untracked` when there are untracked files in the working directory. | +| `stashed` | Displays `stashed` when a stash exists for the local repository. | +| `modified` | Displays `modified` when there are file modifications in the working directory. | +| `staged` | Displays `staged` when a new file has been added to the staging area. | +| `renamed` | Displays `renamed` when a renamed file has been added to the staging area. | +| `deleted` | Displays `deleted` when a file's deletion has been added to the staging area. | +| style\* | Refleja el valor de la opción `style` | -*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo +*: Esta variable sólo puede ser usada como parte de una cadena de estilo -Las siguientes variables pueden ser usadas en `diverged`: +The following variables can be used in `diverged`: -| Variable | Descripción | -| -------------- | ------------------------------------------------------- | -| `ahead_count` | Número de commits por delante de la rama de seguimiento | -| `behind_count` | Número de commits detrás de la rama de seguimiento | +| Variable | Descripción | +| -------------- | ---------------------------------------------- | +| `ahead_count` | Number of commits ahead of the tracking branch | +| `behind_count` | Number of commits behind the tracking branch | -Las siguientes variales pueden ser usadas en `conflicted`, `ahead`, `behind`, `untracked`, `stashed`, `modified`, `staged`, `renamed` y `deleted`: +The following variables can be used in `conflicted`, `ahead`, `behind`, `untracked`, `stashed`, `modified`, `staged`, `renamed` and `deleted`: -| Variable | Descripción | -| -------- | ----------------------------- | -| `count` | Muestra el número de archivos | +| Variable | Descripción | +| -------- | ------------------------ | +| `count` | Show the number of files | ### Ejemplo @@ -1482,7 +1524,7 @@ renamed = "👅" deleted = "🗑" ``` -Mostrar el recuento delante/detrás de la rama que está siendo rastreada +Show ahead/behind count of the branch being tracked ```toml # ~/.config/starship.toml @@ -1504,16 +1546,16 @@ windows_starship = '/mnt/c/Users/username/scoop/apps/starship/current/starship.e ## Go -El módulo `golang` muestra la versión instalada de [Go](https://golang.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `golang` module shows the currently installed version of [Go](https://golang.org/). By default the module will be shown if any of the following conditions are met: -- El directorio actual contiene un archivo `go.mod` -- El directorio actual contiene un archivo `go.sum` -- El directorio actual contiene un archivo `glide.yaml` -- El directorio actual contiene un archivo `Gopkg.yml` -- El directorio actual contiene un archivo `Gopkg.lock` -- El directorio actual contiene un archivo `.go-version` -- El directorio actual contiene un directorio `Godeps` -- El directorio actual contiene un archivo con la extensión `.go` +- 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 ### Opciones @@ -1521,22 +1563,22 @@ El módulo `golang` muestra la versión instalada de [Go](https://golang.org/). | ------------------- | ------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | | `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"🐹 "` | Una cadena de formato que representa el símbolo de Go. | +| `symbol` | `"🐹 "` | A format string representing the symbol of Go. | | `detect_extensions` | `["go"]` | Qué extensiones deberían activar este módulo. | | `detect_files` | `["go.mod", "go.sum", "glide.yaml", "Gopkg.yml", "Gopkg.lock", ".go-version"]` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `["Godeps"]` | Qué carpetas deberían activar este módulo. | | `style` | `"bold cyan"` | El estilo del módulo. | -| `disabled` | `false` | Desactiva el módulo de `golang`. | +| `disabled` | `false` | Disables the `golang` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | --------- | -------------------------------------- | -| version | `v1.12.1` | La versión de `go` | +| version | `v1.12.1` | The version of `go` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -*: 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 @@ -1547,12 +1589,45 @@ El módulo `golang` muestra la versión instalada de [Go](https://golang.org/). format = "via [🏎💨 $version](bold cyan) " ``` +## Haskell + +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 +- The current directory contains any `.hs`, `.cabal`, or `.hs-boot` file + +### Opciones + +| Opción | Por defecto | Descripción | +| ------------------- | ------------------------------------ | ---------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | +| `symbol` | `"λ "` | A format string representing the symbol of Haskell | +| `detect_extensions` | `["hs", "cabal", "hs-boot"]` | Qué extensiones deberían activar este módulo. | +| `detect_files` | `["stack.yaml", "cabal.project"]` | Qué nombres de archivo deberían activar este módulo. | +| `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | +| `style` | `"bold purple"` | El estilo del módulo. | +| `disabled` | `false` | Disables the `haskell` module. | + +### Variables + +| Variable | Ejemplo | Descripción | +| -------------- | ----------- | --------------------------------------------------------------------------------------- | +| version | | `ghc_version` or `snapshot` depending on whether the current project is a Stack project | +| snapshot | `lts-18.12` | Currently selected Stack snapshot | +| ghc\_version | `9.2.1` | Currently installed GHC version | +| symbol | | Refleja el valor de la opción `symbol` | +| style\* | | Refleja el valor de la opción `style` | + +*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo + ## Helm -El módulo `helm` muestra la versión instalada de [Helm](https://helm.sh/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `helm` module shows the currently installed version of [Helm](https://helm.sh/). By default the module will be shown if any of the following conditions are met: -- El directorio actual contiene un fichero `helmfile.yaml` -- El directorio actual contiene un archivo `Chart.yaml` +- The current directory contains a `helmfile.yaml` file +- The current directory contains a `Chart.yaml` file ### Opciones @@ -1563,19 +1638,19 @@ El módulo `helm` muestra la versión instalada de [Helm](https://helm.sh/). Por | `detect_extensions` | `[]` | Qué extensiones deberían activar este módulo. | | `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `[]` | Qué carpetas deberían activar estos módulos. | -| `symbol` | `"⎈ "` | Una cadena de formato que representa el símbolo de Helm. | +| `symbol` | `"⎈ "` | A format string representing the symbol of Helm. | | `style` | `"bold white"` | El estilo del módulo. | -| `disabled` | `false` | Desactiva el módulo `helm`. | +| `disabled` | `false` | Disables the `helm` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `v3.1.1` | La versión de `helm` | +| version | `v3.1.1` | The version of `helm` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -*: 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 @@ -1588,26 +1663,26 @@ format = "via [⎈ $version](bold white) " ## Hostname -El módulo `hostname` muestra el nombre de host del sistema. +The `hostname` module shows the system hostname. ### Opciones -| Opción | Por defecto | Descripción | -| ---------- | --------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `ssh_only` | `true` | Mostrar sólo el nombre de host cuando esté conectado a una sesión SSH. | -| `trim_at` | `"."` | Cadena en la que el nombre de host se corta, después de la primera partida. `"."` se detendrá después del primer punto. `""` deshabilitará cualquier truncamiento | -| `format` | `"[$hostname]($style) in "` | El formato del módulo. | -| `style` | `"bold dimmed green"` | El estilo del módulo. | -| `disabled` | `false` | Desactiva el módulo `hostname`. | +| Opción | Por defecto | Descripción | +| ---------- | --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------ | +| `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 "` | El formato del módulo. | +| `style` | `"bold dimmed green"` | El estilo del módulo. | +| `disabled` | `false` | Disables the `hostname` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | ---------- | ------------------------------------- | -| hostname | `computer` | El nombre de host del ordenador | +| hostname | `computer` | The hostname of the computer | | 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 @@ -1623,10 +1698,10 @@ disabled = false ## Java -El módulo `java` muestra la versión instalada de [Java](https://www.oracle.com/java/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `java` module shows the currently installed version of [Java](https://www.oracle.com/java/). By default the module will be shown if any of the following conditions are met: -- El directorio actual contiene un archivo `pom.xml`, `build.gradle.kts`, `build.sbt`, `.java-version`, `.deps.edn`, `project.clj`, o `build.boot` -- El directorio actual contiene un archivo con la extensión `.java`, `.class`, `.gradle` o `.jar`, `.clj` o `.cljc` +- 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 ### Opciones @@ -1637,19 +1712,19 @@ El módulo `java` muestra la versión instalada de [Java](https://www.oracle.com | `detect_extensions` | `["java", "class", "gradle", "jar", "cljs", "cljc"]` | Qué extensiones deberían activar este módulo. | | `detect_files` | `["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"]` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `[]` | Qué carpetas deberían activar estos módulos. | -| `symbol` | `"☕ "` | Una cadena de formato que representa el símbolo de Java | +| `symbol` | `"☕ "` | A format string representing the symbol of Java | | `style` | `"red dimmed"` | El estilo del módulo. | -| `disabled` | `false` | Desactiva el módulo `java`. | +| `disabled` | `false` | Disables the `java` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | ------- | -------------------------------------- | -| version | `v14` | La versión de `java` | +| version | `v14` | The version of `java` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -*: 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 @@ -1662,49 +1737,49 @@ symbol = "🌟 " ## Jobs -El módulo `jobs` muestra el número actual de tareas en ejecución. El módulo se mostrará sólo si hay tareas en segundo plano ejecutándose. El módulo mostrará el número de tareas ejecutados si hay al menos 2 tareas, o más del valor de configuración de `number_threshold`, si existe. El módulo mostrará un símbolo si hay al menos 1 tarea, o más del valor de configuración de `symbol_threshold`, si existe. Puedes establecer ambos valores a 0 para _siempre_ mostrar el símbolo y el número de tareas, incluso si hay 0 tareas en ejecución. +The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to _always_ show the symbol and number of jobs, even if there are 0 jobs running. -La funcionalidad por defecto es: +The default functionality is: -- 0 tareas -> Nada se muestra. -- 1 tarea -> `symbol` se muestra. -- 2 tareas o más -> `symbol` + `number` son mostrados. +- 0 jobs -> Nothing is shown. +- 1 job -> `symbol` is shown. +- 2 jobs or more -> `symbol` + `number` are shown. -::: aviso +::: warning -Este módulo no está soportado por tcsh y nu. +This module is not supported on tcsh and nu. ::: -::: aviso +::: warning -La opción `threshold` está obsoleta, pero si deseas usarla, el módulo mostrará el número de tareas en ejecución si hay más de 1 tarea, o más que el valor de configuración `threshold`, si existe. Si `threshold` se establece en 0, entonces el módulo también se mostrará cuando haya 0 tareas en ejecución. +The `threshold` option is deprecated, but if you want to use it, the module will show the number of jobs running if there is more than 1 job, or more than the `threshold` config value, if it exists. If `threshold` is set to 0, then the module will also show when there are 0 jobs running. ::: ### Opciones -| Opción | Por defecto | Descripción | -| ------------------ | ----------------------------- | ---------------------------------------------------------------------------------- | -| `threshold`* | `1` | Muestra el número de tareas si se exceden. | -| `symbol_threshold` | `1` | Muestra `symbol` si el conteo de tareas es al menos `symbol_threshold`. | -| `number_threshold` | `2` | Muestra el número de tareas si el conteo de tareas es al menos `symbol_threshold`. | -| `format` | `"[$symbol$number]($style) "` | El formato del módulo. | -| `symbol` | `"✦"` | La cadena utilizada para representar la variable `symbol`. | -| `style` | `"bold blue"` | El estilo del módulo. | -| `disabled` | `false` | Desactiva el módulo `jobs`. | +| Opción | Por defecto | Descripción | +| ------------------ | ----------------------------- | ------------------------------------------------------------------------ | +| `threshold`* | `1` | Show number of jobs if exceeded. | +| `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. | +| `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. | +| `format` | `"[$symbol$number]($style) "` | El formato del módulo. | +| `symbol` | `"✦"` | The string used to represent the `symbol` variable. | +| `style` | `"bold blue"` | El estilo del módulo. | +| `disabled` | `false` | Disables the `jobs` module. | -*: Esta opción está desaprobada, por favor utiliza las opciones `number_threshold` y `symbol_threshold` en su lugar. +*: This option is deprecated, please use the `number_threshold` and `symbol_threshold` options instead. ### Variables | Variable | Ejemplo | Descripción | | --------- | ------- | -------------------------------------- | -| number | `1` | El número de tareas | +| number | `1` | The number of jobs | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -*: 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 @@ -1719,11 +1794,11 @@ symbol_threshold = 0 ## Julia -El módulo `julia` muestra la versión instalada de [Julia](https://julialang.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `julia` module shows the currently installed version of [Julia](https://julialang.org/). By default the module will be shown if any of the following conditions are met: -- El directorio actual contiene un archivo `Project.toml` -- El directorio actual contiene un archivo `Manifest.toml` -- El directorio actual contiene un archivo con la extensión `.jl` +- 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 ### Opciones @@ -1734,19 +1809,19 @@ El módulo `julia` muestra la versión instalada de [Julia](https://julialang.or | `detect_extensions` | `["jl"]` | Qué extensiones deberían activar este módulo. | | `detect_files` | `["Project.toml", "Manifest.toml"]` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `[]` | Qué carpetas deberían activar estos módulos. | -| `symbol` | `"ஃ "` | Una cadena de formato que representa el símbolo de Julia. | +| `symbol` | `"ஃ "` | A format string representing the symbol of Julia. | | `style` | `"bold purple"` | El estilo del módulo. | -| `disabled` | `false` | Desactiva el módulo `julia`. | +| `disabled` | `false` | Disables the `julia` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `v1.4.0` | La versión de `julia` | +| version | `v1.4.0` | The version of `julia` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -*: 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 @@ -1759,9 +1834,9 @@ symbol = "∴ " ## Kotlin -El módulo `kotlin` muestra la versión instalada de [Kotlin](https://kotlinlang.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `kotlin` module shows the currently installed version of [Kotlin](https://kotlinlang.org/). By default the module will be shown if any of the following conditions are met: -- El directorio actual contiene un archivo `.kt` o `.kts` +- The current directory contains a `.kt` or a `.kts` file ### Opciones @@ -1772,20 +1847,20 @@ El módulo `kotlin` muestra la versión instalada de [Kotlin](https://kotlinlang | `detect_extensions` | `["kt", "kts"]` | Qué extensiones deberían activar este módulo. | | `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `[]` | Qué carpetas deberían activar estos módulos. | -| `symbol` | `"🅺 "` | Una cadena de formato que representa el símbolo de Kotlin. | +| `symbol` | `"🅺 "` | A format string representing the symbol of Kotlin. | | `style` | `"bold blue"` | El estilo del módulo. | -| `kotlin_binary` | `"kotlin"` | Configura el binario kotlin que Starship ejecuta al obtener la versión. | -| `disabled` | `false` | Deshabilita el módulo `kotlin`. | +| `kotlin_binary` | `"kotlin"` | Configures the kotlin binary that Starship executes when getting the version. | +| `disabled` | `false` | Disables the `kotlin` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | --------- | -------------------------------------- | -| version | `v1.4.21` | La versión de `kotlin` | +| version | `v1.4.21` | The version of `kotlin` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -*: 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 @@ -1800,42 +1875,42 @@ symbol = "🅺 " # ~/.config/starship.toml [kotlin] -# Utiliza el binario del Compilador de Kotlin para obtener la versión instalada +# Uses the Kotlin Compiler binary to get the installed version 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`. Si se establece la variable de entorno `$KUBECONFIG`, el módulo usará eso si no usará el `~/.kube/config`. +Displays the current [Kubernetes context](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context) name and, if set, the namespace, user and cluster from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via `kubectl config set-context starship-context --namespace astronaut`. Similarly the user and cluster can be set with `kubectl config set-context starship-context --user starship-user` and `kubectl config set-context starship-context --cluster starship-cluster`. If the `$KUBECONFIG` env var is set the module will use that if not it will use the `~/.kube/config`. -::: consejo +::: tip -Este módulo está deshabilitado por defecto. Para habilitarlo, establece `disabled` a `false` en tu archivo de configuración. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### Opciones -| Opción | Por defecto | Descripción | -| ----------------- | ---------------------------------------------------- | --------------------------------------------------------------------------- | -| `symbol` | `"☸ "` | Una cadena de formato que representa el símbolo mostrado antes del Cluster. | -| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | El formato del módulo. | -| `style` | `"cyan bold"` | El estilo del módulo. | -| `context_aliases` | | Tabla de alias de contexto a mostrar. | -| `disabled` | `true` | Desactiva el módulo `kubernetes`. | +| Opción | Predeterminado | Descripción | +| ----------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | +| `symbol` | `"☸ "` | A format string representing the symbol displayed before the Cluster. | +| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | El formato del módulo. | +| `style` | `"cyan bold"` | El estilo del módulo. | +| `context_aliases` | | Table of context aliases to display. | +| `disabled` | `true` | Disables the `kubernetes` module. | ### Variables -| Variable | Ejemplo | Descripción | -| --------- | -------------------- | ----------------------------------------------------------- | -| context | `starship-context` | The current kubernetes context name | -| namespace | `starship-namespace` | Si se establece, el espacio de nombres actual de kubernetes | -| user | `starship-user` | If set, the current kubernetes user | -| cluster | `starship-cluster` | If set, the current kubernetes cluster | -| symbol | | Refleja el valor de la opción `symbol` | -| style\* | | Refleja el valor de la opción `style` | +| Variable | Ejemplo | Descripción | +| --------- | -------------------- | ---------------------------------------- | +| 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 | | 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 @@ -1853,34 +1928,34 @@ disabled = false #### Busqueda por Regex -Adicional al alias simple, `context_aliases` también soporta coincidencias extendidas y renombradas usando expresiones regulares. +Additional to simple aliasing, `context_aliases` also supports extended matching and renaming using regular expressions. -La expresión regular debe coincidir en todo el contexto de kube. los grupos de captura pueden ser referenciados usando `$name` y `$N` en el reemplazo. Esto está más explicado en la documentación del [crate regex](https://docs.rs/regex/1.5.4/regex/struct.Regex.html#method.replace). +The regular expression must match on the entire kube context, capture groups can be referenced using `$name` and `$N` in the replacement. This is more explained in the [regex crate](https://docs.rs/regex/1.5.4/regex/struct.Regex.html#method.replace) documentation. -Los nombres de cluster generados de forma larga y automática pueden ser identificados y abreviados usando expresiones regulares: +Long and automatically generated cluster names can be identified and shortened using regular expressions: ```toml [kubernetes.context_aliases] -# los contextos de OpenShift llevan el espacio de nombres y el usuario en el contexto de kube: `namespace/name/user`: +# OpenShift contexts carry the namespace and user in the kube context: `namespace/name/user`: ".*/openshift-cluster/.*" = "openshift" # Or better, to rename every OpenShift cluster at once: ".*/(?P[\\w-]+)/.*" = "$var_cluster" -# 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`): +# 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`): "gke_.*_(?P[\\w-]+)" = "gke-$var_cluster" ``` -## Salto de línea +## Line Break -El módulo `line_break` separa el indicador en dos líneas. +The `line_break` module separates the prompt into two lines. ### Opciones -| Opción | Por defecto | Descripción | -| ---------- | ----------- | ------------------------------------------------------------------------------- | -| `disabled` | `false` | Deshabilita el módulo `line_break`, haciendo que el mensaje sea una sola línea. | +| Opción | Predeterminado | Descripción | +| ---------- | -------------- | ------------------------------------------------------------------ | +| `disabled` | `false` | Disables the `line_break` module, making the prompt a single line. | ### Ejemplo @@ -1893,25 +1968,25 @@ disabled = true ## Local IP -El módulo `localip` muestra la dirección IPv4 de la interfaz de red principal. +The `localip` module shows the IPv4 address of the primary network interface. ### Opciones -| Opción | 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`. | +| 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. | ### Variables | Variable | Ejemplo | Descripción | | --------- | ------------ | ------------------------------------- | -| localipv4 | 192.168.1.13 | Contiene la dirección IPv4 primaria | +| localipv4 | 192.168.1.13 | Contains the primary IPv4 address | | style\* | | Refleja el valor de la opción `style` | -*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo +*: Esta variable sólo puede ser usada como parte de una cadena de estilo ### Ejemplo @@ -1926,11 +2001,11 @@ disabled = false ## Lua -El módulo `lua` muestra la versión instalada de [Lua](http://www.lua.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `lua` module shows the currently installed version of [Lua](http://www.lua.org/). By default the module will be shown if any of the following conditions are met: -- 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` +- 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 ### Opciones @@ -1938,23 +2013,23 @@ El módulo `lua` muestra la versión instalada de [Lua](http://www.lua.org/). Po | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | | `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"🌙 "` | Una cadena de formato que representa el símbolo de Lua. | +| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. | | `detect_extensions` | `["lua"]` | Qué extensiones deberían activar este módulo. | | `detect_files` | `[".lua-version"]` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `["lua"]` | Qué carpetas deberían activar este módulo. | | `style` | `"bold blue"` | El estilo del módulo. | -| `lua_binary` | `"lua"` | Configura el binario de lua que Starship ejecuta al obtener la versión. | -| `disabled` | `false` | Desactiva el módulo `lua`. | +| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. | +| `disabled` | `false` | Disables the `lua` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `v5.4.0` | La versión de `lua` | +| version | `v5.4.0` | The version of `lua` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -*: 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 @@ -1965,40 +2040,40 @@ El módulo `lua` muestra la versión instalada de [Lua](http://www.lua.org/). Po format = "via [🌕 $version](bold blue) " ``` -## Memoria utilizada +## Memory Usage -El módulo `memory_usage` muestra la memoria del sistema actual y el uso de memoria de intercambio. +The `memory_usage` module shows current system memory and swap usage. -Por defecto, el uso de swap se muestra si el intercambio total del sistema no es cero. +By default the swap usage is displayed if the total system swap is non-zero. -::: consejo +::: tip -Este módulo está deshabilitado por defecto. Para habilitarlo, establece `disabled` a `false` en tu archivo de configuración. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### Opciones -| Opción | 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`. | +| 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. | ### Variables -| Variable | Ejemplo | Descripción | -| ---------------- | ------------- | ---------------------------------------------------------------------------------- | -| ram | `31GiB/65GiB` | La memoria RAM usada/total del sistema actual. | -| ram_pct | `48%` | El porcentaje de la memoria actual del sistema. | -| swap\*\* | `1GiB/4GiB` | El tamaño de la memoria de intercambio del archivo de memoria del sistema actual. | -| swap_pct\*\* | `77%` | El porcentaje de memoria de intercambio del archivo de memoria del sistema actual. | -| symbol | `🐏` | Refleja el valor de la opción `symbol` | -| style\* | | Refleja el valor de la opción `style` | +| Variable | Ejemplo | Descripción | +| ---------------- | ------------- | ------------------------------------------------------------------ | +| ram | `31GiB/65GiB` | The usage/total RAM of the current system memory. | +| ram_pct | `48%` | The percentage of the current system memory. | +| swap\*\* | `1GiB/4GiB` | The swap memory size of the current system swap memory file. | +| swap_pct\*\* | `77%` | The swap memory percentage of the current system swap memory file. | +| symbol | `🐏` | Refleja el valor de la opción `symbol` | +| style\* | | Refleja el valor de la opción `style` | -*: Está variable solo puede utilizarse como parte de una cadena de estilo *\*: La información del archivo SWAP solo se muestra si se detecta en el sistema actual +*: This variable can only be used as a part of a style string *\*: The SWAP file information is only displayed if detected on the current system ### Ejemplo @@ -2014,28 +2089,28 @@ style = "bold dimmed green" ## Mercurial Branch -El módulo `hg_branch` muestra la rama activa del repositorio en su directorio actual. +The `hg_branch` module shows the active branch of the repo in your current directory. ### Opciones -| 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`. | +| 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. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| branch | `master` | La rama de mercurial activa | +| branch | `master` | The active mercurial branch | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo +*: Esta variable sólo puede ser usada como parte de una cadena de estilo ### Ejemplo @@ -2050,35 +2125,35 @@ truncation_symbol = "" ## Nim -El módulo `nim` muestra la versión instalada de [Nim](https://nim-lang.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `nim` module shows the currently installed version of [Nim](https://nim-lang.org/). By default the module will be shown if any of the following conditions are met: -- 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` +- 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 ### Opciones | Opción | Por defecto | Descripción | | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | El formato del módulo | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module | | `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"👑 "` | El símbolo usado antes de mostrar la versión de Nim. | +| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. | | `detect_extensions` | `["nim", "nims", "nimble"]` | Qué extensiones deberían activar este módulo. | | `detect_files` | `["nim.cfg"]` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | | `style` | `"bold yellow"` | El estilo del módulo. | -| `disabled` | `false` | Desactiva el módulo `nim`. | +| `disabled` | `false` | Disables the `nim` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `v1.2.0` | La versión de `nimc` | +| version | `v1.2.0` | The version of `nimc` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -*: 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 @@ -2092,29 +2167,29 @@ symbol = "🎣 " ## Nix-shell -El módulo `nix_shell` muestra el entorno [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html). El módulo se mostrará dentro de un entorno nix-shell. +The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html) environment. The module will be shown when inside a nix-shell environment. ### Opciones -| Opción | 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`. | +| 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. | ### Variables | Variable | Ejemplo | Descripción | | --------- | ------- | -------------------------------------- | -| state | `pure` | El estado de nix-shell | -| name | `lorri` | El nombre de nix-shell | +| state | `pure` | The state of the nix-shell | +| name | `lorri` | The name of the nix-shell | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -*: 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 @@ -2130,38 +2205,38 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' ## Node.js -El módulo `nodejs` muestra la versión instalada de [Node.js](https://nodejs.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `nodejs` module shows the currently installed version of [Node.js](https://nodejs.org/). By default the module will be shown if any of the following conditions are met: -- 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` +- 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 ### 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` | `" "` | Una cadena de formato que representa el símbolo de Node.js. | -| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | 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. | +| 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. | ### Variables | Variable | Ejemplo | Descripción | | --------- | ---------- | -------------------------------------- | -| version | `v13.12.0` | La versión de `node` | +| version | `v13.12.0` | The version of `node` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -*: 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 @@ -2174,14 +2249,14 @@ format = "via [🤖 $version](bold green) " ## OCaml -El módulo `ocaml` muestra la versión instalada de [OCaml](https://ocaml.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `ocaml` module shows the currently installed version of [OCaml](https://ocaml.org/). By default the module will be shown if any of the following conditions are met: -- 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` +- 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 ### Opciones @@ -2189,26 +2264,26 @@ El módulo `ocaml` muestra la versión instalada de [OCaml](https://ocaml.org/). | ------------------------- | -------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | | `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | La cadena de formato para el módulo. | | `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"🐫 "` | El símbolo usado antes de mostrar la versión de OCaml. | -| `global_switch_indicator` | `""` | La cadena de formato usada para representar el interruptor global de OPAM. | -| `local_switch_indicator` | `"*"` | La cadena de formato usada para representar el interruptor local de OPAM. | +| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. | +| `global_switch_indicator` | `""` | The format string used to represent global OPAM switch. | +| `local_switch_indicator` | `"*"` | The format string used to represent local OPAM switch. | | `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | Qué extensiones deberían activar este módulo. | | `detect_files` | `["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `["_opam", "esy.lock"]` | Qué carpetas deberían activar este módulo. | | `style` | `"bold yellow"` | El estilo del módulo. | -| `disabled` | `false` | Desactiva el módulo `ocaml`. | +| `disabled` | `false` | Disables the `ocaml` module. | ### Variables -| Variable | Ejemplo | Descripción | -| ---------------- | ------------ | --------------------------------------------------------------------------- | -| version | `v4.10.0` | La versión de `ocaml` | -| switch_name | `my-project` | El interruptor OPAM activo | -| switch_indicator | | Refleja el valor de `indicator` para el interruptor OPAM activo actualmente | -| symbol | | Refleja el valor de la opción `symbol` | -| style\* | | Refleja el valor de la opción `style` | +| Variable | Ejemplo | Descripción | +| ---------------- | ------------ | ----------------------------------------------------------------- | +| version | `v4.10.0` | The version of `ocaml` | +| switch_name | `my-project` | The active OPAM switch | +| switch_indicator | | Mirrors the value of `indicator` for currently active OPAM switch | +| symbol | | Refleja el valor de la opción `symbol` | +| style\* | | Refleja el valor de la opción `style` | -*: Esta variable 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 @@ -2221,27 +2296,27 @@ format = "via [🐪 $version]($style) " ## OpenStack -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. +The `openstack` module shows the current OpenStack cloud and project. The module only active when the `OS_CLOUD` env var is set, in which case it will read `clouds.yaml` file from any of the [default locations](https://docs.openstack.org/python-openstackclient/latest/configuration/index.html#configuration-files). to fetch the current project in use. ### Opciones -| Opción | 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`. | +| 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. | ### Variables | Variable | Ejemplo | Descripción | | --------- | ------- | -------------------------------------- | -| cloud | `corp` | La nube OpenStack actual | -| project | `dev` | El proyecto OpenStack actual | +| cloud | `corp` | The current OpenStack cloud | +| project | `dev` | The current OpenStack project | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -*: 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 @@ -2254,26 +2329,26 @@ style = "bold yellow" symbol = "☁️ " ``` -## Versión del paquete +## Package Version -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`. +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. -- [**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 +- [**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 > ⚠️ 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. @@ -2282,21 +2357,21 @@ El módulo `package` se muestra cuando el directorio actual es el repositorio de | Opción | Por defecto | Descripción | | ----------------- | --------------------------------- | --------------------------------------------------------------------------------------- | | `format` | `"is [$symbol$version]($style) "` | El formato del módulo. | -| `symbol` | `"📦 "` | El símbolo usado antes de mostrar la versión del paquete. | +| `symbol` | `"📦 "` | The symbol used before displaying the version the package. | | `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | | `style` | `"bold 208"` | El estilo del módulo. | -| `display_private` | `false` | Activar la visualización de la versión para los paquetes marcados como privados. | -| `disabled` | `false` | Desactiva el módulo `package`. | +| `display_private` | `false` | Enable displaying version for packages marked as private. | +| `disabled` | `false` | Disables the `package` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `v1.0.0` | La versión de su paquete | +| version | `v1.0.0` | The version of your package | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -*: 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 @@ -2309,13 +2384,13 @@ format = "via [🎁 $version](208 bold) " ## Perl -El módulo `perl` muestra la versión instalada de [Perl](https://www.perl.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `perl` module shows the currently installed version of [Perl](https://www.perl.org/). By default the module will be shown if any of the following conditions are met: -- 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` +- 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` ### Opciones @@ -2323,18 +2398,18 @@ El módulo `perl` muestra la versión instalada de [Perl](https://www.perl.org/) | ------------------- | -------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | La cadena de formato para el módulo. | | `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"🐪 "` | El símbolo usado antes de mostrar la versión de Perl | +| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | | `detect_extensions` | `["pl", "pm", "pod"]` | Qué extensiones deberían activar este módulo. | | `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | | `style` | `"bold 149"` | El estilo del módulo. | -| `disabled` | `false` | Desactiva el módulo `perl`. | +| `disabled` | `false` | Disables the `perl` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | --------- | -------------------------------------- | -| version | `v5.26.1` | La versión de `perl` | +| version | `v5.26.1` | The version of `perl` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -2349,11 +2424,11 @@ format = "via [🦪 $version]($style) " ## PHP -El módulo `php` muestra la versión instalada de [PHP](https://www.php.net/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `php` module shows the currently installed version of [PHP](https://www.php.net/). By default the module will be shown if any of the following conditions are met: -- El directorio actual contiene un archivo `composer.json` -- El directorio actual contiene un archivo `.php-version` -- El directorio actual contiene una extensión `.php` +- The current directory contains a `composer.json` file +- The current directory contains a `.php-version` file +- The current directory contains a `.php` extension ### Opciones @@ -2361,22 +2436,22 @@ El módulo `php` muestra la versión instalada de [PHP](https://www.php.net/). P | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | | `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"🐘 "` | El símbolo usado antes de mostrar la versión de PHP. | +| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | | `detect_extensions` | `["php"]` | Qué extensiones deberían activar este módulo. | | `detect_files` | `["composer.json", ".php-version"]` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | | `style` | `"147 bold"` | El estilo del módulo. | -| `disabled` | `false` | Desactiva el módulo `php`. | +| `disabled` | `false` | Disables the `php` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `v7.3.8` | La versión de `php` | +| version | `v7.3.8` | The version of `php` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -*: 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 @@ -2389,18 +2464,18 @@ format = "via [🔹 $version](147 bold) " ## Pulumi -El módulo `pulumi` muestra el nombre de usuario actual, [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/)seleccionado y la versión. +The `pulumi` module shows the current username, selected [Pulumi Stack](https://www.pulumi.com/docs/intro/concepts/stack/), and version. -::: consejo +::: tip -Por defecto la versión de Pulumi no se muestra, ya que toma un orden de magnitud más largo para cargar que la mayoría de los plugins (~70ms). Si aún deseas activarlo, [sigue el ejemplo que se muestra a continuación](#with-pulumi-version). +By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, [follow the example shown below](#with-pulumi-version). ::: -Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +By default the module will be shown if any of the following conditions are met: -- El directorio actual contiene `Pulumi.yaml` o `Pulumi.yml` -- Un directorio padre contiene `Pulumi.yaml` o `Pulumi.yml` +- The current directory contains either `Pulumi.yaml` or `Pulumi.yml` +- A parent directory contains either `Pulumi.yaml` or `Pulumi.yml` ### Opciones @@ -2408,21 +2483,21 @@ Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes | ---------------- | -------------------------------------------- | --------------------------------------------------------------------------------------- | | `format` | `"via [$symbol($username@)$stack]($style) "` | La cadena de formato para el módulo. | | `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `" "` | Una cadena de formato que se muestra antes de la pila de Pulumi. | +| `symbol` | `" "` | A format string shown before the Pulumi stack. | | `style` | `"bold 5"` | El estilo del módulo. | -| `disabled` | `false` | Deshabilita el módulo `pulumi`. | +| `disabled` | `false` | Disables the `pulumi` module. | ### Variables -| Variable | Ejemplo | Descripción | -| ----------------- | ---------- | -------------------------------------- | -| version | `v0.12.24` | La versión de `pulumi` | -| stack | `dev` | La pila actual de Pulumi | -| 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` | +| 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` | -*: 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 @@ -2446,10 +2521,10 @@ format = "[$symbol$stack]($style) " ## PureScript -El módulo `purescript` muestra la versión instalada de [PureScript](https://www.purescript.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. By default the module will be shown if any of the following conditions are met: -- El directorio actual contiene un archivo `spago.dhall` -- El directorio actual contiene un archivo con la extensión `.purs` +- The current directory contains a `spago.dhall` file +- The current directory contains a file with the `.purs` extension ### Opciones @@ -2457,22 +2532,22 @@ El módulo `purescript` muestra la versión instalada de [PureScript](https://ww | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | | `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"<=> "` | El símbolo usado antes de mostrar la versión de PureScript. | +| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | | `detect_extensions` | `["purs"]` | Qué extensiones deberían activar este módulo. | | `detect_files` | `["spago.dhall"]` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | | `style` | `"bold white"` | El estilo del módulo. | -| `disabled` | `false` | Deshabilita el módulo `purescript`. | +| `disabled` | `false` | Disables the `purescript` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `0.13.5` | La versión de `purescript` | +| version | `0.13.5` | The version of `purescript` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -*: 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 @@ -2485,21 +2560,21 @@ format = "via [$symbol$version](bold white)" ## Python -El módulo `python` muestra la versión instalada de [Python](https://www.python.org/) y el entorno virtual actual [Python](https://docs.python.org/tutorial/venv.html) si uno está activado. +The `python` module shows the currently installed version of [Python](https://www.python.org/) and the current [Python virtual environment](https://docs.python.org/tutorial/venv.html) if one is activated. -Si `pyenv_version_name` se establece en `true`, mostrará el nombre de la versión de pyenv. De lo contrario, se mostrará el número de versión de `python --version`. +If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. -Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +By default the module will be shown if any of the following conditions are met: -- 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 +- 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 ### Opciones @@ -2507,33 +2582,33 @@ Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes | -------------------- | ------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------- | | `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | El formato del módulo. | | `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"🐍 "` | Una cadena de formato que representa el símbolo de Python | +| `symbol` | `"🐍 "` | A format string representing the symbol of Python | | `style` | `"yellow bold"` | El estilo del módulo. | -| `pyenv_version_name` | `false` | Usar pyenv para obtener la versión de Python | -| `pyenv_prefix` | `pyenv` | Prefijo antes de mostrar la versión de pyenv sólo se utiliza si se utiliza pyenv | -| `python_binary` | `["python", "python3", "python2"]` | Configura los binarios de python que Starship debería ejecutar al obtener la versión. | -| `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`. | +| `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. | -::: consejo +::: tip -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 `python_binary` variable accepts either a string or a list of strings. Starship will try executing each binary until it gets a result. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used. -Los valores por defecto y el orden para `python_binary` fue elegido para identificar primero la versión de Python en un entorno virtualenv/conda (que actualmente añade un `python`, no importa si apunta a `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. +The default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `/usr/bin/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `"python3"` will hide any Python version 2, see example below. ::: ### Variables -| Variable | Ejemplo | Descripción | -| ------------ | --------------- | ------------------------------------------- | -| version | `"v3.8.1"` | La versión de `python` | -| symbol | `"🐍 "` | Refleja el valor de la opción `symbol` | -| style | `"yellow bold"` | Refleja el valor de la opción `style` | -| pyenv_prefix | `"pyenv "` | Ordena el valor de la opción `pyenv_prefix` | -| virtualenv | `"venv"` | El nombre actual del `virtualenv` | +| Variable | Ejemplo | Descripción | +| ------------ | --------------- | ------------------------------------------ | +| version | `"v3.8.1"` | The version of `python` | +| symbol | `"🐍 "` | Refleja el valor de la opción `symbol` | +| style | `"yellow bold"` | Refleja el valor de la opción `style` | +| pyenv_prefix | `"pyenv "` | Mirrors the value of option `pyenv_prefix` | +| virtualenv | `"venv"` | The current `virtualenv` name | ### Ejemplo @@ -2549,7 +2624,7 @@ pyenv_version_name = true # ~/.config/starship.toml [python] -# Solo usa el binario `python3` para obtener la versión. +# Only use the `python3` binary to get the version. python_binary = "python3" ``` @@ -2557,7 +2632,7 @@ python_binary = "python3" # ~/.config/starship.toml [python] -# No se dispara con archivos con extensión py +# Don't trigger for files with the py extension detect_extensions = [] ``` @@ -2565,24 +2640,24 @@ detect_extensions = [] # ~/.config/starship.toml [python] -# Muestra la versión de python desde dentro de un entorno virtual local. +# Display the version of python from inside a local venv. # -# Ten en cuenta que esto solo funcionará cuando el venv esté dentro del proyecto y sólo -# funcionará en el directorio que contiene el directorio venv dir pero ¿tal vez esté bien? +# Note this will only work when the venv is inside the project and it will only +# work in the directory that contains the venv dir but maybe this is ok? python_binary = ["./venv/bin/python", "python", "python3", "python2"] ``` ## R -El módulo `rlang` muestra la versión instalada de [R](https://www.r-project.org/). El módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `rlang` module shows the currently installed version of [R](https://www.r-project.org/). The module will be shown if any of the following conditions are met: -- El directorio actual contiene un archivo con la extensión `.R`. -- El directorio actual contiene un archivo con la extensión `.Rd`. -- 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` +- 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 ### Opciones @@ -2590,18 +2665,18 @@ El módulo `rlang` muestra la versión instalada de [R](https://www.r-project.or | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | | `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"📐"` | Una cadena de formato que representa el símbolo de R. | +| `symbol` | `"📐"` | A format string representing the symbol of R. | | `style` | `"blue bold"` | El estilo del módulo. | -| `detect_extensions` | `["R", "Rd", "Rmd", "Rproj", "Rsx"]` | Qué extensiones deben activar este módulo | -| `detect_files` | `[".Rprofile"]` | Qué nombres de archivo deben activar este módulo | -| `detect_folders` | `[".Rproj.user"]` | Qué carpetas deben activar este módulo | -| `disabled` | `false` | Deshabilita el módulo `r`. | +| `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. | ### Variables | Variable | Ejemplo | Descripción | | -------- | ------------- | -------------------------------------- | -| version | `v4.0.5` | La versión de `R` | +| version | `v4.0.5` | The version of `R` | | symbol | | Refleja el valor de la opción `symbol` | | style | `"blue bold"` | Refleja el valor de la opción `style` | @@ -2616,9 +2691,9 @@ format = "with [📐 $version](blue bold) " ## Red -Por defecto, el módulo `red` muestra la versión actualmente instalada de [Red](https://www.red-lang.org/). El módulo se muestra si algunas de las siguientes condiciones se cumplen: +By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). El módulo se muestra si algunas de las siguientes condiciones se cumplen: -- El directorio actual contiene un archivo con extensión `.red` o `.Red` +- The current directory contains a file with `.red` or `.reds` extension ### Opciones @@ -2626,22 +2701,22 @@ Por defecto, el módulo `red` muestra la versión actualmente instalada de [Red] | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | | `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"🔺 "` | Una cadena de formato que representa el símbolo de Red. | +| `symbol` | `"🔺 "` | A format string representing the symbol of Red. | | `detect_extensions` | `["red"]` | Qué extensiones deberían activar este módulo. | | `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | | `style` | `"red bold"` | El estilo del módulo. | -| `disabled` | `false` | Deshabilita el módulo `rojo`. | +| `disabled` | `false` | Disables the `red` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `v2.5.1` | La versión de `red` | +| version | `v2.5.1` | The version of `red` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -*: 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 @@ -2654,14 +2729,14 @@ symbol = "🔴 " ## Ruby -Por defecto, el módulo `ruby` muestra la versión actualmente instalada de [Ruby](https://www.ruby-lang.org/). El módulo se muestra si algunas de las siguientes condiciones se cumplen: +By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). El módulo se muestra si algunas de las siguientes condiciones se cumplen: -- 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 +- 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 -Starship obtiene la versión actual de Ruby ejecutando `ruby -v`. +Starship gets the current Ruby version by running `ruby -v`. ### Opciones @@ -2669,19 +2744,19 @@ Starship obtiene la versión actual de Ruby ejecutando `ruby -v`. | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | | `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"💎 "` | Una cadena de formato que representa el símbolo de Ruby. | +| `symbol` | `"💎 "` | A format string representing the symbol of Ruby. | | `detect_extensions` | `["rb"]` | Qué extensiones deberían activar este módulo. | | `detect_files` | `["Gemfile", ".ruby-version"]` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | -| `detect_variables` | `["RUBY_VERSION", "RBENV_VERSION"]` | Qué variables de entorno deben activar este módulo. | +| `detect_variables` | `["RUBY_VERSION", "RBENV_VERSION"]` | Which environment variables should trigger this module. | | `style` | `"bold red"` | El estilo del módulo. | -| `disabled` | `false` | Desactiva el módulo `ruby`. | +| `disabled` | `false` | Disables the `ruby` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `v2.5.1` | La versión de `ruby` | +| version | `v2.5.1` | The version of `ruby` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -2698,10 +2773,10 @@ symbol = "🔺 " ## Rust -Por defecto, el módulo `rust` muestra la versión instalada de [Rust](https://www.rust-lang.org/). El módulo se muestra si algunas de las siguientes condiciones se cumplen: +By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). El módulo se muestra si algunas de las siguientes condiciones se cumplen: -- El directorio actual contiene un archivo `Cargo.toml` -- El directorio actual contiene un archivo con la extensión `.rs` +- The current directory contains a `Cargo.toml` file +- The current directory contains a file with the `.rs` extension ### Opciones @@ -2709,22 +2784,22 @@ Por defecto, el módulo `rust` muestra la versión instalada de [Rust](https://w | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | | `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"🦀 "` | Una cadena de formato que representa el símbolo de Rust | +| `symbol` | `"🦀 "` | A format string representing the symbol of Rust | | `detect_extensions` | `["rs"]` | Qué extensiones deberían activar este módulo. | | `detect_files` | `["Cargo.toml"]` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | | `style` | `"bold red"` | El estilo del módulo. | -| `disabled` | `false` | Desactiva el módulo `rust`. | +| `disabled` | `false` | Disables the `rust` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | ----------------- | -------------------------------------- | -| version | `v1.43.0-nightly` | La versión de `rustc` | +| version | `v1.43.0-nightly` | The version of `rustc` | | 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 @@ -2737,11 +2812,11 @@ format = "via [⚙️ $version](red bold)" ## Scala -El módulo `scala` muestra la versión actualmente instalada de [Scala](https://www.scala-lang.org/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). By default the module will be shown if any of the following conditions are met: -- 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` +- 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` ### Opciones @@ -2752,19 +2827,19 @@ El módulo `scala` muestra la versión actualmente instalada de [Scala](https:// | `detect_extensions` | `["sbt", "scala"]` | Qué extensiones deberían activar este módulo. | | `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `[".metals"]` | Qué carpetas deberían activar estos módulos. | -| `symbol` | `"🆂 "` | Una cadena de formato que representa el símbolo de Scala. | +| `symbol` | `"🆂 "` | A format string representing the symbol of Scala. | | `style` | `"red dimmed"` | El estilo del módulo. | -| `disabled` | `false` | Deshabilita el módulo `scala`. | +| `disabled` | `false` | Disables the `scala` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `2.13.5` | La versión de `scala` | +| version | `2.13.5` | The version of `scala` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -*: 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 @@ -2777,41 +2852,41 @@ symbol = "🌟 " ## Shell -El módulo `shell` muestra un indicador para el intérprete de comandos actualmente utilizado. +The `shell` module shows an indicator for currently used shell. -::: consejo +::: tip -Este módulo está deshabilitado por defecto. Para habilitarlo, establece `disabled` a `false` en tu archivo de configuración. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### Opciones -| Opción | 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`. | +| 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. | ### Variables -| Variable | Por defecto | 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`. | +| Variable | Predeterminado | Descripción | +| --------- | -------------- | ---------------------------------------------------------- | +| indicator | | Mirrors the value of `indicator` for currently used shell. | +| style\* | | Mirrors the value of option `style`. | -*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo +*: Esta variable sólo puede ser usada como parte de una cadena de estilo ### Ejemplos @@ -2828,28 +2903,28 @@ disabled = false ## SHLVL -El módulo `shlvl` muestra la variable de entorno [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ("shell level") actual, si está establecido en un número y reúne o supera el umbral especificado. +The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold. ### Opciones -| 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`. | +| 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. | ### Variables | Variable | Ejemplo | Descripción | | --------- | ------- | -------------------------------------- | -| shlvl | `3` | El valor actual de `SHLVL` | +| shlvl | `3` | The current value of `SHLVL` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -*: 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 @@ -2864,26 +2939,26 @@ threshold = 3 ## Singularity -El módulo `singularity` muestra la imagen de [singularity](https://sylabs.io/singularity/) actual, si se encuentra dentro de un contenedor y `$SINGULARITY_NAME` está establecido. +The `singularity` module shows the current [Singularity](https://sylabs.io/singularity/) image, if inside a container and `$SINGULARITY_NAME` is set. ### Opciones -| Opción | 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`. | +| 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. | ### Variables | Variable | Ejemplo | Descripción | | --------- | ------------ | -------------------------------------- | -| env | `centos.img` | La imagen de Singularity actual | +| env | `centos.img` | The current Singularity image | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -*: 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 @@ -2896,51 +2971,49 @@ format = '[📦 \[$env\]]($style) ' ## Status -El módulo `status` muestra el código de salida del comando anterior. El módulo se mostrará sólo si el código de salida no es `0`. El código de estado se convertirá a un entero con signo de 32 bits. +The `status` module displays the exit code of the previous command. If $success_symbol is empty (default), the module will be shown only if the exit code is not `0`. The status code will cast to a signed 32-bit integer. -::: consejo +::: tip -Este módulo está deshabilitado por defecto. Para habilitarlo, establece `disabled` a `false` en tu archivo de configuración. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: -::: advertencia Este módulo no es compatible con el intérprete de comandos nu. ::: - ### Opciones -| Opción | Por defecto | Descripción | -| ----------------------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------ | -| `format` | `"[$symbol$status]($style) "` | El formato del módulo | -| `symbol` | `"✖"` | El símbolo mostrado en error del programa | -| `success_symbol` | `"✔️"` | El símbolo mostrado en el éxito del programa | -| `not_executable_symbol` | `"🚫"` | El símbolo mostrado cuando el archivo no es ejecutable | -| `not_found_symbol` | `"🔍"` | El símbolo mostrado cuando no se encuentra el comando | -| `sigint_symbol` | `"🧱"` | El símbolo mostrado en SIGINT (Ctrl + c) | -| `signal_symbol` | `"⚡"` | El símbolo mostrado en cualquier señal | -| `style` | `"bold red"` | El estilo del módulo. | -| `recognize_signal_code` | `true` | Activar mapeo de señales desde el código de salida | -| `map_symbol` | `false` | Activar mapeo de símbolos desde el código de salida | -| `pipestatus` | `false` | Habilita el reporte de pipstatus | -| `pipestatus_separator` | `|` | | -| `pipestatus_format` | `\\[$pipestatus\\] => [$symbol$common_meaning$signal_name$maybe_int]($style)` | El formato del módulo cuando el comando es un pipeline | -| `disabled` | `true` | Desactiva el módulo `status`. | +| 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 | +| `style` | `"bold red"` | El estilo del módulo. | +| `recognize_signal_code` | `true` | Enable signal mapping from exit code | +| `map_symbol` | `false` | Enable symbols mapping from exit code | +| `pipestatus` | `false` | Enable pipestatus reporting | +| `pipestatus_separator` | `|` | | +| `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. | ### Variables -| Variable | Ejemplo | Descripción | -| -------------- | ------- | ------------------------------------------------------------------------------------------------------------------ | -| status | `127` | El código de salida del último comando | -| hex_status | `0x7F` | El código de salida del último comando en hexadecimal | -| int | `127` | El código de salida del último comando | -| common_meaning | `ERROR` | Comprobación del código si no es una señal | -| signal_number | `9` | Número de señal correspondiente al código de salida, sólo si está señ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` | +| Variable | Ejemplo | Descripción | +| -------------- | ------- | ------------------------------------------------------------------------------------------- | +| status | `127` | The exit code of the last command | +| hex_status | `0x7F` | The exit code of the last command in hex | +| int | `127` | The exit code of the last command | +| common_meaning | `ERROR` | Meaning of the code if not a signal | +| signal_number | `9` | Signal number corresponding to the exit code, only if signalled | +| signal_name | `KILL` | Name of the signal corresponding to the exit code, only if signalled | +| maybe_int | `7` | Contains the exit code number when no meaning has been found | +| pipestatus | | Rendering of in pipeline programs's exit codes, this is only available in pipestatus_format | +| symbol | | Refleja el valor de la opción `symbol` | +| style\* | | Refleja el valor de la opción `style` | -*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo +*: Esta variable sólo puede ser usada como parte de una cadena de estilo ### Ejemplo @@ -2949,31 +3022,32 @@ Este módulo está deshabilitado por defecto. Para habilitarlo, establece `disab [status] style = "bg:blue" -symbol = "🔴" -format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) ' +symbol = "🔴 " +success_symbol = "🟢 SUCCESS" +format = '[\[$symbol$common_meaning$signal_name$maybe_int\]]($style) ' map_symbol = true disabled = false ``` ## Sudo -El módulo `sudo` muestra si las credenciales de sudo están actualmente en caché. El módulo solo se mostrará si las credenciales están guardadas en caché. +The `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached. -::: consejo +::: tip -Este módulo está deshabilitado por defecto. Para habilitarlo, establece `disabled` a `false` en tu archivo de configuración. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### Opciones -| Opción | Por defecto | Descripción | -| --------------- | ----------------------- | ------------------------------------------------------------------------------------------------ | -| `format` | `[as $symbol]($style)"` | El formato del módulo | -| `symbol` | `"🧙 "` | El símbolo mostrado cuando las credenciales están guardadas en caché | -| `style` | `"bold blue"` | El estilo del módulo. | -| `allow_windows` | `false` | Como Windows no tiene sudo de manera predeterminada, el valor predeterminado está deshabilitado. | -| `disabled` | `true` | Deshabilita el módulo `sudo`. | +| 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. | ### Variables @@ -2982,7 +3056,7 @@ Este módulo está deshabilitado por defecto. Para habilitarlo, establece `disab | 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 @@ -3006,10 +3080,10 @@ disabled = false ## Swift -Por defecto, el módulo `swift` muestra la versión instalada de [Swift](https://swift.org/). El módulo se muestra si algunas de las siguientes condiciones se cumplen: +By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). El módulo se muestra si algunas de las siguientes condiciones se cumplen: -- El directorio actual contiene un archivo `Package.swift` -- El directorio actual contiene un archivo con la extensión `.swift` +- The current directory contains a `Package.swift` file +- The current directory contains a file with the `.swift` extension ### Opciones @@ -3017,22 +3091,22 @@ Por defecto, el módulo `swift` muestra la versión instalada de [Swift](https:/ | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | | `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"🐦 "` | Una cadena de formato que representa el símbolo de Swift | +| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | | `detect_extensions` | `["swift"]` | Qué extensiones deberían activar este módulo. | | `detect_files` | `["Package.swift"]` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | | `style` | `"bold 202"` | El estilo del módulo. | -| `disabled` | `false` | Desactiva el módulo `swift`. | +| `disabled` | `false` | Disables the `swift` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `v5.2.4` | La versión de `swift` | +| version | `v5.2.4` | The version of `swift` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -*: 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 @@ -3045,18 +3119,18 @@ format = "via [🏎 $version](red bold)" ## Terraform -El módulo `Terraform` muestra el espacio de trabajo de [Terraform](https://www.terraform.io/docs/language/state/workspaces.html) y la versión seleccionados actualmente. +The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. -::: consejo +::: tip -Por defecto no se muestra la versión de Terraform, ya que esto es lento para las versiones actuales de Terraform cuando hay muchos complementos en uso. Si aún deseas activarlo, [sigue el ejemplo que se muestra a continuación](#with-terraform-version). +By default the Terraform version is not shown, since this is slow for current versions of Terraform when a lot of plugins are in use. If you still want to enable it, [follow the example shown below](#with-terraform-version). ::: -Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +By default the module will be shown if any of the following conditions are met: -- El directorio actual contiene una carpeta `.terraform` -- El directorio actual contiene un archivo con las extensiones `.tf`, `.tfplan` o `.tfstate` +- The current directory contains a `.terraform` folder +- Current directory contains a file with the `.tf`, `.tfplan` or `.tfstate` extensions ### Opciones @@ -3064,23 +3138,23 @@ Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | | `format` | `"via [$symbol$workspace]($style) "` | La cadena de formato para el módulo. | | `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"💠"` | Una cadena de formato que se muestra antes del espacio de trabajo de terraform. | +| `symbol` | `"💠"` | A format string shown before the terraform workspace. | | `detect_extensions` | `["tf", "tfplan", "tfstate"]` | Qué extensiones deberían activar este módulo. | | `detect_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` | Desactiva el módulo `terraform`. | +| `disabled` | `false` | Disables the `terraform` module. | ### Variables -| Variable | Ejemplo | Descripción | -| --------- | ---------- | ----------------------------------------- | -| version | `v0.12.24` | La versión de `terraform` | -| workspace | `default` | El espacio de trabajo actual de Terraform | -| symbol | | Refleja el valor de la opción `symbol` | -| style\* | | Refleja el valor de la opción `style` | +| Variable | Ejemplo | Descripción | +| --------- | ---------- | -------------------------------------- | +| version | `v0.12.24` | The version of `terraform` | +| workspace | `default` | The current Terraform workspace | +| symbol | | Refleja el valor de la opción `symbol` | +| style\* | | Refleja el valor de la opción `style` | -*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo +*: Esta variable sólo puede ser usada como parte de una cadena de estilo ### Ejemplo @@ -3104,36 +3178,36 @@ format = "[🏎💨 $workspace]($style) " ## Hora -El módulo `time` muestra la hora **local** actual. El valor de configuración de `format` es usado por la caja de [`chrono`](https://crates.io/crates/chrono) para controlar cómo se muestra la hora. Echa un vistazo a [los documentos de chrono strftime](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) para ver qué opciones están disponibles. +The `time` module shows the current **local** time. The `format` configuration value is used by the [`chrono`](https://crates.io/crates/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) to see what options are available. -::: consejo +::: tip -Este módulo está deshabilitado por defecto. Para habilitarlo, establece `disabled` a `false` en tu archivo de configuración. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### Opciones -| Opción | 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` | see below | La [cadena de formato de chrono](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) utilizada para formatear la hora. | -| `style` | `"bold yellow"` | El estilo para la hora del módulo | -| `utc_time_offset` | `"local"` | Establece el desplazamiento UTC a utilizar. Rango de -24 < x < 24. Permite a los flotantes acomodar los desplazamientos de zona horaria de 30/45 minutos. | -| `disabled` | `true` | Desactiva el módulo `time`. | -| `time_range` | `"-"` | Establece el intervalo de tiempo durante el cual el módulo se mostrará. La hora debe ser especificada en formato de 24 horas | +| 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 | -Si `use_12hr` es `true`, entonces `time_format` por defecto `"%r"`. De lo contrario, el valor por defecto es `"%T"`. Configurar manualmente `time_format` sobrescribirá la configuración `use_12hr`. +If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Otherwise, it defaults to `"%T"`. Manually setting `time_format` will override the `use_12hr` setting. ### Variables | Variable | Ejemplo | Descripción | | --------- | ---------- | ------------------------------------- | -| time | `13:08:10` | La hora actual. | +| time | `13:08:10` | The current time. | | style\* | | Refleja el valor de la opción `style` | -*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo +*: Esta variable sólo puede ser usada como parte de una cadena de estilo ### Ejemplo @@ -3148,37 +3222,37 @@ utc_time_offset = "-5" time_range = "10:00:00-14:00:00" ``` -## Nombre de usuario +## Username -El módulo `username` muestra el nombre de usuario activo. El módulo se muestra si algunas de las siguientes condiciones se cumplen: +The `username` module shows active user's username. El módulo se muestra si algunas de las siguientes condiciones se cumplen: -- El usuario actual es root -- 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 +- 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 -::: consejo +::: tip -La conexión SSH se detecta comprobando las variables de entorno `SSH_CONNECTION`, `SSH_CLIENT`, y `SSH_TTY`. Si su host SSH no configura estas variables, una solución es establecer una de ellas con un valor tonto. +SSH connection is detected by checking environment variables `SSH_CONNECTION`, `SSH_CLIENT`, and `SSH_TTY`. If your SSH host does not set up these variables, one workaround is to set one of them with a dummy value. ::: ### Opciones -| Opción | Por defecto | Descripción | -| ------------- | ----------------------- | ------------------------------------------ | -| `style_root` | `"bold red"` | El estilo usado cuando el usuario es root. | -| `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` | Desactiva el módulo `username`. | +| 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. | ### Variables -| Variable | Ejemplo | Descripción | -| -------- | ------------ | --------------------------------------------------------------------------------------------------- | -| `style` | `"red bold"` | Refleja el valor de la opción `style_root` cuando root inició sesión y `style_user` por otra parte. | -| `user` | `"matchai"` | El ID de usuario conectado actualmente. | +| Variable | Ejemplo | Descripción | +| -------- | ------------ | ------------------------------------------------------------------------------------------- | +| `style` | `"red bold"` | Mirrors the value of option `style_root` when root is logged in and `style_user` otherwise. | +| `user` | `"matchai"` | The currently logged-in user ID. | ### Ejemplo @@ -3195,9 +3269,9 @@ show_always = true ## Vagrant -El módulo `vagrant` muestra la versión instalada de [Vagrant](https://www.vagrantup.com/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `vagrant` module shows the currently installed version of [Vagrant](https://www.vagrantup.com/). By default the module will be shown if any of the following conditions are met: -- El directorio actual contiene un archivo `Vagrantfile` +- The current directory contains a `Vagrantfile` file ### Opciones @@ -3205,22 +3279,22 @@ El módulo `vagrant` muestra la versión instalada de [Vagrant](https://www.vagr | ------------------- | ------------------------------------ | --------------------------------------------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | | `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"⍱ "` | Una cadena de formato que representa el símbolo de Vagrant. | +| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | | `detect_extensions` | `[]` | Qué extensiones deberían activar este módulo. | | `detect_files` | `["Vagrantfile"]` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | | `style` | `"cyan bold"` | El estilo del módulo. | -| `disabled` | `false` | Deshabilita el módulo `vagrant`. | +| `disabled` | `false` | Disables the `vagrant` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | ---------------- | -------------------------------------- | -| version | `Vagrant 2.2.10` | La versión de `Vagrant` | +| version | `Vagrant 2.2.10` | The version of `Vagrant` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -*: 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 @@ -3233,10 +3307,10 @@ format = "via [⍱ $version](bold white) " ## V -El módulo `vlang` te muestra la versión instalada de [V](https://vlang.io/). Por defecto, el módulo se mostrará si se cumplen cualquiera de las siguientes condiciones: +The `vlang` module shows you your currently installed version of [V](https://vlang.io/). By default the module will be shown if any of the following conditions are met: -- 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` +- The current directory contains a file with `.v` extension +- The current directory contains a `v.mod`, `vpkg.json` or `.vpkg-lock.json` file ### Opciones @@ -3244,18 +3318,18 @@ El módulo `vlang` te muestra la versión instalada de [V](https://vlang.io/). P | ------------------- | -------------------------------------------- | --------------------------------------------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | El formato del módulo. | | `version_format` | `"v${raw}"` | El formato de versión. Las variables disponibles son `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"V "` | Una cadena de formato que representa el símbolo de V | +| `symbol` | `"V "` | A format string representing the symbol of V | | `detect_extensions` | `["v"]` | Qué extensiones deberían activar este módulo. | | `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | | `style` | `"blue bold"` | El estilo del módulo. | -| `disabled` | `false` | Deshabilita el módulo `vlang`. | +| `disabled` | `false` | Disables the `vlang` module. | ### Variables | Variable | Ejemplo | Descripción | | --------- | ------- | -------------------------------------- | -| version | `v0.2` | La versión de `v` | +| version | `v0.2` | The version of `v` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | @@ -3269,26 +3343,26 @@ format = "via [V $version](blue bold) " ## VCSH -El módulo `vcsh` muestra el repositorio activo [VCSH](https://github.com/RichiH/vcsh) actual. El módulo sólo se mostrará si un repositorio está actualmente en uso. +The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. The module will be shown only if a repository is currently in use. ### Opciones -| Opción | Por defecto | Descripción | -| ---------- | -------------------------------- | ------------------------------------------------------------ | -| `symbol` | | El símbolo usado antes de mostrar el nombre del repositorio. | -| `style` | `"bold yellow"` | El estilo del módulo. | -| `format` | `"vcsh [$symbol$repo]($style) "` | El formato del módulo. | -| `disabled` | `false` | Deshabilita el módulo `vcsh`. | +| Opción | 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. | ### Variables -| Variable | Ejemplo | Descripción | -| ----------- | ----------------------------------------------------------- | -------------------------------------- | -| repositorio | `dotfiles` si está en un repositorio VCSH nombrado dotfiles | El nombre del repositorio activo | -| symbol | | Refleja el valor de la opción `symbol` | -| style\* | `black bold dimmed` | Refleja el valor de la opción `style` | +| Variable | Ejemplo | Descripción | +| --------- | ------------------------------------------- | -------------------------------------- | +| repo | `dotfiles` if in a VCSH repo named dotfiles | The active repository name | +| symbol | | Refleja el valor de la opción `symbol` | +| style\* | `black bold dimmed` | Refleja el valor de la opción `style` | -*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo +*: Esta variable sólo puede ser usada como parte de una cadena de estilo ### Ejemplo @@ -3301,19 +3375,19 @@ format = "[🆅 $repo](bold blue) " ## Zig -Por defecto, el módulo `zig` muestra la versión instalada de [Zig](https://ziglang.org/). El módulo se muestra si algunas de las siguientes condiciones se cumplen: +By default the the `zig` module shows the currently installed version of [Zig](https://ziglang.org/). El módulo se muestra si algunas de las siguientes condiciones se cumplen: -- El directorio actual contiene un archivo `.zig` +- The current directory contains a `.zig` file ### 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` | `"↯ "` | El símbolo usado antes de mostrar la versión de Zig. | +| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | | `style` | `"bold yellow"` | El estilo del módulo. | -| `disabled` | `false` | Desactiva el módulo `zig`. | +| `disabled` | `false` | Disables the `zig` module. | | `detect_extensions` | `["zig"]` | Qué extensiones deberían activar este módulo. | | `detect_files` | `[]` | Qué nombres de archivo deberían activar este módulo. | | `detect_folders` | `[]` | Qué carpetas deberían activar este módulo. | @@ -3322,11 +3396,11 @@ Por defecto, el módulo `zig` muestra la versión instalada de [Zig](https://zig | Variable | Ejemplo | Descripción | | --------- | -------- | -------------------------------------- | -| version | `v0.6.0` | La versión de `zig` | +| version | `v0.6.0` | The version of `zig` | | symbol | | Refleja el valor de la opción `symbol` | | style\* | | Refleja el valor de la opción `style` | -*: 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 @@ -3337,97 +3411,97 @@ Por defecto, el módulo `zig` muestra la versión instalada de [Zig](https://zig symbol = "⚡️ " ``` -## Comandos personalizados +## Custom commands -Los módulos `personalizados` muestran la salida de algunos comandos arbitrarios. +The `custom` modules show the output of some arbitrary commands. -Estos módulos se mostrarán si se cumplen alguna de las siguientes condiciones: +These modules will be shown if any of the following conditions are met: -- El directorio actual contiene un archivo cuyo nombre está en `files` -- El directorio actual contiene un directorio cuyo nombre está en `directories` -- El directorio actual contiene un archivo cuya extensión está en `extensions` -- El comando `when` devuelve 0 -- El sistema operativo actual (std::env::consts::OS) coincide con el campo `os` si está definido. +- 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. -::: consejo +::: tip -Múltiples módulos personalizados pueden definirse usando una `.`. +Multiple custom modules can be defined by using a `.`. ::: -::: consejo +::: tip -El orden en el que se muestran los módulos personalizados se puede establecer individualmente incluyendo `${custom.foo}` en el `format` de nivel superior (ya que incluye un punto, necesita usar `${...}`). Por defecto, el módulo `custom` simplemente mostrará todos los módulos personalizados en el orden en que fueron definidos. +The order in which custom modules are shown can be individually set by including `${custom.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `custom` module will simply show all custom modules in the order they were defined. ::: -::: consejo +::: tip -[El issue #1252](https://github.com/starship/starship/discussions/1252) contiene ejemplos de módulos personalizados. Si tiene un ejemplo interesante no cubierto allí, no dude en compartirlo allí! +[Issue #1252](https://github.com/starship/starship/discussions/1252) contains examples of custom modules. If you have an interesting example not covered there, feel free to share it there! ::: -::: advertencia la salida de comandos se imprime sin escapar al prompt +::: warning Command output is printed unescaped to the prompt -Cualquiera que sea la salida que genere el comando se imprime sin modificar en el prompt. Esto significa que si la salida contiene secuencias especiales que son interpretadas por el intérprete, se expandirán cuando se muestre. Estas secuencias especiales son específicas del intérprete, por ejemplo, puedes escribir un módulo de comando que escribe secuencias de bash, por ejemplo, `\h`, pero este módulo no funcionará en el intérprete fish o zsh. +Whatever output the command generates is printed unmodified in the prompt. This means if the output contains special sequences that are interpreted by your shell they will be expanded when displayed. These special sequences are shell specific, e.g. you can write a command module that writes bash sequences, e.g. `\h`, but this module will not work in a fish or zsh shell. -Las cadenas de formato también pueden contener secuencias específicas del intérprete, por ejemplo, [Bash](https://www.gnu.org/software/bash/manual/html_node/Controlling-the-Prompt.html), [Zsh](https://zsh.sourceforge.io/Doc/Release/Prompt-Expansion.html). +Format strings can also contain shell specific prompt sequences, e.g. [Bash](https://www.gnu.org/software/bash/manual/html_node/Controlling-the-Prompt.html), [Zsh](https://zsh.sourceforge.io/Doc/Release/Prompt-Expansion.html). ::: ### Opciones -| Opción | Por defecto | Descripción | -| ------------- | ------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `command` | `""` | El comando cuya salida debe ser impresa. El comando se pasará en stdin al shell. | -| `when` | | Comando de shell usado como condición para mostrar el módulo. El módulo se mostrará si el comando devuelve un código de estado `0`. | -| `shell` | | [Ver abajo](#custom-command-shell) | -| `description` | `""` | La descripción del módulo que se muestra al ejecutar `starship explain`. | -| `files` | `[]` | Los archivos que se buscarán en el directorio de trabajo para obtener una coincidencia. | -| `directories` | `[]` | Los directorios que se buscarán en el directorio de trabajo para una coincidencia. | -| `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` | Desactiva este módulo `custom`. | -| `os` | | Nombre del sistema operativo en el que se mostrará el módulo (unix, linux, macos, windows, ... ) [Ver valores posibles](https://doc.rust-lang.org/std/env/consts/constant.OS.html). | +| 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). | ### Variables -| Variable | Descripción | -| --------- | ----------------------------------------- | -| output | La salida del comando de shell en `shell` | -| symbol | Refleja el valor de la opción `symbol` | -| style\* | Refleja el valor de la opción `style` | +| Variable | Descripción | +| --------- | -------------------------------------- | +| output | The output of shell command in `shell` | +| symbol | Refleja el valor de la opción `symbol` | +| style\* | Refleja el valor de la opción `style` | -*: Esta variable solamente puede ser usada como parte de una cadena de caracteres de estilo +*: Esta variable sólo puede ser usada como parte de una cadena de estilo #### Comando personalizado del intérprete de comandos -`shell` acepta una lista no vacía de cadenas, donde: +`shell` accepts a non-empty list of strings, where: -- La primera cadena es la ruta al intérprete de comandos a usar para ejecutar el comando. -- Otros argumentos siguientes son pasados al shell. +- The first string is the path to the shell to use to execute the command. +- Other following arguments are passed to the shell. -Si no está activado, se retornará a STARSHIP_SHELL y luego a "sh" en Linux, y "cmd /C" en Windows. +If unset, it will fallback to STARSHIP_SHELL and then to "sh" on Linux, and "cmd /C" on Windows. -El `comando` será pasado en stdin. +The `command` will be passed in on stdin. -Si no se da el `shell` o solo contiene un elemento y Starship detecta PowerShell los siguientes argumentos se añadirán automáticamente: `-NoProfile -Command -`. Este comportamiento puede evitarse pasando explícitamente argumentos al intérprete, p.ej. +If `shell` is not given or only contains one element and Starship detects PowerShell will be used, the following arguments will automatically be added: `-NoProfile -Command -`. This behavior can be avoided by explicitly passing arguments to the shell, e.g. ```toml shell = ["pwsh", "-Command", "-"] ``` -::: advertencia Asegúrate de que tu configuración personalizada de shell salga con éxito +::: warning Make sure your custom shell configuration exits gracefully -Si establece un comando personalizado, asegúrese de que el Shell por defecto usado por starship ejecutará correctamente el comando con una salida elgante (a través de la opción `shell`). +If you set a custom command, make sure that the default Shell used by starship will properly execute the command with a graceful exit (via the `shell` option). -Por ejemplo, PowerShell requiere el parámetro `-Command` para ejecutar una sola línea. Omitir este parámetro puede arrojar a starchip a un bucle recursivo donde el shell podría intentar cargar un entorno de perfil completo con starship en sí misma y volver a ejecutar el comando personalizado, entrando en un bucle infinito. +For example, PowerShell requires the `-Command` parameter to execute a one liner. Omitting this parameter might throw starship into a recursive loop where the shell might try to load a full profile environment with starship itself again and hence re-execute the custom command, getting into a never ending loop. -Se recomiendan parámetros similares a `-NoProfile` en PowerShell para otros shells para evitar tiempo extra de carga de un perfil personalizado en cada invocación de starship. +Parameters similar to `-NoProfile` in PowerShell are recommended for other shells as well to avoid extra loading time of a custom profile on every starship invocation. -La detección automática de shells y la adición adecuada de parámetros están actualmente implementados, pero es posible que no todos los shells estén cubiertos. Por favor, [abre un issue](https://github.com/starship/starship/issues/new/choose) con los detalles del intérprete de comandos y la configuración de Starship si te encuentras en tal escenario. +Automatic detection of shells and proper parameters addition are currently implemented, but it's possible that not all shells are covered. [Please open an issue](https://github.com/starship/starship/issues/new/choose) with shell details and starship configuration if you hit such scenario. ::: @@ -3437,13 +3511,13 @@ La detección automática de shells y la adición adecuada de parámetros están # ~/.config/starship.toml [custom.foo] -command = "echo foo" # muestra la salida del comando -files = ["foo"] # puede especificar filtros pero no se admiten comodines +command = "echo foo" # shows output of command +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"] # filtra los archivos *.pst +extensions = ["pst"] # filters *.pst files shell = ["pwsh.exe", "-NoProfile", "-Command", "-"] ``` diff --git a/docs/es-ES/faq/README.md b/docs/es-ES/faq/README.md index 9c37865c..3dd650ed 100644 --- a/docs/es-ES/faq/README.md +++ b/docs/es-ES/faq/README.md @@ -1,4 +1,4 @@ -# Preguntas frecuentes (FAQ) +# Frequently Asked Questions ## ¿Cuál es la configuración usada en el GIF de demostración? @@ -38,7 +38,7 @@ NUM_JOBS=$(jobs -p | wc -l) PS1="$(starship prompt --status=$STATUS --jobs=$NUM_JOBS)" ``` -La [implementación de Bash](https://github.com/starship/starship/blob/master/src/init/starship.bash) integrada en Starship es un poco más compleja para permitir funciones avanzadas como el [módulo Duración del Comando](https://starship.rs/config/#command-duration) y para garantizar que Starship sea compatible con las configuraciones de Bash preinstaladas. +La [implementación de Bash](https://github.com/starship/starship/blob/master/src/init/starship.bash) en Starship es sensíblemente is ligeramente más compleja para permitir características avanzadas como [el módulo de duración de comando](https://starship.rs/config/#command-duration) y para asegurar que Starship es compatible con las configuraciones preinstaladas de Bash. Para obtener una lista de todos los parámetros aceptados por `el prompt de Starship`, usa el siguiente comando: diff --git a/docs/es-ES/guide/README.md b/docs/es-ES/guide/README.md index 8773de82..6efe876f 100644 --- a/docs/es-ES/guide/README.md +++ b/docs/es-ES/guide/README.md @@ -35,10 +35,10 @@

- Sitio Web - · + Sitio web + Instalación - · + Configuración

@@ -95,7 +95,7 @@ >Japonés   Português (Brasil)   Ruso   Vietnamita   Chino Mandarín   Chino Tradicional

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

Starship con iTerm 2 y el tema Snazzy @@ -158,7 +160,7 @@ - **Fácil:** rápido de instalar – empieza a usarlo en minutos.

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

@@ -171,12 +173,12 @@ ### Paso 1. Instalar Starship -Seleccione su sistema operativo de la lista de abajo para ver las instrucciones de instalación: +Select your operating system from the list below to view installation instructions:
Android -Instalar Starship usando cualquiera de los siguientes gestores de paquetes: +Install Starship using any of the following package managers: | Repositorio | Instrucciones | | --------------------------------------------------------------------------------- | ---------------------- | @@ -187,7 +189,7 @@ Instalar Starship usando cualquiera de los siguientes gestores de paquetes:
BSD -Instalar Starship usando cualquiera de los siguientes gestores de paquetes: +Install Starship using any of the following package managers: | Distribución | Repositorio | Instrucciones | | ---------------- | -------------------------------------------------------- | --------------------------------- | @@ -262,12 +264,12 @@ Instalar Starship usando cualquiera de los siguientes gestores de paquetes: ### Paso 2. Configura tu shell para usar Starship -Configure su shell para inicializar starship. Selecciona el tuyo de la lista de abajo: +Configure your shell to initialize starship. Selecciona el tuyo de la lista de abajo:
Bash -Añade el siguiente código al final de `~/.bashrc`: +Añade la siguiente línea al final de `~/.bashrc`: ```sh eval "$(starship init bash)" @@ -278,7 +280,7 @@ eval "$(starship init bash)"
Cmd -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: +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: ```lua load(io.popen('starship init cmd'):read("*a"))() @@ -295,7 +297,7 @@ Añade el siguiente código al final de `~/.elvish/rc.elv`: eval (starship init elvish) ``` -Nota: Solo se admite Elvish v0.17+ +Nota: Sólo se admite Elvish v0.17+
@@ -324,23 +326,28 @@ eval $(starship init ion)
Nushell -Añade lo siguiente al final de tu configuración de Nushell (encuéntrala ejecutando `config path`): +Run the following: -```toml -startup = [ - "mkdir ~/.cache/starship", - "starship init nu | save ~/.cache/starship/init.nu", - "source ~/.cache/starship/init.nu", -] -prompt = "starship_prompt" +```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`): + +```sh +starship init nu | save ~/.cache/starship/init.nu +source ~/.cache/starship/init.nu +``` + +Note: Only Nushell v0.60+ is supported +
PowerShell -Añade lo siguiente al final de tu configuración de PowerShell (encuéntrala ejecutando `$PROFILE`): +Add the following to the end of your PowerShell configuration (find it by running `$PROFILE`): ```powershell Invoke-Expression (&starship init powershell) @@ -383,25 +390,25 @@ eval "$(starship init zsh)" ### Paso 3. Configurar Starship -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! +Start a new shell instance, and you should see your beautiful new shell prompt. If you're happy with the defaults, enjoy! -Si estás buscando personalizar Starship: +If you're looking to further customize Starship: - **[Configuración](https://starship.rs/config/)** – aprende a configurar Starship para ajustar el prompt a tu gusto - **[Ajustes preestablecidos](https://starship.rs/presets/)** - inspírate en la configuración construida por otros -## 🤝 Colaborando +## 🤝 Contribuir -¡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). +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). -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 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 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. 👋 +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. 👋 ## 💭 Inspirado por -Por favor, revisa estos proyectos que inspiraron la creación de Starship. 🙏 +Please check out these previous works that helped inspire the creation of starship. 🙏 - **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** – Un prompt de ZSH para astronautas. @@ -411,9 +418,9 @@ Por favor, revisa estos proyectos que inspiraron la creación de Starship. 🙏


- Icono de Starship + Starship rocket icon

## 📝 Licencia -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). +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. diff --git a/docs/es-ES/installing/README.md b/docs/es-ES/installing/README.md index 17418514..f6e60dfd 100644 --- a/docs/es-ES/installing/README.md +++ b/docs/es-ES/installing/README.md @@ -1,4 +1,4 @@ -# 🚀 Instalación avanzada +# Advanced Installation Para instalar Starship, necesitas hacer dos cosas: @@ -57,7 +57,7 @@ nix-env -iA nixos.starship #### Declarativo, usuario único, a través de [home-manager](https://github.com/nix-community/home-manager) -Habilita el módulo `programs.starship` en tu archivo `home.nix` y añade tus configuraciones +Activa el módulo `programs.starship` en tu archivo `home.nix` y añade tus ajustes ```nix { @@ -78,10 +78,10 @@ Habilita el módulo `programs.starship` en tu archivo `home.nix` y añade tus co } ``` -then run +luego ejecutar ```sh -home-manager switch +interruptor home-manager ``` #### Declarativo, en todo el sistema, con NixOS diff --git a/docs/es-ES/presets/README.md b/docs/es-ES/presets/README.md index 8e2ae668..7b929f8c 100644 --- a/docs/es-ES/presets/README.md +++ b/docs/es-ES/presets/README.md @@ -4,32 +4,38 @@ Aqui tienes una colección de preajustes creados por la comunidad de Starship. To get details on how to use a preset, simply click on the image. -## [Símbolos de Nerd Font](./nerd-font) +## [Símbolos de Nerd Font](./nerd-font.md) This preset changes the symbols for each module to use Nerd Font symbols. [![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) -## [Segmentos entre Corchetes](./bracketed-segments) +## [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) -## [Símbolos de texto sin formato](./plain-text) +## [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. [![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) -## [No Runtime Versions](./no-runtimes) +## [No Runtime Versions](./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) -## [Pure Prompt](./pure-preset) +## [Pure Prompt](./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) + +## [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. + +[![Screenshot of Pastel Powerline preset](/presets/img/pastel-powerline.png "Click to view Pure Prompt preset")](./pastel-powerline) diff --git a/docs/es-ES/presets/bracketed-segments.md b/docs/es-ES/presets/bracketed-segments.md index 8c5b8512..6320bf5b 100644 --- a/docs/es-ES/presets/bracketed-segments.md +++ b/docs/es-ES/presets/bracketed-segments.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#bracketed-segments) +[Return to Presets](./README.md#bracketed-segments) # Bracketed Segments Preset diff --git a/docs/es-ES/presets/nerd-font.md b/docs/es-ES/presets/nerd-font.md index 908f0810..a35d2b8a 100644 --- a/docs/es-ES/presets/nerd-font.md +++ b/docs/es-ES/presets/nerd-font.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#nerd-font-symbols) +[Return to Presets](./README.md#nerd-font-symbols) # Nerd Font Symbols Preset diff --git a/docs/es-ES/presets/no-runtimes.md b/docs/es-ES/presets/no-runtimes.md index fec930be..bf6331b9 100644 --- a/docs/es-ES/presets/no-runtimes.md +++ b/docs/es-ES/presets/no-runtimes.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#no-runtime-versions) +[Return to Presets](./README.md#no-runtime-versions) # No Runtime Versions Preset diff --git a/docs/es-ES/presets/pastel-powerline.md b/docs/es-ES/presets/pastel-powerline.md new file mode 100644 index 00000000..d55aecd3 --- /dev/null +++ b/docs/es-ES/presets/pastel-powerline.md @@ -0,0 +1,17 @@ +[Return to Presets](./README.md#pastel-powerline) + +# Pastel Powerline Preset + +This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). It also shows how path substitution works in starship. + +![Screenshot of Pastel Powerline preset](/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) + +### Configuración + +[Click to download 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 3431ec57..f0faefe2 100644 --- a/docs/es-ES/presets/plain-text.md +++ b/docs/es-ES/presets/plain-text.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#plain-text-symbols) +[Return to Presets](./README.md#plain-text-symbols) ## Plain Text Symbols Preset diff --git a/docs/es-ES/presets/pure-preset.md b/docs/es-ES/presets/pure-preset.md index b8c3dd32..e122dfc7 100644 --- a/docs/es-ES/presets/pure-preset.md +++ b/docs/es-ES/presets/pure-preset.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#pure) +[Return to Presets](./README.md#pure) # Pure Preset diff --git a/docs/fr-FR/README.md b/docs/fr-FR/README.md index a0084f82..149b18f8 100644 --- a/docs/fr-FR/README.md +++ b/docs/fr-FR/README.md @@ -32,7 +32,7 @@ description: Starship est une invite minimaliste, ultra-rapide et hautement pers - Une [Nerd Font](https://www.nerdfonts.com/) est installée et activée dans votre terminal. -### Installation rapide +### Installation 1. Installer le binaire **starship** : @@ -100,7 +100,7 @@ description: Starship est une invite minimaliste, ultra-rapide et hautement pers #### Powershell - Ajoutez ce qui suit à la fin de `Microsoft.PowerShell_profile.ps1`. Vous pouvez vérifier l'emplacement de ce fichier en regardant la variable `$PROFILE` dans PowerShell. Habituellement, son chemin est `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` ou `~/.config/powershell/Microsoft.PowerShell_profile.ps1` sur -Nix. + Ajouter ce qui suit à la fin de `Microsoft.PowerShell_profile.ps1`. Vous pouvez vérifier l'emplacement de ce fichier en regardant la variable `$PROFILE` dans PowerShell. Habituellement, son chemin est `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` ou `~/.config/powershell/Microsoft.PowerShell_profile.ps1` sur -Nix. ```sh Invoke-Expression (&starship init powershell) @@ -144,17 +144,19 @@ description: Starship est une invite minimaliste, ultra-rapide et hautement pers #### Nushell - ::: warning Cela va changer dans le futur. Seule la version nu v0.33 ou supérieure est prise en charge. Ajoutez ce qui suit à votre fichier de configuration nu. Vous pouvez vérifier l'emplacement de ce fichier en exécutant `config path` dans 'nu'. - - ```toml - startup = [ - "mkdir ~/.cache/starship", - "starship init nu | save ~/.cache/starship/init.nu", - "source ~/.cache/starship/init.nu", - ] - prompt = "starship_prompt" + ::: warning Cela va changer dans le futur. Only Nushell v0.60+ is supported. ::: Run the following: + ```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`): + + ```sh + mkdir ~/.cache/starship + starship init nu | save ~/.cache/starship/init.nu + source ~/.cache/starship/init.nu + ``` #### Xonsh @@ -169,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. Ajoutez le code ci-dessous dans un fichier `starship.lua` et placez-le dans le dossier des scripts Clink: + 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: ```lua -- starship.lua diff --git a/docs/fr-FR/advanced-config/README.md b/docs/fr-FR/advanced-config/README.md index 8782275c..85d6f618 100644 --- a/docs/fr-FR/advanced-config/README.md +++ b/docs/fr-FR/advanced-config/README.md @@ -8,7 +8,7 @@ Les configurations dans cette section sont sujettes à modification dans les fut ::: -## Custom pre-prompt and pre-execution Commands in Cmd +## 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: @@ -32,7 +32,7 @@ end load(io.popen('starship init cmd'):read("*a"))() ``` -## Commandes pré-commande et pré-exécution personnalisées en Bash +## Commandes pré-invite et pré-exécution personnalisées en Bash Bash n'a pas de structure officielle préexec/précmd comme la plupart des autres shells. C'est pourquoi il est difficile de fournir des hooks entièrement personnalisables dans `bash`. Cependant, Starship vous permet dans une certaine mesure d'insérer vos propres fonctions dans la procédure de rendu du prompt : @@ -51,7 +51,7 @@ starship_precmd_user_func="blastoff" function blastoff(){ echo "🚀" } -trap blastoff DEBUG # Trap DEBUG *before* running starship +trap blastoff DEBUG # Capture DEBUG *avant* de lancer starship set -o functrace eval $(starship init bash) set +o functrace @@ -69,9 +69,9 @@ function Invoke-Starship-PreCommand { } ``` -## Changer le titre de la fenêtre +## Modifier le titre des fenêtres -Certaines commandes du shell changeront automatiquement le titre de la fenêtre (par exemple, pour refléter votre répertoire de travail). 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 does not do this, but it's fairly straightforward to add this functionality to `bash`, `zsh`, `cmd` or `powershell`. Tout d'abord, définissez une fonction de changement de titre de fenêtre (identique en bash et zsh) : @@ -97,7 +97,7 @@ precmd_functions+=(set_titre_fenetre) Si vous aimez le résultat, ajoutez ces lignes à votre fichier de configuration shell (`~/.bashrc` ou `~/.zshrc`) pour le rendre permanent. -Par exemple, si vous voulez afficher votre répertoire actuel dans le titre de l'onglet de votre terminal, ajoutez le code suivant à votre `~/.bashrc` ou `~/.zshrc`: +Par exemple, si vous voulez afficher votre dossier courant dans le titre de l'onglet de votre terminal, ajoutez le code suivant à votre `~/.bashrc` ou `~/.zshrc`: ```bash function set_win_title(){ @@ -196,7 +196,7 @@ La valeur `none` remplace toutes les autres valeurs si elle n'est pas incluse da Un spécificateur de couleur peut être l'un des éléments suivants : -- One of the standard terminal colors: `black`, `red`, `green`, `blue`, `yellow`, `purple`, `cyan`, `white`. You can optionally prefix these with `bright-` to get the bright version (e.g. `bright-white`). +- Une des couleurs de terminal standard: `black` (noir), `red` (rouge), `green` (vert), `blue` (bleu), `yellow` (jaune), `purple` (violet), `cyan` (cyan), `white` (blanc). Vous pouvez éventuellement les préfixer avec `bright-` pour obtenir la version claire (par exemple `bright-white`). - Un `#` suivi d'un nombre hexadécimal de six chiffres. Ceci spécifie un [ Code hexadécimal de couleur RVB ](https://www.w3schools.com/colors/colors_hexadecimal.asp). - Un nombre entre 0 et 255. Ceci spécifie un [code de couleur ANSI 8 bits](https://i.stack.imgur.com/KTSQa.png). diff --git a/docs/fr-FR/config/README.md b/docs/fr-FR/config/README.md index 435ec720..735bf19d 100644 --- a/docs/fr-FR/config/README.md +++ b/docs/fr-FR/config/README.md @@ -6,22 +6,22 @@ Pour commencer à configurer starship, créez le fichier suivant : `~/.config/st mkdir -p ~/.config && touch ~/.config/starship.toml ``` -Toute la configuration de starship est faite dans ce fichier [TOML](https://github.com/toml-lang/toml): +Toute la configuration de starship est effectuée dans ce fichier [TOML](https://github.com/toml-lang/toml) : ```toml -# Inserts a blank line between shell prompts +# Insère un saut de ligne entre les invites de commande add_newline = true -# 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" +# 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» -# Disable the package module, hiding it from the prompt completely +# Désactive le module «package», le cachant complètement de l’invite [package] disabled = true ``` -Vous pouvez changer l'emplacement par défaut du fichier avec la variable d'environnement `STARSHIP_CONFIG` : +Vous pouvez choisir l'emplacement du fichier avec la variable d'environnement `STARSHIP_CONFIG`: ```sh export STARSHIP_CONFIG=~/example/non/default/path/starship.toml @@ -33,7 +33,7 @@ De manière équivalente, pour Powershell (Windows), ajoutez la ligne suivante $ENV:STARSHIP_CONFIG = "$HOME\example\non\default\path\starship.toml" ``` -Or for Cmd (Windows) would be adding this line to your `starship.lua`: +Ou pour Cmd (Windows) ajouter cette ligne à votre `starship.lua`: ```lua os.setenv('STARSHIP_CONFIG', 'C:\\Users\\user\\example\\non\\default\\path\\starship.toml') @@ -53,7 +53,7 @@ De manière équivalente, pour Powershell (Windows), ajoutez la ligne suivante $ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp" ``` -Or for Cmd (Windows) would be adding this line to your `starship.lua`: +Ou pour Cmd (Windows) ajouter cette ligne à votre `starship.lua`: ```lua os.setenv('STARSHIP_CACHE', 'C:\\Users\\user\\AppData\\Local\\Temp') @@ -61,7 +61,7 @@ os.setenv('STARSHIP_CACHE', 'C:\\Users\\user\\AppData\\Local\\Temp') ### Terminologie -**Module**: Un composant dans l'invite donnant des informations basées sur des informations contextuelles à propos de votre Système d'Exploitation. Par exemple, le module "nodejs" montre la version de Node.js qui est actuellement installée sur votre ordinateur, si votre répertoire actuel est un projet Node.js. +**Module**: Un composant dans l'invite donnant des informations basées sur des informations contextuelles à propos de votre système d'exploitation. Par exemple, le module "nodejs" montre la version de Node.js qui installée sur votre ordinateur, si votre dossier actuel est un projet Node.js. **Variable**: Petits sous-composants qui contiennent des informations fournies par le module. Par exemple, la variable "version" dans le module "nodejs" contient la version actuelle de Node.js. @@ -150,7 +150,7 @@ Voici la liste des options de configuration de l'invite en lui-même. | Option | Défaut | Description | | ----------------- | ------------------------------ | --------------------------------------------------------------------------- | | `format` | [lien](#default-prompt-format) | Configure le format de l'invite. | -| `right_format` | `""` | See [Enable Right Prompt](/advanced-config/#enable-right-prompt) | +| `right_format` | `""` | Voir [Activer le prompt à droite](/advanced-config/#enable-right-prompt) | | `scan_timeout` | `30` | Délai d'attente pour que starship scanne les fichiers (en millisecondes). | | `command_timeout` | `500` | Délai maximal pour les commandes exécutées par starship (en millisecondes). | | `add_newline` | `true` | Insère une ligne vide entre les invites du shell. | @@ -166,7 +166,7 @@ format = """ [│](bold green)$directory$rust$package [└─>](bold green) """ -# Attendez 10 millisecondes pour que starship vérifie les fichiers dans le répertoire de travail. +# Attendez 10 millisecondes pour que starship vérifie les fichiers dans le dossier courant. scan_timeout = 10 # Désactive la nouvelle ligne au début de l'invite @@ -180,7 +180,7 @@ Le `format` par défaut est utilisé pour définir le format de l'invite, si il ```toml format = "$all" -# Which is equivalent to +# Ce qui est équivalent à format = """ $username\ $hostname\ @@ -198,6 +198,7 @@ $git_status\ $hg_branch\ $docker_context\ $package\ +$buf\ $cmake\ $cobol\ $container\ @@ -208,6 +209,7 @@ $elixir\ $elm\ $erlang\ $golang\ +$haskell\ $helm\ $java\ $julia\ @@ -255,13 +257,13 @@ $character""" Si vous voulez étendre le format par défaut, pour pouvoir utiliser `$all` ; les modules que vous ajouter explicitement au format ne seront pas dupliqués. Par ex. ```toml -# Move the directory to the second line +# Déplace le dossier à la ligne suivante format = "$all$directory$character" ``` ## AWS -The `aws` module shows the current AWS region and profile when credentials or a `credential_process` 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. +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. 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. @@ -273,14 +275,15 @@ Lorsque vous utilisez [AWSume](https://awsu.me) le profil est lu à partir de la ### Options -| Option | Default | Description | -| ------------------- | -------------------------------------------------------------------- | ------------------------------------------------------------------- | -| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | Format du module. | -| `symbol` | `"☁️ "` | Le symbole affiché avant le profil AWS actuel. | -| `region_aliases` | | Table des alias de région à afficher en plus du nom AWS. | -| `style` | `"bold yellow"` | Le style du module. | -| `expiration_symbol` | `X` | Le symbole 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`. | ### Variables @@ -308,6 +311,8 @@ symbol = "🅰 " [aws.region_aliases] ap-southeast-2 = "au" us-east-1 = "va" +[aws.profile_aliases] +CompanyGroupFrobozzOnCallAccess = 'Frobozz' ``` #### Afficher la région @@ -333,20 +338,22 @@ us-east-1 = "va" format = "on [$symbol$profile]($style) " style = "bold blue" symbol = "🅰 " +[aws.profile_aliases] +Enterprise_Naming_Scheme-voidstars = 'void**' ``` ## Azure -The `azure` module shows the current Azure Subscription. This is based on showing the name of the default subscription, as defined in the `~/.azure/azureProfile.json` file. +Le module `azure` affiche l'abonnement Azure actuel. Ceci est basé sur l'affichage du nom de l'abonnement par défaut, tel que défini dans le fichier `~/.azure/azureProfile.json`. ### Options -| Variable | Default | Description | -| ---------- | ---------------------------------------- | ------------------------------------------------------ | -| `format` | `"on [$symbol($subscription)]($style) "` | Le format utilisé pour faire le rendu du module Azure. | -| `symbol` | `"ﴃ "` | Le symbole utilisé dans le format. | -| `style` | `"blue bold"` | Le style utilisé dans le format. | -| `disabled` | `true` | Désactive le module `azure`. | +| Variable | Défaut | Description | +| ---------- | ---------------------------------------- | ---------------------------------------- | +| `format` | `"on [$symbol($subscription)]($style) "` | Le format pour le rendu du module Azure. | +| `symbol` | `"ﴃ "` | Le symbole utilisé dans le format. | +| `style` | `"blue bold"` | Le style utilisé dans le format. | +| `disabled` | `true` | Désactive le module `azure`. | ### Exemple @@ -414,60 +421,93 @@ L'option `display` est une array de la table suivante. #### Exemple ```toml -[[battery.display]] # "bold red" style and discharging_symbol when capacity is between 0% and 10% +[[battery.display]] # style "bold red" et discharging_symbol quand la batterie est entre 0% et 10% threshold = 10 style = "bold red" -[[battery.display]] # "bold yellow" style and 💦 symbol when capacity is between 10% and 30% +[[battery.display]] # style "bold yellow" et symbole 💦 quand la batterie est entre 10% et 30% threshold = 30 style = "bold yellow" discharging_symbol = "💦" -# when capacity is over 30%, the battery indicator will not be displayed +# quand la batterie est au-dessus de 30%, l’indicateur de batterie ne sera pas affiché ``` -## Character +## Buf -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 module `buf` affiche la version de [Buf](https://buf.build) installée. Par défaut, le module sera affiché si l’une de ces conditions est remplie: -Le caractère vous dira si la dernière commande a été réussie ou pas. Cela peut être fait de deux manières: +- La commande [`buf`](https://github.com/bufbuild/buf) est installée. +- Le dossier actuel contient un fichier de configuration [`buf.yaml`](https://docs.buf.build/configuration/v1/buf-yaml), [`buf.gen.yaml`](https://docs.buf.build/configuration/v1/buf-gen-yaml) ou [`buf.work.yaml`](https://docs.buf.build/configuration/v1/buf-work-yaml). -- changement de couleur (`red`/`green`) -- changement de forme (`❯`/`✖`) +### Options -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). +| Option | Défaut | Description | +| ------------------- | ------------------------------------------------------------ | ------------------------------------------------------ | +| `format` | `'with [$symbol($version \(Buf $buf_version\) )]($style)'` | Le format du module `buf`. | +| `version_format` | `"v${raw}"` | Le format de la version. | +| `symbol` | `"🦬 "` | Le symbole utilisé avant d’afficher la version de Buf. | +| `detect_extensions` | `[]` | Quelles extensions devraient activer ce module. | +| `detect_files` | `["buf.yaml", "buf.gen.yaml", "buf.work.yaml"]` | Les fichiers qui activent ce module. | +| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. | +| `style` | `"bold blue"` | Le style du module. | +| `disabled` | `false` | Désactive le module `elixir`. | + +### Variables + +| Variable | Exemple | Description | +| ------------- | -------- | -------------------------------------- | +| `buf_version` | `v1.0.0` | La version de `buf` | +| `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 + +[buf] +symbol = "🦬 " +``` + +## Caractère + +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 caractère vous dira si la dernière commande a été réussie ou pas. Il peut faire ça de deux façons: + +- 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). ::: warning -`error_symbol` is not supported on nu shell. - -::: - -::: warning - -`vicmd_symbol` is only supported in cmd, fish and zsh. +`vicmd_symbol` n’est supporté que dans cmd, fish et zsh. ::: ### Options -| Option | Défaut | Description | -| ---------------- | ------------------- | ----------------------------------------------------------------------------- | -| `format` | `"$symbol "` | Le format utilisée avant l'entrée de texte. | -| `success_symbol` | `"[❯](bold green)"` | Le format utilisé avant l'entrée de texte si la commande précédente a réussi. | -| `error_symbol` | `"[❯](bold red)"` | Le format utilisé avant l'entrée de texte si la commande précédente a échoué. | -| `vicmd_symbol` | `"[❮](bold green)"` | Le format utilisé avant l'entrée de texte si le shell est en mode vim normal. | -| `disabled` | `false` | Désactive le module `character`. | +| Option | Défaut | Description | +| ---------------- | ------------------- | -------------------------------------------------------------------------------- | +| `format` | `"$symbol "` | 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`. | ### Variables -| Variable | Exemple | Description | -| -------- | ------- | --------------------------------------------------------------- | -| symbol | | Reflète sois `success_symbol`, `error_symbol` ou `vicmd_symbol` | +| Variable | Exemple | Description | +| -------- | ------- | --------------------------------------------------------------------- | +| symbol | | A mirror of either `success_symbol`, `error_symbol` or `vicmd_symbol` | ### Exemples -#### Avec une forme d'erreur personnalisée +#### Avec un caractère d'erreur personnalisé ```toml # ~/.config/starship.toml @@ -477,7 +517,7 @@ success_symbol = "[➜](bold green) " error_symbol = "[✗](bold red) " ``` -#### Sans forme d'erreur personnalisée +#### Sans caractère d'erreur personnalisé ```toml # ~/.config/starship.toml @@ -498,10 +538,10 @@ vicmd_symbol = "[V](bold green) " ## CMake -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 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 répertoire actuel contient un fichier `CMakeLists.txt` -- Le répertoire actuel contient un fichier ` CMakeCache.txt` +- Le dossier courant contient un fichier `CMakeLists.txt` +- Le dossier courant contient un fichier `CMakeCache.txt` ### Options @@ -509,10 +549,10 @@ Le module `cmake` affiche la version actuellement installée de [CMake](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` | `"△ "` | 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 | +| `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 | | `style` | `"bold blue"` | Le style du module. | | `disabled` | `false` | Désactive le module `cmake`. | @@ -528,10 +568,10 @@ Le module `cmake` affiche la version actuellement installée de [CMake](https:// ## COBOL / GNUCOBOL -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 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 répertoire courant contient un fichier finissant par `.cob` ou `.COB` -- Le répertoire courant contiens un fichier finissant par `.cbl` ou `.CBL` +- Le dossier courant contient un fichier finissant par `.cob` ou `.COB` +- Le dossier courant contiens un fichier finissant par `.cbl` ou `.CBL` ### Options @@ -542,8 +582,8 @@ Le module `cobol` affiche la version de COBOL installée. Par défaut, le module | `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | | `style` | `"bold blue"` | Le style du module. | | `detect_extensions` | `["cbl", "cob", "CBL", "COB"]` | Quelles extensions devraient activer ce module. | -| `detect_files` | `[]` | Quels fichiers devraient activer ce module. | -| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. | +| `detect_files` | `[]` | Les fichiers qui activent ce module. | +| `detect_folders` | `[]` | Les dossiers qui activent ce module. | | `disabled` | `false` | Désactive le module `cobol`. | ### Variables @@ -558,35 +598,35 @@ Le module `cobol` affiche la version de COBOL installée. Par défaut, le module ## Temps d'exécution -Le module `cmd_duration` montre le temps qu'a pris la dernière commande a pris 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. +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. -::: attention, n'accrochez pas la trappe DEBUG en Bash +::: warning Do not hook the DEBUG trap in Bash -Si vous utilisez starship en `bash`, n'accrochez pas `DEBUG` après avoir exécuté `eval $(starship init $0)`, ou ce module **cassera**. +If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. ::: -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. +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. ### Options | 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. | +| `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` | 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). | +| `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. | ### Variables -| Variable | Exemple | Description | -| --------- | -------- | --------------------------------------------- | -| duration | `16m40s` | Le temps nécessaire pour exécuter la commande | -| style\* | | Reflète la valeur de l'option `style` | +| Variable | Exemple | Description | +| --------- | -------- | --------------------------------------- | +| duration | `16m40s` | The time it took to execute the command | +| style\* | | Reflète la valeur de l'option `style` | *: Cette variable peut uniquement être utilisée dans une chaine de style @@ -602,32 +642,32 @@ format = "underwent [$duration](bold yellow)" ## Conda -Le module `conda` affiche l’environnement [Conda](https://docs.conda.io/en/latest/) courant, si `$CONDA_DEFAULT_ENV` est définie. +The `conda` module shows the current [Conda](https://docs.conda.io/en/latest/) environment, if `$CONDA_DEFAULT_ENV` is set. ::: tip -Cela ne supprime pas le modificateur d'invite de conda, vous pouvez exécuter `conda config --set changeps1 False`. +This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. ::: ### Options -| 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`. | +| 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`. | ### Variables -| 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` | +| 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` | *: Cette variable peut uniquement être utilisée dans une chaine de style @@ -646,18 +686,18 @@ The `container` module displays a symbol and container name, if inside a contain ### 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` | Disables the `container` module. | +| 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`. | ### Variables | Variable | Exemple | Description | | --------- | ------------------- | -------------------------------------- | -| name | `fedora-toolbox:35` | The name of the container | +| name | `fedora-toolbox:35` | Le nom du conteneur | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -674,10 +714,10 @@ format = "[$symbol \\[$name\\]]($style) " ## Crystal -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 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 répertoire courant contient un fichier `shard.yml` -- Le répertoire courant contient un fichier `.cr` +- Le dossier courant contient un fichier `shard.yml` +- Le dossier courant contient un fichier `.cr` ### Options @@ -686,17 +726,17 @@ Le module `crystal` affiche la version actuellement installée de [Crystal](http | `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 green"` | Le style du module. | +| `style` | `"bold red"` | Le style du module. | | `detect_extensions` | `["cr"]` | Quelles extensions devraient activer ce module. | -| `detect_files` | `["shard.yml"]` | Quels fichiers devraient activer ce module. | -| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. | +| `detect_files` | `["shard.yml"]` | Les fichiers qui activent ce module. | +| `detect_folders` | `[]` | Les dossiers qui activent ce module. | | `disabled` | `false` | Désactive le module `crystal`. | ### Variables | Variable | Exemple | Description | | --------- | --------- | -------------------------------------- | -| version | `v0.32.1` | La version de `cristal` | +| version | `v0.32.1` | La version de `crystal` | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -713,11 +753,11 @@ format = "via [✨ $version](bold blue) " ## Dart -Le module `dart` affiche la version actuellement installée de [Dart](https://dart.dev/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: +Le 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 répertoire courant contient un fichier `.dart` -- Le répertoire courant contient un répertoire `.dart_tool` -- Le répertoire courant contient un fichier `pubspec.yaml`, `pubspec.yml` ou `pubspec.lock` +- Le dossier courant contient un fichier avec l’extension `.dart` +- Le dossier courant contient un fichier `.dart_tool` +- Le dossier courant contient un fichier `pubsepc.yaml`, `pubspec.yml` ou `pubspec.lock` ### Options @@ -725,10 +765,10 @@ Le module `dart` affiche la version actuellement installée de [Dart](https://da | ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------------ | | `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` | `"🎯 "` | Une chaîne de caractères représentant le symbole de Dart | +| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | | `detect_extensions` | `["dart"]` | Quelles extensions devraient activer ce module. | -| `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | Quels fichiers devraient activer ce module. | -| `detect_folders` | `[".dart_tool"]` | Quels dossiers 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. | | `style` | `"bold blue"` | Le style du module. | | `disabled` | `false` | Désactive le module `dart`. | @@ -753,9 +793,9 @@ format = "via [🔰 $version](bold red) " ## Deno -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 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: -- The current directory contains a `deno.json`, `deno.jsonc`, `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file +- Le dossier courant contient un fichier `deno.json`, `deno.jsonc`, `mod.ts`, `mod.js`, `deps.ts` ou `deps.js` ### Options @@ -763,10 +803,10 @@ Le module `deno` affiche la version actuellement installée de [Deno](https://de | ------------------- | ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | | `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` | `"🦕 "` | Une chaîne de caractères représentant le symbole de Deno | +| `symbol` | `"🦕 "` | A format string representing the symbol of Deno | | `detect_extensions` | `[]` | Quelles extensions devraient activer ce module. | -| `detect_files` | `["deno.json", "deno.jsonc", "mod.ts", "mod.js", "deps.ts", "deps.js"]` | Quels fichiers devraient activer ce module. | -| `detect_folders` | `[]` | Quels dossiers 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. | | `style` | `"green bold"` | Le style du module. | | `disabled` | `false` | Désactive le module `deno`. | @@ -789,39 +829,39 @@ format = "via [🦕 $version](green bold) " ## Dossier -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. +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. -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. +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. -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. +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`. ### Options | 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. | +| `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` | `"🔒"` | 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: "…/" | +| `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` | `"~"` | Le symbole indiquant le répertoire personnel. | +| `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) |
-Ce module possède quelques options de configuration avancées qui contrôlent l'affichage du répertoire. +This module has a few advanced configuration options that control how the directory is displayed. -| 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. | +| 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. | -`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. +`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. ```toml [directory.substitutions] @@ -829,7 +869,7 @@ Par exemple, donné `~/Dev/Nix/nixpkgs/pkgs` où `nixpkgs` est la racine du repo "src/com/long/java/path" = "mypath" ``` -`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`. +`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`.
@@ -837,7 +877,7 @@ Par exemple, donné `~/Dev/Nix/nixpkgs/pkgs` où `nixpkgs` est la racine du repo | Variable | Exemple | Description | | --------- | --------------------- | ------------------------------------- | -| path | `"D:/Projects"` | Le chemin du répertoire courant | +| path | `"D:/Projects"` | The current directory path | | style\* | `"black bold dimmed"` | Reflète la valeur de l'option `style` | *: Cette variable peut uniquement être utilisée dans une chaine de style @@ -867,28 +907,28 @@ truncation_length = 8 truncation_symbol = "…/" ``` -## Contexte Docker +## 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). ### Options -| 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`. | +| 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`. | ### Variables | Variable | Exemple | Description | | --------- | -------------- | -------------------------------------- | -| context | `test_context` | Le contexte actuel de Docker | +| context | `test_context` | Le contexte docker courant | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -905,9 +945,9 @@ format = "via [🐋 $context](blue bold)" ## Dotnet -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. +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. -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 : +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` @@ -918,9 +958,9 @@ Par défaut, ce module ne sera affiché dans votre invite que lorsqu'un ou plusi - `*.fsproj` - `*.xproj` -Vous aurez également besoin du SDK .NET Core pour pouvoir l'utiliser correctement. +You'll also need the .NET Core SDK installed in order to use it correctly. -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. +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. @@ -930,10 +970,10 @@ The module will also show the Target Framework Moniker ([\\w-]+)" = "gke-$var_cluster" ``` -## Saut de ligne +## Line Break -Le module `line_break` sépare l'invite en deux lignes. +The `line_break` module separates the prompt into two lines. ### Options | Option | Défaut | Description | | ---------- | ------- | ----------------------------------------------------------------------- | -| `disabled` | `false` | Désactive le module `line_break` , faisant de l'invite une seule ligne. | +| `disabled` | `false` | Désactive le module `line_break`, mettant l'invite sur une seule ligne. | ### Exemple @@ -1902,7 +1977,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) "` | Format du module. | | `style` | `"bold yellow"` | Le style du module. | -| `disabled` | `true` | Disables the `localip` module. | +| `disabled` | `true` | Désactive le module `localip`. | ### Variables @@ -1926,11 +2001,11 @@ disabled = false ## Lua -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: +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 répertoire courant contient un fichier `.lua-version` -- Le répertoire courant contient un répertoire `lua` -- Le répertoire actuel contient un fichier avec l'extension `.lua` +- Le dossier courant contient un fichier `.lua-version` +- Le dossier courant contient un dossier `lua` +- Le dossier courant contient un fichier avec l’extension `.lua` ### Options @@ -1938,19 +2013,19 @@ Le module `lua` affiche la version actuellement installée de [Lua](http://www.l | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------ | | `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` | `"🌙 "` | Une chaîne de caractères représentant le symbole de Lua. | +| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. | | `detect_extensions` | `["lua"]` | Quelles extensions devraient activer ce module. | -| `detect_files` | `[".lua-version"]` | Quels fichiers devraient activer ce module. | -| `detect_folders` | `["lua"]` | Quels dossiers 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"` | Configure le binaire lua que Starship exécute lors de l'obtention de la version. | +| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. | | `disabled` | `false` | Désactive le module `lua`. | ### Variables | Variable | Exemple | Description | | --------- | -------- | -------------------------------------- | -| version | `v5.4.0` | La version de `lua` | +| version | `v5.4.0` | The version of `lua` | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -1965,40 +2040,40 @@ Le module `lua` affiche la version actuellement installée de [Lua](http://www.l format = "via [🌕 $version](bold blue) " ``` -## Utilisation mémoire +## Memory Usage -Le module `memory_usage` affiche la mémoire système actuelle et l'utilisation de swap. +The `memory_usage` module shows current system memory and swap usage. -Par défaut, l'utilisation du swap est affichée si le swap total du système n'est pas nul. +By default the swap usage is displayed if the total system swap is non-zero. ::: tip -Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### Options -| Option | Défaut | Description | -| ----------- | ----------------------------------------------- | ------------------------------------------------------------------------------ | -| `threshold` | `75` | Masquer l'utilisation de la mémoire à moins qu'elle ne dépasse ce pourcentage. | -| `format` | `"via $symbol [${ram}( \| ${swap})]($style) "` | Format du module. | -| `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`. | +| 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`. | ### Variables -| Variable | Exemple | Description | -| ---------------- | ------------- | ------------------------------------------------------------------------------- | -| ram | `31GiB/65GiB` | La mémoire système utilisée/totale . | -| ram_pct | `48%` | Le pourcentage de la mémoire du système actuel. | -| swap\*\* | `1GiB/4GiB` | La taille de la mémoire swap du fichier de mémoire swap du système courant. | -| swap_pct\*\* | `77%` | Le poucentage de la mémoire swap du fichier de mémoire swap du système courant. | -| symbol | `🐏` | Reflète la valeur de l'option `symbol` | -| style\* | | Reflète la valeur de l'option `style` | +| Variable | Exemple | Description | +| ---------------- | ------------- | ------------------------------------------------------------------ | +| ram | `31GiB/65GiB` | The usage/total RAM of the current system memory. | +| ram_pct | `48%` | The percentage of the current system memory. | +| swap\*\* | `1GiB/4GiB` | The swap memory size of the current system swap memory file. | +| swap_pct\*\* | `77%` | The swap memory percentage of the current system swap memory file. | +| 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 *\*: Les informations sur le fichier SWAP est uniquement affichée si détectée sur le système courant +*: This variable can only be used as a part of a style string *\*: The SWAP file information is only displayed if detected on the current system ### Exemple @@ -2012,26 +2087,26 @@ symbol = " " style = "bold dimmed green" ``` -## Branche Mercurial +## Mercurial Branch -Le module `hg_branch` affiche la branche active du dépôt dans votre répertoire courant. +The `hg_branch` module shows the active branch of the repo in your current directory. ### Options -| 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`. | +| 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`. | ### Variables | Variable | Exemple | Description | | --------- | -------- | -------------------------------------- | -| branch | `master` | La branche mercuriale active | +| branch | `master` | The active mercurial branch | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -2050,23 +2125,23 @@ truncation_symbol = "" ## Nim -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: +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 répertoire courant contient un fichier `nim.cfg` -- Le répertoire actuel contient un fichier avec l'extension `.nim` -- Le répertoire actuel contient un fichier avec l'extension `.nims` -- Le répertoire actuel contient un fichier avec l'extension `.nimble` +- Le dossier courant contient un fichier `nim.cfg` +- Le dossier courant contient un fichier avec l’extension `.nim` +- Le dossier courant contient un fichier avec l’extension `.nims` +- Le dossier courant contient un fichier avec l’extension `.nimble` ### Options | Option | Défaut | Description | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | Format du module | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module | | `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"👑 "` | Le symbole utilisé avant d'afficher la version de Nim. | +| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. | | `detect_extensions` | `["nim", "nims", "nimble"]` | Quelles extensions devraient activer ce module. | -| `detect_files` | `["nim.cfg"]` | Quels fichiers devraient activer ce module. | -| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. | +| `detect_files` | `["nim.cfg"]` | Les fichiers qui activent ce module. | +| `detect_folders` | `[]` | Les dossiers qui activent ce module. | | `style` | `"bold yellow"` | Le style du module. | | `disabled` | `false` | Désactive le module `nim`. | @@ -2074,7 +2149,7 @@ Le module `nim` affiche la version actuellement installée de [Nim](https://nim- | Variable | Exemple | Description | | --------- | -------- | -------------------------------------- | -| version | `v1.2.0` | La version de `nim` | +| version | `v1.2.0` | The version of `nimc` | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -2096,14 +2171,14 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/ ### Options -| 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`. | +| 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`. | ### Variables @@ -2130,34 +2205,34 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' ## Node.js -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: +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 répertoire courant contient un fichier `package.json` -- Le répertoire courant contient un fichier `.node-version` -- Le répertoire courant contient un fichier `.nvmrc` -- Le répertoire courant contient un répertoire `node_modules` -- Le répertoire actuel contient un fichier avec l'extension `.js`, `.mjs` ou `.cjs` -- Le répertoire actuel contient un fichier avec l'extension `.ts` +- 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 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` ### Options -| Option | Défaut | Description | -| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | Format du module. | -| `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | -| `symbol` | `" "` | Une chaîne de caractères représentant le symbole de Node.js. | -| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Quelles extensions devraient activer ce module. | -| `detect_files` | `["package.json", ".node-version"]` | Quels fichiers devraient activer ce module. | -| `detect_folders` | `["node_modules"]` | Quels dossiers devraient activer ce module. | -| `style` | `"bold green"` | Le style du module. | -| `disabled` | `false` | Désactive le module `nodejs`. | -| `not_capable_style` | `bold red` | The style for the module when an engines property in package.json does not match the Node.js version. | +| Option | Défaut | Description | +| ------------------- | ------------------------------------------ | ----------------------------------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Format du module. | +| `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | +| `symbol` | `" "` | A format string representing the symbol of 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. | +| `style` | `"bold green"` | Le style du module. | +| `disabled` | `false` | Désactive le module `nodejs`. | +| `not_capable_style` | `bold red` | The style for the module when an engines property in package.json does not match the Node.js version. | ### Variables | Variable | Exemple | Description | | --------- | ---------- | -------------------------------------- | -| version | `v13.12.0` | La version de `node` | +| version | `v13.12.0` | The version of `node` | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -2174,14 +2249,14 @@ format = "via [🤖 $version](bold green) " ## OCaml -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: +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 répertoire courant contient un fichier avec l'extension `.opam` ou le répertoire `_opam` -- Le répertoire courant contient un répertoire `esy.lock` -- Le répertoire courant contient un fichier `dune` ou `dune-project` -- Le répertoire courant contient un fichier `jbuild` ou `jbuild-ignore` -- Le répertoire courant contient un fichier `.merlin` -- Le répertoire actuel contient un fichier avec l'extension `.ml`, `.mli`, `.re` ou `.rei` +- Le dossier courant contient un fichier avec l’extension `.opam` ou un dossier `_opam` +- The current directory contains a `esy.lock` directory +- Le dossier courant contient un fichier `dune` ou `dune-project` +- Le dossier courant contient un fichier `jbuild` ou `jbuild-ignore` +- Le dossier courant contient un fichier `.merlin` +- Le dossier courant contient un fichier avec l’extension `.ml`, `.mli`, `.re` ou `.rei` ### Options @@ -2189,12 +2264,12 @@ Le module `ocaml` affiche la version actuellement installée de [OCaml](https:// | ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | | `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` | `"🐫 "` | 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. | +| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. | +| `global_switch_indicator` | `""` | The format string used to represent global OPAM switch. | +| `local_switch_indicator` | `"*"` | The format string used to represent local OPAM switch. | | `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | Quelles extensions devraient activer ce module. | -| `detect_files` | `["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]` | Quels fichiers devraient activer ce module. | -| `detect_folders` | `["_opam", "esy.lock"]` | Quels dossiers 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. | | `style` | `"bold yellow"` | Le style du module. | | `disabled` | `false` | Désactive le module `ocaml`. | @@ -2202,7 +2277,7 @@ Le module `ocaml` affiche la version actuellement installée de [OCaml](https:// | Variable | Exemple | Description | | ---------------- | ------------ | ----------------------------------------------------------------- | -| version | `v4.10.0` | La version de `ocaml` | +| version | `v4.10.0` | The version of `ocaml` | | switch_name | `my-project` | The active OPAM switch | | switch_indicator | | Mirrors the value of `indicator` for currently active OPAM switch | | symbol | | Reflète la valeur de l'option `symbol` | @@ -2228,7 +2303,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` | `"☁️ "` | Le symbole utilisé avant d'afficher le cloud OpenStack actuel. | +| `symbol` | `"☁️ "` | The symbol used before displaying the current OpenStack cloud. | | `style` | `"bold yellow"` | Le style du module. | | `disabled` | `false` | Désactive le module `openstack`. | @@ -2254,16 +2329,16 @@ style = "bold yellow" symbol = "☁️ " ``` -## Version du package +## Package Version -The `package` module is shown when the current directory is the repository for a package, and shows its current version. Le module gère actuellement les paquets `npm`, `nimble`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards` et `dart`. +The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards` and `dart` packages. -- [**npm**](https://docs.npmjs.com/cli/commands/npm) – La version du paquet `npm` est extraite du `package.json` présent dans le répertoire courant -- [**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 +- [**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 @@ -2273,16 +2348,16 @@ 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/) – La version du paquet `dart` est extrait du `pubspec.yaml` présent dans le répertoire courant +- [**Dart**](https://pub.dev/) - The `dart` package version is extracted from the `pubspec.yaml` present in the current directory -> ⚠️ La version montrée est celle du paquet dont le code source est dans votre répertoire courant, pas votre gestionnaire de paquet. +> ⚠️ La version montrée est celle du paquet dont le code source est dans votre dossier courant, pas votre gestionnaire de paquet. ### Options | Option | Défaut | Description | | ----------------- | --------------------------------- | ------------------------------------------------------------------------------------------ | | `format` | `"is [$symbol$version]($style) "` | Format du module. | -| `symbol` | `"📦 "` | Le symbole utilisé avant d'afficher la version du paquet. | +| `symbol` | `"📦 "` | The symbol used before displaying the version the package. | | `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | | `style` | `"bold 208"` | Le style du module. | | `display_private` | `false` | Enable displaying version for packages marked as private. | @@ -2292,7 +2367,7 @@ The `package` module is shown when the current directory is the repository for a | Variable | Exemple | Description | | --------- | -------- | -------------------------------------- | -| version | `v1.0.0` | La version de votre package | +| version | `v1.0.0` | The version of your package | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -2309,13 +2384,13 @@ format = "via [🎁 $version](208 bold) " ## Perl -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: +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 répertoire courant contient un fichier `Makefile.PL` ou `Build.PL` -- Le répertoire courant contient un fichier `cpanfile` ou `cpanfile.snapshot` -- Le répertoire courant contient un fichier `META.json` ou `META.yml` -- Le répertoire courant contient un fichier `.perl-version` -- Le répertoire courant contient un fichier `.pl`, `.pm` ou `.pod` +- 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` ### Options @@ -2323,10 +2398,10 @@ Le module `perl` affiche la version actuellement installée de [Perl](https://ww | ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------ | | `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` | `"🐪 "` | Le symbole utilisé avant d'afficher la version de Perl | +| `symbol` | `"🐪 "` | The symbol used before displaying the version of 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"]` | Quels fichiers devraient activer ce module. | -| `detect_folders` | `[]` | Quels dossiers 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. | | `style` | `"bold 149"` | Le style du module. | | `disabled` | `false` | Désactive le module `perl`. | @@ -2334,7 +2409,7 @@ Le module `perl` affiche la version actuellement installée de [Perl](https://ww | Variable | Exemple | Description | | --------- | --------- | -------------------------------------- | -| version | `v5.26.1` | La version de `perl` | +| version | `v5.26.1` | The version of `perl` | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -2349,11 +2424,11 @@ format = "via [🦪 $version]($style) " ## PHP -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: +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 répertoire courant contient un fichier `composer.json` -- Le répertoire courant contient un fichier `.php-version` -- Le répertoire courant contient un fichier avec l'extension `.php` +- Le dossier courant contient un fichier `composer.json` +- Le dossier courant contient un fichier `.php-version` +- The current directory contains a `.php` extension ### Options @@ -2361,10 +2436,10 @@ Le module `php` affiche la version actuellement installée de [PHP](https://www. | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------ | | `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` | `"🐘 "` | Le symbole utilisé avant d'afficher la version de PHP. | +| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | | `detect_extensions` | `["php"]` | Quelles extensions devraient activer ce module. | -| `detect_files` | `["composer.json", ".php-version"]` | Quels fichiers devraient activer ce module. | -| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. | +| `detect_files` | `["composer.json", ".php-version"]` | Les fichiers qui activent ce module. | +| `detect_folders` | `[]` | Les dossiers qui activent ce module. | | `style` | `"147 bold"` | Le style du module. | | `disabled` | `false` | Désactive le module `php`. | @@ -2372,7 +2447,7 @@ Le module `php` affiche la version actuellement installée de [PHP](https://www. | Variable | Exemple | Description | | --------- | -------- | -------------------------------------- | -| version | `v7.3.8` | La version de `php` | +| version | `v7.3.8` | The version of `php` | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -2397,7 +2472,7 @@ By default the Pulumi version is not shown, since it takes an order of magnitude ::: -Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: +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` @@ -2410,17 +2485,17 @@ Par défaut le module sera activé si au moins l'une des conditions suivantes es | `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | | `symbol` | `" "` | A format string shown before the Pulumi stack. | | `style` | `"bold 5"` | Le style du module. | -| `disabled` | `false` | Disables the `pulumi` module. | +| `disabled` | `false` | Désactive le module `pulumi`. | ### Variables -| Variable | Exemple | Description | -| ----------------- | ---------- | -------------------------------------- | -| version | `v0.12.24` | The version of `pulumi` | -| stack | `dev` | The current Pulumi stack | -| nom d'utilisateur | `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` | 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` | *: Cette variable peut uniquement être utilisée dans une chaine de style @@ -2446,10 +2521,10 @@ format = "[$symbol$stack]($style) " ## PureScript -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: +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 répertoire courant contient un fichier `spago.dhall` -- Le répertoire actuel contient un fichier avec l'extension `.purs` +- Le dossier courant contient un fichier `spago.dhall` +- Le dossier courant contient un fichier avec l’extension `.purs` ### Options @@ -2457,10 +2532,10 @@ Le module `purescript` affiche la version actuellement installée de [PureScript | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"<=> "` | Le symbole utilisé avant d'afficher la version de PureScript. | +| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | | `detect_extensions` | `["purs"]` | Quelles extensions devraient activer ce module. | -| `detect_files` | `["spago.dhall"]` | Quels fichiers devraient activer ce module. | -| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. | +| `detect_files` | `["spago.dhall"]` | Les fichiers qui activent ce module. | +| `detect_folders` | `[]` | Les dossiers qui activent ce module. | | `style` | `"bold white"` | Le style du module. | | `disabled` | `false` | Désactive le module `purescript`. | @@ -2468,7 +2543,7 @@ Le module `purescript` affiche la version actuellement installée de [PureScript | Variable | Exemple | Description | | --------- | -------- | -------------------------------------- | -| version | `0.13.5` | La version de `purescript` | +| version | `0.13.5` | The version of `purescript` | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -2485,21 +2560,21 @@ format = "via [$symbol$version](bold white)" ## Python -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é. +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`. -Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: +By default the module will be shown if any of the following conditions are met: -- Le répertoire courant contient un fichier `.python-version` -- Le répertoire courant contient un fichier `Pipfile` -- Le répertoire courant contient un fichier `__init__.py` -- Le répertoire courant contient un fichier `pyproject.toml` -- Le répertoire courant contient un fichier `requirements.txt` -- Le répertoire courant contient un fichier `setup.py` -- Le répertoire courant contient un fichier `tox.ini` -- Le répertoire actuel contient un fichier avec l'extension `.py`. -- Un environnement virtuel est actuellement activé +- Le dossier courant contient un fichier `.python-version` +- Le dossier courant contient un fichier `Pipfile` +- Le dossier courant contient un fichier `__init__.py` +- Le dossier courant contient un fichier `pyproject.toml` +- Le dossier courant contient un fichier `requirements.txt` +- Le dossier courant contient un fichier `setup.py` +- Le dossier courant contient un fichier `tox.ini` +- Le dossier courant contient un fichier avec l’extension `.py`. +- A virtual environment is currently activated ### Options @@ -2507,14 +2582,14 @@ Par défaut le module sera activé si au moins l'une des conditions suivantes es | -------------------- | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | | `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` | `"🐍 "` | Une chaîne de caractères représentant le symbole de Python | +| `symbol` | `"🐍 "` | A format string representing the symbol of Python | | `style` | `"yellow bold"` | Le style du module. | | `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"]` | 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 | +| `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` | Désactive le module `python`. | ::: tip @@ -2529,7 +2604,7 @@ The default values and order for `python_binary` was chosen to first identify th | Variable | Exemple | Description | | ------------ | --------------- | ------------------------------------------ | -| version | `"v3.8.1"` | La version de `python` | +| 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` | @@ -2549,7 +2624,7 @@ pyenv_version_name = true # ~/.config/starship.toml [python] -# N'utilisez que le binaire `python3` pour obtenir la version. +# Only use the `python3` binary to get the version. python_binary = "python3" ``` @@ -2557,7 +2632,7 @@ python_binary = "python3" # ~/.config/starship.toml [python] -# Ne pas déclencher pour les fichiers avec l'extension py +# Don't trigger for files with the py extension detect_extensions = [] ``` @@ -2565,25 +2640,24 @@ detect_extensions = [] # ~/.config/starship.toml [python] -# Affiche la version de python depuis l'intérieur d'un venv local. +# Display the version of python from inside a local venv. # -# Notez que cela ne fonctionnera que lorsque le venv est à l'intérieur du projet, -# et uniquement lorsque vous vous situez dans le répertoire contenant le dossier du venv -# mais peut-être que c'est suffisant? +# Note this will only work when the venv is inside the project and it will only +# work in the directory that contains the venv dir but maybe this is ok? python_binary = ["./venv/bin/python", "python", "python3", "python2"] ``` ## R -Le module `rlang` affiche la version de [R](https://www.r-project.org/) actuellement installée. Le module s’affiche si l’une de ces conditions est remplie : +The `rlang` module shows the currently installed version of [R](https://www.r-project.org/). The module will be shown if any of the following conditions are met: -- Le répertoire actuel contient un fichier avec l'extension `.R`. -- Le répertoire actuel contient un fichier avec l'extension `.Rd`. -- Le répertoire actuel contient un fichier avec l'extension `.Rmd`. -- Le répertoire actuel contient un fichier avec l'extension `.Rproj`. -- Le répertoire actuel contient un fichier avec l'extension `.Rsx`. -- Le répertoire courant contient un fichier `.Rprofile` -- Le répertoire courant contient un dossier `.Rproj.user` +- Le dossier courant contient un fichier avec l’extension `.R`. +- Le dossier courant contient un fichier avec l’extension `.Rd`. +- Le dossier courant contient un fichier avec l’extension `.Rmd`. +- 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 ### Options @@ -2591,18 +2665,18 @@ Le module `rlang` affiche la version de [R](https://www.r-project.org/) actuelle | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------ | | `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` | `"📐"` | Une chaîne de caractères représentant le symbole de R. | +| `symbol` | `"📐"` | A format string representing the symbol of R. | | `style` | `"blue bold"` | Le style du 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 | +| `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` | Désactive le module `r`. | ### Variables | Variable | Exemple | Description | | -------- | ------------- | -------------------------------------- | -| version | `v4.0.5` | La version de `R` | +| version | `v4.0.5` | The version of `R` | | symbol | | Reflète la valeur de l'option `symbol` | | style | `"blue bold"` | Reflète la valeur de l'option `style` | @@ -2617,9 +2691,9 @@ format = "with [📐 $version](blue bold) " ## Red -Par défaut, le module `red` affiche la version actuellement installée de [Red](https://www.red-lang.org/). Le module est affiché si l'une de ces conditions est remplie : +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 : -- Le répertoire actuel contient un fichier avec l'extension `.red` ou `.reds` +- Le dossier courant contient un fichier avec l’extension `.red` ou `.reds` ### Options @@ -2627,10 +2701,10 @@ Par défaut, le module `red` affiche la version actuellement installée de [Red] | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------ | | `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` | `"🔺 "` | Une chaîne de caractères représentant le symbole de Red. | +| `symbol` | `"🔺 "` | A format string representing the symbol of Red. | | `detect_extensions` | `["red"]` | Quelles extensions devraient activer ce module. | -| `detect_files` | `[]` | Quels fichiers devraient activer ce module. | -| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. | +| `detect_files` | `[]` | Les fichiers qui activent ce module. | +| `detect_folders` | `[]` | Les dossiers qui activent ce module. | | `style` | `"red bold"` | Le style du module. | | `disabled` | `false` | Désactive le module `red`. | @@ -2638,7 +2712,7 @@ Par défaut, le module `red` affiche la version actuellement installée de [Red] | Variable | Exemple | Description | | --------- | -------- | -------------------------------------- | -| version | `v2.5.1` | La version de `red` | +| version | `v2.5.1` | The version of `red` | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -2655,14 +2729,14 @@ symbol = "🔴 " ## Ruby -Par défaut, le module `ruby` affiche la version actuellement installée de [Ruby](https://www.ruby-lang.org/). Le module est affiché si l'une de ces conditions est remplie : +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 : -- Le répertoire courant contient un fichier `Gemfile` -- Le répertoire courant contient un fichier `.ruby-version` -- Le répertoire courant contient un fichier `.rb` -- La variable d’environnement `RUBY_VERSION` ou `RBENV_VERSION` est définie +- 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 -Starship obtient la version actuelle de Ruby en exécutant `ruby -v`. +Starship gets the current Ruby version by running `ruby -v`. ### Options @@ -2670,19 +2744,19 @@ Starship obtient la version actuelle de Ruby en exécutant `ruby -v`. | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"💎 "` | Une chaîne de caractères représentant le symbole de Ruby. | +| `symbol` | `"💎 "` | A format string representing the symbol of Ruby. | | `detect_extensions` | `["rb"]` | Quelles extensions devraient activer ce module. | -| `detect_files` | `["Gemfile", ".ruby-version"]` | Quels fichiers devraient activer ce module. | -| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. | -| `detect_variables` | `["RUBY_VERSION", "RBENV_VERSION"]` | Les variables d’environnement qui activent ce module. | -| `style` | `"bold green"` | Le style du 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. | | `disabled` | `false` | Désactive le module `ruby`. | ### Variables | Variable | Exemple | Description | | --------- | -------- | -------------------------------------- | -| version | `v2.5.1` | La version de `ruby` | +| version | `v2.5.1` | The version of `ruby` | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -2699,10 +2773,10 @@ symbol = "🔺 " ## Rust -Par défaut, le module `rust` affiche la version actuellement installée de [Rust](https://www.rust-lang.org/). Le module est affiché si l'une de ces conditions est remplie : +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 : -- Le répertoire courant contient un fichier `Cargo.toml` -- Le répertoire actuel contient un fichier avec l'extension `.rs` +- Le dossier courant contient un fichier `Cargo.toml` +- Le dossier courant contient un fichier avec l’extension `.rs` ### Options @@ -2710,18 +2784,18 @@ Par défaut, le module `rust` affiche la version actuellement installée de [Rus | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------ | | `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` | `"🦀 "` | Une chaîne de caractères représentant le symbole de Rust | +| `symbol` | `"🦀 "` | A format string representing the symbol of Rust | | `detect_extensions` | `["rs"]` | Quelles extensions devraient activer ce module. | -| `detect_files` | `["Cargo.toml"]` | Quels fichiers devraient activer ce module. | -| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. | -| `style` | `"bold green"` | Le style du 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. | | `disabled` | `false` | Désactive le module `rust`. | ### Variables | Variable | Exemple | Description | | --------- | ----------------- | -------------------------------------- | -| version | `v1.43.0-nightly` | La version de `rustc` | +| version | `v1.43.0-nightly` | The version of `rustc` | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -2738,11 +2812,11 @@ format = "via [⚙️ $version](red bold)" ## Scala -Le module `scala` affiche la version actuellement installée de [Scala](https://www.scala-lang.org/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: +The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). By default the module will be shown if any of the following conditions are met: -- Le répertoire courant contient un fichier `build.sbt`, `.scalaenv` ou `.sbtenv` -- Le répertoire actuel contient un fichier avec l'extension `.scala` ou `.sbt` -- Le répertoire courant contient un répertoire nommé `.metals` +- 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` ### Options @@ -2751,9 +2825,9 @@ Le module `scala` affiche la version actuellement installée de [Scala](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` | | `detect_extensions` | `["sbt", "scala"]` | Quelles extensions devraient activer ce module. | -| `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Quels fichiers 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` | `"🆂 "` | Une chaîne de caractères représentant le symbole de Scala. | +| `symbol` | `"🆂 "` | A format string representing the symbol of Scala. | | `style` | `"red dimmed"` | Le style du module. | | `disabled` | `false` | Désactive le module `scala`. | @@ -2761,7 +2835,7 @@ Le module `scala` affiche la version actuellement installée de [Scala](https:// | Variable | Exemple | Description | | --------- | -------- | -------------------------------------- | -| version | `2.13.5` | La version de `scala` | +| version | `2.13.5` | The version of `scala` | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -2782,7 +2856,7 @@ The `shell` module shows an indicator for currently used shell. ::: tip -Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -2790,13 +2864,13 @@ Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur | Option | Défaut | Description | | ---------------------- | ------------------------- | ------------------------------------------------------------ | -| `bash_indicator` | `bsh` | Une chaîne de format utilisée pour représenter bash. | -| `fish_indicator` | `fsh` | Une chaîne de format utilisée pour représenter fish. | -| `zsh_indicator` | `zsh` | Une chaîne de format utilisée pour représenter zsh. | -| `powershell_indicator` | `psh` | Une chaîne de format utilisée pour représenter powershell. | -| `ion_indicator` | `ion` | Une chaîne de format utilisée pour représenter ion. | -| `elvish_indicator` | `esh` | Une chaîne de format utilisée pour représenter elvish. | -| `tcsh_indicator` | `tsh` | Une chaîne de format utilisée pour représenter tcsh. | +| `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. | @@ -2810,7 +2884,7 @@ Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur | Variable | Défaut | Description | | --------- | ------ | ---------------------------------------------------------- | | indicator | | Mirrors the value of `indicator` for currently used shell. | -| style\* | | Reflète la valeur de l'option `style`. | +| style\* | | Mirrors the value of option `style`. | *: Cette variable peut uniquement être utilisée dans une chaine de style @@ -2822,7 +2896,7 @@ Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur [shell] fish_indicator = "" powershell_indicator = "_" -unknown_indicator = "mystery shell" +unknown_indicator = "shell mystère" style = "cyan bold" disabled = false ``` @@ -2869,12 +2943,12 @@ The `singularity` module shows the current [Singularity](https://sylabs.io/singu ### Options -| 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`. | +| 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`. | ### Variables @@ -2897,28 +2971,26 @@ format = '[📦 \[$env\]]($style) ' ## Status -Le module `status` affiche le code de sortie de la commande précédente. Le module ne sera affiché que si le code de sortie n’est pas `0`. The status code will cast to a signed 32-bit integer. +The `status` module displays the exit code of the previous command. If $success_symbol is empty (default), the module will be shown only if the exit code is not `0`. The status code will cast to a signed 32-bit integer. ::: tip -Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: -::: warning This module is not supported on nu shell. ::: - ### Options | Option | Défaut | Description | | ----------------------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------- | | `format` | `"[$symbol$status]($style) "` | The format of the module | | `symbol` | `"✖"` | The symbol displayed on program error | -| `success_symbol` | `"✔️"` | The symbol displayed on program success | +| `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 green"` | Le style du module. | +| `style` | `"bold red"` | 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 | @@ -2930,10 +3002,10 @@ Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur | Variable | Exemple | Description | | -------------- | ------- | ------------------------------------------------------------------------------------------- | -| 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 | +| 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 | @@ -2950,8 +3022,9 @@ Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur [status] style = "bg:blue" -symbol = "🔴" -format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) ' +symbol = "🔴 " +success_symbol = "🟢 SUCCESS" +format = '[\[$symbol$common_meaning$signal_name$maybe_int\]]($style) ' map_symbol = true disabled = false ``` @@ -2962,7 +3035,7 @@ The `sudo` module displays if sudo credentials are currently cached. The module ::: tip -Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -2974,7 +3047,7 @@ Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur | `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. | -| `disabled` | `true` | Disables the `sudo` module. | +| `disabled` | `true` | Désactive le module `sudo`. | ### Variables @@ -2997,7 +3070,7 @@ disabled = false ``` ```toml -# Sous Windows +# On windows # $HOME\.starship\config.toml [sudo] @@ -3007,10 +3080,10 @@ disabled = false ## Swift -Par défaut, le module `swift` affiche la version actuellement installée de [Swift](https://swift.org/). Le module est affiché si l'une de ces conditions est remplie : +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 : -- Le répertoire courant contient un fichier `Package.swift` -- Le répertoire actuel contient un fichier avec l'extension `.swift` +- Le dossier courant contient un fichier `Package.swift` +- Le dossier courant contient un fichier avec l’extension `.swift` ### Options @@ -3018,10 +3091,10 @@ Par défaut, le module `swift` affiche la version actuellement installée de [Sw | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------ | | `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` | `"🐦 "` | Une chaîne de caractères représentant le symbole de Swift | +| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | | `detect_extensions` | `["swift"]` | Quelles extensions devraient activer ce module. | -| `detect_files` | `["Package.swift"]` | Quels fichiers devraient activer ce module. | -| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. | +| `detect_files` | `["Package.swift"]` | Les fichiers qui activent ce module. | +| `detect_folders` | `[]` | Les dossiers qui activent ce module. | | `style` | `"bold 202"` | Le style du module. | | `disabled` | `false` | Désactiver le module `swift`. | @@ -3029,7 +3102,7 @@ Par défaut, le module `swift` affiche la version actuellement installée de [Sw | Variable | Exemple | Description | | --------- | -------- | -------------------------------------- | -| version | `v5.2.4` | La version de `swift` | +| version | `v5.2.4` | The version of `swift` | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -3054,10 +3127,10 @@ By default the Terraform version is not shown, since this is slow for current ve ::: -Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: +By default the module will be shown if any of the following conditions are met: -- Le répertoire courant contient un dossier `.terraform` -- Le répertoire courant contient un fichier avec l’extension `.tf`, `.tfplan` ou `.tfstate` +- The current directory contains a `.terraform` folder +- Le dossier courant contient un fichier avec l’extension `.tf`, `.tfplan` ou `.tfstate` ### Options @@ -3065,10 +3138,10 @@ Par défaut le module sera activé si au moins l'une des conditions suivantes es | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------ | | `format` | `"via [$symbol$workspace]($style) "` | La chaîne de format pour le module. | | `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"💠"` | Une chaîne de format montrée avant l'espace de travail terraform. | +| `symbol` | `"💠"` | A format string shown before the terraform workspace. | | `detect_extensions` | `["tf", "tfplan", "tfstate"]` | Quelles extensions devraient activer ce module. | -| `detect_files` | `[]` | Quels fichiers devraient activer ce module. | -| `detect_folders` | `[".terraform"]` | Quels dossiers devraient activer ce module. | +| `detect_files` | `[]` | Les fichiers qui activent ce module. | +| `detect_folders` | `[".terraform"]` | Les dossiers qui activent ce module. | | `style` | `"bold 105"` | Le style du module. | | `disabled` | `false` | Désactive le module `terraform`. | @@ -3076,7 +3149,7 @@ Par défaut le module sera activé si au moins l'une des conditions suivantes es | Variable | Exemple | Description | | --------- | ---------- | -------------------------------------- | -| version | `v0.12.24` | La version de `terraform` | +| version | `v0.12.24` | The version of `terraform` | | workspace | `default` | The current Terraform workspace | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -3105,27 +3178,27 @@ format = "[🏎💨 $workspace]($style) " ## Date et Heure -Le module `time` affiche l'heure actuelle **localement**. La valeur de `format` est utilisée par le package [`chrono`](https://crates.io/crates/chrono) pour contrôler la façon dont l'heure est affichée. Consultez la [doc de chrono strftime](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) pour découvrir les options disponibles. +The `time` module shows the current **local** time. The `format` configuration value is used by the [`chrono`](https://crates.io/crates/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) to see what options are available. ::: tip -Ce module est désactivé par défaut. Pour l'activer, configurez `disabled` sur `false` dans votre fichier de configuration. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### Options -| Option | Défaut | Description | -| ----------------- | ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `format` | `"at [$time]($style) "` | La chaîne de format pour le module. | -| `use_12hr` | `false` | Activer le format 12h | -| `time_format` | voir plus bas | Le [format chrono](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) utilisé pour formater l'heure. | -| `style` | `"bold yellow"` | Le style utilisé par le module | -| `utc_time_offset` | `"local"` | Définir le décalage horaire UTC à utiliser. Intervalle de -24 < x < 24. Accepte des nombres décimaux pour s'adapter aux décalages de 30/45 minutes. | -| `disabled` | `true` | Dé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` | 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 | -If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Sinon, il est défini comme `"%T"`. Manually setting `time_format` will override the `use_12hr` setting. +If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Otherwise, it defaults to `"%T"`. Manually setting `time_format` will override the `use_12hr` setting. ### Variables @@ -3149,14 +3222,14 @@ utc_time_offset = "-5" time_range = "10:00:00-14:00:00" ``` -## Nom d'utilisateur +## Username -Le module `username` affiche le nom d'utilisateur de l'utilisateur actif. Le module est affiché si l'une de ces conditions est remplie : +The `username` module shows active user's username. Le module est affiché si l'une de ces conditions est remplie : -- L'utilisateur courant est root -- 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 +- 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 ::: tip @@ -3166,20 +3239,20 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, ` ### Options -| Option | Défaut | Description | -| ------------- | ----------------------- | ------------------------------------------------ | -| `style_root` | `"bold green"` | Le style utilisé quand l'utilisateur est root. | -| `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`. | +| 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`. | ### Variables | Variable | Exemple | Description | | -------- | ------------ | ------------------------------------------------------------------------------------------- | | `style` | `"red bold"` | Mirrors the value of option `style_root` when root is logged in and `style_user` otherwise. | -| `user` | `"matchai"` | L’identifiant de l’utilisateur courant. | +| `user` | `"matchai"` | The currently logged-in user ID. | ### Exemple @@ -3196,9 +3269,9 @@ show_always = true ## Vagrant -Le module `vagrant` affiche la version actuellement installée de [Vagrant](https://www.vagrantup.com/). Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: +The `vagrant` module shows the currently installed version of [Vagrant](https://www.vagrantup.com/). By default the module will be shown if any of the following conditions are met: -- Le répertoire courant contient un fichier `Vagrantfile` +- Le dossier courant contient un fichier `Vagrantfile` ### Options @@ -3206,10 +3279,10 @@ Le module `vagrant` affiche la version actuellement installée de [Vagrant](http | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------ | | `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` | `"⍱ "` | Une chaîne de caractères représentant le symbole de Vagrant. | +| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | | `detect_extensions` | `[]` | Quelles extensions devraient activer ce module. | -| `detect_files` | `["Vagrantfile"]` | Quels fichiers devraient activer ce module. | -| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. | +| `detect_files` | `["Vagrantfile"]` | Les fichiers qui activent ce module. | +| `detect_folders` | `[]` | Les dossiers qui activent ce module. | | `style` | `"cyan bold"` | Le style du module. | | `disabled` | `false` | Désactive le module `vagrant`. | @@ -3217,7 +3290,7 @@ Le module `vagrant` affiche la version actuellement installée de [Vagrant](http | Variable | Exemple | Description | | --------- | ---------------- | -------------------------------------- | -| version | `Vagrant 2.2.10` | La version de `Vagrant` | +| version | `Vagrant 2.2.10` | The version of `Vagrant` | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -3234,10 +3307,10 @@ format = "via [⍱ $version](bold white) " ## V -Le module `vlang` affiche la version de [V](https://vlang.io/) installée. Par défaut le module sera activé si au moins l'une des conditions suivantes est remplie: +The `vlang` module shows you your currently installed version of [V](https://vlang.io/). By default the module will be shown if any of the following conditions are met: -- Le répertoire courant contient un fichier avec l'extension `.v` -- Le répertoire courant contient un fichier `v.mod`, `vpkg.json` ou `.vpkg-lock.json` +- Le dossier courant contient un fichier avec l’extension `.v` +- Le dossier courant contient un fichier `v.mod`, `vpkg.json` ou `.vpkg-lock.json` ### Options @@ -3245,10 +3318,10 @@ Le module `vlang` affiche la version de [V](https://vlang.io/) installée. Par d | ------------------- | -------------------------------------------- | ------------------------------------------------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | Format du module. | | `version_format` | `"v${raw}"` | Le format de la version. Les variables disponibles sont `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"V "` | Une chaîne de caractères représentant le symbole de V | +| `symbol` | `"V "` | A format string representing the symbol of V | | `detect_extensions` | `["v"]` | Quelles extensions devraient activer ce module. | -| `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Quels fichiers devraient activer ce module. | -| `detect_folders` | `[]` | Quels dossiers 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. | | `style` | `"blue bold"` | Le style du module. | | `disabled` | `false` | Désactive le module `vlang`. | @@ -3256,7 +3329,7 @@ Le module `vlang` affiche la version de [V](https://vlang.io/) installée. Par d | Variable | Exemple | Description | | --------- | ------- | -------------------------------------- | -| version | `v0.2` | La version de `v` | +| version | `v0.2` | The version of `v` | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -3274,20 +3347,20 @@ The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/v ### Options -| 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`. | +| 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`. | ### Variables -| Variable | Exemple | Description | -| --------- | ----------------------------------------------- | -------------------------------------- | -| repo | `dotfiles` si dans un dépôt VCSH nommé 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` 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` | *: Cette variable peut uniquement être utilisée dans une chaine de style @@ -3302,9 +3375,9 @@ format = "[🆅 $repo](bold blue) " ## Zig -Par défaut, le module `zig` affiche la version actuellement installée de [Zig](https://ziglang.org/). Le module est affiché si l'une de ces conditions est remplie : +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 : -- Le répertoire courant contient un fichier `.zig` +- Le dossier courant contient un fichier `.zip` ### Options @@ -3312,18 +3385,18 @@ Par défaut, le module `zig` affiche la version actuellement installée de [Zig] | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------------ | | `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` | `"↯ "` | Le symbole utilisé avant d'afficher la version de Zig. | +| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | | `style` | `"bold yellow"` | Le style du module. | | `disabled` | `false` | Désactive le module `zig`. | | `detect_extensions` | `["zig"]` | Quelles extensions devraient activer ce module. | -| `detect_files` | `[]` | Quels fichiers devraient activer ce module. | -| `detect_folders` | `[]` | Quels dossiers devraient activer ce module. | +| `detect_files` | `[]` | Les fichiers qui activent ce module. | +| `detect_folders` | `[]` | Les dossiers qui activent ce module. | ### Variables | Variable | Exemple | Description | | --------- | -------- | -------------------------------------- | -| version | `v0.6.0` | La version de `zig` | +| version | `v0.6.0` | La version de `zip` | | symbol | | Reflète la valeur de l'option `symbol` | | style\* | | Reflète la valeur de l'option `style` | @@ -3344,9 +3417,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` +- Le dossier courant contient un fichier dont le nom est dans `files` - The current directory contains a directory whose name is in `directories` -- The current directory contains a file whose extension is in `extensions` +- Le dossier courant contient un fichier dont l’extension est dans `extensions` - The `when` command returns 0 - The current Operating System (std::env::consts::OS) matchs with `os` field if defined. @@ -3387,10 +3460,10 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt | `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` | `""` | Le symbole utilisé avant d'afficher la sortie de la commande. | +| `symbol` | `""` | The symbol used before displaying the command output. | | `style` | `"bold green"` | Le style du module. | | `format` | `"[$symbol($output )]($style)"` | Format du module. | -| `disabled` | `false` | Désactive le module `custom`. | +| `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). | ### Variables @@ -3405,9 +3478,9 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt #### Commandes shell personnalisées -`shell` accepte une liste de chaînes non vide, où: +`shell` accepts a non-empty list of strings, where: -- La première chaîne est le chemin vers le shell à utiliser pour exécuter la commande. +- The first string is the path to the shell to use to execute the command. - Other following arguments are passed to the shell. If unset, it will fallback to STARSHIP_SHELL and then to "sh" on Linux, and "cmd /C" on Windows. @@ -3438,13 +3511,13 @@ Automatic detection of shells and proper parameters addition are currently imple # ~/.config/starship.toml [custom.foo] -command = "echo foo" # shows output of command -files = ["foo"] # can specify filters but wildcards are not supported +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 when = """ test "$HOME" == "$PWD" """ format = " transcending [$output]($style)" [custom.time] command = "time /T" -extensions = ["pst"] # filters *.pst files +extensions = ["pst"] # filtre les fichiers *.pst shell = ["pwsh.exe", "-NoProfile", "-Command", "-"] ``` diff --git a/docs/fr-FR/faq/README.md b/docs/fr-FR/faq/README.md index 00622216..c1ebf808 100644 --- a/docs/fr-FR/faq/README.md +++ b/docs/fr-FR/faq/README.md @@ -23,7 +23,7 @@ Oui, ils peuvent tous deux être utilisés pour désactiver les modules dans l'i ## La documentation dit que Starship est shell-agnostique. Pourquoi mon shell préféré n'est-il pas pris en charge ? -Étant donné la façon dont Starship est construit, il devrait être possible d'ajouter le support pour pratiquement n'importe quel shell. Starship est sans état et agnostique, donc tant que votre shell supporte la personnalisation de l'invite de commande et l'expansion, Starship peut être utilisé. +Étant donné la façon dont Starship est construit, il devrait être possible d'ajouter le support pour pratiquement n'importe quel shell. Le binaire de Starship est sans état et agnostique, donc tant que votre shell supporte la personnalisation rapide et l'expansion du shell, Starship peut être utilisé. Voici un petit exemple pour que Starship fonctionne avec bash : @@ -40,17 +40,17 @@ PS1="$(starship prompt --status=$STATUS --jobs=$NUM_JOBS)" [L'implémentation Bash](https://github.com/starship/starship/blob/master/src/init/starship.bash) intégrée dans Starship est légèrement plus complexe pour permettre des fonctionnalités avancées comme le [module Durée de commande](https://starship.rs/config/#command-duration) et pour s'assurer que Starship est compatible avec les configurations Bash préinstallées. -Pour une liste de tous les flags acceptés par `starship`, utilisez la commande suivante : +Pour une liste de tous les flags acceptés par `starship prompt`, utilisez la commande suivante : ```sh starship prompt --help ``` -L'invite utilisera autant de contexte que possible, mais aucun paramètre n'est "requis". +L'invite de commande utilisera toutes les données contextuelles fournies, mais aucun indicateur n'est "requis". ## Comment utiliser Starship sur des distributions Linux avec des versions de glibc plus ancienne ? -Si vous obtenez une erreur du type "_version 'GLIBC_2.18' not found (required by starship)_" lors de l'utilisation de l'exécutable précompilé (par exemple sur CentOS 6 ou 7), vous pouvez utiliser un exécutable compilé avec `musl` au lieu de `glibc`: +Si vous obtenez une erreur du type "_version 'GLIBC_2.18' not found (required by starship)_" lors de l'utilisation du binaire précompilé (par exemple sur CentOS 6 ou 7), vous pouvez utiliser un binaire compilé avec `musl` au lieu de `glibc`: ```sh curl -sS https://starship.rs/install.sh | sh -s -- --platform unknown-linux-musl diff --git a/docs/fr-FR/guide/README.md b/docs/fr-FR/guide/README.md index 35fd4572..d350cc5d 100644 --- a/docs/fr-FR/guide/README.md +++ b/docs/fr-FR/guide/README.md @@ -139,11 +139,13 @@ />

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

Starship avec iTerm2 et le thème Snazzy @@ -262,7 +264,7 @@ Installez Starship en utilisant l’un de ces gestionnaires de paquets: ### Étape 2. Configurer votre shell pour Starship -Configurez votre shell pour initialiser starship. Sélectionnez le vôtre dans la liste ci-dessous : +Configurez votre shell pour initialiser starship. Sélectionnez le vôtre dans la liste ci-dessous:
Bash @@ -278,7 +280,7 @@ eval "$(starship init bash)"
Cmd -Vous devez utiliser [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) avec Cmd. Créez un fichier avec le chemin `%LocalAppData%\clink\starship.lua` et le contenu suivant: +Vous devez utiliser [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) avec Cmd. Créez le fichier `%LocalAppData%\clink\starship.lua` avec le contenu suivant: ```lua load(io.popen('starship init cmd'):read("*a"))() @@ -295,14 +297,14 @@ 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.17+ est supporté
Fish -Ajoutez le code suivant à la fin de `~/.config/fish/config.fish`: +Ajoute ce qui suit à la fin de `~/.config/fish/config.fish`: ```fish starship init fish | source @@ -324,23 +326,28 @@ eval $(starship init ion)
Nushell -Ajoutez le code suivant à la fin de votre configuration de Nushell (trouvez-la en exécutant `config path`) : +Run the following: -```toml -startup = [ - "mkdir ~/.cache/starship", - "starship init nu | save ~/.cache/starship/init.nu", - "source ~/.cache/starship/init.nu", -] -prompt = "starship_prompt" +```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`): + +```sh +starship init nu | save ~/.cache/starship/init.nu +source ~/.cache/starship/init.nu +``` + +Note: Only Nushell v0.60+ is supported +
PowerShell -Ajoutez ce qui suit à la fin de votre configuration PowerShell (trouvez-la en exécutant `$PROFILE`) : +Add the following to the end of your PowerShell configuration (find it by running `$PROFILE`): ```powershell Invoke-Expression (&starship init powershell) @@ -383,9 +390,9 @@ eval "$(starship init zsh)" ### Étape 3. Configurer Starship -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! +Start a new shell instance, and you should see your beautiful new shell prompt. If you're happy with the defaults, enjoy! -Si vous souhaitez personnaliser Starship: +If you're looking to further customize Starship: - **[Configuration](https://starship.rs/config/)** – apprenez à configurer Starship pour ajuster votre prompt à vos préférences @@ -393,15 +400,15 @@ Si vous souhaitez personnaliser Starship: ## 🤝 Contribuer -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). +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). -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 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 ê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. 👋 +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. 👋 ## 💭Inspiré par -Jetez un œil aux précédents projets qui ont inspiré la création de starship. 🙏 +Please check out these previous works that helped inspire the creation of starship. 🙏 - **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** – Un prompt ZSH pour les astronautes. @@ -411,9 +418,9 @@ Jetez un œil aux précédents projets qui ont inspiré la création de starship


- Icône de roquette de Starship + Starship rocket icon

## 📝 License -Copyright © 2019-présent, [contributeurs de Starship](https://github.com/starship/starship/graphs/contributors).
Ce projet est sous licence [ISC](https://github.com/starship/starship/blob/master/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. diff --git a/docs/fr-FR/installing/README.md b/docs/fr-FR/installing/README.md index 587074d4..73d78ce3 100644 --- a/docs/fr-FR/installing/README.md +++ b/docs/fr-FR/installing/README.md @@ -1,4 +1,4 @@ -# 🚀 Installation avancée +# Installation avancée Pour installer starship, vous devez faire deux choses: diff --git a/docs/fr-FR/migrating-to-0.45.0/README.md b/docs/fr-FR/migrating-to-0.45.0/README.md index ce833b3b..08e62106 100644 --- a/docs/fr-FR/migrating-to-0.45.0/README.md +++ b/docs/fr-FR/migrating-to-0.45.0/README.md @@ -76,7 +76,7 @@ format = "took [$duration]($style) " ### Modules affectés -#### Character +#### Caractères | Propriété supprimée | Remplacement | | ----------------------- | ---------------- | @@ -100,7 +100,7 @@ format = "took [$duration]($style) " Précédemment, la propriété `use_symbol_for_status` était utilisée pour configurer l'invite afin d'afficher le `error_symbol` lorsque la dernière commande aboutissait à un résultat non-nul. -Depuis la version v0.45.0, nous utilisons désormais systématiquement `error_symbol` après une commande dont le résultat est non-nul, fusionnant ainsi les propriétés `use_symbol_for_status` et `error_symbol`. +Depuis la version v0.45.0, nous utilisons systématiquement `error_symbol` après un code de statut non-nul, unifiant ainsi les propriétés `use_symbol_for_status` et `error_symbol`. Pour que l'invite utilise l'ancienne configuration `use_symbol_for_status = true`, ajoutez la ligne suivante à votre configuration: @@ -109,7 +109,7 @@ Pour que l'invite utilise l'ancienne configuration `use_symbol_for_status = true error_symbol = "[✖](bold red)" ``` -_Note :_ L’élément `character` ajoute automatiquement une espace après lui, donc contrairement aux autres chaines `format`, nous n’en ajoutons pas une exprès dans les exemples de dessus. +_Note:_ L'élément `character` est automatiquement suivi d'un espace, donc à la différence des autres valeurs `format`, nous n'en ajoutons pas dans les exemples précédents. #### Temps d'exécution diff --git a/docs/fr-FR/presets/README.md b/docs/fr-FR/presets/README.md index ef3711ef..3c3b2717 100644 --- a/docs/fr-FR/presets/README.md +++ b/docs/fr-FR/presets/README.md @@ -2,34 +2,40 @@ Voici un ensemble de préréglages pour Starship soumis par la communauté. Si vous avez un préréglage à partager, veuillez [proposer une PR](https://github.com/starship/starship/edit/master/docs/presets/README.md) pour mettre à jour ce fichier! 😊 -To get details on how to use a preset, simply click on the image. +Pour obtenir des détails sur comment utiliser un préréglage, cliquez simplement sur l’image. -## [Symboles Nerd Font](./nerd-font) +## [Symboles Nerd Font](./nerd-font.md) -This preset changes the symbols for each module to use Nerd Font symbols. +Ce préréglage change les symboles de chaque module pour utiliser les symboles de Nerd Font. -[![Capture d'écran du pré-réglage Nerd Font Symbols](/presets/img/nerd-font-symbols.png "Click to view Nerd Font Symbols preset")](./nerd-font) +[![Capture d'écran du préréglage Nerd Font Symbols](/presets/img/nerd-font-symbols.png "Cliquez pour voir le préréglage Nerd Font Symbols")](./nerd-font) -## [Segments entre crochets](./bracketed-segments) +## [Segments entre crochets](./bracketed-segments.md) Ce préréglage modifie le format de tous les modules intégrés pour afficher leur segment entre crochets au lieu d'utiliser les labels par défaut de Starship ("via", "on", etc.). -[![Capture d'écran du préréglages Segments entre crochets](/presets/img/bracketed-segments.png "Click to view Bracketed Segments preset")](./bracketed-segments) +[![Capture d'écran du préréglages Segments entre crochets](/presets/img/bracketed-segments.png "Cliquez pour voir le préréglage Segments entre crochets")](./bracketed-segments) -## [Texte uniquement](./plain-text) +## [Texte uniquement](./plain-text.md) -This preset changes the symbols for each module into plain text. Great if you don't have access to Unicode. +Ce préréglage change les symboles de chaque module en texte brut. Idéal si vous n'avez pas accès à Unicode. -[![Capture d'écran du préréglage Texte uniquement](/presets/img/plain-text-symbols.png "Click to view Plain Text Symbols preset")](./plain-text) +[![Capture d'écran du préréglage Texte uniquement](/presets/img/plain-text-symbols.png "Cliquez pour voir le préréglage Texte uniquement")](./plain-text) -## [No Runtime Versions](./no-runtimes) +## [Pas de version des environnements](./no-runtimes.md) -Ce préréglage masque la version des environnements. If you work in containers or virtualized environments, this one is for you! +Ce préréglage masque la version des environnements. Si vous travaillez dans des conteneurs ou environnements virtuels, celui-là est pour vous! -[![Capture d'écran du préréglage Cacher les versions des environnements](/presets/img/no-runtime-versions.png "Click to view No Runtime Versions preset")](./no-runtimes) +[![Capture d'écran du préréglage Pas de version des environnements](/presets/img/no-runtime-versions.png "Cliquez pour voir le préréglage Pas de version des environnements")](./no-runtimes) -## [Pure Prompt](./pure-preset) +## [Invite de commande Pure](./pure-preset.md) Ce préréglage émule l'apparence et le comportement de [Pure](https://github.com/sindresorhus/pure). -[![Capture d'écran du préréglage Pure](/presets/img/pure-preset.png "Click to view Pure Prompt preset")](./pure-preset) +[![Capture d'écran du préréglage Pure](/presets/img/pure-preset.png "Cliquez pour voir le préréglage Pure")](./pure-preset) + +## [Pastel Powerline](./pastel-powerline.md) + +Ce préréglage s'inspire de [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). Il montre également comment fonctionne la substitution de chemin dans starship. + +[![Capture d'écran du préréglage Pastel Powerline](/presets/img/pastel-powerline.png "Cliquez pour voir le préréglage Pure")](./pastel-powerline) diff --git a/docs/fr-FR/presets/bracketed-segments.md b/docs/fr-FR/presets/bracketed-segments.md index b078c2f7..f770e6d9 100644 --- a/docs/fr-FR/presets/bracketed-segments.md +++ b/docs/fr-FR/presets/bracketed-segments.md @@ -1,6 +1,6 @@ -[Return to Presets](/presets/#bracketed-segments) +[Retourner aux préréglages](./README.md#bracketed-segments) -# Bracketed Segments Preset +# Préréglage Segments entre crochets Ce préréglage modifie le format de tous les modules intégrés pour afficher leur segment entre crochets au lieu d'utiliser les labels par défaut de Starship ("via", "on", etc.). @@ -8,6 +8,6 @@ Ce préréglage modifie le format de tous les modules intégrés pour afficher l ### Configuration -[Click to download TOML](/presets/toml/bracketed-segments.toml) +[Cliquez pour télécharger le TOML](/presets/toml/bracketed-segments.toml) <<< @/.vuepress/public/presets/toml/bracketed-segments.toml diff --git a/docs/fr-FR/presets/nerd-font.md b/docs/fr-FR/presets/nerd-font.md index 76608c29..37c184f0 100644 --- a/docs/fr-FR/presets/nerd-font.md +++ b/docs/fr-FR/presets/nerd-font.md @@ -1,8 +1,8 @@ -[Return to Presets](/presets/#nerd-font-symbols) +[Retourner aux préréglages](./README.md#nerd-font-symbols) -# Nerd Font Symbols Preset +# Préréglage Symboles Nerd Font -This preset changes the symbols for each module to use Nerd Font symbols. +Ce préréglage change les symboles de chaque module pour utiliser les symboles de Nerd Font. ![Capture d'écran du pré-réglage 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. ### Configuration -[Click to download TOML](/presets/toml/nerd-font-symbols.toml) +[Cliquez pour télécharger le TOML](/presets/toml/nerd-font-symbols.toml) <<< @/.vuepress/public/presets/toml/nerd-font-symbols.toml diff --git a/docs/fr-FR/presets/no-runtimes.md b/docs/fr-FR/presets/no-runtimes.md index 2bcb83f0..55d3c5e6 100644 --- a/docs/fr-FR/presets/no-runtimes.md +++ b/docs/fr-FR/presets/no-runtimes.md @@ -1,13 +1,13 @@ -[Return to Presets](/presets/#no-runtime-versions) +[Retourner aux préréglages](./README.md#no-runtime-versions) -# No Runtime Versions Preset +# Préréglage Pas de version des environnements -Ce préréglage masque la version des environnements. If you work in containers or virtualized environments, this one is for you! +Ce préréglage masque la version des environnements. Si vous travaillez dans des conteneurs ou environnements virtuels, celui-là est pour vous! ![Capture d'écran du préréglage Cacher les versions des environnements](/presets/img/no-runtime-versions.png) ### Configuration -[Click to download TOML](/presets/toml/no-runtime-versions.toml) +[Cliquez pour télécharger le TOML](/presets/toml/no-runtime-versions.toml) <<< @/.vuepress/public/presets/toml/no-runtime-versions.toml diff --git a/docs/fr-FR/presets/pastel-powerline.md b/docs/fr-FR/presets/pastel-powerline.md new file mode 100644 index 00000000..8a0eb18f --- /dev/null +++ b/docs/fr-FR/presets/pastel-powerline.md @@ -0,0 +1,17 @@ +[Retourner aux préréglages](./README.md#pastel-powerline) + +# Préréglage Pastel Powerline + +Ce préréglage s'inspire de [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). Il montre également comment fonctionne la substitution de chemin dans starship. + +![Capture d'écran du préréglage Pastel Powerline](/presets/img/pastel-powerline.png) + +### Pré-requis + +- Une [Nerd Font](https://www.nerdfonts.com/) est installée et activée dans votre terminal (l'exemple utilise Caskaydia Cove Nerd Font) + +### Configuration + +[Cliquez pour télécharger le TOML](/presets/toml/pastel-powerline.toml) + +<<< @/.vuepress/public/presets/toml/pastel-powerline.toml diff --git a/docs/fr-FR/presets/plain-text.md b/docs/fr-FR/presets/plain-text.md index cd2df50b..7addaf6a 100644 --- a/docs/fr-FR/presets/plain-text.md +++ b/docs/fr-FR/presets/plain-text.md @@ -1,13 +1,13 @@ -[Return to Presets](/presets/#plain-text-symbols) +[Retourner aux préréglages](./README.md#plain-text-symbols) -## Plain Text Symbols Preset +## Préréglage Symboles en texte brut -This preset changes the symbols for each module into plain text. Great if you don't have access to Unicode. +Ce préréglage change les symboles de chaque module en texte brut. Idéal si vous n'avez pas accès à Unicode. -![Capture d'écran du préréglage Texte uniquement](/presets/img/plain-text-symbols.png) +![Capture d'écran du préréglage Symboles en texte brut](/presets/img/plain-text-symbols.png) ### Configuration -[Click to download TOML](/presets/toml/plain-text-symbols.toml) +[Cliquez pour télécharger le TOML](/presets/toml/plain-text-symbols.toml) <<< @/.vuepress/public/presets/toml/plain-text-symbols.toml diff --git a/docs/fr-FR/presets/pure-preset.md b/docs/fr-FR/presets/pure-preset.md index e0457a11..a8036c74 100644 --- a/docs/fr-FR/presets/pure-preset.md +++ b/docs/fr-FR/presets/pure-preset.md @@ -1,6 +1,6 @@ -[Return to Presets](/presets/#pure) +[Retourner aux préréglages](./README.md#pure) -# Pure Preset +# Préréglage Pure Ce préréglage émule l'apparence et le comportement de [Pure](https://github.com/sindresorhus/pure). @@ -8,6 +8,6 @@ Ce préréglage émule l'apparence et le comportement de [Pure](https://github.c ### Configuration -[Click to download TOML](/presets/toml/pure-preset.toml) +[Cliquez pour télécharger le TOML](/presets/toml/pure-preset.toml) <<< @/.vuepress/public/presets/toml/pure-preset.toml diff --git a/docs/id-ID/README.md b/docs/id-ID/README.md index e85a1c86..0ce4f520 100644 --- a/docs/id-ID/README.md +++ b/docs/id-ID/README.md @@ -144,17 +144,19 @@ description: Starship merupakan sebuah prompt yang minimal, super cepat, dan san #### Nushell - ::: peringatan Hal ini dapat berubah di kemudian hari. Hanya nu versi v0.33 atau versi terbaru yang mendapat dukungan pengembangan. ::: Tambahkan skrip berikut ke dalam file konfigurasi nu. Lokasi dari file ini dapat dicek dengan menjalankan `config path` pada nu. - - ```toml - startup = [ - "mkdir ~/.cache/starship", - "starship init nu | save ~/.cache/starship/init.nu", - "source ~/.cache/starship/init.nu", - ] - prompt = "starship_prompt" + ::: peringatan Hal ini dapat berubah di kemudian hari. Only Nushell v0.60+ is supported. ::: Run the following: + ```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`): + + ```sh + mkdir ~/.cache/starship + starship init nu | save ~/.cache/starship/init.nu + source ~/.cache/starship/init.nu + ``` #### Xonsh diff --git a/docs/id-ID/advanced-config/README.md b/docs/id-ID/advanced-config/README.md index f46f4939..4fac9da7 100644 --- a/docs/id-ID/advanced-config/README.md +++ b/docs/id-ID/advanced-config/README.md @@ -2,7 +2,7 @@ Meskipun Starship tergolong sebagai shell yang serbaguna, terkadang kita butuh upaya yang lebih dari sekadar mengedit `starship.toml` untuk membuatnya menjalankan beberapa hal tertentu. Halaman ini merincikan beberapa teknik konfigurasi lanjutan yang digunakan oleh starship. -::: peringatan +::: warning Konfigurasi pada bagian ini dapat berubah saat pembaruan Starship rilis di kemudian hari nanti. diff --git a/docs/id-ID/config/README.md b/docs/id-ID/config/README.md index 4ff4a52d..6b54a25d 100644 --- a/docs/id-ID/config/README.md +++ b/docs/id-ID/config/README.md @@ -27,7 +27,7 @@ Kamu bisa mengganti lokasi file konfigurasi bawaan dengan menggunakan environmen export STARSHIP_CONFIG=~/example/non/default/path/starship.toml ``` -Ekuivalen dalam PowerShell (Windows), tambahkan baris berikut pada `$PROFILE`: +Pada PowerShell (Windows), tambahkan baris berikut pada `$PROFILE`: ```powershell $ENV:STARSHIP_CONFIG = "$HOME\example\non\default\path\starship.toml" @@ -149,7 +149,7 @@ Berikut adalah opsi konfigurasi dari list yang bersifat prompt-wide. | Opsi | Bawaan | Deskripsi | | ----------------- | ------------------------------ | ---------------------------------------------------------------------- | -| `fromat` | [link](#default-prompt-format) | Mengkonfigurasi format pada prompt. | +| `format` | [link](#default-prompt-format) | Mengkonfigurasi format pada prompt. | | `right_format` | `""` | See [Enable Right Prompt](/advanced-config/#enable-right-prompt) | | `scan_timeout` | `30` | Batas waktu starpship untuk memindai file (dalam milidetik). | | `command_timeout` | `500` | Batas waktu untuk perintah yang dijalankan starship (dalam milidetik). | @@ -198,6 +198,7 @@ $git_status\ $hg_branch\ $docker_context\ $package\ +$buf\ $cmake\ $cobol\ $container\ @@ -208,6 +209,7 @@ $elixir\ $elm\ $erlang\ $golang\ +$haskell\ $helm\ $java\ $julia\ @@ -261,7 +263,7 @@ format = "$all$directory$character" ## AWS -The `aws` module shows the current AWS region and profile when credentials or a `credential_process` 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. 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. @@ -273,14 +275,15 @@ Ketika menggunakan [AWSume](https://awsu.me) profil dibaca dari variabel environ ### Opsi -| Opsi | Bawaan | Deskripsi | -| ------------------- | -------------------------------------------------------------------- | ---------------------------------------------------------------- | -| `format` | `'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. | -| `style` | `"bold yellow"` | Gaya penataan untuk modul. | -| `expiration_symbol` | `X` | Simbol ditampilkan ketika temporer kredensial telah kedaluwarsa. | -| `disabled` | `false` | Menonaktifkan modul `AWS`. | +| 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. | ### Variabel @@ -308,6 +311,8 @@ symbol = "🅰 " [aws.region_aliases] ap-southeast-2 = "au" us-east-1 = "va" +[aws.profile_aliases] +CompanyGroupFrobozzOnCallAccess = 'Frobozz' ``` #### Menampilkan region @@ -333,6 +338,8 @@ us-east-1 = "va" format = "on [$symbol$profile]($style) " style = "bold blue" symbol = "🅰 " +[aws.profile_aliases] +Enterprise_Naming_Scheme-voidstars = 'void**' ``` ## Azure @@ -343,7 +350,7 @@ The `azure` module shows the current Azure Subscription. This is based on showin | Variabel | Bawaan | Deskripsi | | ---------- | ---------------------------------------- | ------------------------------------------ | -| `format` | `"on [$symbol($subscription)]($style) "` | The format for the Azure module to render. | +| `fromat` | `"on [$symbol($subscription)]($style) "` | The format for the Azure module to render. | | `symbol` | `"ﴃ "` | The symbol used in the format. | | `style` | `"blue bold"` | The style used in the format. | | `disabled` | `true` | Disables the `azure` module. | @@ -373,7 +380,7 @@ Modul `battery` menampilkan seberapa penuh baterai perangkat terisi dan status p | `discharging_symbol` | `" "` | Simbol dimunculkan ketika baterai terpakai. | | `unknown_symbol` | `" "` | Simbol dimunculkan ketika keadaan baterai tidak dikenali. | | `empty_symbol` | `" "` | Simbol dimunculkan ketika keadaan baterai kosong. | -| `format` | `"[$symbol$percentage]($style) "` | Format dari modul. | +| `fromat` | `"[$symbol$percentage]($style) "` | Format dari modul. | | `display` | [link](#battery-display) | Menampilkan ambang dan gaya dari modul. | | `disabled` | `false` | Menonaktifkan modul `baterai`. | @@ -426,24 +433,57 @@ discharging_symbol = "💦" # when capacity is over 30%, the battery indicator will not be displayed ``` +## 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: + +- 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. + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------------- | ------------------------------------------------------------ | ----------------------------------------------------- | +| `fromat` | `'with [$symbol($version \(Buf $buf_version\) )]($style)'` | The format for the `buf` module. | +| `version_format` | `"v${raw}"` | Format dari versi. | +| `symbol` | `"🦬 "` | The symbol used before displaying the version of Buf. | +| `detect_extensions` | `[]` | Ekstensi mana yang sebaiknya memicu modul ini. | +| `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. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| ------------- | -------- | --------------------------------- | +| `buf_version` | `v1.0.0` | The version of `buf` | +| `symbol` | | Menyalin nilai dari opsi `symbol` | +| `style`* | | Menyalin nilai dari opsi `style` | + +*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + +### Contoh + +```toml +# ~/.config/starship.toml + +[buf] +symbol = "🦬 " +``` + ## Karakter -Modul `character` menampilkan sebuah karakter (biasanya anak panah) di samping teks pada terminalmu. +The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. -Karakter dapat memberitahu kamu apakah perintah terakhir berhasil atau tidak. Karakter dapat memberitahumu dengan dua cara ini: +The character will tell you whether the last command was successful or not. It can do this in two ways: -- mengganti warna (`red`/`green`) -- mengganti bentuk (`❯`/`✖`) +- changing color (`red`/`green`) +- changing shape (`❯`/`✖`) -Secara bawaan karakter hanya dapat mengganti warna. Jika kamu juga ingin mengganti bentuknya, perhatikan [contoh](#with-custom-error-shape) berikut. +By default it only changes color. If you also want to change its shape take a look at [this example](#with-custom-error-shape). -::: peringatan - -`error_symbol` is not supported on nu shell. - -::: - -::: peringatan +::: warning `vicmd_symbol` is only supported in cmd, fish and zsh. @@ -451,19 +491,19 @@ Secara bawaan karakter hanya dapat mengganti warna. Jika kamu juga ingin menggan ### Opsi -| Opsi | Bawaan | Deskripsi | -| ---------------- | ------------------- | ------------------------------------------------------------------------------------------------- | -| `format` | `"$symbol "` | Format string yang digunakan sebelum masukan teks. | -| `success_symbol` | `"[❯](bold green)"` | Format string yang digunakan sebelum masukan teks jika perintah sebelumnya berhasil. | -| `error_symbol` | `"[❯](bold red)"` | Format string yang digunakan sebelum masukan teks jika perintah sebelumnya gagal. | -| `vicmd_symbol` | `"[❮](bold green)"` | Format string yang digunakan sebelum masukan teks jika shell sedang dalam vim dengan mode normal. | -| `disabled` | `false` | Menonaktifkan module `character`. | +| Opsi | Bawaan | Deskripsi | +| ---------------- | ------------------- | -------------------------------------------------------------------------------- | +| `fromat` | `"$symbol "` | 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. | ### Variabel -| Variabel | Contoh | Deskripsi | -| -------- | ------ | ---------------------------------------------------------------------- | -| symbol | | Representasi dari `success_symbol`, `error_symbol` atau `vicmd_symbol` | +| Variabel | Contoh | Deskripsi | +| -------- | ------ | --------------------------------------------------------------------- | +| symbol | | A mirror of either `success_symbol`, `error_symbol` or `vicmd_symbol` | ### Contoh @@ -498,29 +538,29 @@ vicmd_symbol = "[V](bold green) " ## CMake -Modul `cmake` menampilkan versi terkini dari [CMake](https://cmake.org/) yang terpasang. Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: +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: -- Direktori terkini yang berisikan sebuah file `CMakeLists.txt` -- Direktori terkini yang berisikan sebuah file `CMakeCache.txt` +- The current directory contains a `CMakeLists.txt` file +- The current directory contains a `CMakeCache.txt` file ### Opsi | Opsi | Bawaan | Deskripsi | | ------------------- | -------------------------------------- | ----------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | +| `fromat` | `"via [$symbol($version )]($style)"` | Format dari modul. | | `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"△ "` | 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 | +| `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 | | `style` | `"bold blue"` | Gaya penataan untuk modul. | -| `disabled` | `false` | Menonaktifkan modul `cmake`. | +| `disabled` | `false` | Disables the `cmake` module. | ### Variabel | Variabel | Contoh | Deskripsi | | --------- | --------- | --------------------------------- | -| version | `v3.17.3` | Versi dari cmake | +| version | `v3.17.3` | The version of cmake | | symbol | | Menyalin nilai dari opsi `symbol` | | style\* | | Menyalin nilai dari opsi `style` | @@ -538,7 +578,7 @@ The `cobol` module shows the currently installed version of COBOL. By default, t | Opsi | Bawaan | Deskripsi | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | | `symbol` | `"⚙️ "` | The symbol used before displaying the version of COBOL. | -| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | +| `fromat` | `"via [$symbol($version )]($style)"` | Format dari modul. | | `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `style` | `"bold blue"` | Gaya penataan untuk modul. | | `detect_extensions` | `["cbl", "cob", "CBL", "COB"]` | Ekstensi mana yang sebaiknya memicu modul ini. | @@ -558,35 +598,35 @@ The `cobol` module shows the currently installed version of COBOL. By default, t ## Durasi Perintah -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`. +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. -::: jangan lakukan hook DEBUG trap dalam Bash +::: warning Do not hook the DEBUG trap in Bash -Jia kamu menjalankan Starship di `bash`, jangan lakukan hook DEBUG trap setelah menjalankan `eval $(starship init $0)`, atau modulnya **akan** rusak. +If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. ::: -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. +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. ### Opsi | Opsi | Bawaan | Deskripsi | | ---------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `min_tim` | `2_000` | Durasi terpendek untuk menampilkan waktu (dalam milidetik). | -| `show_milliseconds` | `false` | Tampilkan milidetik sebagai ganti detik untuk durasinya. | -| `format` | `"took [$duration]($style) "` | Format dari modul. | +| `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). | +| `show_milliseconds` | `false` | Show milliseconds in addition to seconds for the duration. | +| `fromat` | `"took [$duration]($style) "` | Format dari modul. | | `style` | `"bold yellow"` | Gaya penataan untuk modul. | -| `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). | +| `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. | ### Variabel -| Variabel | Contoh | Deskripsi | -| --------- | -------- | -------------------------------------------------- | -| duration | `16m40s` | Waktu yang dibutuhkan untuk menyelesaikan perintah | -| style\* | | Menyalin nilai dari opsi `style` | +| Variabel | Contoh | Deskripsi | +| --------- | -------- | --------------------------------------- | +| duration | `16m40s` | The time it took to execute the command | +| style\* | | Menyalin nilai dari opsi `style` | *: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string @@ -604,28 +644,28 @@ format = "underwent [$duration](bold yellow)" The `conda` module shows the current [Conda](https://docs.conda.io/en/latest/) environment, if `$CONDA_DEFAULT_ENV` is set. -::: saran +::: tip -Hal ini tidak menahan pengubah (modifier) prompt dari conda sendiri, kamu mungkin bisa menjalankan `conda config --set changeps1 False`. +This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. ::: ### Opsi -| 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. | -| `format` | `"via [$symbol$environment]($style) "` | Format dari modul. | -| `ignore_base` | `true` | Mengabaikan `base` environment saat aktif. | -| `disabled` | `false` | Menonaktifkan modul `conda`. | +| 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. | ### Variabel | Variabel | Contoh | Deskripsi | | ----------- | ------------ | --------------------------------- | -| environment | `astronauts` | Environment conda saat ini | +| environment | `astronauts` | The current conda environment | | symbol | | Menyalin nilai dari opsi `symbol` | | style\* | | Menyalin nilai dari opsi `style` | @@ -646,12 +686,12 @@ The `container` module displays a symbol and container name, if inside a contain ### Opsi -| Opsi | Bawaan | Deskripsi | -| ---------- | ------------------------------------ | ----------------------------------------- | -| `symbol` | `"⬢"` | The symbol shown, when inside a container | -| `style` | `"bold red dimmed"` | Gaya penataan untuk modul. | -| `format` | "[$symbol \\[$name\\]]($style) " | Format dari modul. | -| `disabled` | `false` | Disables the `container` module. | +| Opsi | Bawaan | Deskripsi | +| ---------- | -------------------------------------- | ----------------------------------------- | +| `symbol` | `"⬢"` | The symbol shown, when inside a container | +| `style` | `"bold red dimmed"` | Gaya penataan untuk modul. | +| `fromat` | `"[$symbol \\[$name\\]]($style) "` | Format dari modul. | +| `disabled` | `false` | Disables the `container` module. | ### Variabel @@ -674,29 +714,29 @@ format = "[$symbol \\[$name\\]]($style) " ## Crystal -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 `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: -- Direktori terkini yang berisikan sebuah file `shard.yml` -- Direktori terkini yang berisikan sebuah file `.cr` +- The current directory contains a `shard.yml` file +- The current directory contains a `.cr` file ### Opsi | Opsi | Bawaan | Deskripsi | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | -| `symbol` | `"🔮 "` | Simbol yang digunakan sebelum menampilkan versi crystal terkini. | -| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | +| `symbol` | `"🔮 "` | The symbol used before displaying the version of crystal. | +| `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` | Menonaktifkan modul `crystal`. | +| `disabled` | `false` | Disables the `crystal` module. | ### Variabel | Variabel | Contoh | Deskripsi | | --------- | --------- | --------------------------------- | -| version | `v0.32.1` | Versi dari `crystal` | +| version | `v0.32.1` | The version of `crystal` | | symbol | | Menyalin nilai dari opsi `symbol` | | style\* | | Menyalin nilai dari opsi `style` | @@ -713,30 +753,30 @@ format = "via [✨ $version](bold blue) " ## Dart -Modul `dart` menampilkan versi terkini dari [Dart](https://dart.dev/) yang terpasang. Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: +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: -- 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` +- 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 ### Opsi | Opsi | Bawaan | Deskripsi | | ------------------- | ------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | +| `fromat` | `"via [$symbol($version )]($style)"` | Format dari modul. | | `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"🎯 "` | Sebuah format string yang melambangkan simbol Dart | +| `symbol` | `"🎯 "` | A format string representing the symbol of 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` | Menonaktifkan modul `dart`. | +| `disabled` | `false` | Disables the `dart` module. | ### Variabel | Variabel | Contoh | Deskripsi | | --------- | -------- | --------------------------------- | -| version | `v2.8.4` | Versi dari `dart` | +| version | `v2.8.4` | The version of `dart` | | symbol | | Menyalin nilai dari opsi `symbol` | | style\* | | Menyalin nilai dari opsi `style` | @@ -753,7 +793,7 @@ format = "via [🔰 $version](bold red) " ## Deno -Modul `deno` menampilkan versi terkini dari [Deno](https://deno.land/) yang terpasang. Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: +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 current directory contains a `deno.json`, `deno.jsonc`, `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file @@ -761,20 +801,20 @@ Modul `deno` menampilkan versi terkini dari [Deno](https://deno.land/) yang terp | Opsi | Bawaan | Deskripsi | | ------------------- | ----------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | +| `fromat` | `"via [$symbol($version )]($style)"` | Format dari modul. | | `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | -| `symbol` | `🦕 "` | Sebuah format string yang melambangkan simbol Deno | +| `symbol` | `"🦕 "` | A format string representing the symbol of 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` | Menonaktifkan modul `deno`. | +| `disabled` | `false` | Disables the `deno` module. | ### Variabel | Variabel | Contoh | Deskripsi | | --------- | -------- | --------------------------------- | -| version | `v1.8.3` | Versi dari `deno` | +| version | `v1.8.3` | The version of `deno` | | symbol | | Menyalin nilai dari opsi `symbol` | | style\* | | Menyalin nilai dari opsi `style` | @@ -789,31 +829,31 @@ format = "via [🦕 $version](green bold) " ## Direktori -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. +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. -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. +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. -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`. +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`. ### Opsi | Opsi | Bawaan | Deskripsi | | ------------------- | ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `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. | -| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | Format dari modul. | +| `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. | +| `fromat` | `"[$path]($style)[$read_only]($read_only_style) "` | Format dari modul. | | `style` | `"bold cyan"` | Gaya penataan untuk modul. | -| `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: ".../" | +| `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` | `"~"` | Simbol yang mengindikasikan direktori home. | +| `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) |
-Modul ini memilki beberapa opsi konfigurasi lanjutan yang mengontrol bagaimana direktori ditampilkan. +This module has a few advanced configuration options that control how the directory is displayed. | Advanced Option | Bawaan | Deskripsi | | --------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------- | @@ -837,7 +877,7 @@ Sebagai contoh, untuk `~/Dev/Nix/nixpkgs/pkgs` dimana `nixpkgs` merupakan root r | Variabel | Contoh | Deskripsi | | --------- | --------------------- | -------------------------------- | -| path | `"D:/Projects"` | Direktori terkini | +| path | `"D:/Projects"` | The current directory path | | style\* | `"black bold dimmed"` | Menyalin nilai dari opsi `style` | *: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string @@ -873,22 +913,22 @@ The `docker_context` module shows the currently active [Docker context](https:// ### Opsi -| Opsi | Bawaan | Deskripsi | -| ------------------- | ------------------------------------------------------------- | ----------------------------------------------------------------------------------------- | -| `format` | `"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`. | +| 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. | ### Variabel | Variabel | Contoh | Deskripsi | | --------- | -------------- | --------------------------------- | -| context | `test_context` | Docker context terkini | +| context | `test_context` | The current docker context | | symbol | | Menyalin nilai dari opsi `symbol` | | style\* | | Menyalin nilai dari opsi `style` | @@ -905,9 +945,9 @@ format = "via [🐋 $context](blue bold)" ## Dotnet -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. +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. -Secara bawaan, modul ini hanya akan ditampilkan ke prompt kamu ketika teradapat satu atau lebih file berikut di dalam direktorimu saat ini: +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` @@ -918,34 +958,34 @@ Secara bawaan, modul ini hanya akan ditampilkan ke prompt kamu ketika teradapat - `*.fsproj` - `*.xproj` -Kamu juga perlu memasang .NET Core SDK untuk menggunakannya dengan baik. +You'll also need the .NET Core SDK installed in order to use it correctly. -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. +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. -Modul ini juga akan menampilkan Target Framework Moniker () ketika terdapat sebuah file csproj di dalam direktori terkini. +The module will also show the Target Framework Moniker () when there is a csproj file in the current directory. ### Opsi | Opsi | Bawaan | Deskripsi | | ------------------- | ------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )(🎯 $tfm )]($style)"` | Format dari modul. | +| `fromat` | `"via [$symbol($version )(🎯 $tfm )]($style)"` | Format dari modul. | | `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | -| `symbol` | `".NET "` | Simbol yang digunakan sebelum menampilkan versi dotnet terkini. | -| `heuristic` | `true` | Menggunakan versi yang lebih cepat untuk membuat starship tetap trendi. | +| `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"]` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_files` | `["global.json", "project.json", "Directory.Build.props", "Directory.Build.targets", "Packages.props"]` | 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` | Menonaktifkan modul `dotnet`. | +| `disabled` | `false` | Disables the `dotnet` module. | ### Variabel -| Variabel | Contoh | Deskripsi | -| --------- | ---------------- | ------------------------------------------------------ | -| version | `v3.1.201` | Versi dari sdk `dotnet` | -| tfm | `netstandard2.0` | Target Framework Moniket yang tengah ditarget starship | -| symbol | | Menyalin nilai dari opsi `symbol` | -| style\* | | Menyalin nilai dari opsi `style` | +| Variabel | Contoh | Deskripsi | +| --------- | ---------------- | ------------------------------------------------------------------ | +| version | `v3.1.201` | The version of `dotnet` sdk | +| tfm | `netstandard2.0` | The Target Framework Moniker that the current project is targeting | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | *: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string @@ -962,29 +1002,29 @@ heuristic = false ## Elixir -Modul `elixir` menampilkan versi terkini dari [Elixir](https://elixir-lang.org/) dan [Erlang/OTP](https://erlang.org/doc/). Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: +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: -- Direktori terkini yang berisikan sebuah file `mix.exs`. +- The current directory contains a `mix.exs` file. ### Opsi | Opsi | Bawaan | Deskripsi | | ------------------- | ----------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `format` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | Format dari modul elixir. | +| `fromat` | `'via [$symbol($version \(OTP $otp_version\) )]($style)'` | The format for the module elixir. | | `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"💧 "` | Simbol yang digunakan sebelum menampilkan versi Elixir/Erlang terkini. | +| `symbol` | `"💧 "` | The symbol used before displaying the version of Elixir/Erlang. | | `detect_extensions` | `[]` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_files` | `["mix.exs"]` | filenames mana yang sebaiknya memicu modul ini. | | `detect_folders` | `[]` | Folder mana yang sebaiknya memicul modul ini. | | `style` | `"bold purple"` | Gaya penataan untuk modul. | -| `disabled` | `false` | Menonaktifkan modul `elixir`. | +| `disabled` | `false` | Disables the `elixir` module. | ### Variabel | Variabel | Contoh | Deskripsi | | ----------- | ------- | --------------------------------- | -| version | `v1.10` | Versi dari `elixir` | -| otp_version | | Versi otp dari `elixir` | +| version | `v1.10` | The version of `elixir` | +| otp_version | | The otp version of `elixir` | | symbol | | Menyalin nilai dari opsi `symbol` | | style\* | | Menyalin nilai dari opsi `style` | @@ -1001,32 +1041,32 @@ symbol = "🔮 " ## Elm -Modul `elixir` menampilkan versi terkini dari [Elm](https://elm-lang.org/) yang terpasang. Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: +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: -- Direktori terkini yang berisikan sebuah file `elm.json` -- Direktori terkini yang berisikan sebuah file `elm-package.json` -- Direktori terkini yang berisikan sebuah file `elm-version` -- Direktori terkini yang berisikan sebuah folder`elm-stuff` -- Direktori terkini yang berisikan sebuah file `*.elm` +- 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 +- The current directory contains `*.elm` files ### Opsi | Opsi | Bawaan | Deskripsi | | ------------------- | -------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | +| `fromat` | `"via [$symbol($version )]($style)"` | Format dari modul. | | `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"🌳 "` | Sebuah format string yang melambangkan simbol Elm. | +| `symbol` | `"🌳 "` | A format string representing the symbol of Elm. | | `detect_extensions` | `["elm"]` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | filenames mana yang sebaiknya memicu modul ini. | | `detect_folders` | `["elm-stuff"]` | Folder mana yang sebaiknya memicul modul ini. | | `style` | `"cyan bold"` | Gaya penataan untuk modul. | -| `disabled` | `false` | Menonaktifkan modul `elm`. | +| `disabled` | `false` | Disables the `elm` module. | ### Variabel | Variabel | Contoh | Deskripsi | | --------- | --------- | --------------------------------- | -| version | `v0.19.1` | Versi dari `elm` | +| version | `v0.19.1` | The version of `elm` | | symbol | | Menyalin nilai dari opsi `symbol` | | style\* | | Menyalin nilai dari opsi `style` | @@ -1043,14 +1083,14 @@ format = "via [ $version](cyan bold) " ## Variabel Environment -Modul `env_var` menampilkan nilai terkini dari variabel environment yang dipilih. Modul hanya akan aktif jika beberapa syarat berikut telah terpenuhi: +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: -- Opsi konfigurasi `variable` cocok dengan variabel environment yang ada -- Opsi konfigurasi `variable` tidak didefinisikan, tapi opsi konfigurasi `default` yang didefinisikan +- The `variable` configuration option matches an existing environment variable +- The `variable` configuration option is not defined, but the `default` configuration option is -Multi-variabel environment dapat ditampilkan dengan menggunakan `.`. (lihat contoh) Jika opsi konfigurasi `variable` tidak diset, modul akan menampilkan nilai variabel di bawah teks nama setelah karakter `.`. +::: tip Multiple environmental variables can be displayed by using a `.`. (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. -Contoh: konfigurasi berikut akan menampilkan nilai dari variabel USER environment +Example: following configuration will display value of USER environment variable ```toml # ~/.config/starship.toml @@ -1063,21 +1103,21 @@ default = "unknown user" ### Opsi -| Opsi | Bawaan | Deskripsi | -| ---------- | ------------------------------ | ------------------------------------------------------------------------------------- | -| `symbol` | `""` | Simbol yang digunakan sebelum menampilkan nilai dari variabel. | -| `variabel` | | Variabel environment yang akan ditampilkan. | -| `bawaan` | | Nilai bawaan yang akan ditampilkan ketika variabel yang terpilih tidak didefinisikan. | -| `format` | `"with [$env_value]($style) "` | Format dari modul. | -| `disabled` | `false` | Menonaktifkan modul `env_var`. | +| Opsi | Bawaan | Deskripsi | +| ---------- | ------------------------------ | ---------------------------------------------------------------------------- | +| `symbol` | `""` | 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. | +| `fromat` | `"with [$env_value]($style) "` | Format dari modul. | +| `disabled` | `false` | Disables the `env_var` module. | ### Variabel -| Variabel | Contoh | Deskripsi | -| --------- | ------------------------------------------------- | -------------------------------------- | -| env_value | `Windows NT` (jika _variable_ akan menjadi `$OS`) | Nilai environment dari opsi `variable` | -| symbol | | Menyalin nilai dari opsi `symbol` | -| style\* | `black bold dimmed` | Menyalin nilai dari opsi `style` | +| Variabel | Contoh | Deskripsi | +| --------- | ------------------------------------------- | ------------------------------------------ | +| env_value | `Windows NT` (if _variable_ would be `$OS`) | The environment value of option `variable` | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | `black bold dimmed` | Menyalin nilai dari opsi `style` | *: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string @@ -1091,7 +1131,7 @@ variable = "SHELL" default = "unknown shell" ``` -Menampilkan multi-variabel environment: +Displaying multiple environmental variables: ```toml # ~/.config/starship.toml @@ -1105,16 +1145,16 @@ default = "unknown user" ## Erlang -The `erlang` module shows the currently installed version of [Erlang/OTP](https://erlang.org/doc/). Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: +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: -- Direktori terkini yang berisikan sebuah file `rebar.config`. -- Direktori terkini yang berisikan sebuah file `erlang.mk`. +- The current directory contains a `rebar.config` file. +- The current directory contains a `erlang.mk` file. ### Opsi | Opsi | Bawaan | Deskripsi | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | +| `fromat` | `"via [$symbol($version )]($style)"` | Format dari modul. | | `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `symbol` | `" "` | The symbol used before displaying the version of erlang. | | `style` | `"bold red"` | Gaya penataan untuk modul. | @@ -1179,7 +1219,7 @@ The `gcloud` module shows the current configuration for [`gcloud`](https://cloud | Opsi | Bawaan | Deskripsi | | ----------------- | ---------------------------------------------------------- | ---------------------------------------------------------------- | -| `format` | `'on [$symbol$account(@$domain)(\($region\))]($style) '` | Format dari modul. | +| `fromat` | `'on [$symbol$account(@$domain)(\($region\))]($style) '` | Format dari modul. | | `symbol` | `"☁️ "` | The symbol used before displaying the current GCP profile. | | `region_aliases` | | Table of region aliases to display in addition to the GCP name. | | `project_aliases` | | Table of project aliases to display in addition to the GCP name. | @@ -1194,7 +1234,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 | `bawaan` | The active config name written in `~/.config/gcloud/active_config` | +| active | `default` | The active config name written in `~/.config/gcloud/active_config` | | symbol | | Menyalin nilai dari opsi `symbol` | | style\* | | Menyalin nilai dari opsi `style` | @@ -1253,12 +1293,13 @@ The `git_branch` module shows the active branch of the repo in your current dire | Opsi | Bawaan | Deskripsi | | -------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | | `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | -| `format` | `"on [$symbol$branch]($style) "` | Format dari modul. Use `"$branch"` to refer to the current branch name. | +| `fromat` | `"on [$symbol$branch]($style) "` | Format dari modul. Use `"$branch"` to refer to the current branch name. | | `symbol` | `" "` | A format string representing the symbol of git branch. | | `style` | `"bold purple"` | Gaya penataan untuk modul. | | `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | | `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. | ### Variabel @@ -1282,6 +1323,7 @@ The `git_branch` module shows the active branch of the repo in your current dire symbol = "🌱 " truncation_length = 4 truncation_symbol = "" +ignore_branches = ["master", "main"] ``` ## Git Commit @@ -1293,7 +1335,7 @@ The `git_commit` module shows the current commit hash and also the tag (if any) | Opsi | Bawaan | Deskripsi | | -------------------- | ---------------------------------- | ------------------------------------------------------- | | `commit_hash_length` | `7` | The length of the displayed git commit hash. | -| `format` | `"[\\($hash$tag\\)]($style) "` | Format dari modul. | +| `fromat` | `"[\\($hash$tag\\)]($style) "` | Format dari modul. | | `style` | `"bold green"` | Gaya penataan untuk modul. | | `only_detached` | `true` | Only show git commit hash when in detached `HEAD` state | | `tag_disabled` | `true` | Disables showing tag info in `git_commit` module. | @@ -1335,7 +1377,7 @@ The `git_state` module will show in directories which are part of a git reposito | `am` | `"AM"` | A format string displayed when an `apply-mailbox` (`git am`) is in progress. | | `am_or_rebase` | `"AM/REBASE"` | A format string displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. | | `style` | `"bold yellow"` | Gaya penataan untuk modul. | -| `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | Format dari modul. | +| `fromat` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | Format dari modul. | | `disabled` | `false` | Disables the `git_state` module. | ### Variabel @@ -1363,7 +1405,7 @@ cherry_pick = "[🍒 PICKING](bold red)" The `git_metrics` module will show the number of added and deleted lines in the current git repository. -::: saran +::: tip This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. @@ -1376,7 +1418,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | `added_style` | `"bold green"` | The style for the added count. | | `deleted_style` | `"bold red"` | The style for the deleted count. | | `only_nonzero_diffs` | `true` | Render status only for changed items. | -| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | Format dari modul. | +| `fromat` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | Format dari modul. | | `disabled` | `true` | Disables the `git_metrics` module. | ### Variabel @@ -1404,7 +1446,7 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) ' The `git_status` module shows symbols representing the state of the repo in your current directory. -::: saran +::: tip The Git Status module is very slow in Windows directories (for example under `/mnt/c/`) when in a WSL environment. You can disable the module or use the `windows_starship` option to use a Windows-native Starship executable to compute `git_status` for those paths. @@ -1414,7 +1456,7 @@ The Git Status module is very slow in Windows directories (for example under `/m | Opsi | Bawaan | Deskripsi | | ------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | The default format for `git_status` | +| `fromat` | `'([\[$all_status$ahead_behind\]]($style) )'` | The default format for `git_status` | | `conflicted` | `"="` | This branch has merge conflicts. | | `ahead` | `"⇡"` | The format of `ahead` | | `behind` | `"⇣"` | The format of `behind` | @@ -1504,11 +1546,11 @@ 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/). Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: +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: -- Direktori terkini yang berisikan sebuah file `go.mod` -- Direktori terkini yang berisikan sebuah file `go.sum` -- Direktori terkini yang berisikan sebuah file `glide.yaml` +- 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 @@ -1519,7 +1561,7 @@ The `golang` module shows the currently installed version of [Go](https://golang | Opsi | Bawaan | Deskripsi | | ------------------- | ------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | +| `fromat` | `"via [$symbol($version )]($style)"` | Format dari modul. | | `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `symbol` | `"🐹 "` | A format string representing the symbol of Go. | | `detect_extensions` | `["go"]` | Ekstensi mana yang sebaiknya memicu modul ini. | @@ -1547,18 +1589,51 @@ The `golang` module shows the currently installed version of [Go](https://golang format = "via [🏎💨 $version](bold cyan) " ``` +## Haskell + +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 +- The current directory contains any `.hs`, `.cabal`, or `.hs-boot` file + +### Opsi + +| Opsi | Bawaan | Deskripsi | +| ------------------- | ------------------------------------ | -------------------------------------------------- | +| `fromat` | `"via [$symbol($version )]($style)"` | Format dari modul. | +| `symbol` | `"λ "` | A format string representing the symbol of Haskell | +| `detect_extensions` | `["hs", "cabal", "hs-boot"]` | Ekstensi mana yang sebaiknya memicu modul ini. | +| `detect_files` | `["stack.yaml", "cabal.project"]` | filenames mana yang sebaiknya memicu modul ini. | +| `detect_folders` | `[]` | Folder mana yang sebaiknya memicul modul ini. | +| `style` | `"bold purple"` | Gaya penataan untuk modul. | +| `disabled` | `false` | Disables the `haskell` module. | + +### Variabel + +| Variabel | Contoh | Deskripsi | +| -------------- | ----------- | --------------------------------------------------------------------------------------- | +| version | | `ghc_version` or `snapshot` depending on whether the current project is a Stack project | +| snapshot | `lts-18.12` | Currently selected Stack snapshot | +| ghc\_version | `9.2.1` | Currently installed GHC version | +| symbol | | Menyalin nilai dari opsi `symbol` | +| style\* | | Menyalin nilai dari opsi `style` | + +*: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string + ## Helm -The `helm` module shows the currently installed version of [Helm](https://helm.sh/). Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: +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: -- Direktori terkini yang berisikan sebuah file `helmfile.yaml` +- The current directory contains a `helmfile.yaml` file - The current directory contains a `Chart.yaml` file ### Opsi | Opsi | Bawaan | Deskripsi | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | +| `fromat` | `"via [$symbol($version )]($style)"` | Format dari modul. | | `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `detect_extensions` | `[]` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | filenames mana yang sebaiknya memicu modul ini. | @@ -1596,7 +1671,7 @@ The `hostname` module shows the system 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 "` | Format dari modul. | +| `fromat` | `"[$hostname]($style) in "` | Format dari modul. | | `style` | `"bold dimmed green"` | Gaya penataan untuk modul. | | `disabled` | `false` | Disables the `hostname` module. | @@ -1623,7 +1698,7 @@ disabled = false ## Java -The `java` module shows the currently installed version of [Java](https://www.oracle.com/java/). Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: +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 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 @@ -1632,7 +1707,7 @@ The `java` module shows the currently installed version of [Java](https://www.or | Opsi | Bawaan | Deskripsi | | ------------------- | --------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `format` | `"via [${symbol}(${version} )]($style)"` | Format dari modul. | +| `fromat` | `"via [${symbol}(${version} )]($style)"` | Format dari modul. | | `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `detect_extensions` | `["java", "class", "gradle", "jar", "cljs", "cljc"]` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_files` | `["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"]` | filenames mana yang sebaiknya memicu modul ini. | @@ -1670,13 +1745,13 @@ The default functionality is: - 1 job -> `symbol` is shown. - 2 jobs or more -> `symbol` + `number` are shown. -::: peringatan +::: warning This module is not supported on tcsh and nu. ::: -::: peringatan +::: 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. @@ -1689,7 +1764,7 @@ The `threshold` option is deprecated, but if you want to use it, the module will | `threshold`* | `1` | Show number of jobs if exceeded. | | `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. | | `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. | -| `format` | `"[$symbol$number]($style) "` | Format dari modul. | +| `fromat` | `"[$symbol$number]($style) "` | Format dari modul. | | `symbol` | `"✦"` | The string used to represent the `symbol` variable. | | `style` | `"bold blue"` | Gaya penataan untuk modul. | | `disabled` | `false` | Disables the `jobs` module. | @@ -1719,7 +1794,7 @@ symbol_threshold = 0 ## Julia -The `julia` module shows the currently installed version of [Julia](https://julialang.org/). Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: +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 current directory contains a `Project.toml` file - The current directory contains a `Manifest.toml` file @@ -1729,7 +1804,7 @@ The `julia` module shows the currently installed version of [Julia](https://juli | Opsi | Bawaan | Deskripsi | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | +| `fromat` | `"via [$symbol($version )]($style)"` | Format dari modul. | | `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `detect_extensions` | `["jl"]` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_files` | `["Project.toml", "Manifest.toml"]` | filenames mana yang sebaiknya memicu modul ini. | @@ -1759,7 +1834,7 @@ symbol = "∴ " ## Kotlin -The `kotlin` module shows the currently installed version of [Kotlin](https://kotlinlang.org/). Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: +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: - The current directory contains a `.kt` or a `.kts` file @@ -1767,7 +1842,7 @@ The `kotlin` module shows the currently installed version of [Kotlin](https://ko | Opsi | Bawaan | Deskripsi | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | +| `fromat` | `"via [$symbol($version )]($style)"` | Format dari modul. | | `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `detect_extensions` | `["kt", "kts"]` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_files` | `[]` | filenames mana yang sebaiknya memicu modul ini. | @@ -1808,7 +1883,7 @@ kotlin_binary = "kotlinc" 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`. -::: saran +::: tip This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. @@ -1819,7 +1894,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | Opsi | Bawaan | Deskripsi | | ----------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | | `symbol` | `"☸ "` | A format string representing the symbol displayed before the Cluster. | -| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | Format dari modul. | +| `fromat` | `'[$symbol$context( \($namespace\))]($style) in '` | Format dari modul. | | `style` | `"cyan bold"` | Gaya penataan untuk modul. | | `context_aliases` | | Table of context aliases to display. | | `disabled` | `true` | Disables the `kubernetes` module. | @@ -1900,7 +1975,7 @@ The `localip` module shows the IPv4 address of the primary network interface. | Opsi | Bawaan | Deskripsi | | ---------- | ------------------------- | ------------------------------------------------------ | | `ssh_only` | `true` | Only show IP address when connected to an SSH session. | -| `format` | `"[$localipv4]($style) "` | Format dari modul. | +| `fromat` | `"[$localipv4]($style) "` | Format dari modul. | | `style` | `"bold yellow"` | Gaya penataan untuk modul. | | `disabled` | `true` | Disables the `localip` module. | @@ -1926,7 +2001,7 @@ disabled = false ## Lua -The `lua` module shows the currently installed version of [Lua](http://www.lua.org/). Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: +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 current directory contains a `.lua-version` file - The current directory contains a `lua` directory @@ -1936,7 +2011,7 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o | Opsi | Bawaan | Deskripsi | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | +| `fromat` | `"via [$symbol($version )]($style)"` | Format dari modul. | | `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `symbol` | `"🌙 "` | A format string representing the symbol of Lua. | | `detect_extensions` | `["lua"]` | Ekstensi mana yang sebaiknya memicu modul ini. | @@ -1971,7 +2046,7 @@ The `memory_usage` module shows current system memory and swap usage. By default the swap usage is displayed if the total system swap is non-zero. -::: saran +::: tip This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. @@ -1982,7 +2057,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | Opsi | Bawaan | Deskripsi | | ----------- | ----------------------------------------------- | -------------------------------------------------------- | | `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. | -| `format` | `"via $symbol [${ram}( \| ${swap})]($style) "` | Format dari modul. | +| `fromat` | `"via $symbol [${ram}( \| ${swap})]($style) "` | Format dari modul. | | `symbol` | `"🐏"` | The symbol used before displaying the memory usage. | | `style` | `"bold dimmed white"` | Gaya penataan untuk modul. | | `disabled` | `true` | Disables the `memory_usage` module. | @@ -2022,7 +2097,7 @@ The `hg_branch` module shows the active branch of the repo in your current direc | ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------- | | `symbol` | `" "` | The symbol used before the hg bookmark or branch name of the repo in your current directory. | | `style` | `"bold purple"` | Gaya penataan untuk modul. | -| `format` | `"on [$symbol$branch]($style) "` | Format dari modul. | +| `fromat` | `"on [$symbol$branch]($style) "` | Format dari modul. | | `truncation_length` | `2^63 - 1` | Truncates the hg branch name to `N` graphemes | | `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. | | `disabled` | `true` | Disables the `hg_branch` module. | @@ -2050,9 +2125,9 @@ truncation_symbol = "" ## Nim -The `nim` module shows the currently installed version of [Nim](https://nim-lang.org/). Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: +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: -- Direktori terkini yang berisikan sebuah file `nim.cfg` +- 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 @@ -2061,7 +2136,7 @@ The `nim` module shows the currently installed version of [Nim](https://nim-lang | Opsi | Bawaan | Deskripsi | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | Format dari modul | +| `fromat` | `"via [$symbol($version )]($style)"` | The format for the module | | `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. | | `detect_extensions` | `["nim", "nims", "nimble"]` | Ekstensi mana yang sebaiknya memicu modul ini. | @@ -2098,7 +2173,7 @@ The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/ | Opsi | Bawaan | Deskripsi | | ------------ | ---------------------------------------------- | ----------------------------------------------------- | -| `format` | `'via [$symbol$state( \($name\))]($style) '` | Format dari modul. | +| `fromat` | `'via [$symbol$state( \($name\))]($style) '` | Format dari modul. | | `symbol` | `"❄️ "` | A format string representing the symbol of nix-shell. | | `style` | `"bold blue"` | Gaya penataan untuk modul. | | `impure_msg` | `"impure"` | A format string shown when the shell is impure. | @@ -2130,28 +2205,28 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' ## Node.js -The `nodejs` module shows the currently installed version of [Node.js](https://nodejs.org/). Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: +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: -- Direktori terkini yang berisikan sebuah file `package.json` +- 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` extension +- The current directory contains a file with the `.ts`, `.mts` or `.cts` extension ### Opsi -| Opsi | Bawaan | Deskripsi | -| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | -| `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | -| `symbol` | `" "` | A format string representing the symbol of Node.js. | -| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Ekstensi mana yang sebaiknya memicu modul ini. | -| `detect_files` | `["package.json", ".node-version"]` | filenames mana yang sebaiknya memicu modul ini. | -| `detect_folders` | `["node_modules"]` | Folder mana yang sebaiknya memicul modul ini. | -| `style` | `"bold green"` | Gaya penataan untuk modul. | -| `disabled` | `false` | Disables the `nodejs` module. | -| `not_capable_style` | `bold red` | The style for the module when an engines property in package.json does not match the Node.js version. | +| Opsi | Bawaan | Deskripsi | +| ------------------- | ------------------------------------------ | ----------------------------------------------------------------------------------------------------- | +| `fromat` | `"via [$symbol($version )]($style)"` | Format dari modul. | +| `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | +| `symbol` | `" "` | A format string representing the symbol of Node.js. | +| `detect_extensions` | `["js", "mjs", "cjs", "ts", "mts", "cts"]` | Ekstensi mana yang sebaiknya memicu modul ini. | +| `detect_files` | `["package.json", ".node-version"]` | filenames mana yang sebaiknya memicu modul ini. | +| `detect_folders` | `["node_modules"]` | Folder mana yang sebaiknya memicul modul ini. | +| `style` | `"bold green"` | Gaya penataan untuk modul. | +| `disabled` | `false` | Disables the `nodejs` module. | +| `not_capable_style` | `bold red` | The style for the module when an engines property in package.json does not match the Node.js version. | ### Variabel @@ -2174,7 +2249,7 @@ format = "via [🤖 $version](bold green) " ## OCaml -The `ocaml` module shows the currently installed version of [OCaml](https://ocaml.org/). Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: +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 current directory contains a file with `.opam` extension or `_opam` directory - The current directory contains a `esy.lock` directory @@ -2187,7 +2262,7 @@ The `ocaml` module shows the currently installed version of [OCaml](https://ocam | Opsi | Bawaan | Deskripsi | | ------------------------- | -------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | The format string for the module. | +| `fromat` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | The format string for the module. | | `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. | | `global_switch_indicator` | `""` | The format string used to represent global OPAM switch. | @@ -2227,7 +2302,7 @@ The `openstack` module shows the current OpenStack cloud and project. The module | Opsi | Bawaan | Deskripsi | | ---------- | --------------------------------------------------- | -------------------------------------------------------------- | -| `format` | `"on [$symbol$cloud(\\($project\\))]($style) "` | Format dari modul. | +| `fromat` | `"on [$symbol$cloud(\\($project\\))]($style) "` | Format dari modul. | | `symbol` | `"☁️ "` | The symbol used before displaying the current OpenStack cloud. | | `style` | `"bold yellow"` | Gaya penataan untuk modul. | | `disabled` | `false` | Disables the `openstack` module. | @@ -2281,7 +2356,7 @@ The `package` module is shown when the current directory is the repository for a | Opsi | Bawaan | Deskripsi | | ----------------- | --------------------------------- | ----------------------------------------------------------------------------------- | -| `format` | `"is [$symbol$version]($style) "` | Format dari modul. | +| `fromat` | `"is [$symbol$version]($style) "` | Format dari modul. | | `symbol` | `"📦 "` | The symbol used before displaying the version the package. | | `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `style` | `"bold 208"` | Gaya penataan untuk modul. | @@ -2309,7 +2384,7 @@ format = "via [🎁 $version](208 bold) " ## Perl -The `perl` module shows the currently installed version of [Perl](https://www.perl.org/). Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: +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 current directory contains a `Makefile.PL` or `Build.PL` file - The current directory contains a `cpanfile` or `cpanfile.snapshot` file @@ -2321,7 +2396,7 @@ The `perl` module shows the currently installed version of [Perl](https://www.pe | Opsi | Bawaan | Deskripsi | | ------------------- | -------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format string for the module. | +| `fromat` | `"via [$symbol($version )]($style)"` | The format string for the module. | | `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | | `detect_extensions` | `["pl", "pm", "pod"]` | Ekstensi mana yang sebaiknya memicu modul ini. | @@ -2349,9 +2424,9 @@ format = "via [🦪 $version]($style) " ## PHP -The `php` module shows the currently installed version of [PHP](https://www.php.net/). Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: +The `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: -- Direktori terkini yang berisikan sebuah file `composer.json` +- The current directory contains a `composer.json` file - The current directory contains a `.php-version` file - The current directory contains a `.php` extension @@ -2359,7 +2434,7 @@ The `php` module shows the currently installed version of [PHP](https://www.php. | Opsi | Bawaan | Deskripsi | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | +| `fromat` | `"via [$symbol($version )]($style)"` | Format dari modul. | | `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | | `detect_extensions` | `["php"]` | Ekstensi mana yang sebaiknya memicu modul ini. | @@ -2391,13 +2466,13 @@ 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. -::: saran +::: 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). ::: -Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: +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` @@ -2406,7 +2481,7 @@ Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: | Opsi | Bawaan | Deskripsi | | ---------------- | -------------------------------------------- | ----------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($username@)$stack]($style) "` | The format string for the module. | +| `fromat` | `"via [$symbol($username@)$stack]($style) "` | The format string for the module. | | `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `symbol` | `" "` | A format string shown before the Pulumi stack. | | `style` | `"bold 5"` | Gaya penataan untuk modul. | @@ -2446,16 +2521,16 @@ format = "[$symbol$stack]($style) " ## PureScript -The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: +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: -- Direktori terkini yang berisikan sebuah file `spago.dhall` +- The current directory contains a `spago.dhall` file - The current directory contains a file with the `.purs` extension ### Opsi | Opsi | Bawaan | Deskripsi | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | +| `fromat` | `"via [$symbol($version )]($style)"` | Format dari modul. | | `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | | `detect_extensions` | `["purs"]` | Ekstensi mana yang sebaiknya memicu modul ini. | @@ -2489,15 +2564,15 @@ The `python` module shows the currently installed version of [Python](https://ww 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`. -Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: +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 - The current directory contains a `__init__.py` file -- Direktori terkini yang berisikan sebuah file `pyproject.toml` -- Direktori terkini yang berisikan sebuah file `requirements.txt` -- Direktori terkini yang berisikan sebuah file `setup.py` -- Direktori terkini yang berisikan sebuah file `tox.ini` +- 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 @@ -2505,19 +2580,19 @@ Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: | Opsi | Bawaan | Deskripsi | | -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- | -| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | Format dari modul. | +| `fromat` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | Format dari modul. | | `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `symbol` | `"🐍 "` | A format string representing the symbol of Python | | `style` | `"yellow bold"` | Gaya penataan untuk modul. | | `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"]` | Ekstensi mana yang sebaiknya memicu modul ini | -| `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | filenames mana yang sebaiknya memicu modul ini | -| `detect_folders` | `[]` | Folder mana yang sebaiknya memicul modul ini | +| `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. | -::: saran +::: 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. @@ -2588,13 +2663,13 @@ The `rlang` module shows the currently installed version of [R](https://www.r-pr | Opsi | Bawaan | Deskripsi | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | +| `fromat` | `"via [$symbol($version )]($style)"` | Format dari modul. | | `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `symbol` | `"📐"` | A format string representing the symbol of R. | | `style` | `"blue bold"` | Gaya penataan untuk modul. | -| `detect_extensions` | `["R", "Rd", "Rmd", "Rproj", "Rsx"]` | Ekstensi mana yang sebaiknya memicu modul ini | -| `detect_files` | `[".Rprofile"]` | filenames mana yang sebaiknya memicu modul ini | -| `detect_folders` | `[".Rproj.user"]` | Folder mana yang sebaiknya memicul modul ini | +| `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. | ### Variabel @@ -2624,7 +2699,7 @@ By default the `red` module shows the currently installed version of [Red](https | Opsi | Bawaan | Deskripsi | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | +| `fromat` | `"via [$symbol($version )]($style)"` | Format dari modul. | | `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `symbol` | `"🔺 "` | A format string representing the symbol of Red. | | `detect_extensions` | `["red"]` | Ekstensi mana yang sebaiknya memicu modul ini. | @@ -2667,7 +2742,7 @@ Starship gets the current Ruby version by running `ruby -v`. | Opsi | Bawaan | Deskripsi | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | +| `fromat` | `"via [$symbol($version )]($style)"` | Format dari modul. | | `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `symbol` | `"💎 "` | A format string representing the symbol of Ruby. | | `detect_extensions` | `["rb"]` | Ekstensi mana yang sebaiknya memicu modul ini. | @@ -2707,7 +2782,7 @@ By default the `rust` module shows the currently installed version of [Rust](htt | Opsi | Bawaan | Deskripsi | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | +| `fromat` | `"via [$symbol($version )]($style)"` | Format dari modul. | | `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `symbol` | `"🦀 "` | A format string representing the symbol of Rust | | `detect_extensions` | `["rs"]` | Ekstensi mana yang sebaiknya memicu modul ini. | @@ -2737,7 +2812,7 @@ format = "via [⚙️ $version](red bold)" ## Scala -The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: +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 current directory contains a `build.sbt`, `.scalaenv` or `.sbtenv` file - The current directory contains a file with the `.scala` or `.sbt` extension @@ -2747,7 +2822,7 @@ The `scala` module shows the currently installed version of [Scala](https://www. | Opsi | Bawaan | Deskripsi | | ------------------- | ---------------------------------------- | ----------------------------------------------------------------------------------- | -| `format` | `"via [${symbol}(${version} )]($style)"` | Format dari modul. | +| `fromat` | `"via [${symbol}(${version} )]($style)"` | Format dari modul. | | `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `detect_extensions` | `["sbt", "scala"]` | Ekstensi mana yang sebaiknya memicu modul ini. | | `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | filenames mana yang sebaiknya memicu modul ini. | @@ -2779,7 +2854,7 @@ symbol = "🌟 " The `shell` module shows an indicator for currently used shell. -::: saran +::: tip This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. @@ -2800,7 +2875,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | `cmd_indicator` | `cmd` | A format string used to represent cmd. | | `nu_indicator` | `nu` | A format string used to represent nu. | | `unknown_indicator` | | The default value to be displayed when the shell is unknown. | -| `format` | `"[$indicator]($style) "` | Format dari modul. | +| `fromat` | `"[$indicator]($style) "` | Format dari modul. | | `style` | `"white bold"` | Gaya penataan untuk modul. | | `disabled` | `true` | Disables the `shell` module. | @@ -2809,7 +2884,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | Variabel | Bawaan | Deskripsi | | --------- | ------ | ---------------------------------------------------------- | | indicator | | Mirrors the value of `indicator` for currently used shell. | -| style\* | | Menyalin nilai dari opsi `style`. | +| style\* | | Mirrors the value of option `style`. | *: Variabel tersebut hanya dapat digunakan sebagai bagian dari penataan string @@ -2835,7 +2910,7 @@ The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/int | Opsi | Bawaan | Deskripsi | | ----------- | ---------------------------- | ------------------------------------------------------------- | | `threshold` | `2` | Display threshold. | -| `format` | `"[$symbol$shlvl]($style) "` | Format dari modul. | +| `fromat` | `"[$symbol$shlvl]($style) "` | Format dari modul. | | `symbol` | `"↕️ "` | The symbol used to represent the `SHLVL`. | | `repeat` | `false` | Causes `symbol` to be repeated by the current `SHLVL` amount. | | `style` | `"bold yellow"` | Gaya penataan untuk modul. | @@ -2870,7 +2945,7 @@ The `singularity` module shows the current [Singularity](https://sylabs.io/singu | Opsi | Bawaan | Deskripsi | | ---------- | -------------------------------- | ------------------------------------------------ | -| `format` | `'[$symbol\[$env\]]($style) '` | Format dari modul. | +| `fromat` | `'[$symbol\[$env\]]($style) '` | Format dari modul. | | `symbol` | `""` | A format string displayed before the image name. | | `style` | `"bold dimmed blue"` | Gaya penataan untuk modul. | | `disabled` | `false` | Disables the `singularity` module. | @@ -2896,23 +2971,21 @@ format = '[📦 \[$env\]]($style) ' ## Status -The `status` module displays the exit code of the previous command. The module will be shown only if the exit code is not `0`. The status code will cast to a signed 32-bit integer. +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. -::: saran +::: tip This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: -::: warning This module is not supported on nu shell. ::: - ### Opsi | Opsi | Bawaan | Deskripsi | | ----------------------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------- | -| `format` | `"[$symbol$status]($style) "` | The format of the module | +| `fromat` | `"[$symbol$status]($style) "` | The format of the module | | `symbol` | `"✖"` | The symbol displayed on program error | -| `success_symbol` | `"✔️"` | The symbol displayed on program success | +| `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) | @@ -2949,8 +3022,9 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y [status] style = "bg:blue" -symbol = "🔴" -format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) ' +symbol = "🔴 " +success_symbol = "🟢 SUCCESS" +format = '[\[$symbol$common_meaning$signal_name$maybe_int\]]($style) ' map_symbol = true disabled = false ``` @@ -2959,7 +3033,7 @@ disabled = false The `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached. -::: saran +::: tip This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. @@ -2969,7 +3043,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | Opsi | Bawaan | Deskripsi | | --------------- | ----------------------- | ------------------------------------------------------- | -| `format` | `[as $symbol]($style)"` | The format of the module | +| `fromat` | `[as $symbol]($style)"` | The format of the module | | `symbol` | `"🧙 "` | The symbol displayed when credentials are cached | | `style` | `"bold blue"` | Gaya penataan untuk modul. | | `allow_windows` | `false` | Since windows has no default sudo, default is disabled. | @@ -3015,7 +3089,7 @@ By default the `swift` module shows the currently installed version of [Swift](h | Opsi | Bawaan | Deskripsi | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | +| `fromat` | `"via [$symbol($version )]($style)"` | Format dari modul. | | `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `symbol` | `"🐦 "` | A format string representing the symbol of Swift | | `detect_extensions` | `["swift"]` | Ekstensi mana yang sebaiknya memicu modul ini. | @@ -3047,13 +3121,13 @@ 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. -::: saran +::: 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). ::: -Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: +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 @@ -3062,7 +3136,7 @@ Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: | Opsi | Bawaan | Deskripsi | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | -| `format` | `"via [$symbol$workspace]($style) "` | The format string for the module. | +| `fromat` | `"via [$symbol$workspace]($style) "` | The format string for the module. | | `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `symbol` | `"💠"` | A format string shown before the terraform workspace. | | `detect_extensions` | `["tf", "tfplan", "tfstate"]` | Ekstensi mana yang sebaiknya memicu modul ini. | @@ -3076,7 +3150,7 @@ Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: | Variabel | Contoh | Deskripsi | | --------- | ---------- | --------------------------------- | | version | `v0.12.24` | The version of `terraform` | -| workspace | `bawaan` | The current Terraform workspace | +| workspace | `default` | The current Terraform workspace | | symbol | | Menyalin nilai dari opsi `symbol` | | style\* | | Menyalin nilai dari opsi `style` | @@ -3106,7 +3180,7 @@ 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. -::: saran +::: tip This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. @@ -3116,7 +3190,7 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y | Opsi | Bawaan | Deskripsi | | ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | -| `format` | `"at [$time]($style) "` | The format string for the module. | +| `fromat` | `"at [$time]($style) "` | The format string for the module. | | `use_12hr` | `false` | Enables 12 hour formatting | | `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. | | `style` | `"bold yellow"` | The style for the module time | @@ -3157,7 +3231,7 @@ The `username` module shows active user's username. The module will be shown if - The user is currently connected as an SSH session - The variable `show_always` is set to true -::: saran +::: 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. @@ -3169,7 +3243,7 @@ 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 "` | Format dari modul. | +| `fromat` | `"[$user]($style) in "` | Format dari modul. | | `show_always` | `false` | Always shows the `username` module. | | `disabled` | `false` | Disables the `username` module. | @@ -3195,7 +3269,7 @@ show_always = true ## Vagrant -The `vagrant` module shows the currently installed version of [Vagrant](https://www.vagrantup.com/). Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: +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 current directory contains a `Vagrantfile` file @@ -3203,7 +3277,7 @@ The `vagrant` module shows the currently installed version of [Vagrant](https:// | Opsi | Bawaan | Deskripsi | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | +| `fromat` | `"via [$symbol($version )]($style)"` | Format dari modul. | | `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | | `detect_extensions` | `[]` | Ekstensi mana yang sebaiknya memicu modul ini. | @@ -3233,7 +3307,7 @@ format = "via [⍱ $version](bold white) " ## V -The `vlang` module shows you your currently installed version of [V](https://vlang.io/). Secara bawaan, modul akan aktif jika beberapa syarat berikut telah terpenuhi: +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 current directory contains a file with `.v` extension - The current directory contains a `v.mod`, `vpkg.json` or `.vpkg-lock.json` file @@ -3242,7 +3316,7 @@ The `vlang` module shows you your currently installed version of [V](https://vla | Opsi | Bawaan | Deskripsi | | ------------------- | -------------------------------------------- | ----------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | +| `fromat` | `"via [$symbol($version )]($style)"` | Format dari modul. | | `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `symbol` | `"V "` | A format string representing the symbol of V | | `detect_extensions` | `["v"]` | Ekstensi mana yang sebaiknya memicu modul ini. | @@ -3277,7 +3351,7 @@ The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/v | ---------- | -------------------------------- | ------------------------------------------------------ | | `symbol` | | The symbol used before displaying the repository name. | | `style` | `"bold yellow"` | Gaya penataan untuk modul. | -| `format` | `"vcsh [$symbol$repo]($style) "` | Format dari modul. | +| `fromat` | `"vcsh [$symbol$repo]($style) "` | Format dari modul. | | `disabled` | `false` | Disables the `vcsh` module. | ### Variabel @@ -3296,7 +3370,7 @@ The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/v # ~/.config/starship.toml [vcsh] -format = "via [✨ $repo](bold blue) " +format = "[🆅 $repo](bold blue) " ``` ## Zig @@ -3309,7 +3383,7 @@ By default the the `zig` module shows the currently installed version of [Zig](h | Opsi | Bawaan | Deskripsi | | ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | Format dari modul. | +| `fromat` | `"via [$symbol($version )]($style)"` | Format dari modul. | | `version_format` | `"v${raw}"` | Format dari versi. Variabel yang tersedia adalah `raw`, `major`, `minor`, & `patch` | | `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | | `style` | `"bold yellow"` | Gaya penataan untuk modul. | @@ -3349,19 +3423,19 @@ These modules will be shown if any of the following conditions are met: - The `when` command returns 0 - The current Operating System (std::env::consts::OS) matchs with `os` field if defined. -::: saran +::: tip Multiple custom modules can be defined by using a `.`. ::: -::: saran +::: 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. ::: -::: saran +::: 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! @@ -3382,13 +3456,13 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt | `command` | `""` | The command whose output should be printed. The command will be passed on stdin to the shell. | | `when` | | 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) | -| `deskripsi` | `""` | The description of the module that is shown when running `starship explain`. | +| `description` | `""` | The description of the module that is shown when running `starship explain`. | | `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. | -| `format` | `"[$symbol($output )]($style)"` | Format dari modul. | +| `fromat` | `"[$symbol($output )]($style)"` | Format dari modul. | | `disabled` | `false` | Disables this `custom` module. | | `os` | | Operating System name on which the module will be shown (unix, linux, macos, windows, ... ) [See possible values](https://doc.rust-lang.org/std/env/consts/constant.OS.html). | diff --git a/docs/id-ID/faq/README.md b/docs/id-ID/faq/README.md index d977ad01..c3c797e7 100644 --- a/docs/id-ID/faq/README.md +++ b/docs/id-ID/faq/README.md @@ -1,4 +1,4 @@ -# Pertanyaan Umum (FAQ) +# Frequently Asked Questions ## What is the configuration used in the demo GIF? diff --git a/docs/id-ID/guide/README.md b/docs/id-ID/guide/README.md index e4916276..6bf1588b 100644 --- a/docs/id-ID/guide/README.md +++ b/docs/id-ID/guide/README.md @@ -139,6 +139,8 @@ />

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

-Jelajahi dokumentasi Starship  ▶ +Explore the Starship docs  ▶

@@ -324,17 +326,22 @@ eval $(starship init ion)
Nushell -Add the following to the end of your Nushell configuration (find it by running `config path`): +Run the following: -```toml -startup = [ - "mkdir ~/.cache/starship", - "starship init nu | save ~/.cache/starship/init.nu", - "source ~/.cache/starship/init.nu", -] -prompt = "starship_prompt" +```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`): + +```sh +starship init nu | save ~/.cache/starship/init.nu +source ~/.cache/starship/init.nu +``` + +Note: Only Nushell v0.60+ is supported +
@@ -385,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! -Jika kamu ingin mengkustomisasi Starship lebih jauh: +If you're looking to further customize Starship: - **[Configuration](https://starship.rs/config/)** – learn how to configure Starship to tweak your prompt to your liking @@ -397,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/). -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. 👋 +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. 👋 ## 💭 Terinspirasi Oleh @@ -411,7 +418,7 @@ Please check out these previous works that helped inspire the creation of starsh


- Ikon roket Starship + Starship rocket icon

## 📝 Lisensi diff --git a/docs/id-ID/installing/README.md b/docs/id-ID/installing/README.md index 05511a65..ebd4312d 100644 --- a/docs/id-ID/installing/README.md +++ b/docs/id-ID/installing/README.md @@ -1,4 +1,4 @@ -# 🚀 Advanced Installation +# Advanced Installation To install starship, you need to do two things: diff --git a/docs/id-ID/migrating-to-0.45.0/README.md b/docs/id-ID/migrating-to-0.45.0/README.md index 5f5feda6..f1df1278 100644 --- a/docs/id-ID/migrating-to-0.45.0/README.md +++ b/docs/id-ID/migrating-to-0.45.0/README.md @@ -115,7 +115,7 @@ _Catatan:_ Element `character` secara otomatis menambahkan sebuah spasi setelahn | Properti Yang Digantikan | Penggantinya | | ------------------------ | ------------ | -| `prefix` | `format` | +| `prefix` | `fromat` | **Perubahan pada konfigurasi bawaan** @@ -129,7 +129,7 @@ _Catatan:_ Element `character` secara otomatis menambahkan sebuah spasi setelahn | Properti Yang Digantikan | Penggantinya | | ------------------------ | ------------ | -| `prefix` | `format` | +| `prefix` | `fromat` | **Perubahan pada konfigurasi bawaan** @@ -143,8 +143,8 @@ _Catatan:_ Element `character` secara otomatis menambahkan sebuah spasi setelahn | Properti Yang Digantikan | Penggantinya | | ------------------------ | ------------ | -| `prefix` | `format` | -| `suffix` | `format` | +| `prefix` | `fromat` | +| `suffix` | `fromat` | **Perubahan pada konfigurasi bawaan** @@ -159,8 +159,8 @@ _Catatan:_ Element `character` secara otomatis menambahkan sebuah spasi setelahn | Properti Yang Digantikan | Penggantinya | | ------------------------ | ------------ | -| `prefix` | `format` | -| `suffix` | `format` | +| `prefix` | `fromat` | +| `suffix` | `fromat` | **Perubahan pada konfigurasi bawaan** @@ -175,9 +175,9 @@ _Catatan:_ Element `character` secara otomatis menambahkan sebuah spasi setelahn | Properti Yang Digantikan | Penggantinya | | ------------------------ | ------------ | -| `prefix` | `format` | -| `suffix` | `format` | -| `show_sync_count` | `format` | +| `prefix` | `fromat` | +| `suffix` | `fromat` | +| `show_sync_count` | `fromat` | **Perubahan pada konfigurasi bawaan** @@ -206,8 +206,8 @@ behind = "⇣${count}" | Properti Yang Digantikan | Penggantinya | | ------------------------ | ------------ | -| `prefix` | `format` | -| `suffix` | `format` | +| `prefix` | `fromat` | +| `suffix` | `fromat` | **Perubahan pada konfigurasi bawaan** @@ -222,9 +222,9 @@ behind = "⇣${count}" | Properti Yang Digantikan | Penggantinya | | ------------------------ | ------------ | -| `label` | `format` | -| `prefix` | `format` | -| `suffix` | `format` | +| `label` | `fromat` | +| `prefix` | `fromat` | +| `suffix` | `fromat` | **Perubahan pada konfigurasi bawaan** @@ -239,7 +239,7 @@ behind = "⇣${count}" | Properti Yang Digantikan | Penggantinya | | ------------------------ | ------------- | -| `format` | `time_format` | +| `fromat` | `time_format` | **Perubahan pada konfigurasi bawaan** @@ -254,8 +254,8 @@ behind = "⇣${count}" | Properti Yang Digantikan | Penggantinya | | ------------------------ | ------------ | -| `prefix` | `format` | -| `suffix` | `format` | +| `prefix` | `fromat` | +| `suffix` | `fromat` | **Perubahan pada konfigurasi bawaan** diff --git a/docs/id-ID/presets/README.md b/docs/id-ID/presets/README.md index e34faf98..5d7631b0 100644 --- a/docs/id-ID/presets/README.md +++ b/docs/id-ID/presets/README.md @@ -4,32 +4,38 @@ Berikut ini adalah koleksi konfigurasi prasetel dari kumpulan komunita Starship. To get details on how to use a preset, simply click on the image. -## [Simbol Nerd Font](./nerd-font) +## [Simbol Nerd Font](./nerd-font.md) This preset changes the symbols for each module to use Nerd Font symbols. [![Tangkapan Layar dari preset simbol Nerd Font](/presets/img/nerd-font-symbols.png "Click to view Nerd Font Symbols preset")](./nerd-font) -## [Segmen Berkurung](./bracketed-segments) +## [Segmen Berkurung](./bracketed-segments.md) Konfigurasi prasetel berikut mengubah format dari seluruh modul bawaan untuk menampilkan segmennya di dalam tanda kurung daripada menggunakan susunan kata bawaan Starship ("via", "on", dll.). [![Tangkapan Layar dari Segmen Berkurung](/presets/img/bracketed-segments.png "Click to view Bracketed Segments preset")](./bracketed-segments) -## [Simbol Teks Sederhana](./plain-text) +## [Simbol Teks Sederhana](./plain-text.md) This preset changes the symbols for each module into plain text. Great if you don't have access to Unicode. [![Tangkapan Layar dari preset Simbol Teks Sederhana](/presets/img/plain-text-symbols.png "Click to view Plain Text Symbols preset")](./plain-text) -## [No Runtime Versions](./no-runtimes) +## [No Runtime Versions](./no-runtimes.md) Konfigurasi prasetel berikut menyembunyikan versi language runtimes. Jika kamu bekerja di dalam kontainer atau environments virtual, preset berikut cocok untukmu! [![Tangkapan Layar dari preset Penyembunyian Versi Runtime](/presets/img/no-runtime-versions.png "Click to view No Runtime Versions preset")](./no-runtimes) -## [Pure Prompt](./pure-preset) +## [Pure Prompt](./pure-preset.md) This preset emulates the look and behavior of [Pure](https://github.com/sindresorhus/pure). [![Screenshot of Pure preset](/presets/img/pure-preset.png "Click to view Pure Prompt preset")](./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. + +[![Screenshot of Pastel Powerline preset](/presets/img/pastel-powerline.png "Click to view Pure Prompt preset")](./pastel-powerline) diff --git a/docs/id-ID/presets/bracketed-segments.md b/docs/id-ID/presets/bracketed-segments.md index d0bdc642..833058a9 100644 --- a/docs/id-ID/presets/bracketed-segments.md +++ b/docs/id-ID/presets/bracketed-segments.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#bracketed-segments) +[Return to Presets](./README.md#bracketed-segments) # Bracketed Segments Preset diff --git a/docs/id-ID/presets/nerd-font.md b/docs/id-ID/presets/nerd-font.md index 59178a3e..19082c82 100644 --- a/docs/id-ID/presets/nerd-font.md +++ b/docs/id-ID/presets/nerd-font.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#nerd-font-symbols) +[Return to Presets](./README.md#nerd-font-symbols) # Nerd Font Symbols Preset diff --git a/docs/id-ID/presets/no-runtimes.md b/docs/id-ID/presets/no-runtimes.md index db31af02..42f4b2e1 100644 --- a/docs/id-ID/presets/no-runtimes.md +++ b/docs/id-ID/presets/no-runtimes.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#no-runtime-versions) +[Return to Presets](./README.md#no-runtime-versions) # No Runtime Versions Preset diff --git a/docs/id-ID/presets/pastel-powerline.md b/docs/id-ID/presets/pastel-powerline.md new file mode 100644 index 00000000..658bd631 --- /dev/null +++ b/docs/id-ID/presets/pastel-powerline.md @@ -0,0 +1,17 @@ +[Return to Presets](./README.md#pastel-powerline) + +# Pastel Powerline Preset + +This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). It also shows how path substitution works in starship. + +![Screenshot of Pastel Powerline preset](/presets/img/pastel-powerline.png) + +### Prasyarat + +- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (the example uses Caskaydia Cove Nerd Font) + +### Konfigurasi + +[Click to download TOML](/presets/toml/pastel-powerline.toml) + +<<< @/.vuepress/public/presets/toml/pastel-powerline.toml diff --git a/docs/id-ID/presets/plain-text.md b/docs/id-ID/presets/plain-text.md index 549b93fd..f3cf9a43 100644 --- a/docs/id-ID/presets/plain-text.md +++ b/docs/id-ID/presets/plain-text.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#plain-text-symbols) +[Return to Presets](./README.md#plain-text-symbols) ## Plain Text Symbols Preset diff --git a/docs/id-ID/presets/pure-preset.md b/docs/id-ID/presets/pure-preset.md index 54106318..a00d6fb3 100644 --- a/docs/id-ID/presets/pure-preset.md +++ b/docs/id-ID/presets/pure-preset.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#pure) +[Return to Presets](./README.md#pure) # Pure Preset diff --git a/docs/it-IT/README.md b/docs/it-IT/README.md index 6e8a52c4..667afe99 100644 --- a/docs/it-IT/README.md +++ b/docs/it-IT/README.md @@ -48,7 +48,7 @@ description: Starship è il prompt minimalista, super veloce ed estremamente per Per aggiornare Starship stesso, riavviare lo script sopra. Sostituirà la versione corrente senza toccare la configurazione di Starship. - #### Installa con Package Manager + #### Installa via Package Manager Con [Homebrew](https://brew.sh/): @@ -100,7 +100,7 @@ description: Starship è il prompt minimalista, super veloce ed estremamente per #### Powershell - Aggiungi quanto segue alla fine di `Microsoft.PowerShell_profile.ps1`. Puoi controllare la posizione di questo file interrogando la variabile `$PROFILE` in PowerShell. In genere il percorso è `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` oppure `~/.config/powershell/Microsoft.PowerShell_profile.ps1` in -Nix. + Aggiungi quanto segue alla fine di `Microsoft.PowerShell_profile.ps1`. Puoi controllare la posizione di questo file interrogando la variabile `$PROFILE` in PowerShell. Tipicamente il percorso è `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` oppure `~/.config/powershell/Microsoft.PowerShell_profile.ps1` su -Nix. ```sh Invoke-Expression (&starship init powershell) @@ -144,17 +144,19 @@ description: Starship è il prompt minimalista, super veloce ed estremamente per #### Nushell - ::: warning Questo cambierà in futuro. È supportata solo la versione v0.33 o superiore. ::: Aggiungi quanto segue al tuo file di configurazione nu. Puoi controllare la posizione di questo file eseguendo `percorso di configurazione` in nu. - - ```toml - startup = [ - "mkdir ~/.cache/starship", - "starship init nu | save ~/.cache/starship/init.nu", - "source ~/.cache/starship/init.nu", - ] - prompt = "starship_prompt" + ::: warning Questo cambierà in futuro. Only Nushell v0.60+ is supported. ::: Run the following: + ```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`): + + ```sh + mkdir ~/.cache/starship + starship init nu | save ~/.cache/starship/init.nu + source ~/.cache/starship/init.nu + ``` #### Xonsh diff --git a/docs/it-IT/advanced-config/README.md b/docs/it-IT/advanced-config/README.md index 2a864db8..e5a77cef 100644 --- a/docs/it-IT/advanced-config/README.md +++ b/docs/it-IT/advanced-config/README.md @@ -176,7 +176,7 @@ Note: Continuation prompts are only available in the following shells: continuation_prompt = "▶▶" ``` -## Stile delle Stringhe +## Stringhe di stile Le stringhe di stile sono un elenco di parole, separate da spazi bianchi. Le parole non sono sensibili alle maiuscole (cioè `grassetto` e `BoLd` sono considerate la stessa stringa). Ogni parola può essere una delle seguenti: diff --git a/docs/it-IT/config/README.md b/docs/it-IT/config/README.md index f70a3ad8..3fc7c368 100644 --- a/docs/it-IT/config/README.md +++ b/docs/it-IT/config/README.md @@ -95,7 +95,7 @@ Per esempio: - `[⌘ $version](grassetto verde)` stamperà un simbolo `⌘` seguito dal contenuto della variabile `version`, con testo grassetto di colore verde. - `[a [b](rosso) c](verde)` stamperà `a b c` con `b` rosso, e `a` e `c` verde. -#### Stile delle Stringhe +#### Stringhe di stile La maggior parte dei moduli in starship ti permettono di configurare i loro stili di visualizzazione. Questo viene fatto con una voce (solitamente chiamata `style`) che è una stringa che specifica la configurazione. Ecco alcuni esempi di stringhe di stile per quello che fanno. Per maggiori dettagli sulla sintassi completa, consulta la [guida di configurazione avanzata](/advanced-config/). @@ -198,6 +198,7 @@ $git_status\ $hg_branch\ $docker_context\ $package\ +$buf\ $cmake\ $cobol\ $container\ @@ -208,6 +209,7 @@ $elixir\ $elm\ $erlang\ $golang\ +$haskell\ $helm\ $java\ $julia\ @@ -261,7 +263,7 @@ format = "$all$directory$character" ## AWS -The `aws` module shows the current AWS region and profile when credentials or a `credential_process` 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. 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. @@ -278,6 +280,7 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL | `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. | @@ -308,6 +311,8 @@ symbol = "🅰 " [aws.region_aliases] ap-southeast-2 = "au" us-east-1 = "va" +[aws.profile_aliases] +CompanyGroupFrobozzOnCallAccess = 'Frobozz' ``` #### Display region @@ -333,6 +338,8 @@ us-east-1 = "va" format = "on [$symbol$profile]($style) " style = "bold blue" symbol = "🅰 " +[aws.profile_aliases] +Enterprise_Naming_Scheme-voidstars = 'void**' ``` ## Azure @@ -426,6 +433,45 @@ discharging_symbol = "💦" # when capacity is over 30%, the battery indicator will not be displayed ``` +## 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: + +- 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. + +### Opzioni + +| Opzione | Default | Descrizione | +| ------------------- | ------------------------------------------------------------ | ----------------------------------------------------- | +| `format` | `'with [$symbol($version \(Buf $buf_version\) )]($style)'` | The format for the `buf` module. | +| `version_format` | `"v${raw}"` | Il formato della versione. | +| `symbol` | `"🦬 "` | The symbol used before displaying the version of Buf. | +| `detect_extensions` | `[]` | Quali estensioni dovrebbero attivare questo modulo. | +| `detect_files` | `["buf.yaml", "buf.gen.yaml", "buf.work.yaml"]` | Quali nomi di file dovrebbero attivare questo modulo. | +| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `style` | `"bold blue"` | Lo stile per il modulo. | +| `disabled` | `false` | Disables the `elixir` module. | + +### Variables + +| Variable | Esempio | Descrizione | +| ------------- | -------- | ------------------------------------ | +| `buf_version` | `v1.0.0` | The version of `buf` | +| `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 + +[buf] +symbol = "🦬 " +``` + ## Character The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. @@ -439,12 +485,6 @@ By default it only changes color. If you also want to change its shape take a lo ::: warning -`error_symbol` is not supported on nu shell. - -::: - -::: warning - `vicmd_symbol` is only supported in cmd, fish and zsh. ::: @@ -510,9 +550,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` | `[]` | 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 | +| `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 | | `style` | `"bold blue"` | Lo stile per il modulo. | | `disabled` | `false` | Disables the `cmake` module. | @@ -646,12 +686,12 @@ The `container` module displays a symbol and container name, if inside a contain ### Opzioni -| Opzione | Default | Descrizione | -| ---------- | ------------------------------------ | ----------------------------------------- | -| `symbol` | `"⬢"` | The symbol shown, when inside a container | -| `style` | `"bold red dimmed"` | Lo stile per il modulo. | -| `format` | "[$symbol \\[$name\\]]($style) " | The format for the module. | -| `disabled` | `false` | Disables the `container` module. | +| Opzione | Default | Descrizione | +| ---------- | -------------------------------------- | ----------------------------------------- | +| `symbol` | `"⬢"` | The symbol shown, when inside a container | +| `style` | `"bold red dimmed"` | Lo stile per il modulo. | +| `format` | `"[$symbol \\[$name\\]]($style) "` | The format for the module. | +| `disabled` | `false` | Disables the `container` module. | ### Variables @@ -1007,7 +1047,7 @@ The `elm` module shows the currently installed version of [Elm](https://elm-lang - 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 -- The current directory contains a `*.elm` files +- The current directory contains `*.elm` files ### Opzioni @@ -1259,6 +1299,7 @@ The `git_branch` module shows the active branch of the repo in your current dire | `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | | `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. | | `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | +| `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for "master" or "main". | | `disabled` | `false` | Disables the `git_branch` module. | ### Variables @@ -1282,6 +1323,7 @@ The `git_branch` module shows the active branch of the repo in your current dire symbol = "🌱 " truncation_length = 4 truncation_symbol = "" +ignore_branches = ["master", "main"] ``` ## Git Commit @@ -1547,6 +1589,39 @@ The `golang` module shows the currently installed version of [Go](https://golang format = "via [🏎💨 $version](bold cyan) " ``` +## Haskell + +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 +- The current directory contains any `.hs`, `.cabal`, or `.hs-boot` file + +### Opzioni + +| Opzione | Default | Descrizione | +| ------------------- | ------------------------------------ | ----------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `symbol` | `"λ "` | A format string representing the symbol of Haskell | +| `detect_extensions` | `["hs", "cabal", "hs-boot"]` | Quali estensioni dovrebbero attivare questo modulo. | +| `detect_files` | `["stack.yaml", "cabal.project"]` | Quali nomi di file dovrebbero attivare questo modulo. | +| `detect_folders` | `[]` | Quali cartelle dovrebbero attivare questo modulo. | +| `style` | `"bold purple"` | Lo stile per il modulo. | +| `disabled` | `false` | Disables the `haskell` module. | + +### Variables + +| Variable | Esempio | Descrizione | +| -------------- | ----------- | --------------------------------------------------------------------------------------- | +| version | | `ghc_version` or `snapshot` depending on whether the current project is a Stack project | +| snapshot | `lts-18.12` | Currently selected Stack snapshot | +| ghc\_version | `9.2.1` | Currently installed GHC version | +| symbol | | 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 + ## 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: @@ -2137,21 +2212,21 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n - 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` extension +- The current directory contains a file with the `.ts`, `.mts` or `.cts` extension ### Opzioni -| Opzione | Default | Descrizione | -| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `version_format` | `"v${raw}"` | Il formato della versione. Le variabili disponibili sono `raw`, `major`, `minore`, & `patch` | -| `symbol` | `" "` | A format string representing the symbol of Node.js. | -| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Quali estensioni dovrebbero attivare questo modulo. | -| `detect_files` | `["package.json", ".node-version"]` | Quali nomi di file dovrebbero attivare questo modulo. | -| `detect_folders` | `["node_modules"]` | Quali cartelle dovrebbero attivare questo modulo. | -| `style` | `"bold green"` | Lo stile per il modulo. | -| `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. | +| Opzione | Default | Descrizione | +| ------------------- | ------------------------------------------ | ----------------------------------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `"v${raw}"` | Il formato della versione. Le variabili disponibili sono `raw`, `major`, `minore`, & `patch` | +| `symbol` | `" "` | A format string representing the symbol of Node.js. | +| `detect_extensions` | `["js", "mjs", "cjs", "ts", "mts", "cts"]` | Quali estensioni dovrebbero attivare questo modulo. | +| `detect_files` | `["package.json", ".node-version"]` | Quali nomi di file dovrebbero attivare questo modulo. | +| `detect_folders` | `["node_modules"]` | Quali cartelle dovrebbero attivare questo modulo. | +| `style` | `"bold green"` | Lo stile per il modulo. | +| `disabled` | `false` | Disables the `nodejs` module. | +| `not_capable_style` | `bold red` | The style for the module when an engines property in package.json does not match the Node.js version. | ### Variables @@ -2285,8 +2360,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` | Abilita la visualizzazione della versione per i pacchetti contrassegnati come privati. | -| `disabled` | `false` | Disabilita il modulo `package`. | +| `display_private` | `false` | Enable displaying version for packages marked as private. | +| `disabled` | `false` | Disables the `package` module. | ### Variables @@ -2512,9 +2587,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"]` | 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 | +| `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. | ::: tip @@ -2592,9 +2667,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"]` | 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 | +| `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. | ### Variables @@ -2896,7 +2971,7 @@ format = '[📦 \[$env\]]($style) ' ## Status -The `status` module displays the exit code of the previous command. The module will be shown only if the exit code is not `0`. The status code will cast to a signed 32-bit integer. +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 @@ -2904,15 +2979,13 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y ::: -::: warning This module is not supported on nu shell. ::: - ### Opzioni | Opzione | Default | Descrizione | | ----------------------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------- | | `format` | `"[$symbol$status]($style) "` | The format of the module | | `symbol` | `"✖"` | The symbol displayed on program error | -| `success_symbol` | `"✔️"` | The symbol displayed on program success | +| `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) | @@ -2949,8 +3022,9 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y [status] style = "bg:blue" -symbol = "🔴" -format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) ' +symbol = "🔴 " +success_symbol = "🟢 SUCCESS" +format = '[\[$symbol$common_meaning$signal_name$maybe_int\]]($style) ' map_symbol = true disabled = false ``` @@ -3130,7 +3204,7 @@ If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Otherwise, it de | Variable | Esempio | Descrizione | | --------- | ---------- | ----------------------------------- | -| ora | `13:08:10` | The current time. | +| time | `13:08:10` | The current time. | | style\* | | Mirrors the value of option `style` | *: This variable can only be used as a part of a style string @@ -3244,12 +3318,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 "` | Una stringa di formato che rappresenta il simbolo di V | +| `symbol` | `"V "` | A format string representing the symbol of V | | `detect_extensions` | `["v"]` | Quali estensioni dovrebbero attivare questo modulo. | | `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Quali nomi di file dovrebbero attivare questo modulo. | | `detect_folders` | `[]` | Quali cartelle dovrebbero attivare questo modulo. | | `style` | `"blu grassetto"` | Lo stile per il modulo. | -| `disabled` | `false` | Disabilita il modulo `vlang`. | +| `disabled` | `false` | Disables the `vlang` module. | ### Variables @@ -3382,7 +3456,7 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt | `command` | `""` | The command whose output should be printed. The command will be passed on stdin to the shell. | | `when` | | 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) | -| `descrizione` | `""` | The description of the module that is shown when running `starship explain`. | +| `description` | `""` | The description of the module that is shown when running `starship explain`. | | `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. | diff --git a/docs/it-IT/faq/README.md b/docs/it-IT/faq/README.md index 752afea7..baed8538 100644 --- a/docs/it-IT/faq/README.md +++ b/docs/it-IT/faq/README.md @@ -1,4 +1,4 @@ -# FAQ +# Frequently Asked Questions ## Qual è la configurazione utilizzata nella GIF demo? diff --git a/docs/it-IT/guide/README.md b/docs/it-IT/guide/README.md index a95b56aa..10049666 100644 --- a/docs/it-IT/guide/README.md +++ b/docs/it-IT/guide/README.md @@ -139,11 +139,13 @@ />

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

Starship con iTerm2 e il tema Snazzy @@ -158,7 +160,7 @@ - **Facile:** veloce da installare - inizia ad usarlo in pochi minuti.

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

@@ -171,7 +173,7 @@ ### Fase 1. Installa Starship -Selezionare il sistema operativo dall'elenco qui sotto per visualizzare le istruzioni per l'installazione: +Select your operating system from the list below to view installation instructions:
Android @@ -262,7 +264,7 @@ Install Starship using any of the following package managers: ### Fase 2. Imposta la tua shell a utilizzare Starship -Configura la shell a inizializzare Starship. Seleziona la tua dalla lista qui sotto: +Configure your shell to initialize starship. Select yours from the list below:
Bash @@ -324,17 +326,22 @@ eval $(starship init ion)
Nushell -Add the following to the end of your Nushell configuration (find it by running `config path`): +Run the following: -```toml -startup = [ - "mkdir ~/.cache/starship", - "starship init nu | save ~/.cache/starship/init.nu", - "source ~/.cache/starship/init.nu", -] -prompt = "starship_prompt" +```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`): + +```sh +starship init nu | save ~/.cache/starship/init.nu +source ~/.cache/starship/init.nu +``` + +Note: Only Nushell v0.60+ is supported +
@@ -383,9 +390,9 @@ eval "$(starship init zsh)" ### Fase 3. Configura Starship -Inizia una nuova istanza del shell, e dovresti vedere il tuo bellissimo nuovo shell prompt. Se sei soddisfatto dei valori predefiniti, ottimo! +Start a new shell instance, and you should see your beautiful new shell prompt. If you're happy with the defaults, enjoy! -Se stai cercando di personalizzare ulteriormente Starship: +If you're looking to further customize Starship: - **[Configurazione](https://starship.rs/config/)** – impara come configurare Starship per modificare il tuo prompt a tuo piacimento @@ -393,15 +400,15 @@ Se stai cercando di personalizzare ulteriormente Starship: ## 🤝 Contribuire -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). +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). -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 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 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. 👋 +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. 👋 ## 💭 Ispirato Da -Ti invito di controllare questi lavori precedenti che hanno contribuito a ispirare la creazione di Starship. 🙏 +Please check out these previous works that helped inspire the creation of starship. 🙏 - **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** – Un prompt ZSH per astronauti. @@ -416,4 +423,4 @@ Ti invito di controllare questi lavori precedenti che hanno contribuito a ispira ## 📝 Licenza -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). +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. diff --git a/docs/it-IT/installing/README.md b/docs/it-IT/installing/README.md index 6153ea30..749c62c5 100644 --- a/docs/it-IT/installing/README.md +++ b/docs/it-IT/installing/README.md @@ -1,4 +1,4 @@ -# 🚀 Installazione Avanzata +# Advanced Installation Per installare starship, è necessario fare due cose: diff --git a/docs/it-IT/presets/README.md b/docs/it-IT/presets/README.md index a23283cc..b09df057 100644 --- a/docs/it-IT/presets/README.md +++ b/docs/it-IT/presets/README.md @@ -4,32 +4,38 @@ Ecco una raccolta dei preset di configurazione inviati dalla community per Stars To get details on how to use a preset, simply click on the image. -## [Nerd Font Symbols](./nerd-font) +## [Nerd Font Symbols](./nerd-font.md) This preset changes the symbols for each module to use Nerd Font symbols. [![Screenshot dei preset di Nerd Font Symbols](/presets/img/nerd-font-symbols.png "Click to view Nerd Font Symbols preset")](./nerd-font) -## [Bracketed Segments](./bracketed-segments) +## [Bracketed Segments](./bracketed-segments.md) This preset changes the format of all the built-in modules to show their segment in brackets instead of using the default Starship wording ("via", "on", etc.). [![Screenshot of Bracketed Segments preset](/presets/img/bracketed-segments.png "Click to view Bracketed Segments preset")](./bracketed-segments) -## [Plain Text Symbols](./plain-text) +## [Plain Text Symbols](./plain-text.md) This preset changes the symbols for each module into plain text. Great if you don't have access to Unicode. [![Screenshot of Plain Text Symbols preset](/presets/img/plain-text-symbols.png "Click to view Plain Text Symbols preset")](./plain-text) -## [No Runtime Versions](./no-runtimes) +## [No Runtime Versions](./no-runtimes.md) This preset hides the version of language runtimes. If you work in containers or virtualized environments, this one is for you! [![Screenshot of Hide Runtime Versions preset](/presets/img/no-runtime-versions.png "Click to view No Runtime Versions preset")](./no-runtimes) -## [Pure Prompt](./pure-preset) +## [Pure Prompt](./pure-preset.md) This preset emulates the look and behavior of [Pure](https://github.com/sindresorhus/pure). [![Screenshot of Pure preset](/presets/img/pure-preset.png "Click to view Pure Prompt preset")](./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. + +[![Screenshot of Pastel Powerline preset](/presets/img/pastel-powerline.png "Click to view Pure Prompt preset")](./pastel-powerline) diff --git a/docs/it-IT/presets/bracketed-segments.md b/docs/it-IT/presets/bracketed-segments.md index f05cb116..aa7b7910 100644 --- a/docs/it-IT/presets/bracketed-segments.md +++ b/docs/it-IT/presets/bracketed-segments.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#bracketed-segments) +[Return to Presets](./README.md#bracketed-segments) # Bracketed Segments Preset diff --git a/docs/it-IT/presets/nerd-font.md b/docs/it-IT/presets/nerd-font.md index 046f987f..2ef8ac93 100644 --- a/docs/it-IT/presets/nerd-font.md +++ b/docs/it-IT/presets/nerd-font.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#nerd-font-symbols) +[Return to Presets](./README.md#nerd-font-symbols) # Nerd Font Symbols Preset diff --git a/docs/it-IT/presets/no-runtimes.md b/docs/it-IT/presets/no-runtimes.md index c39d7795..ef6ee80f 100644 --- a/docs/it-IT/presets/no-runtimes.md +++ b/docs/it-IT/presets/no-runtimes.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#no-runtime-versions) +[Return to Presets](./README.md#no-runtime-versions) # No Runtime Versions Preset diff --git a/docs/it-IT/presets/pastel-powerline.md b/docs/it-IT/presets/pastel-powerline.md new file mode 100644 index 00000000..d029e2b1 --- /dev/null +++ b/docs/it-IT/presets/pastel-powerline.md @@ -0,0 +1,17 @@ +[Return to Presets](./README.md#pastel-powerline) + +# Pastel Powerline Preset + +This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). It also shows how path substitution works in starship. + +![Screenshot of Pastel Powerline preset](/presets/img/pastel-powerline.png) + +### Prerequisiti + +- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (the example uses Caskaydia Cove Nerd Font) + +### Configurazione + +[Click to download TOML](/presets/toml/pastel-powerline.toml) + +<<< @/.vuepress/public/presets/toml/pastel-powerline.toml diff --git a/docs/it-IT/presets/plain-text.md b/docs/it-IT/presets/plain-text.md index 9fce92db..190a34a8 100644 --- a/docs/it-IT/presets/plain-text.md +++ b/docs/it-IT/presets/plain-text.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#plain-text-symbols) +[Return to Presets](./README.md#plain-text-symbols) ## Plain Text Symbols Preset diff --git a/docs/it-IT/presets/pure-preset.md b/docs/it-IT/presets/pure-preset.md index 30bbea4a..a1670746 100644 --- a/docs/it-IT/presets/pure-preset.md +++ b/docs/it-IT/presets/pure-preset.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#pure) +[Return to Presets](./README.md#pure) # Pure Preset diff --git a/docs/ja-JP/README.md b/docs/ja-JP/README.md index 4c1aefec..ef79eaed 100644 --- a/docs/ja-JP/README.md +++ b/docs/ja-JP/README.md @@ -144,17 +144,19 @@ description: Starship はミニマルで、非常に高速で、カスタマイ #### Nushell - ::: warning This will change in the future. nu バージョン 0.33 以降のみサポートされます。 ::: Add the following to your nu config file. nu で`config path`を実行することで、設定ファイルの場所を確認できます。 - - ```toml - startup = [ - "mkdir ~/.cache/starship", - "starship init nu | save ~/.cache/starship/init.nu", - "source ~/.cache/starship/init.nu", - ] - prompt = "starship_prompt" + ::: warning This will change in the future. Only Nushell v0.60+ is supported. ::: Run the following: + ```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`): + + ```sh + mkdir ~/.cache/starship + starship init nu | save ~/.cache/starship/init.nu + source ~/.cache/starship/init.nu + ``` #### Xonsh diff --git a/docs/ja-JP/config/README.md b/docs/ja-JP/config/README.md index 115a2550..4141b743 100644 --- a/docs/ja-JP/config/README.md +++ b/docs/ja-JP/config/README.md @@ -47,7 +47,7 @@ os.setenv('STARSHIP_CONFIG', 'C:\\Users\\user\\example\\non\\default\\path\\star export STARSHIP_CACHE=~/.starship/cache ``` -PowerShell (Windows) で同様に `$PROFILE` にこの行を追加します。 +PowerShell (Windows) で同様に `$PROFILE`にこの行を追加します。 ```powershell $ENV:STARSHIP_CACHE = "$HOME\AppData\Local\Temp" @@ -199,6 +199,7 @@ $git_status\ $hg_branch\ $docker_context\ $package\ +$buf\ $cmake\ $cobol\ $container\ @@ -209,6 +210,7 @@ $elixir\ $elm\ $erlang\ $golang\ +$haskell\ $helm\ $java\ $julia\ @@ -262,7 +264,7 @@ format = "$all$directory$character" ## AWS -The `aws` module shows the current AWS region and profile when credentials or a `credential_process` 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. これは `~/.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. @@ -276,12 +278,13 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL | オプション | デフォルト | 説明 | | ------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------- | -| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | moduleのフォーマットです。 | +| `format` | `'on [$symbol($profile )(\($region\) )(\[$duration\])]($style)'` | module のフォーマットです。 | | `symbol` | `"☁️ "` | 現在のAWSプロファイルを表示する前に表示される記号です。 | | `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`モジュールを無効にします。 | +| `disabled` | `false` | Disables the `AWS` module. | ### 変数 @@ -309,6 +312,8 @@ symbol = "🅰 " [aws.region_aliases] ap-southeast-2 = "au" us-east-1 = "va" +[aws.profile_aliases] +CompanyGroupFrobozzOnCallAccess = 'Frobozz' ``` #### リージョンを表示 @@ -334,6 +339,8 @@ us-east-1 = "va" format = "on [$symbol$profile]($style) " style = "bold blue" symbol = "🅰 " +[aws.profile_aliases] +Enterprise_Naming_Scheme-voidstars = 'void**' ``` ## Azure @@ -427,22 +434,55 @@ discharging_symbol = "💦" # when capacity is over 30%, the battery indicator will not be displayed ``` -## Character +## Buf -`character`モジュールは、端末でテキストが入力される場所の横に文字（通常は矢印）を表示します。 +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: -文字は、最後のコマンドが成功したかどうかを示します。 表し方は下記の2つです。 +- 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. -- 色の変更 (`赤`/`緑`) -- プロンプトの表示の変更 (`❯`/`✖`) +### オプション -デフォルトでは、色だけが変更されます。 形も変えてみたい場合は[このサンプル](#with-custom-error-shape)も参考にしてください。 +| オプション | デフォルト | 説明 | +| ------------------- | ------------------------------------------------------------ | ----------------------------------------------------- | +| `format` | `'with [$symbol($version \(Buf $buf_version\) )]($style)'` | The format for the `buf` module. | +| `version_format` | `"v${raw}"` | バージョンのフォーマット。 | +| `symbol` | `"🦬 "` | The symbol used before displaying the version of Buf. | +| `detect_extensions` | `[]` | どの拡張子がこのモジュールをアクティブにするか | +| `detect_files` | `["buf.yaml", "buf.gen.yaml", "buf.work.yaml"]` | どのファイル名がこのモジュールをアクティブにするか | +| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | +| `style` | `"bold blue"` | モジュールのスタイルです。 | +| `disabled` | `false` | Disables the `elixir` module. | -::: warning +### 変数 -`error_symbol` is not supported on nu shell. +| 変数 | 設定例 | 説明 | +| ------------- | -------- | ---------------------- | +| `buf_version` | `v1.0.0` | The version of `buf` | +| `symbol` | | オプション `記号` の値をミラーする | +| `style`* | | オプション `style` の値をミラーする | -::: +*: この変数は、スタイル文字列の一部としてのみ使用することができます。 + +### 設定例 + +```toml +# ~/.config/starship.toml + +[buf] +symbol = "🦬 " +``` + +## 文字 + +The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. + +The character will tell you whether the last command was successful or not. It can do this in two ways: + +- 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). ::: warning @@ -452,19 +492,19 @@ discharging_symbol = "💦" ### オプション -| オプション | デフォルト | 説明 | -| ---------------- | ------------------- | -------------------------------------------- | -| `format` | `"$symbol"` | テキスト入力の前に使用される書式文字列。 | -| `success_symbol` | `"[❯](bold green)"` | 前のコマンドが成功した場合にテキスト入力の前に使用される書式文字列です。 | -| `error_symbol` | `"[❯](bold red)"` | 前のコマンドが失敗した場合にテキスト入力の前に使用される書式文字列です。 | -| `vicmd_symbol` | `"[❮](bold green)"` | シェルが vim ノーマルモードの場合にテキスト入力の前に使用されるフォーマット文字列。 | -| `disabled` | `false` | `character`モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| ---------------- | ------------------- | -------------------------------------------------------------------------------- | +| `format` | `"$symbol "` | The format string used before the text input. | +| `success_symbol` | `"[❯](bold green)"` | The format string used before the text input if the previous command succeeded. | +| `error_symbol` | `"[❯](bold red)"` | The format string used before the text input if the previous command failed. | +| `vicmd_symbol` | `"[❮](bold green)"` | The format string used before the text input if the shell is in vim normal mode. | +| `disabled` | `false` | Disables the `character` module. | ### 変数 -| 変数 | 設定例 | 説明 | -| ------ | --- | ----------------------------------------------------------- | -| symbol | | `success_symbol` 、もしくは `error_symbol` 、 `vicmd_symbol` のミラー | +| 変数 | 設定例 | 説明 | +| ------ | --- | --------------------------------------------------------------------- | +| symbol | | A mirror of either `success_symbol`, `error_symbol` or `vicmd_symbol` | ### 設定例 @@ -499,29 +539,29 @@ vicmd_symbol = "[V](bold green) " ## CMake -`cmake`モジュールは、現在インストールされている[Cmake](https://cmake.org/)のバージョンを表示します。 デフォルトでは次のいずれかの条件が満たされると、モジュールがアクティブになります。 +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: -- カレントディレクトリに `CMakeLists.txt` ファイルが含まれている -- カレントディレクトリに `CMakeCache.txt` ファイルが含まれている +- The current directory contains a `CMakeLists.txt` file +- The current directory contains a `CMakeCache.txt` file ### オプション | オプション | デフォルト | 説明 | | ------------------- | -------------------------------------- | ------------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | +| `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 | | `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | -| `symbol` | `"△ "` | cmakeのバージョンの前に使用される記号 | -| `detect_extensions` | `[]` | どの拡張子がこのモジュールをアクティブにするか | -| `detect_files` | `["CMakeLists.txt", "CMakeCache.txt"]` | どのファイル名がこのモジュールをアクティブにするか | -| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | +| `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 | | `style` | `"bold blue"` | モジュールのスタイルです。 | -| `disabled` | `false` | `cmake`モジュールを無効にします。 | +| `disabled` | `false` | Disables the `cmake` module. | ### 変数 | 変数 | 設定例 | 説明 | | --------- | --------- | ---------------------- | -| version | `v3.17.3` | cmake のバージョン | +| version | `v3.17.3` | The version of cmake | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | @@ -529,7 +569,7 @@ vicmd_symbol = "[V](bold green) " ## COBOL / GNUCOBOL -`COBOL` モジュールは、現在インストールされているCOBOLのバージョンを表示します。 By default, the module will be shown if any of the following conditions are met: +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: - The current directory contains any files ending in `.cob` or `.COB` - The current directory contains any files ending in `.cbl` or `.CBL` @@ -539,7 +579,7 @@ vicmd_symbol = "[V](bold green) " | オプション | デフォルト | 説明 | | ------------------- | ------------------------------------ | ------------------------------------------------------- | | `symbol` | `"⚙️ "` | The symbol used before displaying the version of COBOL. | -| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | +| `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 | | `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | | `style` | `"bold blue"` | モジュールのスタイルです。 | | `detect_extensions` | `["cbl", "cob", "CBL", "COB"]` | どの拡張子がこのモジュールをアクティブにするか | @@ -557,37 +597,37 @@ vicmd_symbol = "[V](bold green) " *: この変数は、スタイル文字列の一部としてのみ使用することができます。 -## Command Duration +## コマンド実行時間 -`cmd_duration`モジュールは、最後のコマンドの実行にかかった時間を示します。 モジュールが表示されるのは、コマンドが2秒以上かかった場合、または`min_time`値が存在する場合のみです。 +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. -::: warning BashでDEBUGトラップをhookしない +::: warning Do not hook the DEBUG trap in Bash -`bash`でStarshipを実行している場合、 `eval $(starship init $0)`実行した後に`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. ::: -preexecのような機能を必要とするBashユーザーは、 [rcalorasのbash_preexecフレームワーク](https://github.com/rcaloras/bash-preexec)を使用できます。 `eval $(starship init $0)` を実行する前に、`preexec_functions`、および`precmd_functions`定義するだけで、通常どおり続行します。 +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. ### オプション | オプション | デフォルト | 説明 | | ---------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `min_time` | `2_000` | 実行時間を表示する最短期間（ミリ秒単位）です。 | -| `show_milliseconds` | `false` | 実行時間の秒に加えてミリ秒を表示します。 | -| `format` | `"took [$duration]($style) "` | moduleのフォーマットです。 | +| `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) "` | module のフォーマットです。 | | `style` | `"bold yellow"` | モジュールのスタイルです。 | -| `disabled` | `false` | `cmd_duration`モジュールを無効にします。 | -| `show_notifications` | `false` | コマンドが完了したらデスクトップ通知を表示します。 | -| `min_time_to_notify` | `45_000` | 通知を持続する最短期間(ミリ秒単位) | +| `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. | ### 変数 -| 変数 | 設定例 | 説明 | -| --------- | -------- | ---------------------- | -| duration | `16m40s` | コマンドの実行時間 | -| style\* | | オプション `style` の値をミラーする | +| 変数 | 設定例 | 説明 | +| --------- | -------- | --------------------------------------- | +| duration | `16m40s` | The time it took to execute the command | +| style\* | | オプション `style` の値をミラーする | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -607,28 +647,28 @@ The `conda` module shows the current [Conda](https://docs.conda.io/en/latest/) e ::: tip -Note: これはconda自身の プロンプト修飾子 を抑制しません。`conda config --set changeps1 False` で実行することができます。 +This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. ::: ### オプション -| オプション | デフォルト | 説明 | -| ------------------- | -------------------------------------- | ---------------------------------------------------------------------------------------------------------------- | -| `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`モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| ------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `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. | ### 変数 -| 変数 | 設定例 | 説明 | -| ----------- | ------------ | ---------------------- | -| environment | `astronauts` | 現在の conda 環境 | -| symbol | | オプション `記号` の値をミラーする | -| style\* | | オプション `style` の値をミラーする | +| 変数 | 設定例 | 説明 | +| ----------- | ------------ | ----------------------------- | +| environment | `astronauts` | The current conda environment | +| symbol | | オプション `記号` の値をミラーする | +| style\* | | オプション `style` の値をミラーする | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -647,12 +687,12 @@ 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"` | モジュールのスタイルです。 | -| `format` | "[$symbol \\[$name\\]]($style) " | moduleのフォーマットです。 | -| `disabled` | `false` | Disables the `container` module. | +| オプション | デフォルト | 説明 | +| ---------- | -------------------------------------- | ----------------------------------------- | +| `symbol` | `"⬢"` | The symbol shown, when inside a container | +| `style` | `"bold red dimmed"` | モジュールのスタイルです。 | +| `format` | `"[$symbol \\[$name\\]]($style) "` | module のフォーマットです。 | +| `disabled` | `false` | Disables the `container` module. | ### 変数 @@ -675,31 +715,31 @@ format = "[$symbol \\[$name\\]]($style) " ## Crystal -`crystal`モジュールは、現在インストールされている[Crystal](https://crystal-lang.org/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +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: -- カレントディレクトリに`shard.yml`ファイルが含まれている -- カレントディレクトリに`.cr`の拡張子のファイルが含まれている +- The current directory contains a `shard.yml` file +- The current directory contains a `.cr` file ### オプション -| オプション | デフォルト | 説明 | -| ------------------- | ------------------------------------ | ------------------------------------------------------ | -| `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`モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| ------------------- | ------------------------------------ | --------------------------------------------------------- | +| `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. | ### 変数 -| 変数 | 設定例 | 説明 | -| --------- | --------- | ---------------------- | -| version | `v0.32.1` | `crystal` のバージョン | -| symbol | | オプション `記号` の値をミラーする | -| style\* | | オプション `style` の値をミラーする | +| 変数 | 設定例 | 説明 | +| --------- | --------- | ------------------------ | +| version | `v0.32.1` | The version of `crystal` | +| symbol | | オプション `記号` の値をミラーする | +| style\* | | オプション `style` の値をミラーする | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -714,11 +754,11 @@ format = "via [✨ $version](bold blue) " ## Dart -`dart`モジュールは、現在インストールされている[Dart](https://dart.dev/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +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_tool`ディレクトリが含まれている -- カレントディレクトリに`pubspec.yaml`, `pubspec.yml`,もしくは`pubspec.lock`が含まれている +- 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 ### オプション @@ -726,18 +766,18 @@ format = "via [✨ $version](bold blue) " | ------------------- | ------------------------------------------------- | ------------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | | `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | -| `symbol` | `"🎯 "` | Dartのシンボルを表すフォーマット文字列 | +| `symbol` | `"🎯 "` | A format string representing the symbol of Dart | | `detect_extensions` | `["dart"]` | どの拡張子がこのモジュールをアクティブにするか | | `detect_files` | `["pubspec.yaml", "pubspec.yml", "pubspec.lock"]` | どのファイル名がこのモジュールをアクティブにするか | | `detect_folders` | `[".dart_tool"]` | どのフォルダーがこのモジュールをアクティブにするか | | `style` | `"bold blue"` | モジュールのスタイルです。 | -| `disabled` | `false` | `dart`モジュールを無効にします。 | +| `disabled` | `false` | Disables the `dart` module. | ### 変数 | 変数 | 設定例 | 説明 | | --------- | -------- | ---------------------- | -| version | `v2.8.4` | `dart` のバージョン | +| version | `v2.8.4` | The version of `dart` | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | @@ -754,7 +794,7 @@ format = "via [🔰 $version](bold red) " ## Deno -`deno`モジュールは、現在インストールされている[Deno](https://deno.land/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +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 current directory contains a `deno.json`, `deno.jsonc`, `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file @@ -762,20 +802,20 @@ format = "via [🔰 $version](bold red) " | オプション | デフォルト | 説明 | | ------------------- | ----------------------------------------------------------------------- | ------------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | +| `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 | | `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | -| `symbol` | `"🦕 "` | Dart のシンボルを表すフォーマット文字列 | +| `symbol` | `"🦕 "` | A format string representing the symbol of Deno | | `detect_extensions` | `[]` | どの拡張子がこのモジュールをアクティブにするか | | `detect_files` | `["deno.json", "deno.jsonc", "mod.ts", "mod.js", "deps.ts", "deps.js"]` | どのファイル名がこのモジュールをアクティブにするか | | `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | | `style` | `"green bold"` | モジュールのスタイルです。 | -| `disabled` | `false` | `deno`モジュールを無効化します。 | +| `disabled` | `false` | Disables the `deno` module. | ### 変数 | 変数 | 設定例 | 説明 | | --------- | -------- | ---------------------- | -| version | `v1.8.3` | `deno`のバージョン | +| version | `v1.8.3` | The version of `deno` | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | @@ -790,36 +830,36 @@ format = "via [🦕 $version](green bold) " ## Directory -`directory`モジュールには、現在のディレクトリへのパスが表示され、3つの親フォルダは切り捨てられます。 ディレクトリは、現在のgitリポジトリであるとルートとなります。 +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. -fishスタイルのpwdオプションを使用すると、切り捨てられたパスを非表示にする代わりに、オプションで有効にした番号に基づいて各ディレクトリの短縮名が表示されます。 +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. -例として、`~/Dev/Nix/nixpkgs/pkgs`で、`nixpkgs`がリポジトリルートであり、オプションが`1`に設定されている場合を挙げます。 以前は`nixpkgs/pkgs`でしたが、`~/D/N/nixpkgs/pkgs`が表示されます。 +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`. ### オプション | オプション | デフォルト | 説明 | | ------------------- | ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `truncation_length` | `3` | 現在のディレクトリを切り捨てる親フォルダーの数です。 | -| `truncate_to_repo` | `true` | 現在いるgitリポジトリのルートに切り捨てるかどうかです。 | -| `format` | `"[$path]($style)[$read_only]($read_only_style) "` | moduleのフォーマットです。 | +| `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) "` | module のフォーマットです。 | | `style` | `"bold cyan"` | モジュールのスタイルです。 | -| `disabled` | `false` | `directory`モジュールを無効にします。 | -| `read_only` | `"🔒"` | このシンボルが表示されている時、現在のディレクトリは読み取り専用です。 | -| `read_only_style` | `"red"` | 読み取り専用シンボルのスタイルです。 | -| `truncation_symbol` | `""` | The symbol to prefix to truncated paths. 例: "…/" | +| `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` | `"~"` | ホームディレクトリを示すシンボルです。 | +| `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) |
-このモジュールは、どのようにディレクトリを表示するかについての高度なオプションをいくつか持っています。 +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` | fish shellのpwdパスロジックを適用するときに使用する文字数です。 | +| `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. | `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. @@ -836,10 +876,10 @@ fishスタイルのpwdオプションを使用すると、切り捨てられた ### 変数 -| 変数 | 設定例 | 説明 | -| --------- | --------------------- | ---------------------- | -| path | `"D:/Projects"` | カレントディレクトリのパス | -| style\* | `"black bold dimmed"` | オプション `style` の値をミラーする | +| 変数 | 設定例 | 説明 | +| --------- | --------------------- | -------------------------- | +| path | `"D:/Projects"` | The current directory path | +| style\* | `"black bold dimmed"` | オプション `style` の値をミラーする | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -874,24 +914,24 @@ The `docker_context` module shows the currently active [Docker context](https:// ### オプション -| オプション | デフォルト | 説明 | -| ------------------- | ---------------------------------- | -------------------------------------------------------------- | -| `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`モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| ------------------- | ------------------------------------------------------------- | --------------------------------------------------------------------------------- | +| `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. | ### 変数 -| 変数 | 設定例 | 説明 | -| --------- | -------------- | ---------------------- | -| context | `test_context` | 現在の Docker コンテキスト | -| symbol | | オプション `記号` の値をミラーする | -| style\* | | オプション `style` の値をミラーする | +| 変数 | 設定例 | 説明 | +| --------- | -------------- | -------------------------- | +| context | `test_context` | The current docker context | +| symbol | | オプション `記号` の値をミラーする | +| style\* | | オプション `style` の値をミラーする | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -906,9 +946,9 @@ format = "via [🐋 $context](blue bold)" ## Dotnet -`dotnet`モジュールはカレントディレクトリに関係する[.NET Core SDK](https://dotnet.microsoft.com/)のバージョンを表示します。 もし SDKは現在のディレクトリに固定されているのであれば、その固定されたバージョンが表示されます。 それ以外の場合、モジュール SDKの最新のインストールバージョンを示します。 +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. -デフォルトでは、このモジュールは現在のディレクトリに以下のファイルが 存在する場合にのみプロンプトで表示されます: +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` @@ -921,29 +961,29 @@ format = "via [🐋 $context](blue bold)" You'll also need the .NET Core SDK installed in order to use it correctly. -内部的に、このモジュールは自身のバージョン検知のメカニズムを利用します。 `dotnet --version` を実行するより2倍速く実行できますが、.NET project一般的でないディレクトリlayoutの場合は間違ったバージョンが示されてしまうことがあります。 速度よりも精度が重要な場合は、次の方法でメカニズムを無効にできます。 モジュールオプションで`heuristic = false `を設定します。 +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. ### オプション -| オプション | デフォルト | 説明 | -| ------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ | -| `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`モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| ------------------- | ------------------------------------------------------------------------------------------------------- | -------------------------------------------------------- | +| `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. | ### 変数 | 変数 | 設定例 | 説明 | | --------- | ---------------- | ------------------------------------------------------------------ | -| version | `v3.1.201` | `dotnet sdk` のバージョンです | +| version | `v3.1.201` | The version of `dotnet` sdk | | tfm | `netstandard2.0` | The Target Framework Moniker that the current project is targeting | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | @@ -963,9 +1003,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/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +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: -- カレントディレクトリに`mix.exs`ファイルが含まれている. +- The current directory contains a `mix.exs` file. ### オプション @@ -1002,26 +1042,26 @@ symbol = "🔮 " ## Elm -The `elm` module shows the currently installed version of [Elm](https://elm-lang.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +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: -- カレントディレクトリに`elm.json`ファイルが含まれている -- カレントディレクトリに`elm-package.json`ファイルが含まれている -- カレントディレクトリに`.elm-version`ファイルが含まれている -- カレントディレクトリに`elm-stuff`フォルダが含まれている -- カレントディレクトリに`*.elm`ファイルが含まれている +- 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 +- The current directory contains `*.elm` files ### オプション | オプション | デフォルト | 説明 | | ------------------- | -------------------------------------------------- | ------------------------------------------------------ | -| `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 Elm. | | `detect_extensions` | `["elm"]` | どの拡張子がこのモジュールをアクティブにするか | | `detect_files` | `["elm.json", "elm-package.json", ".elm-version"]` | どのファイル名がこのモジュールをアクティブにするか | | `detect_folders` | `["elm-stuff"]` | どのフォルダーがこのモジュールをアクティブにするか | | `style` | `"cyan bold"` | モジュールのスタイルです。 | -| `disabled` | `false` | `elm`モジュールを無効にします。 | +| `disabled` | `false` | Disables the `elm` module. | ### 変数 @@ -1042,12 +1082,12 @@ The `elm` module shows the currently installed version of [Elm](https://elm-lang format = "via [ $version](cyan bold) " ``` -## Environment Variable +## 環境変数 -The `env_var` module displays the current value of a selected environment variables. 次の条件のいずれかが満たされると、モジュールが表示されます。 +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: -- `variable`オプションが、既存の環境変数と一致する -- `variable`オプションが定義されておらず、`default`オプションが定義されている +- The `variable` configuration option matches an existing environment variable +- The `variable` configuration option is not defined, but the `default` configuration option is ::: tip Multiple environmental variables can be displayed by using a `.`. (see example) If the `variable` configuration option is not set, the module will display value of variable under the name of text after the `.` character. @@ -1064,13 +1104,13 @@ default = "unknown user" ### オプション -| オプション | デフォルト | 説明 | -| ---------- | ------------------------------ | ------------------------------------- | -| `symbol` | `""` | 環境変数を表示する前に使用される記号です。 | -| `variable` | | 表示される環境変数です。 | -| `default` | | 上のvariableが定義されていない場合に表示されるデフォルトの値です。 | -| `format` | `"with [$env_value]($style) "` | moduleのフォーマットです。 | -| `disabled` | `false` | `env_var`モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| ---------- | ------------------------------ | ---------------------------------------------------------------------------- | +| `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. | ### 変数 @@ -1106,31 +1146,31 @@ default = "unknown user" ## Erlang -The `erlang` module shows the currently installed version of [Erlang/OTP](https://erlang.org/doc/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +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: -- カレントディレクトリに`rebar.config`ファイルが含まれている. -- カレントディレクトリに`erlang.mk`ファイルが含まれている. +- The current directory contains a `rebar.config` file. +- The current directory contains a `erlang.mk` file. ### オプション | オプション | デフォルト | 説明 | | ------------------- | ------------------------------------ | -------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | +| `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 | | `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | | `symbol` | `" "` | The symbol used before displaying the version of erlang. | | `style` | `"bold red"` | モジュールのスタイルです。 | | `detect_extensions` | `[]` | どの拡張子がこのモジュールをアクティブにするか | | `detect_files` | `["rebar.config", "elang.mk"]` | どのファイル名がこのモジュールをアクティブにするか | | `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | -| `disabled` | `false` | `erlang`モジュールを無効にします。 | +| `disabled` | `false` | Disables the `erlang` module. | ### 変数 -| 変数 | 設定例 | 説明 | -| --------- | --------- | ---------------------- | -| version | `v22.1.3` | `erlang` のバージョン | -| symbol | | オプション `記号` の値をミラーする | -| style\* | | オプション `style` の値をミラーする | +| 変数 | 設定例 | 説明 | +| --------- | --------- | ----------------------- | +| version | `v22.1.3` | The version of `erlang` | +| symbol | | オプション `記号` の値をミラーする | +| style\* | | オプション `style` の値をミラーする | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -1145,7 +1185,7 @@ format = "via [e $version](bold red) " ## Fill -`fill` モジュールは行の余分なスペースを記号で埋めます。 一行に複数の`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. ### オプション @@ -1174,30 +1214,30 @@ AA -------------------------------------------- BB ----------------------------- ## Google Cloud (`gcloud`) -`gcloud` モジュールは、 [`gcloud`](https://cloud.google.com/sdk/gcloud) CLIの現在の設定が表示されます。 これは `~/.config/gcloud/active_config` ファイルと `~/.config/gcloud/configurations/config_{CONFIG NAME}` ファイルと `CLOUDSDK_CONFIG` 環境変数に基づきます。 +The `gcloud` module shows the current configuration for [`gcloud`](https://cloud.google.com/sdk/gcloud) CLI. This is based on the `~/.config/gcloud/active_config` file and the `~/.config/gcloud/configurations/config_{CONFIG NAME}` file and the `CLOUDSDK_CONFIG` env var. ### オプション | オプション | デフォルト | 説明 | | ----------------- | ---------------------------------------------------------- | ---------------------------------------------------------------- | -| `format` | `'on [$symbol$account(@$domain)(\($region\))]($style) '` | moduleのフォーマットです。 | -| `symbol` | `"☁️ "` | 現在のGCPプロファイルを表示する前に表示される記号です。 | -| `region_aliases` | | GCP名に加えて表示するリージョンのエイリアスです。 | +| `format` | `'on [$symbol$account(@$domain)(\($region\))]($style) '` | module のフォーマットです。 | +| `symbol` | `"☁️ "` | The symbol used before displaying the current GCP profile. | +| `region_aliases` | | Table of region aliases to display in addition to the GCP name. | | `project_aliases` | | Table of project aliases to display in addition to the GCP name. | | `style` | `"bold blue"` | モジュールのスタイルです。 | -| `disabled` | `false` | `gcloud`モジュールを無効にします。 | +| `disabled` | `false` | Disables the `gcloud` module. | ### 変数 -| 変数 | 設定例 | 説明 | -| --------- | ------------- | ----------------------------------------------- | -| 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` の値をミラーする | +| 変数 | 設定例 | 説明 | +| --------- | ------------- | ------------------------------------------------------------------ | +| 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` の値をミラーする | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -1247,20 +1287,21 @@ very-long-project-name = "vlpn" ## Git Branch -`git_branch`モジュールは、現在のディレクトリにあるリポジトリのアクティブなブランチを表示します。 +The `git_branch` module shows the active branch of the repo in your current directory. ### オプション -| オプション | デフォルト | 説明 | -| -------------------- | -------------------------------- | ------------------------------------------------------------------------------------ | -| `always_show_remote` | `false` | 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. | -| `disabled` | `false` | `git_branch`モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| -------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | +| `always_show_remote` | `false` | Shows the remote tracking branch name, even if it is equal to the local branch name. | +| `format` | `"on [$symbol$branch]($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. | ### 変数 @@ -1283,30 +1324,31 @@ very-long-project-name = "vlpn" symbol = "🌱 " truncation_length = 4 truncation_symbol = "" +ignore_branches = ["master", "main"] ``` -## Git Commit +## Git コミット -`git_commit` モジュールは、カレントディレクトリのリポジトリの現在のコミットハッシュとタグ (もしあれば) を表示します。 +The `git_commit` module shows the current commit hash and also the tag (if any) of the repo in your current directory. ### オプション -| オプション | デフォルト | 説明 | -| -------------------- | ---------------------------------- | ----------------------------------------- | -| `commit_hash_length` | `7` | 表示されるgitコミットハッシュの長さです。 | -| `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`モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| -------------------- | ---------------------------------- | ------------------------------------------------------- | +| `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. | ### 変数 -| 変数 | 設定例 | 説明 | -| --------- | --------- | ---------------------- | -| hash | `b703eb3` | 現在の git コミットハッシュ | -| style\* | | オプション `style` の値をミラーする | +| 変数 | 設定例 | 説明 | +| --------- | --------- | --------------------------- | +| hash | `b703eb3` | The current git commit hash | +| style\* | | オプション `style` の値をミラーする | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -1322,7 +1364,7 @@ tag_symbol = "🔖 " ## Git State -`git_state`モジュールはgitディレクトリの進行状態を表します。 (例: _REBASING_, _BISECTING_, その他) 進捗情報がある場合(例: REBASING 3/10)はその情報も表示されます。 +The `git_state` module will show in directories which are part of a git repository, and where there is an operation in progress, such as: _REBASING_, _BISECTING_, etc. If there is progress information (e.g., REBASING 3/10), that information will be shown too. ### オプション @@ -1336,8 +1378,8 @@ tag_symbol = "🔖 " | `am` | `"AM"` | A format string displayed when an `apply-mailbox` (`git am`) is in progress. | | `am_or_rebase` | `"AM/REBASE"` | A format string displayed when an ambiguous `apply-mailbox` or `rebase` is in progress. | | `style` | `"bold yellow"` | モジュールのスタイルです。 | -| `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | moduleのフォーマットです。 | -| `disabled` | `false` | `git_state`モジュールを無効にします。 | +| `format` | `'\([$state( $progress_current/$progress_total)]($style)\) '` | module のフォーマットです。 | +| `disabled` | `false` | Disables the `git_state` module. | ### 変数 @@ -1366,7 +1408,7 @@ The `git_metrics` module will show the number of added and deleted lines in the ::: tip -このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで`disabled`を`false`に設定します。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -1377,7 +1419,7 @@ The `git_metrics` module will show the number of added and deleted lines in the | `added_style` | `"bold green"` | The style for the added count. | | `deleted_style` | `"bold red"` | The style for the deleted count. | | `only_nonzero_diffs` | `true` | Render status only for changed items. | -| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | moduleのフォーマットです。 | +| `format` | `'([+$added]($added_style) )([-$deleted]($deleted_style) )'` | module のフォーマットです。 | | `disabled` | `true` | Disables the `git_metrics` module. | ### 変数 @@ -1403,7 +1445,7 @@ format = '[+$added]($added_style)/[-$deleted]($deleted_style) ' ## Git Status -`git_status`モジュールは、現在のディレクトリのリポジトリの状態を表すシンボルを表示します。 +The `git_status` module shows symbols representing the state of the repo in your current directory. ::: tip @@ -1415,11 +1457,11 @@ The Git Status module is very slow in Windows directories (for example under `/m | オプション | デフォルト | 説明 | | ------------------- | ----------------------------------------------- | ----------------------------------------------------------------------------------------------------------- | -| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | `git_status` のデフォルトフォーマット | -| `conflicted` | `"="` | このブランチにはマージの競合があります。 | -| `ahead` | `"⇡"` | `ahead`のフォーマット | -| `behind` | `"⇣"` | `behind`のフォーマット | -| `diverged` | `"⇕"` | `diverged`のフォーマット | +| `format` | `'([\[$all_status$ahead_behind\]]($style) )'` | The default format for `git_status` | +| `conflicted` | `"="` | This branch has merge conflicts. | +| `ahead` | `"⇡"` | The format of `ahead` | +| `behind` | `"⇣"` | The format of `behind` | +| `diverged` | `"⇕"` | The format of `diverged` | | `up_to_date` | `""` | The format of `up_to_date` | | `untracked` | `"?"` | The format of `untracked` | | `stashed` | `"$"` | The format of `stashed` | @@ -1429,12 +1471,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` | `git_status`モジュールを無効にします。 | +| `disabled` | `false` | Disables the `git_status` module. | | `windows_starship` | | Use this (Linux) path to a Windows Starship executable to render `git_status` when on Windows paths in WSL. | ### 変数 -` format` 内では以下の変数が利用できます。 +The following variables can be used in `format`: | 変数 | 説明 | | -------------- | ------------------------------------------------------------------------------------------------------------- | @@ -1460,9 +1502,9 @@ The following variables can be used in `diverged`: The following variables can be used in `conflicted`, `ahead`, `behind`, `untracked`, `stashed`, `modified`, `staged`, `renamed` and `deleted`: -| 変数 | 説明 | -| ------- | ------------- | -| `count` | ファイルの数を表示します。 | +| 変数 | 説明 | +| ------- | ------------------------ | +| `count` | Show the number of files | ### 設定例 @@ -1505,16 +1547,16 @@ 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/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +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: -- カレントディレクトリに`go.mod`ファイルが含まれている -- カレントディレクトリに`go.sum`ファイルが含まれている -- カレントディレクトリに`glide.yaml`ファイルが含まれている -- カレントディレクトリに`Gopkg.yml`ファイルが含まれている -- カレントディレクトリに`Gopkg.lock`ファイルが含まれている -- カレントディレクトリに`.go-version`ファイルが含まれている -- カレントディレクトリに`Godeps`ファイルが含まれている -- カレントディレクトリに`.go`の拡張子のファイルが含まれている +- 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 ### オプション @@ -1527,7 +1569,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"]` | どのファイル名がこのモジュールをアクティブにするか | | `detect_folders` | `["Godeps"]` | どのフォルダーがこのモジュールをアクティブにするか | | `style` | `"bold cyan"` | モジュールのスタイルです。 | -| `disabled` | `false` | `golang`モジュールを無効にします。 | +| `disabled` | `false` | Disables the `golang` module. | ### 変数 @@ -1548,18 +1590,51 @@ The `golang` module shows the currently installed version of [Go](https://golang format = "via [🏎💨 $version](bold cyan) " ``` +## Haskell + +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 +- The current directory contains any `.hs`, `.cabal`, or `.hs-boot` file + +### オプション + +| オプション | デフォルト | 説明 | +| ------------------- | ------------------------------------ | -------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 | +| `symbol` | `"λ "` | A format string representing the symbol of Haskell | +| `detect_extensions` | `["hs", "cabal", "hs-boot"]` | どの拡張子がこのモジュールをアクティブにするか | +| `detect_files` | `["stack.yaml", "cabal.project"]` | どのファイル名がこのモジュールをアクティブにするか | +| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | +| `style` | `"bold purple"` | モジュールのスタイルです。 | +| `disabled` | `false` | Disables the `haskell` module. | + +### 変数 + +| 変数 | 設定例 | 説明 | +| -------------- | ----------- | --------------------------------------------------------------------------------------- | +| version | | `ghc_version` or `snapshot` depending on whether the current project is a Stack project | +| snapshot | `lts-18.12` | Currently selected Stack snapshot | +| ghc\_version | `9.2.1` | Currently installed GHC version | +| symbol | | オプション `記号` の値をミラーする | +| style\* | | オプション `style` の値をミラーする | + +*: この変数は、スタイル文字列の一部としてのみ使用することができます。 + ## Helm -The `helm` module shows the currently installed version of [Helm](https://helm.sh/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +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: -- カレントディレクトリに`helmfile.yaml`ファイルが含まれている +- The current directory contains a `helmfile.yaml` file - The current directory contains a `Chart.yaml` file ### オプション | オプション | デフォルト | 説明 | | ------------------- | ------------------------------------ | ------------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | +| `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 | | `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | | `detect_extensions` | `[]` | どの拡張子がこのモジュールをアクティブにするか | | `detect_files` | `["helmfile.yaml", "Chart.yaml"]` | どのファイル名がこのモジュールをアクティブにするか | @@ -1587,25 +1662,25 @@ The `helm` module shows the currently installed version of [Helm](https://helm.s format = "via [⎈ $version](bold white) " ``` -## Hostname +## ホスト名 -`hostname`モジュールには、システムのホスト名が表示されます。 +The `hostname` module shows the system hostname. ### オプション -| オプション | デフォルト | 説明 | -| ---------- | --------------------------- | --------------------------------------------------------------------------- | -| `ssh_only` | `true` | SSHセッションに接続されている場合にのみホスト名を表示します。 | -| `trim_at` | `"."` | この文字が最初にマッチするまでをホスト名と認識します。 `"."`は最初の. までをホスト名として認識します。 `""`を指定した場合トリムしません。 | -| `format` | `"[$hostname]($style) in "` | moduleのフォーマットです。 | -| `style` | `"bold dimmed green"` | モジュールのスタイルです。 | -| `disabled` | `false` | `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. | ### 変数 | 変数 | 設定例 | 説明 | | --------- | ---------- | ---------------------------- | -| ホスト名 | `computer` | The hostname of the computer | +| hostname | `computer` | The hostname of the computer | | style\* | | オプション `style` の値をミラーする | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -1624,7 +1699,7 @@ disabled = false ## Java -The `java` module shows the currently installed version of [Java](https://www.oracle.com/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 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 @@ -1633,14 +1708,14 @@ The `java` module shows the currently installed version of [Java](https://www.or | オプション | デフォルト | 説明 | | ------------------- | --------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ | -| `format` | `"via [${symbol}(${version} )]($style)"` | moduleのフォーマットです。 | +| `format` | `"via [${symbol}(${version} )]($style)"` | module のフォーマットです。 | | `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | | `detect_extensions` | `["java", "class", "gradle", "jar", "cljs", "cljc"]` | どの拡張子がこのモジュールをアクティブにするか | | `detect_files` | `["pom.xml", "build.gradle.kts", "build.sbt", ".java-version", ".deps.edn", "project.clj", "build.boot"]` | どのファイル名がこのモジュールをアクティブにするか | | `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | | `symbol` | `"☕ "` | A format string representing the symbol of Java | | `style` | `"red dimmed"` | モジュールのスタイルです。 | -| `disabled` | `false` | `Java`モジュールを無効にします。 | +| `disabled` | `false` | Disables the `java` module. | ### 変数 @@ -1661,9 +1736,9 @@ The `java` module shows the currently installed version of [Java](https://www.or symbol = "🌟 " ``` -## ジョブ +## Jobs -`jobs`モジュールには、実行中のジョブの現在の数が表示されます。 このモジュールは、実行中のバックグラウンドジョブがある場合にのみ表示されます。 The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to _always_ show the symbol and number of jobs, even if there are 0 jobs running. +The `jobs` module shows the current number of jobs running. The module will be shown only if there are background jobs running. The module will show the number of jobs running if there are at least 2 jobs, or more than the `number_threshold` config value, if it exists. The module will show a symbol if there is at least 1 job, or more than the `symbol_threshold` config value, if it exists. You can set both values to 0 in order to _always_ show the symbol and number of jobs, even if there are 0 jobs running. The default functionality is: @@ -1687,13 +1762,13 @@ The `threshold` option is deprecated, but if you want to use it, the module will | オプション | デフォルト | 説明 | | ------------------ | ----------------------------- | ------------------------------------------------------------------------ | -| `threshold`* | `1` | 超過した場合、ジョブの数を表示します。 | +| `threshold`* | `1` | Show number of jobs if exceeded. | | `symbol_threshold` | `1` | Show `symbol` if the job count is at least `symbol_threshold`. | | `number_threshold` | `2` | Show the number of jobs if the job count is at least `number_threshold`. | -| `format` | `"[$symbol$number]($style) "` | moduleのフォーマットです。 | +| `format` | `"[$symbol$number]($style) "` | module のフォーマットです。 | | `symbol` | `"✦"` | The string used to represent the `symbol` variable. | | `style` | `"bold blue"` | モジュールのスタイルです。 | -| `disabled` | `false` | `jobs`モジュールを無効にします。 | +| `disabled` | `false` | Disables the `jobs` module. | *: This option is deprecated, please use the `number_threshold` and `symbol_threshold` options instead. @@ -1701,7 +1776,7 @@ The `threshold` option is deprecated, but if you want to use it, the module will | 変数 | 設定例 | 説明 | | --------- | --- | ---------------------- | -| number | `1` | ジョブの数 | +| number | `1` | The number of jobs | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | @@ -1720,30 +1795,30 @@ symbol_threshold = 0 ## Julia -The `julia` module shows the currently installed version of [Julia](https://julialang.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +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: -- カレントディレクトリに`Project.toml`ファイルが含まれている -- カレントディレクトリに`Manifest.toml`ファイルが含まれている -- カレントディレクトリに`.jl`の拡張子のファイルが含まれている +- 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 ### オプション | オプション | デフォルト | 説明 | | ------------------- | ------------------------------------ | ------------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | +| `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 | | `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | | `detect_extensions` | `["jl"]` | どの拡張子がこのモジュールをアクティブにするか | | `detect_files` | `["Project.toml", "Manifest.toml"]` | どのファイル名がこのモジュールをアクティブにするか | | `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | -| `symbol` | `"ஃ "` | Juliaのシンボルを表すフォーマット文字列 | +| `symbol` | `"ஃ "` | A format string representing the symbol of Julia. | | `style` | `"bold purple"` | モジュールのスタイルです。 | -| `disabled` | `false` | `julia`モジュールを無効にします。 | +| `disabled` | `false` | Disables the `julia` module. | ### 変数 | 変数 | 設定例 | 説明 | | --------- | -------- | ---------------------- | -| version | `v1.4.0` | `julia`のバージョン | +| version | `v1.4.0` | The version of `julia` | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | @@ -1760,31 +1835,31 @@ symbol = "∴ " ## Kotlin -`kotlin`モジュールは、現在インストールされている[Kotlin](https://kotlinlang.org/)のバージョンを表示します。 デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +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: -- カレントディレクトリに`.kt`もしくは`.kts`ファイルが含まれている +- The current directory contains a `.kt` or a `.kts` file ### オプション -| オプション | デフォルト | 説明 | -| ------------------- | ------------------------------------ | ------------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | -| `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | -| `detect_extensions` | `["kt", "kts"]` | どの拡張子がこのモジュールをアクティブにするか | -| `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか | -| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | -| `symbol` | `"🅺 "` | Kotlinのシンボルを表すフォーマット文字列 | -| `style` | `"bold blue"` | モジュールのスタイルです。 | -| `kotlin_binary` | `"kotlin"` | Starshipがバージョンを取得するときに実行するkotlinバイナリを設定します。 | -| `disabled` | `false` | `kotlin`モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 | +| `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | +| `detect_extensions` | `["kt", "kts"]` | どの拡張子がこのモジュールをアクティブにするか | +| `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか | +| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | +| `symbol` | `"🅺 "` | A format string representing the symbol of Kotlin. | +| `style` | `"bold blue"` | モジュールのスタイルです。 | +| `kotlin_binary` | `"kotlin"` | Configures the kotlin binary that Starship executes when getting the version. | +| `disabled` | `false` | Disables the `kotlin` module. | ### 変数 -| 変数 | 設定例 | 説明 | -| --------- | --------- | ---------------------- | -| version | `v1.4.21` | `kotlin`のバージョン | -| symbol | | オプション `記号` の値をミラーする | -| style\* | | オプション `style` の値をミラーする | +| 変数 | 設定例 | 説明 | +| --------- | --------- | ----------------------- | +| version | `v1.4.21` | The version of `kotlin` | +| symbol | | オプション `記号` の値をミラーする | +| style\* | | オプション `style` の値をミラーする | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -1801,40 +1876,40 @@ symbol = "🅺 " # ~/.config/starship.toml [kotlin] -# Kotlinコンパイラバイナリを使用してバージョンを確認する +# Uses the Kotlin Compiler binary to get the installed version kotlin_binary = "kotlinc" ``` ## Kubernetes -Displays the current [Kubernetes context](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context) name and, if set, the namespace, user and cluster from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via `kubectl config set-context starship-context --namespace astronaut`. Similarly the user and cluster can be set with `kubectl config set-context starship-context --user starship-user` and `kubectl config set-context starship-context --cluster starship-cluster`. `$KUBECONFIG` 環境変数が設定されている場合、このモジュールは環境変数を優先して使用し、`~/.kube/config` は使用しません。 +Displays the current [Kubernetes context](https://kubernetes.io/docs/concepts/configuration/organize-cluster-access-kubeconfig/#context) name and, if set, the namespace, user and cluster from the kubeconfig file. The namespace needs to be set in the kubeconfig file, this can be done via `kubectl config set-context starship-context --namespace astronaut`. Similarly the user and cluster can be set with `kubectl config set-context starship-context --user starship-user` and `kubectl config set-context starship-context --cluster starship-cluster`. If the `$KUBECONFIG` env var is set the module will use that if not it will use the `~/.kube/config`. ::: tip -このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで`disabled`を`false`に設定します。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### オプション -| オプション | デフォルト | 説明 | -| ----------------- | ---------------------------------------------------- | ------------------------------- | -| `symbol` | `"☸ "` | クラスター名の前に表示されるシンボルを表すフォーマット文字列。 | -| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | moduleのフォーマットです。 | -| `style` | `"cyan bold"` | モジュールのスタイルです。 | -| `context_aliases` | | コンテキストの表示エイリアスを定義するテーブル。 | -| `disabled` | `true` | `kubernetes` モジュールを無効にする。 | +| オプション | デフォルト | 説明 | +| ----------------- | ---------------------------------------------------- | --------------------------------------------------------------------- | +| `symbol` | `"☸ "` | A format string representing the symbol displayed before the Cluster. | +| `format` | `'[$symbol$context( \($namespace\))]($style) in '` | module のフォーマットです。 | +| `style` | `"cyan bold"` | モジュールのスタイルです。 | +| `context_aliases` | | Table of context aliases to display. | +| `disabled` | `true` | Disables the `kubernetes` module. | ### 変数 -| 変数 | 設定例 | 説明 | -| --------- | -------------------- | -------------------------------------- | -| context | `starship-context` | The current kubernetes context name | -| namespace | `starship-namespace` | 設定されている場合、現在の Kubernetes の namespace 名 | -| user | `starship-user` | If set, the current kubernetes user | -| cluster | `starship-cluster` | If set, the current kubernetes cluster | -| symbol | | オプション `記号` の値をミラーする | -| style\* | | オプション `style` の値をミラーする | +| 変数 | 設定例 | 説明 | +| --------- | -------------------- | ---------------------------------------- | +| context | `starship-context` | The current kubernetes context name | +| namespace | `starship-namespace` | If set, the current kubernetes namespace | +| user | `starship-user` | If set, the current kubernetes user | +| cluster | `starship-cluster` | If set, the current kubernetes cluster | +| symbol | | オプション `記号` の値をミラーする | +| style\* | | オプション `style` の値をミラーする | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -1875,13 +1950,13 @@ Long and automatically generated cluster names can be identified and shortened u ## Line Break -`line_break`モジュールは、プロンプトを2行に分割します。 +The `line_break` module separates the prompt into two lines. ### オプション -| オプション | デフォルト | 説明 | -| ---------- | ------- | ------------------------------------- | -| `disabled` | `false` | `line_break`モジュールを無効にして、プロンプトを1行にします。 | +| オプション | デフォルト | 説明 | +| ---------- | ------- | ------------------------------------------------------------------ | +| `disabled` | `false` | Disables the `line_break` module, making the prompt a single line. | ### 設定例 @@ -1901,7 +1976,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) "` | moduleのフォーマットです。 | +| `format` | `"[$localipv4]($style) "` | module のフォーマットです。 | | `style` | `"bold yellow"` | モジュールのスタイルです。 | | `disabled` | `true` | Disables the `localip` module. | @@ -1927,7 +2002,7 @@ disabled = false ## Lua -The `lua` module shows the currently installed version of [Lua](http://www.lua.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +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 current directory contains a `.lua-version` file - The current directory contains a `lua` directory @@ -1937,7 +2012,7 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o | オプション | デフォルト | 説明 | | ------------------- | ------------------------------------ | -------------------------------------------------------------------------- | -| `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 Lua. | | `detect_extensions` | `["lua"]` | どの拡張子がこのモジュールをアクティブにするか | @@ -1951,7 +2026,7 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o | 変数 | 設定例 | 説明 | | --------- | -------- | ---------------------- | -| version | `v5.4.0` | `lua` のバージョン | +| version | `v5.4.0` | The version of `lua` | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | @@ -1966,27 +2041,27 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o format = "via [🌕 $version](bold blue) " ``` -## メモリ使用量 +## Memory Usage -`memory_usage` モジュールは、現在のシステムメモリとスワップ使用量を示します。 +The `memory_usage` module shows current system memory and swap usage. -デフォルトでは、システムスワップの合計がゼロ以外の場合、スワップ使用量が表示されます。 +By default the swap usage is displayed if the total system swap is non-zero. ::: tip -このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで`disabled`を`false`に設定します。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### オプション -| オプション | デフォルト | 説明 | -| ----------- | ----------------------------------------------- | --------------------------- | -| `threshold` | `75` | この閾値を超えない限り、メモリ使用率は表示されません。 | -| `format` | `"via $symbol [${ram}( \| ${swap})]($style) "` | moduleのフォーマットです。 | -| `symbol` | `"🐏"` | メモリ使用率を表示する前に使用される記号です。 | -| `style` | `"bold dimmed white"` | モジュールのスタイルです。 | -| `disabled` | `true` | `memory_usage`モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| ----------- | ----------------------------------------------- | -------------------------------------------------------- | +| `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. | +| `format` | `"via $symbol [${ram}( \| ${swap})]($style) "` | module のフォーマットです。 | +| `symbol` | `"🐏"` | The symbol used before displaying the memory usage. | +| `style` | `"bold dimmed white"` | モジュールのスタイルです。 | +| `disabled` | `true` | Disables the `memory_usage` module. | ### 変数 @@ -2015,7 +2090,7 @@ style = "bold dimmed green" ## Mercurial Branch -` hg_branch `モジュールは、現在のディレクトリにあるリポジトリのアクティブなブランチを示します。 +The `hg_branch` module shows the active branch of the repo in your current directory. ### オプション @@ -2023,9 +2098,9 @@ style = "bold dimmed green" | ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------- | | `symbol` | `" "` | The symbol used before the hg bookmark or branch name of the repo in your current directory. | | `style` | `"bold purple"` | モジュールのスタイルです。 | -| `format` | `"on [$symbol$branch]($style) "` | moduleのフォーマットです。 | +| `format` | `"on [$symbol$branch]($style) "` | module のフォーマットです。 | | `truncation_length` | `2^63 - 1` | Truncates the hg branch name to `N` graphemes | -| `truncation_symbol` | `"…"` | ブランチ名切り捨てられていることを示すための記号です。 | +| `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. | | `disabled` | `true` | Disables the `hg_branch` module. | ### 変数 @@ -2051,9 +2126,9 @@ truncation_symbol = "" ## Nim -The `nim` module shows the currently installed version of [Nim](https://nim-lang.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +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: -- カレントディレクトリに`nim.cfg`ファイルが含まれている +- 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 @@ -2093,18 +2168,18 @@ symbol = "🎣 " ## Nix-shell -The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html) environment. このモジュールは、nixシェル環境内にあるときに表示されます。 +The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html) environment. The module will be shown when inside a nix-shell environment. ### オプション | オプション | デフォルト | 説明 | | ------------ | ---------------------------------------------- | ----------------------------------------------------- | -| `format` | `'via [$symbol$state( \($name\))]($style) '` | moduleのフォーマットです。 | +| `format` | `'via [$symbol$state( \($name\))]($style) '` | module のフォーマットです。 | | `symbol` | `"❄️ "` | A format string representing the symbol of nix-shell. | | `style` | `"bold blue"` | モジュールのスタイルです。 | | `impure_msg` | `"impure"` | A format string shown when the shell is impure. | | `pure_msg` | `"pure"` | A format string shown when the shell is pure. | -| `disabled` | `false` | `nix_shell`モジュールを無効にします。 | +| `disabled` | `false` | Disables the `nix_shell` module. | ### 変数 @@ -2131,28 +2206,28 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' ## Node.js -The `nodejs` module shows the currently installed version of [Node.js](https://nodejs.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +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: -- カレントディレクトリに`package.json`ファイルが含まれている +- The current directory contains a `package.json` file - The current directory contains a `.node-version` file - The current directory contains a `.nvmrc` file -- カレントディレクトリに`node_modules`ディレクトリが含まれている +- 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` extension +- The current directory contains a file with the `.ts`, `.mts` or `.cts` extension ### オプション -| オプション | デフォルト | 説明 | -| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | -| `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | -| `symbol` | `" "` | A format string representing the symbol of Node.js. | -| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | どの拡張子がこのモジュールをアクティブにするか | -| `detect_files` | `["package.json", ".node-version"]` | どのファイル名がこのモジュールをアクティブにするか | -| `detect_folders` | `["node_modules"]` | どのフォルダーがこのモジュールをアクティブにするか | -| `style` | `"bold green"` | モジュールのスタイルです。 | -| `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. | +| オプション | デフォルト | 説明 | +| ------------------- | ------------------------------------------ | ----------------------------------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 | +| `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | +| `symbol` | `" "` | A format string representing the symbol of Node.js. | +| `detect_extensions` | `["js", "mjs", "cjs", "ts", "mts", "cts"]` | どの拡張子がこのモジュールをアクティブにするか | +| `detect_files` | `["package.json", ".node-version"]` | どのファイル名がこのモジュールをアクティブにするか | +| `detect_folders` | `["node_modules"]` | どのフォルダーがこのモジュールをアクティブにするか | +| `style` | `"bold green"` | モジュールのスタイルです。 | +| `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. | ### 変数 @@ -2175,7 +2250,7 @@ format = "via [🤖 $version](bold green) " ## OCaml -The `ocaml` module shows the currently installed version of [OCaml](https://ocaml.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +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 current directory contains a file with `.opam` extension or `_opam` directory - The current directory contains a `esy.lock` directory @@ -2228,7 +2303,7 @@ The `openstack` module shows the current OpenStack cloud and project. The module | オプション | デフォルト | 説明 | | ---------- | --------------------------------------------------- | -------------------------------------------------------------- | -| `format` | `"on [$symbol$cloud(\\($project\\))]($style) "` | moduleのフォーマットです。 | +| `format` | `"on [$symbol$cloud(\\($project\\))]($style) "` | module のフォーマットです。 | | `symbol` | `"☁️ "` | The symbol used before displaying the current OpenStack cloud. | | `style` | `"bold yellow"` | モジュールのスタイルです。 | | `disabled` | `false` | Disables the `openstack` module. | @@ -2255,9 +2330,9 @@ style = "bold yellow" symbol = "☁️ " ``` -## パッケージのバージョン +## Package Version -`package`モジュールは、現在のディレクトリがパッケージのリポジトリである場合に表示され、現在のバージョンが表示されます。 The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards` and `dart` packages. +The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `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 @@ -2280,14 +2355,14 @@ symbol = "☁️ " ### オプション -| オプション | デフォルト | 説明 | -| ----------------- | --------------------------------- | --------------------------------------------------------- | -| `format` | `"is [$symbol$version]($style) "` | moduleのフォーマットです。 | -| `symbol` | `"📦 "` | パッケージのバージョンを表示する前に使用される記号です。 | -| `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | -| `style` | `"bold 208"` | モジュールのスタイルです。 | -| `display_private` | `false` | Enable displaying version for packages marked as private. | -| `disabled` | `false` | `package`モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| ----------------- | --------------------------------- | ---------------------------------------------------------- | +| `format` | `"is [$symbol$version]($style) "` | module のフォーマットです。 | +| `symbol` | `"📦 "` | The symbol used before displaying the version the package. | +| `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | +| `style` | `"bold 208"` | モジュールのスタイルです。 | +| `display_private` | `false` | Enable displaying version for packages marked as private. | +| `disabled` | `false` | Disables the `package` module. | ### 変数 @@ -2310,7 +2385,7 @@ format = "via [🎁 $version](208 bold) " ## Perl -The `perl` module shows the currently installed version of [Perl](https://www.perl.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +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 current directory contains a `Makefile.PL` or `Build.PL` file - The current directory contains a `cpanfile` or `cpanfile.snapshot` file @@ -2350,9 +2425,9 @@ format = "via [🦪 $version]($style) " ## PHP -The `php` module shows the currently installed version of [PHP](https://www.php.net/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +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: -- カレントディレクトリに`composer.json`ファイルが含まれている +- The current directory contains a `composer.json` file - The current directory contains a `.php-version` file - The current directory contains a `.php` extension @@ -2360,14 +2435,14 @@ The `php` module shows the currently installed version of [PHP](https://www.php. | オプション | デフォルト | 説明 | | ------------------- | ------------------------------------ | ------------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | +| `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 | | `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | -| `symbol` | `"🐘 "` | PHPのバージョンを表示する前に使用される記号です。 | +| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | | `detect_extensions` | `["php"]` | どの拡張子がこのモジュールをアクティブにするか | | `detect_files` | `["composer.json", ".php-version"]` | どのファイル名がこのモジュールをアクティブにするか | | `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | | `style` | `"147 bold"` | モジュールのスタイルです。 | -| `disabled` | `false` | `php`モジュールを無効にします。 | +| `disabled` | `false` | Disables the `php` module. | ### 変数 @@ -2394,11 +2469,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). それでも有効にしたい場合は、 [以下の例に従ってください](#with-pulumi-version). +By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, [follow the example shown below](#with-pulumi-version). ::: -デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +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` @@ -2419,7 +2494,7 @@ By default the Pulumi version is not shown, since it takes an order of magnitude | --------- | ---------- | --------------------------- | | version | `v0.12.24` | The version of `pulumi` | | stack | `dev` | The current Pulumi stack | -| ユーザ名 | `alice` | The current Pulumi username | +| username | `alice` | The current Pulumi username | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | @@ -2447,9 +2522,9 @@ format = "[$symbol$stack]($style) " ## PureScript -The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +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: -- カレントディレクトリに`spago.dhall`ファイルが含まれている +- The current directory contains a `spago.dhall` file - The current directory contains a file with the `.purs` extension ### オプション @@ -2488,19 +2563,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. -`pyenvversionname` が `true` に設定されている場合 、pyenv でのバージョン名が表示されます 。 そうでなければ、`python --version` を元にバージョン番号を表示します。 +If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. -デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +By default the module will be shown if any of the following conditions are met: -- カレントディレクトリに`.python-version`ファイルが含まれている -- カレントディレクトリに`Pipfile`ファイルが含まれている +- The current directory contains a `.python-version` file +- The current directory contains a `Pipfile` file - The current directory contains a `__init__.py` file -- カレントディレクトリに`pyproject.toml`ファイルが含まれている -- カレントディレクトリに`requirements.txt`ファイルが含まれている -- カレントディレクトリに`setup.py`ファイルが含まれている -- カレントディレクトリに`tox.ini`ファイルが含まれている -- カレントディレクトリに`.py`の拡張子のファイルが含まれている. -- 仮想環境がアクティブである +- 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 ### オプション @@ -2510,13 +2585,13 @@ The `python` module shows the currently installed version of [Python](https://ww | `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | | `symbol` | `"🐍 "` | A format string representing the symbol of Python | | `style` | `"yellow bold"` | モジュールのスタイルです。 | -| `pyenv_version_name` | `false` | pyenvを使用してPythonバージョンを取得します | +| `pyenv_version_name` | `false` | Use pyenv to get Python version | | `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `python_binary` | `["python", "python3", "python2"]` | Configures the python binaries that Starship should executes when getting the version. | -| `detect_extensions` | `["py"]` | どの拡張子がこのモジュールをアクティブにするか | -| `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | どのファイル名がこのモジュールをアクティブにするか | -| `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | -| `disabled` | `false` | `python`モジュールを無効にします。 | +| `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. | ::: tip @@ -2593,9 +2668,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"]` | どの拡張子がこのモジュールをアクティブにするか | -| `detect_files` | `[".Rprofile"]` | どのファイル名がこのモジュールをアクティブにするか | -| `detect_folders` | `[".Rproj.user"]` | どのフォルダーがこのモジュールをアクティブにするか | +| `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. | ### 変数 @@ -2655,11 +2730,11 @@ symbol = "🔴 " ## Ruby -デフォルトでは`ruby`モジュールは現在インストールされている[Ruby](https://www.ruby-lang.org/)のバージョンを表示します。 次の条件のいずれかが満たされると、モジュールが表示されます: +By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). 次の条件のいずれかが満たされると、モジュールが表示されます: -- カレントディレクトリに`Gemfile`ファイルが含まれている -- カレントディレクトリに `.ruby-version` ファイルが含まれている -- カレントディレクトリに`.rb`の拡張子のファイルが含まれている +- 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 Starship gets the current Ruby version by running `ruby -v`. @@ -2670,13 +2745,13 @@ Starship gets the current Ruby version by running `ruby -v`. | ------------------- | ------------------------------------ | ------------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | | `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | -| `symbol` | `"💎 "` | Rubyのシンボルを表すフォーマット文字列. | +| `symbol` | `"💎 "` | A format string representing the symbol of Ruby. | | `detect_extensions` | `["rb"]` | どの拡張子がこのモジュールをアクティブにするか | | `detect_files` | `["Gemfile", ".ruby-version"]` | どのファイル名がこのモジュールをアクティブにするか | | `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | | `detect_variables` | `["RUBY_VERSION", "RBENV_VERSION"]` | Which environment variables should trigger this module. | | `style` | `"bold red"` | モジュールのスタイルです。 | -| `disabled` | `false` | `ruby`モジュールを無効にします。 | +| `disabled` | `false` | Disables the `ruby` module. | ### 変数 @@ -2699,29 +2774,29 @@ symbol = "🔺 " ## Rust -デフォルトでは`rust`モジュールは現在インストールされている[Rust](https://www.rust-lang.org/)のバージョンを表示します。 次の条件のいずれかが満たされると、モジュールが表示されます: +By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). 次の条件のいずれかが満たされると、モジュールが表示されます: -- カレントディレクトリに`Cargo.toml`ファイルが含まれている -- カレントディレクトリに`.rs`の拡張子のファイルが含まれている +- The current directory contains a `Cargo.toml` file +- The current directory contains a file with the `.rs` extension ### オプション | オプション | デフォルト | 説明 | | ------------------- | ------------------------------------ | ------------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | +| `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 | | `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | -| `symbol` | `"🦀 "` | Rustのシンボルを表すフォーマット文字列 | +| `symbol` | `"🦀 "` | A format string representing the symbol of Rust | | `detect_extensions` | `["rs"]` | どの拡張子がこのモジュールをアクティブにするか | | `detect_files` | `["Cargo.toml"]` | どのファイル名がこのモジュールをアクティブにするか | | `detect_folders` | `[]` | どのフォルダーがこのモジュールをアクティブにするか | | `style` | `"bold red"` | モジュールのスタイルです。 | -| `disabled` | `false` | `rust`モジュールを無効にします。 | +| `disabled` | `false` | Disables the `rust` module. | ### 変数 | 変数 | 設定例 | 説明 | | --------- | ----------------- | ---------------------- | -| version | `v1.43.0-nightly` | `rustc`のバージョン | +| version | `v1.43.0-nightly` | The version of `rustc` | | symbol | | オプション `記号` の値をミラーする | | style\* | | オプション `style` の値をミラーする | @@ -2738,7 +2813,7 @@ format = "via [⚙️ $version](red bold)" ## Scala -The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +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 current directory contains a `build.sbt`, `.scalaenv` or `.sbtenv` file - The current directory contains a file with the `.scala` or `.sbt` extension @@ -2748,7 +2823,7 @@ The `scala` module shows the currently installed version of [Scala](https://www. | オプション | デフォルト | 説明 | | ------------------- | ---------------------------------------- | ------------------------------------------------------ | -| `format` | `"via [${symbol}(${version} )]($style)"` | moduleのフォーマットです。 | +| `format` | `"via [${symbol}(${version} )]($style)"` | module のフォーマットです。 | | `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | | `detect_extensions` | `["sbt", "scala"]` | どの拡張子がこのモジュールをアクティブにするか | | `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | どのファイル名がこのモジュールをアクティブにするか | @@ -2782,7 +2857,7 @@ The `shell` module shows an indicator for currently used shell. ::: tip -このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで`disabled`を`false`に設定します。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -2801,7 +2876,7 @@ The `shell` module shows an indicator for currently used shell. | `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) "` | moduleのフォーマットです。 | +| `format` | `"[$indicator]($style) "` | module のフォーマットです。 | | `style` | `"white bold"` | モジュールのスタイルです。 | | `disabled` | `true` | Disables the `shell` module. | @@ -2810,7 +2885,7 @@ The `shell` module shows an indicator for currently used shell. | 変数 | デフォルト | 説明 | | --------- | ----- | ---------------------------------------------------------- | | indicator | | Mirrors the value of `indicator` for currently used shell. | -| style\* | | オプション `style` の値をミラーする. | +| style\* | | Mirrors the value of option `style`. | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -2836,7 +2911,7 @@ The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/int | オプション | デフォルト | 説明 | | ----------- | ---------------------------- | ------------------------------------------------------------- | | `threshold` | `2` | Display threshold. | -| `format` | `"[$symbol$shlvl]($style) "` | moduleのフォーマットです。 | +| `format` | `"[$symbol$shlvl]($style) "` | module のフォーマットです。 | | `symbol` | `"↕️ "` | The symbol used to represent the `SHLVL`. | | `repeat` | `false` | Causes `symbol` to be repeated by the current `SHLVL` amount. | | `style` | `"bold yellow"` | モジュールのスタイルです。 | @@ -2871,7 +2946,7 @@ The `singularity` module shows the current [Singularity](https://sylabs.io/singu | オプション | デフォルト | 説明 | | ---------- | -------------------------------- | ------------------------------------------------ | -| `format` | `'[$symbol\[$env\]]($style) '` | moduleのフォーマットです。 | +| `format` | `'[$symbol\[$env\]]($style) '` | module のフォーマットです。 | | `symbol` | `""` | A format string displayed before the image name. | | `style` | `"bold dimmed blue"` | モジュールのスタイルです。 | | `disabled` | `false` | Disables the `singularity` module. | @@ -2897,23 +2972,21 @@ format = '[📦 \[$env\]]($style) ' ## Status -The `status` module displays the exit code of the previous command. The module will be shown only if the exit code is not `0`. The status code will cast to a signed 32-bit integer. +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 -このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで`disabled`を`false`に設定します。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: -::: warning This module is not supported on nu shell. ::: - ### オプション | オプション | デフォルト | 説明 | | ----------------------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------- | | `format` | `"[$symbol$status]($style) "` | The format of the module | | `symbol` | `"✖"` | The symbol displayed on program error | -| `success_symbol` | `"✔️"` | The symbol displayed on program success | +| `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) | @@ -2950,8 +3023,9 @@ The `status` module displays the exit code of the previous command. The module w [status] style = "bg:blue" -symbol = "🔴" -format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) ' +symbol = "🔴 " +success_symbol = "🟢 SUCCESS" +format = '[\[$symbol$common_meaning$signal_name$maybe_int\]]($style) ' map_symbol = true disabled = false ``` @@ -2962,7 +3036,7 @@ The `sudo` module displays if sudo credentials are currently cached. The module ::: tip -このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで`disabled`を`false`に設定します。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -3016,7 +3090,7 @@ By default the `swift` module shows the currently installed version of [Swift](h | オプション | デフォルト | 説明 | | ------------------- | ------------------------------------ | ------------------------------------------------------ | -| `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 Swift | | `detect_extensions` | `["swift"]` | どの拡張子がこのモジュールをアクティブにするか | @@ -3046,18 +3120,18 @@ format = "via [🏎 $version](red bold)" ## Terraform -`terraform` モジュールは、現在選択されている[Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) とバージョンを表示します。 +The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. ::: tip -Terraformのバージョンはデフォルトでは表示されません。多くのプラグインが使用されている場合、現在のTerraformのバージョンでは遅くなるからです。 それでも有効にしたい場合は、 [以下の例に従ってください](#with-terraform-version). +By default the Terraform version is not shown, since this is slow for current versions of Terraform when a lot of plugins are in use. If you still want to enable it, [follow the example shown below](#with-terraform-version). ::: -デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +By default the module will be shown if any of the following conditions are met: -- カレントディレクトリに`.terraform`フォルダが含まれている -- 現在のディレクトリに `.tf`, `.tfplan` または `.tfstate` のいずれかの拡張子を持つファイルがある。 +- The current directory contains a `.terraform` folder +- Current directory contains a file with the `.tf`, `.tfplan` or `.tfstate` extensions ### オプション @@ -3065,21 +3139,21 @@ Terraformのバージョンはデフォルトでは表示されません。多 | ------------------- | ------------------------------------ | ------------------------------------------------------ | | `format` | `"via [$symbol$workspace]($style) "` | モジュールのフォーマット文字列。 | | `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | -| `symbol` | `"💠"` | ワークスペースの前に表示されるフォーマット文字列。 | +| `symbol` | `"💠"` | A format string shown before the terraform workspace. | | `detect_extensions` | `["tf", "tfplan", "tfstate"]` | どの拡張子がこのモジュールをアクティブにするか | | `detect_files` | `[]` | どのファイル名がこのモジュールをアクティブにするか | | `detect_folders` | `[".terraform"]` | どのフォルダーがこのモジュールをアクティブにするか | | `style` | `"bold 105"` | モジュールのスタイルです。 | -| `disabled` | `false` | `terraform`モジュールを無効にします。 | +| `disabled` | `false` | Disables the `terraform` module. | ### 変数 -| 変数 | 設定例 | 説明 | -| --------- | ---------- | ---------------------- | -| version | `v0.12.24` | `terraform` のバージョン | -| workspace | `default` | 現在のTerraformワークスペース | -| symbol | | オプション `記号` の値をミラーする | -| style\* | | オプション `style` の値をミラーする | +| 変数 | 設定例 | 説明 | +| --------- | ---------- | ------------------------------- | +| version | `v0.12.24` | The version of `terraform` | +| workspace | `default` | The current Terraform workspace | +| symbol | | オプション `記号` の値をミラーする | +| style\* | | オプション `style` の値をミラーする | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -3103,35 +3177,35 @@ format = "[🏎💨 $version$workspace]($style) " format = "[🏎💨 $workspace]($style) " ``` -## Time +## 時刻 -`time`モジュールは、現在の**現地**時間を示します。 `format`設定は、時間の表示方法を制御するために[`chrono`](https://crates.io/crates/chrono)クレートによって使用されます。 使用可能なオプションを確認するには、[chrono strftimeのドキュメント](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html)をご覧ください。 +The `time` module shows the current **local** time. The `format` configuration value is used by the [`chrono`](https://crates.io/crates/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) to see what options are available. ::: tip -このモジュールはデフォルトで無効になっています。 有効にするには、設定ファイルで`disabled`を`false`に設定します。 +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### オプション -| オプション | デフォルト | 説明 | -| ----------------- | ----------------------- | ----------------------------------------------------------------------------------------------------- | -| `format` | `"at [$time]($style) "` | モジュールのフォーマット文字列。 | -| `use_12hr` | `false` | 12時間のフォーマットを有効にします。 | -| `time_format` | この表の下を参照してください | 時刻のフォーマットに使用される[クロノフォーマット文字列](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) です。 | -| `style` | `"bold yellow"` | モジュールのスタイルです。 | -| `utc_time_offset` | `"local"` | 使用するUTCオフセットを設定します。 Range from -24 < x < 24. フロートが30/45分のタイムゾーンオフセットに対応できるようにします。 | -| `disabled` | `true` | `time`モジュールを無効にします。 | -| `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | +| オプション | デフォルト | 説明 | +| ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | +| `format` | `"at [$time]($style) "` | モジュールのフォーマット文字列。 | +| `use_12hr` | `false` | Enables 12 hour formatting | +| `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. | +| `style` | `"bold yellow"` | The style for the module time | +| `utc_time_offset` | `"local"` | Sets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. | +| `disabled` | `true` | Disables the `time` module. | +| `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | -If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. それ以外の場合、デフォルトは`"%T"`です。 Manually setting `time_format` will override the `use_12hr` setting. +If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Otherwise, it defaults to `"%T"`. Manually setting `time_format` will override the `use_12hr` setting. ### 変数 | 変数 | 設定例 | 説明 | | --------- | ---------- | ---------------------- | -| 時刻 | `13:08:10` | The current time. | +| time | `13:08:10` | The current time. | | style\* | | オプション `style` の値をミラーする | *: この変数は、スタイル文字列の一部としてのみ使用することができます。 @@ -3149,14 +3223,14 @@ utc_time_offset = "-5" time_range = "10:00:00-14:00:00" ``` -## ユーザー名 +## Username -`username`モジュールには、アクティブなユーザーのユーザー名が表示されます。 次の条件のいずれかが満たされると、モジュールが表示されます: +The `username` module shows active user's username. 次の条件のいずれかが満たされると、モジュールが表示されます: -- カレントユーザーがroot -- カレントユーザーが、ログインしているユーザーとは異なる -- ユーザーがSSHセッションとして接続されている -- `show_always`変数がtrueに設定されている +- 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 ::: tip @@ -3166,13 +3240,13 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, ` ### オプション -| オプション | デフォルト | 説明 | -| ------------- | ----------------------- | ------------------------- | -| `style_root` | `"bold red"` | ユーザーがrootのときに使用されるスタイルです。 | -| `style_user` | `"bold yellow"` | 非rootユーザーに使用されるスタイルです。 | -| `format` | `"[$user]($style) in "` | moduleのフォーマットです。 | -| `show_always` | `false` | `username`モジュールを常に表示します。 | -| `disabled` | `false` | `username`モジュールを無効にします。 | +| オプション | デフォルト | 説明 | +| ------------- | ----------------------- | ------------------------------------- | +| `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. | ### 変数 @@ -3196,7 +3270,7 @@ show_always = true ## Vagrant -The `vagrant` module shows the currently installed version of [Vagrant](https://www.vagrantup.com/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +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 current directory contains a `Vagrantfile` file @@ -3204,7 +3278,7 @@ The `vagrant` module shows the currently installed version of [Vagrant](https:// | オプション | デフォルト | 説明 | | ------------------- | ------------------------------------ | ------------------------------------------------------ | -| `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 Vagrant. | | `detect_extensions` | `[]` | どの拡張子がこのモジュールをアクティブにするか | @@ -3234,7 +3308,7 @@ format = "via [⍱ $version](bold white) " ## V -The `vlang` module shows you your currently installed version of [V](https://vlang.io/). デフォルトでは次の条件のいずれかが満たされると、モジュールが表示されます。 +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 current directory contains a file with `.v` extension - The current directory contains a `v.mod`, `vpkg.json` or `.vpkg-lock.json` file @@ -3243,7 +3317,7 @@ The `vlang` module shows you your currently installed version of [V](https://vla | オプション | デフォルト | 説明 | | ------------------- | -------------------------------------------- | ------------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | +| `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 | | `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | | `symbol` | `"V "` | A format string representing the symbol of V | | `detect_extensions` | `["v"]` | どの拡張子がこのモジュールをアクティブにするか | @@ -3278,7 +3352,7 @@ The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/v | ---------- | -------------------------------- | ------------------------------------------------------ | | `symbol` | | The symbol used before displaying the repository name. | | `style` | `"bold yellow"` | モジュールのスタイルです。 | -| `format` | `"vcsh [$symbol$repo]($style) "` | moduleのフォーマットです。 | +| `format` | `"vcsh [$symbol$repo]($style) "` | module のフォーマットです。 | | `disabled` | `false` | Disables the `vcsh` module. | ### 変数 @@ -3310,7 +3384,7 @@ By default the the `zig` module shows the currently installed version of [Zig](h | オプション | デフォルト | 説明 | | ------------------- | ------------------------------------ | ------------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | moduleのフォーマットです。 | +| `format` | `"via [$symbol($version )]($style)"` | module のフォーマットです。 | | `version_format` | `"v${raw}"` | バージョンのフォーマット。 使用可能な変数は`raw`、`major`、`minor`と`patch`です。 | | `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | | `style` | `"bold yellow"` | モジュールのスタイルです。 | @@ -3382,14 +3456,14 @@ 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` | | [この表の下を参照してください](#custom-command-shell) | -| `説明` | `""` | The description of the module that is shown when running `starship explain`. | +| `shell` | | [See below](#custom-command-shell) | +| `description` | `""` | The description of the module that is shown when running `starship explain`. | | `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のフォーマットです。 | +| `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). | diff --git a/docs/ja-JP/faq/README.md b/docs/ja-JP/faq/README.md index 3c136227..85e5b1fe 100644 --- a/docs/ja-JP/faq/README.md +++ b/docs/ja-JP/faq/README.md @@ -1,4 +1,4 @@ -# FAQ +# Frequently Asked Questions ## デモGIFで使用される構成は何ですか？ @@ -38,7 +38,7 @@ NUM_JOBS=$(jobs -p | wc -l) PS1="$(starship prompt --status=$STATUS --jobs=$NUM_JOBS)" ``` -Starshipに搭載されている[Bashの実装](https://github.com/starship/starship/blob/master/src/init/starship.bash)は、[Command Duration モジュール](https://starship.rs/config/#command-duration)のような高度な機能を可能にするためと、プリインストールされたBashの設定との互換性を確保するために、若干複雑になっています。 +Starshipに組み込まれた[Bashの実装](https://github.com/starship/starship/blob/master/src/init/starship.bash)は、[ Command Durationモジュール](https://starship.rs/config/#command-duration)などの高度な機能を可能にし、Starshipが事前にインストールされたBash構成と互換性があるようにするため、少し複雑です。 `Starshipのプロンプト`で受け入れられるすべてのフラグのリストは、次のコマンドを取得できます。 diff --git a/docs/ja-JP/guide/README.md b/docs/ja-JP/guide/README.md index 260f51e1..ab804eff 100644 --- a/docs/ja-JP/guide/README.md +++ b/docs/ja-JP/guide/README.md @@ -139,6 +139,8 @@ />

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

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

@@ -324,17 +326,22 @@ eval $(starship init ion)
Nushell -Add the following to the end of your Nushell configuration (find it by running `config path`): +Run the following: -```toml -startup = [ - "mkdir ~/.cache/starship", - "starship init nu | save ~/.cache/starship/init.nu", - "source ~/.cache/starship/init.nu", -] -prompt = "starship_prompt" +```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`): + +```sh +starship init nu | save ~/.cache/starship/init.nu +source ~/.cache/starship/init.nu +``` + +Note: Only Nushell v0.60+ is supported +
@@ -393,15 +400,15 @@ If you're looking to further customize Starship: ## 🤝 貢献 -私たちは常に**すべてのスキルレベル**の貢献者を探しています！ もし簡単にプロジェクトへ参加する方法をお探しなら、 [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue) に取り組んでみてください。 +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). -あなたが英語以外の言語に堪能な場合、ドキュメントの翻訳と更新に協力していただけると嬉しいです。 協力してくれる場合、翻訳は [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. If you would like to help, translations can be contributed on the [Starship Crowdin](https://translate.starship.rs/). -もしあなたが Starship への貢献に興味がある場合は、我々の[貢献ガイド](https://github.com/starship/starship/blob/master/CONTRIBUTING.md)をご覧ください。 また、気軽に我々の[Discord サーバー](https://discord.gg/8Jzqu3T)へ顔を出してください。 👋 +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 の作成に影響を与えた、これまでのプロジェクトをチェックしてください 🙏 +Please check out these previous works that helped inspire the creation of starship. 🙏 - **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** – A ZSH prompt for astronauts. @@ -416,4 +423,4 @@ If you're looking to further customize Starship: ## 📝 ライセンス -Copyright © 2019-present, [Starship Contributors](https://github.com/starship/starship/graphs/contributors).
このプロジェクトは [ISC](https://github.com/starship/starship/blob/master/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. diff --git a/docs/ja-JP/installing/README.md b/docs/ja-JP/installing/README.md index 70182be4..a2d76732 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/migrating-to-0.45.0/README.md b/docs/ja-JP/migrating-to-0.45.0/README.md index e2ffa955..48cc17f6 100644 --- a/docs/ja-JP/migrating-to-0.45.0/README.md +++ b/docs/ja-JP/migrating-to-0.45.0/README.md @@ -76,7 +76,7 @@ format = "took [$duration]($style) " ### 影響を受けるモジュール -#### Character +#### 文字 | 削除されたプロパティ | 置換後 | | ----------------------- | ---------------- | @@ -111,7 +111,7 @@ error_symbol = "[✖](bold red)" _注意:_ `character` 要素は自動的にスペースを後ろに追加するため、他の `format` 文字列とは異なり、上記の例では特にスペースを追加していません。 -#### Command Duration +#### コマンド実行時間 | 削除されたプロパティ | 置換後 | | ---------- | -------- | @@ -139,7 +139,7 @@ _注意:_ `character` 要素は自動的にスペースを後ろに追加する ++ format = "[$path]($style)[$read_only]($read_only_style) " ``` -#### Environment Variable +#### 環境変数 | 削除されたプロパティ | 置換後 | | ---------- | -------- | @@ -155,7 +155,7 @@ _注意:_ `character` 要素は自動的にスペースを後ろに追加する ++ format = "with [$env_value]($style) " ``` -#### Git Commit +#### Git コミット | 削除されたプロパティ | 置換後 | | ---------- | -------- | @@ -202,7 +202,7 @@ diverged = "⇕⇡${ahead_count}⇣${behind_count}" behind = "⇣${count}" ``` -#### Hostname +#### ホスト名 | 削除されたプロパティ | 置換後 | | ---------- | -------- | @@ -235,7 +235,7 @@ behind = "⇣${count}" ++ format = '[$symbol\[$env\]]($style) ' ``` -#### Time +#### 時刻 | 削除されたプロパティ | 置換後 | | ---------- | ------------- | diff --git a/docs/ja-JP/presets/README.md b/docs/ja-JP/presets/README.md index dbe549c8..f7738d28 100644 --- a/docs/ja-JP/presets/README.md +++ b/docs/ja-JP/presets/README.md @@ -4,32 +4,38 @@ To get details on how to use a preset, simply click on the image. -## [Nerd Font Symbols](./nerd-font) +## [Nerd Font Symbols](./nerd-font.md) This preset changes the symbols for each module to use Nerd Font symbols. [![Nerd Font Symbolsプリセットのスクリーンショット](/presets/img/nerd-font-symbols.png "Click to view Nerd Font Symbols preset")](./nerd-font) -## [Bracketed Segments](./bracketed-segments) +## [Bracketed Segments](./bracketed-segments.md) このプリセットは付属のモジュール全てのフォーマットを変更し、デフォルトのStarshipの表示("via", "on", etc.)から、それぞれの情報を括弧で区分けするように変更します。 [![Bracketed Segmentsプリセットのスクリーンショット](/presets/img/bracketed-segments.png "Click to view Bracketed Segments preset")](./bracketed-segments) -## [Plain Text Symbols](./plain-text) +## [Plain Text Symbols](./plain-text.md) This preset changes the symbols for each module into plain text. Great if you don't have access to Unicode. [![Plain Text Symbolsプリセットのスクリーンショット](/presets/img/plain-text-symbols.png "Click to view Plain Text Symbols preset")](./plain-text) -## [No Runtime Versions](./no-runtimes) +## [No Runtime Versions](./no-runtimes.md) This preset hides the version of language runtimes. If you work in containers or virtualized environments, this one is for you! [![Screenshot of Hide Runtime Versions preset](/presets/img/no-runtime-versions.png "Click to view No Runtime Versions preset")](./no-runtimes) -## [Pure Prompt](./pure-preset) +## [Pure Prompt](./pure-preset.md) This preset emulates the look and behavior of [Pure](https://github.com/sindresorhus/pure). [![Screenshot of Pure preset](/presets/img/pure-preset.png "Click to view Pure Prompt preset")](./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. + +[![Screenshot of Pastel Powerline preset](/presets/img/pastel-powerline.png "Click to view Pure Prompt preset")](./pastel-powerline) diff --git a/docs/ja-JP/presets/bracketed-segments.md b/docs/ja-JP/presets/bracketed-segments.md index 8e35f015..e5313e3d 100644 --- a/docs/ja-JP/presets/bracketed-segments.md +++ b/docs/ja-JP/presets/bracketed-segments.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#bracketed-segments) +[Return to Presets](./README.md#bracketed-segments) # Bracketed Segments Preset diff --git a/docs/ja-JP/presets/nerd-font.md b/docs/ja-JP/presets/nerd-font.md index 54d3875c..da55f2f1 100644 --- a/docs/ja-JP/presets/nerd-font.md +++ b/docs/ja-JP/presets/nerd-font.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#nerd-font-symbols) +[Return to Presets](./README.md#nerd-font-symbols) # Nerd Font Symbols Preset diff --git a/docs/ja-JP/presets/no-runtimes.md b/docs/ja-JP/presets/no-runtimes.md index e12b4956..c7984058 100644 --- a/docs/ja-JP/presets/no-runtimes.md +++ b/docs/ja-JP/presets/no-runtimes.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#no-runtime-versions) +[Return to Presets](./README.md#no-runtime-versions) # No Runtime Versions Preset diff --git a/docs/ja-JP/presets/pastel-powerline.md b/docs/ja-JP/presets/pastel-powerline.md new file mode 100644 index 00000000..66082374 --- /dev/null +++ b/docs/ja-JP/presets/pastel-powerline.md @@ -0,0 +1,17 @@ +[Return to Presets](./README.md#pastel-powerline) + +# Pastel Powerline Preset + +This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). It also shows how path substitution works in starship. + +![Screenshot of Pastel Powerline preset](/presets/img/pastel-powerline.png) + +### 必要なもの + +- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (the example uses Caskaydia Cove Nerd Font) + +### 設定 + +[Click to download TOML](/presets/toml/pastel-powerline.toml) + +<<< @/.vuepress/public/presets/toml/pastel-powerline.toml diff --git a/docs/ja-JP/presets/plain-text.md b/docs/ja-JP/presets/plain-text.md index c2eefb74..fc2641f4 100644 --- a/docs/ja-JP/presets/plain-text.md +++ b/docs/ja-JP/presets/plain-text.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#plain-text-symbols) +[Return to Presets](./README.md#plain-text-symbols) ## Plain Text Symbols Preset diff --git a/docs/ja-JP/presets/pure-preset.md b/docs/ja-JP/presets/pure-preset.md index 34308917..3b006b53 100644 --- a/docs/ja-JP/presets/pure-preset.md +++ b/docs/ja-JP/presets/pure-preset.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#pure) +[Return to Presets](./README.md#pure) # Pure Preset diff --git a/docs/ko-KR/README.md b/docs/ko-KR/README.md index 879c68e4..e5e04844 100644 --- a/docs/ko-KR/README.md +++ b/docs/ko-KR/README.md @@ -2,7 +2,7 @@ home: true heroImage: /logo.svg heroText: -tagline: The minimal, blazing-fast, and infinitely customizable prompt for any shell! +tagline: 간결하고 화끈하게 빠르며 무제한으로 커스터마이징이 가능한 프롬프트. 어떤 쉘에서든 사용할 수 있습니다! actionText: Get Started → actionLink: ./guide/ features: @@ -120,7 +120,7 @@ description: Starship is the minimal, blazing fast, and extremely customizable p #### Elvish - ::: 주의 elvish 버전 v0.17 이상에서만 지원됩니다. ::: + ::: warning elvish v0.17 이상만 지원. ::: `~/.elvish/rc.elv` 의 끝부분에 아래 라인을 추가: @@ -144,17 +144,19 @@ description: Starship is the minimal, blazing fast, and extremely customizable p #### Nushell - ::: 주의 이는 추후 변경될 예정입니다. 버전 v0.33 이상에서만 지원됩니다. ::: 새로운 설정 파일에 아래의 내용을 추가하세요. `config path`를 실행시키면 파일의 위치를 확인할 수 있습니다. - - ```toml - startup = [ - "mkdir ~/.cache/starship", - "starship init nu | save ~/.cache/starship/init.nu", - "source ~/.cache/starship/init.nu", - ] - prompt = "starship_prompt" + ::: 주의 이는 추후 변경될 예정입니다. Only Nushell v0.60+ is supported. ::: Run the following: + ```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`): + + ```sh + mkdir ~/.cache/starship + starship init nu | save ~/.cache/starship/init.nu + source ~/.cache/starship/init.nu + ``` #### Xonsh @@ -169,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+) 를 사용해야 합니다. `starship.lua` 파일에 아래의 라인을 추가하고 파일을 Clink scripts 폴더에 저장합니다. + 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: ```lua -- starship.lua diff --git a/docs/ko-KR/config/README.md b/docs/ko-KR/config/README.md index 5a2bd8a1..db6eac3f 100644 --- a/docs/ko-KR/config/README.md +++ b/docs/ko-KR/config/README.md @@ -198,6 +198,7 @@ $git_status\ $hg_branch\ $docker_context\ $package\ +$buf\ $cmake\ $cobol\ $container\ @@ -208,6 +209,7 @@ $elixir\ $elm\ $erlang\ $golang\ +$haskell\ $helm\ $java\ $julia\ @@ -261,7 +263,7 @@ format = "$all$directory$character" ## AWS -The `aws` module shows the current AWS region and profile when credentials or a `credential_process` 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. 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. @@ -278,6 +280,7 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL | `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. | @@ -308,6 +311,8 @@ symbol = "🅰 " [aws.region_aliases] ap-southeast-2 = "au" us-east-1 = "va" +[aws.profile_aliases] +CompanyGroupFrobozzOnCallAccess = 'Frobozz' ``` #### Display region @@ -333,6 +338,8 @@ us-east-1 = "va" format = "on [$symbol$profile]($style) " style = "bold blue" symbol = "🅰 " +[aws.profile_aliases] +Enterprise_Naming_Scheme-voidstars = 'void**' ``` ## Azure @@ -426,6 +433,45 @@ discharging_symbol = "💦" # when capacity is over 30%, the battery indicator will not be displayed ``` +## 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: + +- 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. + +### Options + +| Option | Default | Description | +| ------------------- | ------------------------------------------------------------ | ----------------------------------------------------- | +| `format` | `'with [$symbol($version \(Buf $buf_version\) )]($style)'` | The format for the `buf` module. | +| `version_format` | `"v${raw}"` | The version format. | +| `symbol` | `"🦬 "` | The symbol used before displaying the version of Buf. | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["buf.yaml", "buf.gen.yaml", "buf.work.yaml"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `style` | `"bold blue"` | The style for the module. | +| `disabled` | `false` | Disables the `elixir` module. | + +### Variables + +| Variable | Example | Description | +| ------------- | -------- | ------------------------------------ | +| `buf_version` | `v1.0.0` | The version of `buf` | +| `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 + +[buf] +symbol = "🦬 " +``` + ## Character The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. @@ -439,12 +485,6 @@ By default it only changes color. If you also want to change its shape take a lo ::: warning -`error_symbol` is not supported on nu shell. - -::: - -::: warning - `vicmd_symbol` is only supported in cmd, fish and zsh. ::: @@ -646,12 +686,12 @@ The `container` module displays a symbol and container name, if inside a contain ### Options -| Option | Default | Description | -| ---------- | ------------------------------------ | ----------------------------------------- | -| `symbol` | `"⬢"` | The symbol shown, when inside a container | -| `style` | `"bold red dimmed"` | The style for the module. | -| `format` | "[$symbol \\[$name\\]]($style) " | The format for the module. | -| `disabled` | `false` | Disables the `container` module. | +| Option | Default | Description | +| ---------- | -------------------------------------- | ----------------------------------------- | +| `symbol` | `"⬢"` | The symbol shown, when inside a container | +| `style` | `"bold red dimmed"` | The style for the module. | +| `format` | `"[$symbol \\[$name\\]]($style) "` | The format for the module. | +| `disabled` | `false` | Disables the `container` module. | ### Variables @@ -1007,7 +1047,7 @@ The `elm` module shows the currently installed version of [Elm](https://elm-lang - 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 -- The current directory contains a `*.elm` files +- The current directory contains `*.elm` files ### Options @@ -1259,6 +1299,7 @@ The `git_branch` module shows the active branch of the repo in your current dire | `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | | `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. | | `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | +| `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for "master" or "main". | | `disabled` | `false` | Disables the `git_branch` module. | ### Variables @@ -1282,6 +1323,7 @@ The `git_branch` module shows the active branch of the repo in your current dire symbol = "🌱 " truncation_length = 4 truncation_symbol = "" +ignore_branches = ["master", "main"] ``` ## Git Commit @@ -1547,6 +1589,39 @@ The `golang` module shows the currently installed version of [Go](https://golang format = "via [🏎💨 $version](bold cyan) " ``` +## Haskell + +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 +- The current directory contains any `.hs`, `.cabal`, or `.hs-boot` file + +### Options + +| Option | Default | Description | +| ------------------- | ------------------------------------ | -------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `symbol` | `"λ "` | A format string representing the symbol of Haskell | +| `detect_extensions` | `["hs", "cabal", "hs-boot"]` | Which extensions should trigger this module. | +| `detect_files` | `["stack.yaml", "cabal.project"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"bold purple"` | The style for the module. | +| `disabled` | `false` | Disables the `haskell` module. | + +### Variables + +| Variable | Example | Description | +| -------------- | ----------- | --------------------------------------------------------------------------------------- | +| version | | `ghc_version` or `snapshot` depending on whether the current project is a Stack project | +| snapshot | `lts-18.12` | Currently selected Stack snapshot | +| ghc\_version | `9.2.1` | Currently installed GHC version | +| 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 + ## 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: @@ -2137,21 +2212,21 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n - 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` extension +- The current directory contains a file with the `.ts`, `.mts` or `.cts` extension ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `" "` | A format string representing the symbol of Node.js. | -| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this module. | -| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. | -| `style` | `"bold green"` | The style for the module. | -| `disabled` | `false` | Disables the `nodejs` module. | -| `not_capable_style` | `bold red` | The style for the module when an engines property in package.json does not match the Node.js version. | +| Option | Default | Description | +| ------------------- | ------------------------------------------ | ----------------------------------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `" "` | A format string representing the symbol of Node.js. | +| `detect_extensions` | `["js", "mjs", "cjs", "ts", "mts", "cts"]` | Which extensions should trigger this module. | +| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. | +| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. | +| `style` | `"bold green"` | The style for the module. | +| `disabled` | `false` | Disables the `nodejs` module. | +| `not_capable_style` | `bold red` | The style for the module when an engines property in package.json does not match the Node.js version. | ### Variables @@ -2896,7 +2971,7 @@ format = '[📦 \[$env\]]($style) ' ## Status -The `status` module displays the exit code of the previous command. The module will be shown only if the exit code is not `0`. The status code will cast to a signed 32-bit integer. +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 @@ -2904,15 +2979,13 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y ::: -::: warning This module is not supported on nu shell. ::: - ### Options | Option | Default | Description | | ----------------------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------- | | `format` | `"[$symbol$status]($style) "` | The format of the module | | `symbol` | `"✖"` | The symbol displayed on program error | -| `success_symbol` | `"✔️"` | The symbol displayed on program success | +| `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) | @@ -2949,8 +3022,9 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y [status] style = "bg:blue" -symbol = "🔴" -format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) ' +symbol = "🔴 " +success_symbol = "🟢 SUCCESS" +format = '[\[$symbol$common_meaning$signal_name$maybe_int\]]($style) ' map_symbol = true disabled = false ``` diff --git a/docs/ko-KR/faq/README.md b/docs/ko-KR/faq/README.md index 19d26683..c3c797e7 100644 --- a/docs/ko-KR/faq/README.md +++ b/docs/ko-KR/faq/README.md @@ -1,4 +1,4 @@ -# FAQ +# Frequently Asked Questions ## What is the configuration used in the demo GIF? diff --git a/docs/ko-KR/guide/README.md b/docs/ko-KR/guide/README.md index 8368f45a..2305c58e 100644 --- a/docs/ko-KR/guide/README.md +++ b/docs/ko-KR/guide/README.md @@ -139,6 +139,8 @@ />

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

-**The minimal, blazing-fast, and infinitely customizable prompt for any shell!** +**간결하고 화끈하게 빠르며 무제한으로 커스터마이징이 가능한 프롬프트. 어떤 쉘에서든 사용할 수 있습니다!** - ** Fast:** 빨라요 – _엄청 엄청_ 빠릅니다! 🚀 - ** Customizable:** 프롬프트의 모든 측면을 커스텀 가능합니다. @@ -158,7 +160,7 @@ - **Easy:** 빠른 설치 - 몇 분 안에 사용할 수 있습니다.

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

@@ -169,9 +171,9 @@ - 터미널에 [Nerd Font](https://www.nerdfonts.com/)가 설치되어 있고 사용 가능해야 합니다. (ex. [Fira Code Nerd Font](https://www.nerdfonts.com/font-downloads)) -### Step 1. Starship 설치하기 +### 1단계. Starship 설치하기 -아래의 목록 중 해당하는 운영체제를 골라 설치 지침을 확인하세요: +Select your operating system from the list below to view installation instructions:
Android @@ -260,9 +262,9 @@ Install Starship using any of the following package managers:
-### Step 2. 쉘에 Starship 적용하기 +### 2단계. 쉘에 Starship 적용하기 -쉘에 Starship 초기 설정을 합니다. 아래의 리스트 중에 해당하는 것을 고르세요: +Configure your shell to initialize starship. Select yours from the list below:
Bash @@ -324,21 +326,26 @@ eval $(starship init ion)
Nushell -Add the following to the end of your Nushell configuration (find it by running `config path`): +Run the following: -```toml -startup = [ - "mkdir ~/.cache/starship", - "starship init nu | save ~/.cache/starship/init.nu", - "source ~/.cache/starship/init.nu", -] -prompt = "starship_prompt" +```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`): + +```sh +starship init nu | save ~/.cache/starship/init.nu +source ~/.cache/starship/init.nu +``` + +Note: Only Nushell v0.60+ is supported +
-Powershell +파워셀 Add the following to the end of your PowerShell configuration (find it by running `$PROFILE`): @@ -381,17 +388,17 @@ eval "$(starship init zsh)"
-### Step 3. Starship 설정하기 +### 3단계. Starship 설정하기 -새로운 쉘 인스턴스를 시작하면 아름다운 새 쉘 프롬프트를 볼 수 있습니다. 기본 설정에 만족한다면, 즐기세요! +Start a new shell instance, and you should see your beautiful new shell prompt. If you're happy with the defaults, enjoy! -Starship을 추가로 커스터마이징 하고싶다면: +If you're looking to further customize Starship: - **[Configuration](https://starship.rs/config/)** – 원하는대로 프롬프트를 수정할 수 있도록 Starship 설정을 배울 수 있습니다. - **[Presets](https://starship.rs/presets/)** – 다른 사람들이 만들어둔 설정들을 보고 영감을 받을 수 있습니다. -## 🤝 기여 +## 🤝 기여하기 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). @@ -411,7 +418,7 @@ Please check out these previous works that helped inspire the creation of starsh


- Starship 로켓 아이콘 + Starship rocket icon

## 📝라이선스 diff --git a/docs/ko-KR/installing/README.md b/docs/ko-KR/installing/README.md index 6108777d..d9b34f54 100644 --- a/docs/ko-KR/installing/README.md +++ b/docs/ko-KR/installing/README.md @@ -1,4 +1,4 @@ -# 🚀 Advanced Installation +# Advanced Installation To install starship, you need to do two things: diff --git a/docs/ko-KR/presets/README.md b/docs/ko-KR/presets/README.md index 12f5d20b..26c2314b 100644 --- a/docs/ko-KR/presets/README.md +++ b/docs/ko-KR/presets/README.md @@ -4,32 +4,38 @@ Here is a collection of community-submitted configuration presets for Starship. To get details on how to use a preset, simply click on the image. -## [Nerd Font Symbols](./nerd-font) +## [Nerd Font Symbols](./nerd-font.md) This preset changes the symbols for each module to use Nerd Font symbols. [![Screenshot of Nerd Font Symbols preset](/presets/img/nerd-font-symbols.png "Click to view Nerd Font Symbols preset")](./nerd-font) -## [Bracketed Segments](./bracketed-segments) +## [Bracketed Segments](./bracketed-segments.md) This preset changes the format of all the built-in modules to show their segment in brackets instead of using the default Starship wording ("via", "on", etc.). [![Screenshot of Bracketed Segments preset](/presets/img/bracketed-segments.png "Click to view Bracketed Segments preset")](./bracketed-segments) -## [Plain Text Symbols](./plain-text) +## [Plain Text Symbols](./plain-text.md) This preset changes the symbols for each module into plain text. Great if you don't have access to Unicode. [![Screenshot of Plain Text Symbols preset](/presets/img/plain-text-symbols.png "Click to view Plain Text Symbols preset")](./plain-text) -## [No Runtime Versions](./no-runtimes) +## [No Runtime Versions](./no-runtimes.md) This preset hides the version of language runtimes. If you work in containers or virtualized environments, this one is for you! [![Screenshot of Hide Runtime Versions preset](/presets/img/no-runtime-versions.png "Click to view No Runtime Versions preset")](./no-runtimes) -## [Pure Prompt](./pure-preset) +## [Pure Prompt](./pure-preset.md) This preset emulates the look and behavior of [Pure](https://github.com/sindresorhus/pure). [![Screenshot of Pure preset](/presets/img/pure-preset.png "Click to view Pure Prompt preset")](./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. + +[![Screenshot of Pastel Powerline preset](/presets/img/pastel-powerline.png "Click to view Pure Prompt preset")](./pastel-powerline) diff --git a/docs/ko-KR/presets/bracketed-segments.md b/docs/ko-KR/presets/bracketed-segments.md index 9b236714..9271a036 100644 --- a/docs/ko-KR/presets/bracketed-segments.md +++ b/docs/ko-KR/presets/bracketed-segments.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#bracketed-segments) +[Return to Presets](./README.md#bracketed-segments) # Bracketed Segments Preset diff --git a/docs/ko-KR/presets/nerd-font.md b/docs/ko-KR/presets/nerd-font.md index da5cc489..e11acde9 100644 --- a/docs/ko-KR/presets/nerd-font.md +++ b/docs/ko-KR/presets/nerd-font.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#nerd-font-symbols) +[Return to Presets](./README.md#nerd-font-symbols) # Nerd Font Symbols Preset diff --git a/docs/ko-KR/presets/no-runtimes.md b/docs/ko-KR/presets/no-runtimes.md index 1815872d..fd305051 100644 --- a/docs/ko-KR/presets/no-runtimes.md +++ b/docs/ko-KR/presets/no-runtimes.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#no-runtime-versions) +[Return to Presets](./README.md#no-runtime-versions) # No Runtime Versions Preset diff --git a/docs/ko-KR/presets/pastel-powerline.md b/docs/ko-KR/presets/pastel-powerline.md new file mode 100644 index 00000000..e1d1db15 --- /dev/null +++ b/docs/ko-KR/presets/pastel-powerline.md @@ -0,0 +1,17 @@ +[Return to Presets](./README.md#pastel-powerline) + +# Pastel Powerline Preset + +This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). It also shows how path substitution works in starship. + +![Screenshot of Pastel Powerline preset](/presets/img/pastel-powerline.png) + +### 준비 사항 + +- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (the example uses Caskaydia Cove Nerd Font) + +### Configuration + +[Click to download TOML](/presets/toml/pastel-powerline.toml) + +<<< @/.vuepress/public/presets/toml/pastel-powerline.toml diff --git a/docs/ko-KR/presets/plain-text.md b/docs/ko-KR/presets/plain-text.md index 12cb453e..49607e9a 100644 --- a/docs/ko-KR/presets/plain-text.md +++ b/docs/ko-KR/presets/plain-text.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#plain-text-symbols) +[Return to Presets](./README.md#plain-text-symbols) ## Plain Text Symbols Preset diff --git a/docs/ko-KR/presets/pure-preset.md b/docs/ko-KR/presets/pure-preset.md index 96a1b6a2..ad61b499 100644 --- a/docs/ko-KR/presets/pure-preset.md +++ b/docs/ko-KR/presets/pure-preset.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#pure) +[Return to Presets](./README.md#pure) # Pure Preset diff --git a/docs/nl-NL/README.md b/docs/nl-NL/README.md index 9017975d..0be27077 100644 --- a/docs/nl-NL/README.md +++ b/docs/nl-NL/README.md @@ -144,17 +144,19 @@ description: Starship is the minimal, blazing fast, and extremely customizable p #### Nushell - ::: warning This will change in the future. ::: Add the following to your nu config file. De locatie van hiervan kunt u vinden door `config path` uit te voeren in nushell. - - ```toml - startup = [ - "mkdir ~/.cache/starship", - "starship init nu | save ~/.cache/starship/init.nu", - "source ~/.cache/starship/init.nu", - ] - prompt = "starship_prompt" + ::: warning This will change in the future. Only Nushell v0.60+ is supported. ::: Run the following: + ```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`): + + ```sh + mkdir ~/.cache/starship + starship init nu | save ~/.cache/starship/init.nu + source ~/.cache/starship/init.nu + ``` #### Xonsh diff --git a/docs/nl-NL/config/README.md b/docs/nl-NL/config/README.md index 5a2bd8a1..db6eac3f 100644 --- a/docs/nl-NL/config/README.md +++ b/docs/nl-NL/config/README.md @@ -198,6 +198,7 @@ $git_status\ $hg_branch\ $docker_context\ $package\ +$buf\ $cmake\ $cobol\ $container\ @@ -208,6 +209,7 @@ $elixir\ $elm\ $erlang\ $golang\ +$haskell\ $helm\ $java\ $julia\ @@ -261,7 +263,7 @@ format = "$all$directory$character" ## AWS -The `aws` module shows the current AWS region and profile when credentials or a `credential_process` 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. 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. @@ -278,6 +280,7 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL | `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. | @@ -308,6 +311,8 @@ symbol = "🅰 " [aws.region_aliases] ap-southeast-2 = "au" us-east-1 = "va" +[aws.profile_aliases] +CompanyGroupFrobozzOnCallAccess = 'Frobozz' ``` #### Display region @@ -333,6 +338,8 @@ us-east-1 = "va" format = "on [$symbol$profile]($style) " style = "bold blue" symbol = "🅰 " +[aws.profile_aliases] +Enterprise_Naming_Scheme-voidstars = 'void**' ``` ## Azure @@ -426,6 +433,45 @@ discharging_symbol = "💦" # when capacity is over 30%, the battery indicator will not be displayed ``` +## 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: + +- 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. + +### Options + +| Option | Default | Description | +| ------------------- | ------------------------------------------------------------ | ----------------------------------------------------- | +| `format` | `'with [$symbol($version \(Buf $buf_version\) )]($style)'` | The format for the `buf` module. | +| `version_format` | `"v${raw}"` | The version format. | +| `symbol` | `"🦬 "` | The symbol used before displaying the version of Buf. | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["buf.yaml", "buf.gen.yaml", "buf.work.yaml"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `style` | `"bold blue"` | The style for the module. | +| `disabled` | `false` | Disables the `elixir` module. | + +### Variables + +| Variable | Example | Description | +| ------------- | -------- | ------------------------------------ | +| `buf_version` | `v1.0.0` | The version of `buf` | +| `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 + +[buf] +symbol = "🦬 " +``` + ## Character The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. @@ -439,12 +485,6 @@ By default it only changes color. If you also want to change its shape take a lo ::: warning -`error_symbol` is not supported on nu shell. - -::: - -::: warning - `vicmd_symbol` is only supported in cmd, fish and zsh. ::: @@ -646,12 +686,12 @@ The `container` module displays a symbol and container name, if inside a contain ### Options -| Option | Default | Description | -| ---------- | ------------------------------------ | ----------------------------------------- | -| `symbol` | `"⬢"` | The symbol shown, when inside a container | -| `style` | `"bold red dimmed"` | The style for the module. | -| `format` | "[$symbol \\[$name\\]]($style) " | The format for the module. | -| `disabled` | `false` | Disables the `container` module. | +| Option | Default | Description | +| ---------- | -------------------------------------- | ----------------------------------------- | +| `symbol` | `"⬢"` | The symbol shown, when inside a container | +| `style` | `"bold red dimmed"` | The style for the module. | +| `format` | `"[$symbol \\[$name\\]]($style) "` | The format for the module. | +| `disabled` | `false` | Disables the `container` module. | ### Variables @@ -1007,7 +1047,7 @@ The `elm` module shows the currently installed version of [Elm](https://elm-lang - 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 -- The current directory contains a `*.elm` files +- The current directory contains `*.elm` files ### Options @@ -1259,6 +1299,7 @@ The `git_branch` module shows the active branch of the repo in your current dire | `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | | `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. | | `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | +| `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for "master" or "main". | | `disabled` | `false` | Disables the `git_branch` module. | ### Variables @@ -1282,6 +1323,7 @@ The `git_branch` module shows the active branch of the repo in your current dire symbol = "🌱 " truncation_length = 4 truncation_symbol = "" +ignore_branches = ["master", "main"] ``` ## Git Commit @@ -1547,6 +1589,39 @@ The `golang` module shows the currently installed version of [Go](https://golang format = "via [🏎💨 $version](bold cyan) " ``` +## Haskell + +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 +- The current directory contains any `.hs`, `.cabal`, or `.hs-boot` file + +### Options + +| Option | Default | Description | +| ------------------- | ------------------------------------ | -------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `symbol` | `"λ "` | A format string representing the symbol of Haskell | +| `detect_extensions` | `["hs", "cabal", "hs-boot"]` | Which extensions should trigger this module. | +| `detect_files` | `["stack.yaml", "cabal.project"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"bold purple"` | The style for the module. | +| `disabled` | `false` | Disables the `haskell` module. | + +### Variables + +| Variable | Example | Description | +| -------------- | ----------- | --------------------------------------------------------------------------------------- | +| version | | `ghc_version` or `snapshot` depending on whether the current project is a Stack project | +| snapshot | `lts-18.12` | Currently selected Stack snapshot | +| ghc\_version | `9.2.1` | Currently installed GHC version | +| 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 + ## 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: @@ -2137,21 +2212,21 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n - 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` extension +- The current directory contains a file with the `.ts`, `.mts` or `.cts` extension ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `" "` | A format string representing the symbol of Node.js. | -| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this module. | -| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. | -| `style` | `"bold green"` | The style for the module. | -| `disabled` | `false` | Disables the `nodejs` module. | -| `not_capable_style` | `bold red` | The style for the module when an engines property in package.json does not match the Node.js version. | +| Option | Default | Description | +| ------------------- | ------------------------------------------ | ----------------------------------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `" "` | A format string representing the symbol of Node.js. | +| `detect_extensions` | `["js", "mjs", "cjs", "ts", "mts", "cts"]` | Which extensions should trigger this module. | +| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. | +| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. | +| `style` | `"bold green"` | The style for the module. | +| `disabled` | `false` | Disables the `nodejs` module. | +| `not_capable_style` | `bold red` | The style for the module when an engines property in package.json does not match the Node.js version. | ### Variables @@ -2896,7 +2971,7 @@ format = '[📦 \[$env\]]($style) ' ## Status -The `status` module displays the exit code of the previous command. The module will be shown only if the exit code is not `0`. The status code will cast to a signed 32-bit integer. +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 @@ -2904,15 +2979,13 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y ::: -::: warning This module is not supported on nu shell. ::: - ### Options | Option | Default | Description | | ----------------------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------- | | `format` | `"[$symbol$status]($style) "` | The format of the module | | `symbol` | `"✖"` | The symbol displayed on program error | -| `success_symbol` | `"✔️"` | The symbol displayed on program success | +| `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) | @@ -2949,8 +3022,9 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y [status] style = "bg:blue" -symbol = "🔴" -format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) ' +symbol = "🔴 " +success_symbol = "🟢 SUCCESS" +format = '[\[$symbol$common_meaning$signal_name$maybe_int\]]($style) ' map_symbol = true disabled = false ``` diff --git a/docs/nl-NL/faq/README.md b/docs/nl-NL/faq/README.md index 19d26683..c3c797e7 100644 --- a/docs/nl-NL/faq/README.md +++ b/docs/nl-NL/faq/README.md @@ -1,4 +1,4 @@ -# FAQ +# Frequently Asked Questions ## What is the configuration used in the demo GIF? diff --git a/docs/nl-NL/guide/README.md b/docs/nl-NL/guide/README.md index d34bbdbc..88f5d656 100644 --- a/docs/nl-NL/guide/README.md +++ b/docs/nl-NL/guide/README.md @@ -137,11 +137,13 @@ />

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

Starship met iTerm2 en het thema Snazzy @@ -156,7 +158,7 @@ - **Makkelijk:** snel te installeren - begin in een handomdraai met het te gebruiken.

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

@@ -322,17 +324,22 @@ eval $(starship init ion)
Nushell -Add the following to the end of your Nushell configuration (find it by running `config path`): +Run the following: -```toml -startup = [ - "mkdir ~/.cache/starship", - "starship init nu | save ~/.cache/starship/init.nu", - "source ~/.cache/starship/init.nu", -] -prompt = "starship_prompt" +```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`): + +```sh +starship init nu | save ~/.cache/starship/init.nu +source ~/.cache/starship/init.nu +``` + +Note: Only Nushell v0.60+ is supported +
diff --git a/docs/nl-NL/installing/README.md b/docs/nl-NL/installing/README.md index 39834d1b..fc1e90a3 100644 --- a/docs/nl-NL/installing/README.md +++ b/docs/nl-NL/installing/README.md @@ -1,4 +1,4 @@ -# 🚀 Advanced Installation +# Advanced Installation To install starship, you need to do two things: diff --git a/docs/nl-NL/presets/README.md b/docs/nl-NL/presets/README.md index 12f5d20b..26c2314b 100644 --- a/docs/nl-NL/presets/README.md +++ b/docs/nl-NL/presets/README.md @@ -4,32 +4,38 @@ Here is a collection of community-submitted configuration presets for Starship. To get details on how to use a preset, simply click on the image. -## [Nerd Font Symbols](./nerd-font) +## [Nerd Font Symbols](./nerd-font.md) This preset changes the symbols for each module to use Nerd Font symbols. [![Screenshot of Nerd Font Symbols preset](/presets/img/nerd-font-symbols.png "Click to view Nerd Font Symbols preset")](./nerd-font) -## [Bracketed Segments](./bracketed-segments) +## [Bracketed Segments](./bracketed-segments.md) This preset changes the format of all the built-in modules to show their segment in brackets instead of using the default Starship wording ("via", "on", etc.). [![Screenshot of Bracketed Segments preset](/presets/img/bracketed-segments.png "Click to view Bracketed Segments preset")](./bracketed-segments) -## [Plain Text Symbols](./plain-text) +## [Plain Text Symbols](./plain-text.md) This preset changes the symbols for each module into plain text. Great if you don't have access to Unicode. [![Screenshot of Plain Text Symbols preset](/presets/img/plain-text-symbols.png "Click to view Plain Text Symbols preset")](./plain-text) -## [No Runtime Versions](./no-runtimes) +## [No Runtime Versions](./no-runtimes.md) This preset hides the version of language runtimes. If you work in containers or virtualized environments, this one is for you! [![Screenshot of Hide Runtime Versions preset](/presets/img/no-runtime-versions.png "Click to view No Runtime Versions preset")](./no-runtimes) -## [Pure Prompt](./pure-preset) +## [Pure Prompt](./pure-preset.md) This preset emulates the look and behavior of [Pure](https://github.com/sindresorhus/pure). [![Screenshot of Pure preset](/presets/img/pure-preset.png "Click to view Pure Prompt preset")](./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. + +[![Screenshot of Pastel Powerline preset](/presets/img/pastel-powerline.png "Click to view Pure Prompt preset")](./pastel-powerline) diff --git a/docs/nl-NL/presets/bracketed-segments.md b/docs/nl-NL/presets/bracketed-segments.md index 9b236714..9271a036 100644 --- a/docs/nl-NL/presets/bracketed-segments.md +++ b/docs/nl-NL/presets/bracketed-segments.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#bracketed-segments) +[Return to Presets](./README.md#bracketed-segments) # Bracketed Segments Preset diff --git a/docs/nl-NL/presets/nerd-font.md b/docs/nl-NL/presets/nerd-font.md index dc9e2185..366c2640 100644 --- a/docs/nl-NL/presets/nerd-font.md +++ b/docs/nl-NL/presets/nerd-font.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#nerd-font-symbols) +[Return to Presets](./README.md#nerd-font-symbols) # Nerd Font Symbols Preset diff --git a/docs/nl-NL/presets/no-runtimes.md b/docs/nl-NL/presets/no-runtimes.md index 1815872d..fd305051 100644 --- a/docs/nl-NL/presets/no-runtimes.md +++ b/docs/nl-NL/presets/no-runtimes.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#no-runtime-versions) +[Return to Presets](./README.md#no-runtime-versions) # No Runtime Versions Preset diff --git a/docs/nl-NL/presets/pastel-powerline.md b/docs/nl-NL/presets/pastel-powerline.md new file mode 100644 index 00000000..cc48170d --- /dev/null +++ b/docs/nl-NL/presets/pastel-powerline.md @@ -0,0 +1,17 @@ +[Return to Presets](./README.md#pastel-powerline) + +# Pastel Powerline Preset + +This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). It also shows how path substitution works in starship. + +![Screenshot of Pastel Powerline preset](/presets/img/pastel-powerline.png) + +### Benodigdheden + +- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (the example uses Caskaydia Cove Nerd Font) + +### Configuration + +[Click to download TOML](/presets/toml/pastel-powerline.toml) + +<<< @/.vuepress/public/presets/toml/pastel-powerline.toml diff --git a/docs/nl-NL/presets/plain-text.md b/docs/nl-NL/presets/plain-text.md index 12cb453e..49607e9a 100644 --- a/docs/nl-NL/presets/plain-text.md +++ b/docs/nl-NL/presets/plain-text.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#plain-text-symbols) +[Return to Presets](./README.md#plain-text-symbols) ## Plain Text Symbols Preset diff --git a/docs/nl-NL/presets/pure-preset.md b/docs/nl-NL/presets/pure-preset.md index 96a1b6a2..ad61b499 100644 --- a/docs/nl-NL/presets/pure-preset.md +++ b/docs/nl-NL/presets/pure-preset.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#pure) +[Return to Presets](./README.md#pure) # Pure Preset diff --git a/docs/pl-PL/README.md b/docs/pl-PL/README.md index 08031dd2..0aec0d69 100644 --- a/docs/pl-PL/README.md +++ b/docs/pl-PL/README.md @@ -144,17 +144,19 @@ description: Starship is the minimal, blazing fast, and extremely customizable p #### Nushell - ::: warning This will change in the future. Działa tylko dla wersji powłoki nu v0.33 lub wyższej. ::: Add the following to your nu config file. Możesz sprawdzić lokalizację tego pliku wywołując polecenie `config path` w powłoce nu. - - ```toml - startup = [ - "mkdir ~/.cache/starship", - "starship init nu | save ~/.cache/starship/init.nu", - "source ~/.cache/starship/init.nu", - ] - prompt = "starship_prompt" + ::: warning This will change in the future. Only Nushell v0.60+ is supported. ::: Run the following: + ```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`): + + ```sh + mkdir ~/.cache/starship + starship init nu | save ~/.cache/starship/init.nu + source ~/.cache/starship/init.nu + ``` #### Xonsh diff --git a/docs/pl-PL/config/README.md b/docs/pl-PL/config/README.md index 5d37f08d..ab260191 100644 --- a/docs/pl-PL/config/README.md +++ b/docs/pl-PL/config/README.md @@ -198,6 +198,7 @@ $git_status\ $hg_branch\ $docker_context\ $package\ +$buf\ $cmake\ $cobol\ $container\ @@ -208,6 +209,7 @@ $elixir\ $elm\ $erlang\ $golang\ +$haskell\ $helm\ $java\ $julia\ @@ -261,7 +263,7 @@ format = "$all$directory$character" ## AWS -The `aws` module shows the current AWS region and profile when credentials or a `credential_process` 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. 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. @@ -278,6 +280,7 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL | `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. | @@ -308,6 +311,8 @@ symbol = "🅰 " [aws.region_aliases] ap-southeast-2 = "au" us-east-1 = "va" +[aws.profile_aliases] +CompanyGroupFrobozzOnCallAccess = 'Frobozz' ``` #### Display region @@ -333,6 +338,8 @@ us-east-1 = "va" format = "on [$symbol$profile]($style) " style = "bold blue" symbol = "🅰 " +[aws.profile_aliases] +Enterprise_Naming_Scheme-voidstars = 'void**' ``` ## Azure @@ -426,6 +433,45 @@ discharging_symbol = "💦" # when capacity is over 30%, the battery indicator will not be displayed ``` +## 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: + +- 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. + +### Options + +| Option | Default | Description | +| ------------------- | ------------------------------------------------------------ | ----------------------------------------------------- | +| `format` | `'with [$symbol($version \(Buf $buf_version\) )]($style)'` | The format for the `buf` module. | +| `version_format` | `"v${raw}"` | The version format. | +| `symbol` | `"🦬 "` | The symbol used before displaying the version of Buf. | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["buf.yaml", "buf.gen.yaml", "buf.work.yaml"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `style` | `"bold blue"` | The style for the module. | +| `disabled` | `false` | Disables the `elixir` module. | + +### Variables + +| Zmienne | Example | Description | +| ------------- | -------- | ------------------------------------ | +| `buf_version` | `v1.0.0` | The version of `buf` | +| `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 + +[buf] +symbol = "🦬 " +``` + ## Character The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. @@ -439,12 +485,6 @@ By default it only changes color. If you also want to change its shape take a lo ::: warning -`error_symbol` is not supported on nu shell. - -::: - -::: warning - `vicmd_symbol` is only supported in cmd, fish and zsh. ::: @@ -646,12 +686,12 @@ The `container` module displays a symbol and container name, if inside a contain ### Options -| Option | Default | Description | -| ---------- | ------------------------------------ | ----------------------------------------- | -| `symbol` | `"⬢"` | The symbol shown, when inside a container | -| `style` | `"bold red dimmed"` | The style for the module. | -| `format` | "[$symbol \\[$name\\]]($style) " | The format for the module. | -| `disabled` | `false` | Disables the `container` module. | +| Option | Default | Description | +| ---------- | -------------------------------------- | ----------------------------------------- | +| `symbol` | `"⬢"` | The symbol shown, when inside a container | +| `style` | `"bold red dimmed"` | The style for the module. | +| `format` | `"[$symbol \\[$name\\]]($style) "` | The format for the module. | +| `disabled` | `false` | Disables the `container` module. | ### Variables @@ -1007,7 +1047,7 @@ The `elm` module shows the currently installed version of [Elm](https://elm-lang - 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 -- The current directory contains a `*.elm` files +- The current directory contains `*.elm` files ### Options @@ -1066,7 +1106,7 @@ default = "unknown user" | Option | Default | Description | | ---------- | ------------------------------ | ---------------------------------------------------------------------------- | | `symbol` | `""` | The symbol used before displaying the variable value. | -| `zmienne` | | The environment variable to be displayed. | +| `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. | @@ -1259,6 +1299,7 @@ The `git_branch` module shows the active branch of the repo in your current dire | `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | | `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. | | `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | +| `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for "master" or "main". | | `disabled` | `false` | Disables the `git_branch` module. | ### Variables @@ -1282,6 +1323,7 @@ The `git_branch` module shows the active branch of the repo in your current dire symbol = "🌱 " truncation_length = 4 truncation_symbol = "" +ignore_branches = ["master", "main"] ``` ## Git Commit @@ -1547,6 +1589,39 @@ The `golang` module shows the currently installed version of [Go](https://golang format = "via [🏎💨 $version](bold cyan) " ``` +## Haskell + +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 +- The current directory contains any `.hs`, `.cabal`, or `.hs-boot` file + +### Options + +| Option | Default | Description | +| ------------------- | ------------------------------------ | -------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `symbol` | `"λ "` | A format string representing the symbol of Haskell | +| `detect_extensions` | `["hs", "cabal", "hs-boot"]` | Which extensions should trigger this module. | +| `detect_files` | `["stack.yaml", "cabal.project"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"bold purple"` | The style for the module. | +| `disabled` | `false` | Disables the `haskell` module. | + +### Variables + +| Zmienne | Example | Description | +| -------------- | ----------- | --------------------------------------------------------------------------------------- | +| version | | `ghc_version` or `snapshot` depending on whether the current project is a Stack project | +| snapshot | `lts-18.12` | Currently selected Stack snapshot | +| ghc\_version | `9.2.1` | Currently installed GHC version | +| 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 + ## 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: @@ -2137,21 +2212,21 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n - 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` extension +- The current directory contains a file with the `.ts`, `.mts` or `.cts` extension ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `" "` | A format string representing the symbol of Node.js. | -| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this module. | -| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. | -| `style` | `"bold green"` | The style for the module. | -| `disabled` | `false` | Disables the `nodejs` module. | -| `not_capable_style` | `bold red` | The style for the module when an engines property in package.json does not match the Node.js version. | +| Option | Default | Description | +| ------------------- | ------------------------------------------ | ----------------------------------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `" "` | A format string representing the symbol of Node.js. | +| `detect_extensions` | `["js", "mjs", "cjs", "ts", "mts", "cts"]` | Which extensions should trigger this module. | +| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. | +| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. | +| `style` | `"bold green"` | The style for the module. | +| `disabled` | `false` | Disables the `nodejs` module. | +| `not_capable_style` | `bold red` | The style for the module when an engines property in package.json does not match the Node.js version. | ### Variables @@ -2896,7 +2971,7 @@ format = '[📦 \[$env\]]($style) ' ## Status -The `status` module displays the exit code of the previous command. The module will be shown only if the exit code is not `0`. The status code will cast to a signed 32-bit integer. +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 @@ -2904,15 +2979,13 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y ::: -::: warning This module is not supported on nu shell. ::: - ### Options | Option | Default | Description | | ----------------------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------- | | `format` | `"[$symbol$status]($style) "` | The format of the module | | `symbol` | `"✖"` | The symbol displayed on program error | -| `success_symbol` | `"✔️"` | The symbol displayed on program success | +| `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) | @@ -2949,8 +3022,9 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y [status] style = "bg:blue" -symbol = "🔴" -format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) ' +symbol = "🔴 " +success_symbol = "🟢 SUCCESS" +format = '[\[$symbol$common_meaning$signal_name$maybe_int\]]($style) ' map_symbol = true disabled = false ``` diff --git a/docs/pl-PL/faq/README.md b/docs/pl-PL/faq/README.md index d7dd23cb..ca452244 100644 --- a/docs/pl-PL/faq/README.md +++ b/docs/pl-PL/faq/README.md @@ -1,4 +1,4 @@ -# Najczęściej zadawane pytania (FAQ) +# Frequently Asked Questions ## Jakiej konfiguracji użyto w GIFie demonstracyjnym? diff --git a/docs/pl-PL/guide/README.md b/docs/pl-PL/guide/README.md index ea307c9b..c7af02c4 100644 --- a/docs/pl-PL/guide/README.md +++ b/docs/pl-PL/guide/README.md @@ -139,11 +139,13 @@ />

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

Starship na iTerm2 z motywem Snazzy @@ -158,7 +160,7 @@ - **Łatwy w obsłudze:** szybka instalacja - zacznij korzystać w kilka minut.

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

@@ -324,17 +326,22 @@ eval $(starship init ion)
Nushell -Add the following to the end of your Nushell configuration (find it by running `config path`): +Run the following: -```toml -startup = [ - "mkdir ~/.cache/starship", - "starship init nu | save ~/.cache/starship/init.nu", - "source ~/.cache/starship/init.nu", -] -prompt = "starship_prompt" +```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`): + +```sh +starship init nu | save ~/.cache/starship/init.nu +source ~/.cache/starship/init.nu +``` + +Note: Only Nushell v0.60+ is supported +
@@ -393,15 +400,15 @@ If you're looking to further customize Starship: ## 🤝Wspomóż nas -Zawsze szukamy pomocy od osób **na każdym poziomie zaawansowania**! Jeśli potrzebujesz łatwiejszego wdrożenia w projekt, wypróbuj [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). +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). -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 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ż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ć. 👋 +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. 👋 ## 💭Inspiracje -Zapoznaj się z wcześniejszymi projektami które zainspirowały nas do stworzenia starship. 🙏 +Please check out these previous works that helped inspire the creation of 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 d3797196..8e060f62 100644 --- a/docs/pl-PL/installing/README.md +++ b/docs/pl-PL/installing/README.md @@ -1,4 +1,4 @@ -# 🚀 Zaawansowana Instalacja +# Advanced Installation Aby zainstalować starship, musisz zrobić dwie rzeczy: diff --git a/docs/pl-PL/presets/README.md b/docs/pl-PL/presets/README.md index 2e7f29b3..c601524b 100644 --- a/docs/pl-PL/presets/README.md +++ b/docs/pl-PL/presets/README.md @@ -4,32 +4,38 @@ Poniżej zamieszczono zestaw gotowych konfiguracji Starship stworzonych przez sp To get details on how to use a preset, simply click on the image. -## [Symbole Nerd Font](./nerd-font) +## [Symbole Nerd Font](./nerd-font.md) This preset changes the symbols for each module to use Nerd Font symbols. [![Screenshot of Nerd Font Symbols preset](/presets/img/nerd-font-symbols.png "Click to view Nerd Font Symbols preset")](./nerd-font) -## [Moduły w nawiasach kwadratowych](./bracketed-segments) +## [Moduły w nawiasach kwadratowych](./bracketed-segments.md) Ta konfiguracja zmienia format wyświetlania wbudowanych modułów - zamiast domyślnych wyrazów ("via", "on", itp.) są wypisywane w nawiasach kwadratowych. [![Screenshot of Bracketed Segments preset](/presets/img/bracketed-segments.png "Click to view Bracketed Segments preset")](./bracketed-segments) -## [Symbole "plain text"](./plain-text) +## [Symbole "plain text"](./plain-text.md) This preset changes the symbols for each module into plain text. Great if you don't have access to Unicode. [![Screenshot of Plain Text Symbols preset](/presets/img/plain-text-symbols.png "Click to view Plain Text Symbols preset")](./plain-text) -## [No Runtime Versions](./no-runtimes) +## [No Runtime Versions](./no-runtimes.md) This preset hides the version of language runtimes. If you work in containers or virtualized environments, this one is for you! [![Screenshot of Hide Runtime Versions preset](/presets/img/no-runtime-versions.png "Click to view No Runtime Versions preset")](./no-runtimes) -## [Pure Prompt](./pure-preset) +## [Pure Prompt](./pure-preset.md) This preset emulates the look and behavior of [Pure](https://github.com/sindresorhus/pure). [![Screenshot of Pure preset](/presets/img/pure-preset.png "Click to view Pure Prompt preset")](./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. + +[![Screenshot of Pastel Powerline preset](/presets/img/pastel-powerline.png "Click to view Pure Prompt preset")](./pastel-powerline) diff --git a/docs/pl-PL/presets/bracketed-segments.md b/docs/pl-PL/presets/bracketed-segments.md index 3d4d7f9b..44218338 100644 --- a/docs/pl-PL/presets/bracketed-segments.md +++ b/docs/pl-PL/presets/bracketed-segments.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#bracketed-segments) +[Return to Presets](./README.md#bracketed-segments) # Bracketed Segments Preset diff --git a/docs/pl-PL/presets/nerd-font.md b/docs/pl-PL/presets/nerd-font.md index 3df41f10..d7d2d2c7 100644 --- a/docs/pl-PL/presets/nerd-font.md +++ b/docs/pl-PL/presets/nerd-font.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#nerd-font-symbols) +[Return to Presets](./README.md#nerd-font-symbols) # Nerd Font Symbols Preset diff --git a/docs/pl-PL/presets/no-runtimes.md b/docs/pl-PL/presets/no-runtimes.md index d7fa7a8c..9c61ba9a 100644 --- a/docs/pl-PL/presets/no-runtimes.md +++ b/docs/pl-PL/presets/no-runtimes.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#no-runtime-versions) +[Return to Presets](./README.md#no-runtime-versions) # No Runtime Versions Preset diff --git a/docs/pl-PL/presets/pastel-powerline.md b/docs/pl-PL/presets/pastel-powerline.md new file mode 100644 index 00000000..2b039b30 --- /dev/null +++ b/docs/pl-PL/presets/pastel-powerline.md @@ -0,0 +1,17 @@ +[Return to Presets](./README.md#pastel-powerline) + +# Pastel Powerline Preset + +This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). It also shows how path substitution works in starship. + +![Screenshot of Pastel Powerline preset](/presets/img/pastel-powerline.png) + +### Wymagania wstępne + +- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (the example uses Caskaydia Cove Nerd Font) + +### Konfiguracja + +[Click to download TOML](/presets/toml/pastel-powerline.toml) + +<<< @/.vuepress/public/presets/toml/pastel-powerline.toml diff --git a/docs/pl-PL/presets/plain-text.md b/docs/pl-PL/presets/plain-text.md index 6ad6d8a1..b20f9a8c 100644 --- a/docs/pl-PL/presets/plain-text.md +++ b/docs/pl-PL/presets/plain-text.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#plain-text-symbols) +[Return to Presets](./README.md#plain-text-symbols) ## Plain Text Symbols Preset diff --git a/docs/pl-PL/presets/pure-preset.md b/docs/pl-PL/presets/pure-preset.md index caf282bc..41ac0651 100644 --- a/docs/pl-PL/presets/pure-preset.md +++ b/docs/pl-PL/presets/pure-preset.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#pure) +[Return to Presets](./README.md#pure) # Pure Preset diff --git a/docs/pt-BR/README.md b/docs/pt-BR/README.md index f0808c81..5234ee8a 100644 --- a/docs/pt-BR/README.md +++ b/docs/pt-BR/README.md @@ -37,7 +37,7 @@ description: O Starship é o prompt minimalista, extremamente rápido e extremam 1. Instale o binário do **starship**: - #### Instalar a última versão + #### Instalando a última versão Com o Shell: @@ -48,7 +48,7 @@ description: O Starship é o prompt minimalista, extremamente rápido e extremam Para atualizar o Starship de maneira manual, execute novamente o script acima. Isto irá substituir a versão atual sem alterar as configurações do Starship. - #### Instalar via Gerenciador de Pacotes + #### Instalar via gerenciador de pacotes Com o [Homebrew](https://brew.sh/): @@ -62,7 +62,7 @@ description: O Starship é o prompt minimalista, extremamente rápido e extremam scoop install starship ``` -1. Adicione o script de inicialização ao arquivo de configuração do shell: +1. Adicione o script de inicialização no arquivo de configuração do seu shell: #### Bash @@ -100,7 +100,7 @@ description: O Starship é o prompt minimalista, extremamente rápido e extremam #### Powershell - Adicione o comando a seguir ao final do arquivo `Microsoft.PowerShell_profile.ps1`. Você pode conferir a localização do arquivo consultando a varável `$PROFILE` no PowerShell. Normalmente o caminho é `~\Documentos\PowerShell\Microsoft.PowerShell_profile.ps1` ou `~/.config/powershell/Microsoft.PowerShell_profile.ps1` no -Nix. + Adicione o comando a seguir ao final do arquivo `Microsoft.PowerShell_profile.ps1`. Você pode checar a localização deste arquivo consultando a variável `$PROFILE` no PowerShell. Normalmente o caminho é `~\Documentos\PowerShell\Microsoft.PowerShell_profile.ps1` ou `~/.config/powershell/Microsoft.PowerShell_profile.ps1` no -Nix. ```sh Invoke-Expression (&starship init powershell) @@ -120,7 +120,7 @@ description: O Starship é o prompt minimalista, extremamente rápido e extremam #### Elvish - ::: warning Apenas a versão elvish v0.17 ou superior é suportada. ::: + ::: warning Apenas a versão v0.17 ou superior do elvish é suportada. ::: Adicione o comando a seguir ao final do arquivo `~/.elvish/rc.elv`: @@ -144,17 +144,19 @@ description: O Starship é o prompt minimalista, extremamente rápido e extremam #### Nushell - ::: Atenção Isto vai mudar no futuro. Apenas a versão v0.33 do nu ou superior é suportada. Adicione o seguinte no seu arquivo de configuração nu. Você pode verificar o local deste arquivo rodando `config path` in nu. - - ```toml - startup = [ - "mkdir ~/.cache/starship", - "starship init nu | save ~/.cache/starship/init.nu", - "source ~/.cache/starship/init.nu", - ] - prompt = "starship_prompt" + ::: Atenção Isto vai mudar no futuro. Only Nushell v0.60+ is supported. ::: Run the following: + ```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`): + + ```sh + mkdir ~/.cache/starship + starship init nu | save ~/.cache/starship/init.nu + source ~/.cache/starship/init.nu + ``` #### Xonsh @@ -169,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. Adicione o seguinte num arquivo `starship.lua` e coloque este arquivo no diretório scripts do Clink: + 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: ```lua -- starship.lua diff --git a/docs/pt-BR/advanced-config/README.md b/docs/pt-BR/advanced-config/README.md index df09878f..638099ba 100644 --- a/docs/pt-BR/advanced-config/README.md +++ b/docs/pt-BR/advanced-config/README.md @@ -32,11 +32,11 @@ end load(io.popen('starship init cmd'):read("*a"))() ``` -## Comandos personalizados de pré-prompt e pré-execução no Bash +## Comandos personalizados de pre-prompt e pre-execution no Bash -Bash não possui uma estrutura formal pré-prompt/pré-execução como a maioria dos outros shells. Por causa disso, é difícil fornecer ganchos totalmente personalizáveis no `bash`. No entanto, Starship te oferece uma capacidade limitada de inserir suas próprias funções na processo de prompt-rendering: +O Bash não possui uma estrutura formal para os hooks preexec/precmd como a maioria dos outros shells. Por esse motivo, é difícil fornecer hooks totalmente customizáveis no `bash`. No entanto, Starship te oferece uma capacidade limitada de inserir suas próprias funções na processo de prompt-rendering: -- Para executar uma função personalizada logo antes de o prompt ser inicializado, define uma nova função e, em seguida, atribui seu nome a `starship_precmd_user_func`. Por exemplo, para exibir um foguete antes do prompt, você faria +- Para rodar uma função personalizada antes do prompt iniciar, defina uma nova função e atribua seu nome para `starship_precmd_user_func`. Por exemplo, para desenhar um foguete antes do prompt iniciar você faria ```bash function blastoff(){ @@ -45,7 +45,7 @@ function blastoff(){ starship_precmd_user_func="blastoff" ``` -- Para executar uma função personalizada logo antes de um comando ser executado, você pode usar o [`DEBUG` mecanismo de captura](https://jichu4n.com/posts/debug-trap-and-prompt_command-in-bash/). No entanto, você **deve** capturar o sinal DEBUG _antes_ de inicializar o Starship! Starship pode preservar o valor da captura do DEBUG, mas se a captura for substituída após a inicialização do starship, algumas funcionalidades serão interrompidas. +- Para rodar uma função personalizada antes que um comando seja executado, você pode usar [`DEBUG` como mecanismo de armadilha](https://jichu4n.com/posts/debug-trap-and-prompt_command-in-bash/). No entanto, você **deve** prender o sinal de DEBUG _antes_ de inicializar o Starship! O Starship consegue preservar o valor da armadilha DEBUG, mas se a armadilha for substituída depois do starship iniciar, algumas funções iram quebrar. ```bash function blastoff(){ @@ -57,9 +57,9 @@ eval $(starship init bash) set +o functrace ``` -## Comandos personalizados de pré-prompt e pré-execução no PowerShell +## Comandos personalizados de pre-prompt e pre-execution no PowerShell -PowerShell não possui uma estrutura formal pré-prompt/pré-execução como a maioria dos outros shells. Por causa disso, é difícil fornecer ganchos totalmente personalizáveis no `powershell`. No entanto, Starship te oferece uma capacidade limitada de inserir suas próprias funções na processo de prompt-rendering: +O PowerShell não possui uma estrutura formal para os hooks preexec/precmd como a maioria dos outros shells. Por esse motivo, é difícil fornecer hooks totalmente customizáveis no `powershell`. No entanto, Starship te oferece uma capacidade limitada de inserir suas próprias funções na processo de prompt-rendering: Crie uma função chamada `Invoke-Starship-PreCommand` @@ -69,11 +69,11 @@ function Invoke-Starship-PreCommand { } ``` -## Alterar Título da Janela +## Altera o título da janela -Alguns prompts do shell alterarão automaticamente o título da janela para você (ex., para refletir no seu diretório de trabalho). Fish ainda faz isso por padrão. Starship não faz isso, mas é bastante simples adicionar essa funcionalidade para `bash`, `zsh`, `cmd` ou `powershell`. +Alguns shell prompts iram alterar o titulo da janela automaticamente para você (e.x: para espelhar o diretório atual). Fish faz isso por padrão. Starship não faz isso, mas é bastante simples adicionar essa funcionalidade para `bash`, `zsh`, `cmd` ou `powershell`. -Primeiro, defina uma função de mudança de título da janela (idêntica em bash e zsh): +Primeiro, defina uma função de alteração de titulo de janela (é o mesmo para bash e zsh): ```bash function set_win_title(){ @@ -81,23 +81,23 @@ function set_win_title(){ } ``` -Você pode usar variáveis para personalizar este título (`$USER`, `$HOSTNAME` e `$PWD` são escolhas populares). +Você pode usar variáveis para customizar o titulo (`$USER`, `$HOSTNAME`, e `$PWD` são escolhas populares). -No `bash`, defina esta função como a função precmd da nave estelar: +No `bash`, defina esta função como a precedente da função starship: ```bash starship_precmd_user_func="set_win_title" ``` -No `zsh`, adicione isso ao array `precmd_functions`: +No `zsh`, adicione no array `precmd_functions`: ```bash precmd_functions+=(set_win_title) ``` -Se você gostar do resultado, adicione estas linhas ao seu arquivo de configuração do shell (`~/.bashrc` ou `~/.zshrc`) para torná-lo permanente. +Se você gostar do resultado, adicione esta linha ao seu arquivo de configuração de shell (`~/.bashrc` or `~/.zshrc`) para torna-lo permanente. -Por exemplo, se você deseja exibir seu diretório atual no título da guia do terminal, adicione o seguinte trecho ao seu `~/.bashrc` ou `~/.zshrc`: +Por exemplo, se você quiser exibir seu diretório atual no seu titulo de aba do terminal, adicione o seguinte snippet ao seu `~/.bashrc` ou `~/.zshrc`: ```bash function set_win_title(){ @@ -119,19 +119,19 @@ load(io.popen('starship init cmd'):read("*a"))() Você também pode definir uma saída semelhante com o PowerShell criando uma função chamada `Invoke-Starship-PreCommand`. ```powershell -# editar $PROFILE +# edit $PROFILE function Invoke-Starship-PreCommand { - $host.ui.Write("`e]0; PS> $env:USERNAME@$env:COMPUTERNAME`: $pwd `a") + $host.ui.Write("`e]0; PS> $env:USERNAME@$env:COMPUTERNAME`: $pwd `a") } -Invoke-Expression (& starship init powershell) +Invoke-Expression (&starship init powershell) ``` ## Ativando o Prompt Direito -Alguns shells suportam um prompt direito que é renderizado na mesma linha que a entrada. Starship pode definir o conteúdo do prompt correto usando a opção `right_format`. Qualquer módulo que pode ser usado no `format` também é compatível com `right_format`. A variável `$all` conterá apenas módulos não usado explicitamente em `format` ou `right_format`. +Alguns shells suportam um prompt no lado direito que renderiza na mesma linha do input. Starship consegue definir o conteúdo do prompt direito usando a opção `right_format`. Qualquer módulo pode ser usado no `format` é suportado o `right_format`. A variável `$all` só irá alterar os módulos que não usaram de forma explicita o `format` ou `right_format`. -Nota: O prompt direito é uma única linha após 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. 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). `right_format` é atualmente compatível com os seguintes shells: elvish, fish, zsh, xonsh, cmd. @@ -140,28 +140,28 @@ Nota: O prompt direito é uma única linha após o local de entrada. Para alinha ```toml # ~/.config/starship.toml -# Um prompt mínimo à esquerda +# Um prompt esquerdo minimo format = """$character""" -# movw o restante do prompt para a direita +# Move o resto do prompt para direita right_format = """$all""" ``` -Produz um prompt como o seguinte: +Gera um prompt parecido com o seguinte: ``` ▶ starship on  rprompt [!] is 📦 v0.57.0 via 🦀 v1.54.0 took 17s ``` -## Prompt de Continuação +## Prompt de Continução -Alguns shells suportam um prompt de continuação junto com o prompt normal. Esse prompt é renderizado em vez do prompt normal quando o usuário insere uma instrução incompleta (como um único parêntese esquerdo ou aspas). +Algumas shells suportam prompt de continuação juntamento com o prompt normal. Este prompt é renderizado em vez do prompt normal quando o usuário insere um comando incompleto (Como um parentese ou aspas a esquerda). -Starship pode definir o prompt de continuação usando a opção `continuation_prompt`. O prompt padrão é `"[∙](bright-black) "`. +O Starship consegue definir o prompt de continuação usando a opção `continuation_prompt`. O prompt padrão é `"[∙](bright-black) "`. -Nota: `continuation_prompt` deve ser definido como uma string literal sem nenhuma variável. +Nota: `continuation_prompt` deve ser definido como uma string literal sem variáveis. -Nota: os prompts de continuação estão disponíveis apenas nos seguintes shells: +Nota: Prompt de continuação são disponíveis apenas nos shells a seguir: - `bash` - `zsh` @@ -170,15 +170,15 @@ Nota: os prompts de continuação estão disponíveis apenas nos seguintes shell ### Exemplo ```toml -# ~/.config/starship.toml +#~/.config/starship.toml -# Um prompt de continuação que exibe duas setas preenchidas +# Um prompt de continuação que mostra duas setas continuation_prompt = "▶▶" ``` ## Estilo dos textos -As strings de estilo são uma lista de palavras, separadas por espaços em branco. As palavras não diferenciam maiúsculas de minúsculas (ou seja, `bold` e `BoLd` são considerados a mesma string). Cada palavra pode ser uma das seguintes: +Estilo de strings são uma lista de palavras, separadas por espaço. As palavras não são case sensitive (ou seja `bold` e `BoLd` são consideradas iguais). Cada palavra pode ser uma das seguintes: - `bold` - `italic` @@ -190,14 +190,14 @@ As strings de estilo são uma lista de palavras, separadas por espaços em branc - `` - `none` -onde `` é um especificador de cor (discutido abaixo). `fg:` e `` atualmente fazem a mesma coisa, embora isso possa mudar no futuro. `inverted` troca as cores de fundo e primeiro plano. A ordem das palavras na string não importa. +onde `` é uma especialista de cores (discutido abaixo). `fg:` e `` atualmente fazem a mesma coisa, isto deve mudar no futuro. `inverted` troca as cores de background e foreground. A ordem de palavras na string não importa. -O token `none` substitui todos os outros tokens em uma string se não fizer parte de um especificador `bg:`, de modo que, ex., `fg:red none fg:blue` ainda criará uma string sem estilo. `bg:none` define o plano de fundo para a cor padrão para que `fg:red bg:none` seja equivalente a `red` ou `fg:red` e `bg:green fg:red bg:none` também é equivalente a `fg:red` ou `red`. Pode ser um erro usar `none` em conjunto com outros tokens no futuro. +O token `none` substitui todos os outros tokens na string se ele não fizer parte de um `bg:` especificado que seja, por exemplo `fg:red none fg:blue` ainda criará uma string sem estilo. `bg:none` define a cor padrão de background então `fg:red bg:none` é equivalente a `red` ou `fg:red` e `bg:green fg:red bg:none` é equivalente a `fg:red` ou`red`. Pode se transformar em um erro ao usar `none` em um conjunto de outros tokens no futuro. -Um especificador de cor pode ser um dos seguintes: +Um especialista em cores pode ser um dos seguintes: - Uma das cores padrão do terminal: `black`, `red`, `green`, `blue`, `yellow`, `purple`, `cyan`, `white`. Você pode, opcionalmente, prefixar esses com `bright-` para obter a versão brilhante/clara (por exemplo, `bright-white`). -- Um `#` seguido por um número hexadecimal de seis dígitos. Especifica um [Código hexadecimal de cor RGB](https://www.w3schools.com/colors/colors_hexadecimal.asp). -- Um número entre 0-255. Especifica um [Código de cores ANSI de 8 bits](https://i.stack.imgur.com/KTSQa.png). +- Um `#` seguido por um número de seis dígitos hexadecimais. Isto especifica um [Código RGB em formato hexadecimal](https://www.w3schools.com/colors/colors_hexadecimal.asp). +- Um número entre 0-255. Este especifica um [Código de Cor ANSI 8 bits](https://i.stack.imgur.com/KTSQa.png). -Se várias cores forem especificadas para primeiro plano/plano de fundo, a última na string terá prioridade. +Se múltiplas cores forem especificadas para foreground/background, a ultima da string que terá prioridade. diff --git a/docs/pt-BR/config/README.md b/docs/pt-BR/config/README.md index d93ed05b..f7805ceb 100644 --- a/docs/pt-BR/config/README.md +++ b/docs/pt-BR/config/README.md @@ -41,7 +41,7 @@ os.setenv('STARSHIP_CONFIG', 'C:\\Users\\user\\example\\non\\default\\path\\star ### Logging -Por padrão, o starship registra avisos e erros em um arquivo chamado `~/.cache/starship/session_${STARSHIP_SESSION_KEY}.log`, onde a chave de sessão corresponde a uma instância do seu terminal. Isso, no entanto, pode ser alterado usando a variável de ambiente `STARSHIP_CACHE`: +Por padrão o starship grava logs de erros e warnings dentro de um arquivo chamado `~/.cache/starship/session_${STARSHIP_SESSION_KEY}.log`, onde a session key corresponde a instancia do seu terminal. Isto, no entanto pode ser alterado usando a variável de ambiente `STARSHIP_CACHE`: ```sh export STARSHIP_CACHE=~/.starship/cache @@ -61,19 +61,19 @@ os.setenv('STARSHIP_CACHE', 'C:\\Users\\user\\AppData\\Local\\Temp') ### Terminologia -**Módulo**: Um componente no prompt que fornece informações com base em informações contextuais do seu sistema operacional. Por exemplo, o módulo "nodejs" mostra a versão do Node.js que está atualmente instalada em seu computador, se seu diretório atual for um projeto Node.js. +**Módulo**: Um componente no prompt que fornece informações baseado no contexto do seu SO. Por exemplo, o "nodejs"módulo exibe a versão do Node.js que está instalada no computador, se o diretório atual for um projeto Node.js. -**Variável**: Subcomponentes menores que contêm informações fornecidas pelo módulo. Por exemplo, a variável "version" no módulo "nodejs" contém a versão atual do Node.js. +**Variável**: Um pequeno subcomponente que contem informações fornecidas pelo módulo. Por exemplo, a variável "version" no módulo "nodejs"contem a versão atual do Node.js. -Por convenção, a maioria dos módulos tem um prefixo de cor de terminal padrão (ex., `via` em "nodejs") e um espaço vazio como sufixo. +Por convenção, a maioria dos módulos tem um prefixo de cor (e.x. `via` no "nodejs") e um espaço vazio para sufixo. ### Formatação de Strings -As strings de formato são o formato com o qual um módulo imprime todas as suas variáveis. A maioria dos módulos tem uma entrada chamada `format` que configura o formato de exibição do módulo. Você pode usar textos, variáveis e grupos de texto em uma string de formato. +Formatar uma string é a forma de como o módulo ira imprimir suas variáveis. A maioria dos módulos tem uma entrada chamada `format` que configura o formato que o módulo é exibido. Você pode usar textos, variáveis e grupo de textos em uma formatação de string. #### Variável -Uma variável contém um símbolo `$` seguido pelo nome da variável. O nome de uma variável pode conter apenas letras, números e `_`. +Uma variável contem um simbolo `$` seguido pelo nome da variável. O nome de uma variável pode apenas conter letras, números e `_`. Por exemplo: @@ -83,11 +83,11 @@ Por exemplo: #### Grupo de Texto -Um grupo de texto é composto de duas partes diferentes. +Um grupo de texto é composto por duas partes diferentes. -A primeira parte, que está entre um `[]`, é uma [string de formato](#format-strings). Você pode adicionar textos, variáveis ou até mesmo grupos de texto aninhados nele. +A primeira parte, é contida em um `[]`, é uma [formatação de string](#format-strings). Você pode adicionar textos, variáveis ou até mesmos grupo de textos aninhados. -Na segunda parte, que está dentro de um `()`, está uma [string de estilo](#style-strings). Isso pode ser usado para estilizar a primeira parte. +Na segunda parte, é composta por um `()`, é uma [estilização de string](#style-strings). Isto pode ser usado para estilizar a primeira parte. Por exemplo: @@ -97,7 +97,7 @@ Por exemplo: #### Estilo dos textos -A maioria dos módulos no starship permite que você configure seus estilos de exibição. Isso é feito com uma entrada (normalmente chamada de `estilo`) que é uma string especificando a configuração. Aqui estão alguns exemplos de strings de estilo junto com o que elas fazem. Para obter detalhes sobre a sintaxe completa, consulte o [guia de configuração avançada](/advanced-config/). +A maioria dos módulos do starship permite que você configure o estilo de exibição dos textos. Isso é feito através de um parâmetro (geralmente chamado `style`) que é uma string especificando a configuração. Aqui estão alguns exemplos de strings de estilo e o que elas fazem. Para detalhes sobre a sintaxe completa, consulte o [guia de configurações avançadas](/advanced-config/). - `"fg:green bg:blue"` deixa o texto verde com o fundo azul - `"bg:blue fg:bright-green"` deixa o texto verde brilhante com o fundo azul @@ -106,11 +106,11 @@ A maioria dos módulos no starship permite que você configure seus estilos de e - `"bold italic fg:purple"` deixa o texto em negrito e itálico com a cor roxa - `""` desabilita explicitamente todos os estilos -Observe que a aparência do estilo será controlada pelo emulador de terminal. Por exemplo, alguns emuladores de terminal irão clarear as cores em vez de colocar o texto em negrito, e alguns temas de cores usam os mesmos valores para as cores normais e brilhantes. Além disso, para obter texto em itálico, seu terminal deve suportar itálico. +Note que a aparência do estilo será controlado pelo seu terminal. Por exemplo, alguns terminais deixarão as cores mais brilhantes ao invés de deixar o texto em negrito, ou alguns temas podem usar as mesmas cores para cores brilhantes e normais. Além disso, para textos em itálico, o terminal precisa ter suporte. #### Formatação de String Condicional -Uma string de formato condicional envolta de `(` e `)` não será renderizada se todas as variáveis internas estiverem vazias. +Uma formatação condicional de string é envolto por `(` e `)` não vai ser exibido caso a variável dentro esteja vazia. Por exemplo: @@ -120,17 +120,17 @@ Por exemplo: #### Caracteres Especiais -Os seguintes símbolos têm uso especial em uma string de formato e devem ser evitados: `$ \ [ ] ( )`. +O símbolos a seguir tem um uso na formatação de string e deve ser escapados `$ \ [ ] ( )`. -Observe que o TOML tem [strings básicas e strings literais](https://toml.io/en/v1.0.0#string). É recomendado usar uma string literal (entre aspas simples) em seu config. Se você quiser usar uma string básica (entre aspas duplas), você deve escapar da própria barra invertida (ou seja, use `\\`). +Note que TOML tem [string básicas e strings literais](https://toml.io/en/v1.0.0#string). É recomendado usar um string literal(cercado por aspas simples) em seu config. Se você quiser usar uma string básica(cercado por aspas duplas), você precisa adicionar o backslash (ex: use `\\`). -Por exemplo, quando você deseja imprimir um símbolo `$` em uma nova linha, as seguintes configurações para `format` são equivalentes: +Por exemplo, quando você quer imprimir um simbolo `$` em uma nova linha, as configurações de `format` a seguir são equivalentes: ```toml # com string básica format = "\n\\$" -# com string básica multilinha +# com múltiplas linhas de string básica format = """ \\$""" @@ -143,7 +143,7 @@ format = ''' ## Prompt de Comando -Esta é a lista de opções de configuração em todo o prompt. +Está é a lista de opções de configuração de prompt. ### Opções @@ -160,27 +160,27 @@ Esta é a lista de opções de configuração em todo o prompt. ```toml # ~/.config/starship.toml -# Use custom format +# Usa um format customizado format = """ [┌───────────────────>](bold green) [│](bold green)$directory$rust$package [└─>](bold green) """ -# Espera 10 milliseconds para que o starship verifique os arquivos no diretório atual. +#Espera 10 milissegundos para que o starship check os arquivos do diretório atual. scan_timeout = 10 -# Remove a quebra de linha no início do prompt +# Desabilita uma nova linha no inicio do prompt add_newline = false ``` ### Format de Prompt Padrão -O padrão `format` é usado para definir o formato do prompt, se estiver vazio ou nenhum `format` for fornecido. O padrão é como mostrado: +O `formato` padrão é usado para definir o formato do prompt, se um valor vazio ou não `formatado` for informado. Os valores padrão são os seguintes: ```toml format = "$all" -# Equivalente a +# Que é equivalente a: format = """ $username\ $hostname\ @@ -198,6 +198,7 @@ $git_status\ $hg_branch\ $docker_context\ $package\ +$buf\ $cmake\ $cobol\ $container\ @@ -208,6 +209,7 @@ $elixir\ $elm\ $erlang\ $golang\ +$haskell\ $helm\ $java\ $julia\ @@ -252,7 +254,7 @@ $shell\ $character""" ``` -Se você quiser apenas estender o formato padrão, você pode usar `$all`; os módulos que você adicionar explicitamente ao formato não serão duplicados. Ex. +Se você quer estender o formato padrão, você pode usar `$all`; Os módulos adicionado explicitamente não serão duplicados. Ex. ```toml # Move o diretório para a segunda linha @@ -261,11 +263,11 @@ format = "$all$directory$character" ## AWS -The `aws` module shows the current AWS region and profile when credentials or a `credential_process` have been setup. Isto é baseado nas variáveis de env `AWS_REGION`, `AWS_DEFAULT_REGION`, and `AWS_PROFILE` contidas no arquivo `~/.aws/config`. Este modulo exibi também tempo de expiração de credenciais temporarias. +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. -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. +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`. -Quando usar [aws-vault](https://github.com/99designs/aws-vault) o perfil é lido da variável `AWS_VAULT` e o tempo de expiração de credenciais é lida da variável de env `AWS_SESSION_EXPIRATION`. +Quando usar [aws-vault](https://github.com/99designs/aws-vault), o perfil é lido da variável de ambiente `AWS_VAULT` e o tempo de expiração de credenciais é lido da variável de ambiente `AWS_SESSION_EXPIRATION`. Quando usar [awsu](https://github.com/kreuzwerker/awsu) o perfil é lido da varável de env `AWSU_PROFILE`. @@ -273,14 +275,15 @@ 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. | -| `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`. | +| 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. | ### Variáveis @@ -289,7 +292,7 @@ Quando usar [AWSume](https://awsu.me) o perfil é lido da variável `AWSUME_PROF | region | `ap-northeast-1` | A região atual do AWS | | profile | `astronauts` | O perfil atual do AWS | | duration | `2h27m20s` | A duração temporária das credenciais | -| symbol | | Espelha o valor da opção `símbolo` | +| 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 @@ -302,12 +305,14 @@ Quando usar [AWSume](https://awsu.me) o perfil é lido da variável `AWSUME_PROF # ~/.config/starship.toml [aws] -format = 'em [$symbol($profile )(\($region\) )]($style)' +format = 'on [$symbol($profile )(\($region\) )]($style)' style = "bold blue" symbol = "🅰 " [aws.region_aliases] ap-southeast-2 = "au" us-east-1 = "va" +[aws.profile_aliases] +CompanyGroupFrobozzOnCallAccess = 'Frobozz' ``` #### Exibir região @@ -316,7 +321,7 @@ us-east-1 = "va" # ~/.config/starship.toml [aws] -format = "em [$symbol$region]($style) " +format = "on [$symbol$region]($style) " style = "bold blue" symbol = "🅰 " [aws.region_aliases] @@ -330,9 +335,11 @@ us-east-1 = "va" # ~/.config/starship.toml [aws] -format = "em [$symbol$profile]($style) " +format = "on [$symbol$profile]($style) " style = "bold blue" symbol = "🅰 " +[aws.profile_aliases] +Enterprise_Naming_Scheme-voidstars = 'void**' ``` ## Azure @@ -355,7 +362,7 @@ O módulo `azure` exibe a assinatura Azure atual. Isto é baseado na exibição [azure] disabled = false -format = "em [$symbol($subscription)]($style) " +format = "on [$symbol($subscription)]($style) " symbol = "ﴃ " style = "blue bold" ``` @@ -390,7 +397,7 @@ discharging_symbol = "💀 " ### Indicador de bateria -A configuração `display` é usada para definir quando o indicador de bateria deve ser exibido (threshold), qual deve ser o simbolo(symbol) e como você gostaria de exibir (style). Se nenhum `display` for fornecido. O padrão é como mostrado: +A configuração `display` é usada para definir quando o indicador de bateria deve ser exibido (threshold), qual deve ser o simbolo(symbol) e como você gostaria de exibir (style). Se nenhum `display` for fornecido. Os valores padrão são os seguintes: ```toml [[battery.display]] @@ -426,22 +433,55 @@ discharging_symbol = "💦" # when capacity is over 30%, the battery indicator will not be displayed ``` +## 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: + +- 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. + +### Opções + +| Opções | Padrão | Descrição | +| ------------------- | ------------------------------------------------------------ | ----------------------------------------------------- | +| `format` | `'with [$symbol($version \(Buf $buf_version\) )]($style)'` | The format for the `buf` module. | +| `version_format` | `"v${raw}"` | O formato da versão. | +| `symbol` | `"🦬 "` | The symbol used before displaying the version of Buf. | +| `detect_extensions` | `[]` | Quais extensões devem ativar este módulo. | +| `detect_files` | `["buf.yaml", "buf.gen.yaml", "buf.work.yaml"]` | Quais nomes de arquivos devem ativar este módulo. | +| `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | +| `style` | `"bold blue"` | O estilo do módulo. | +| `disabled` | `false` | Disables the `elixir` module. | + +### Variáveis + +| Variável | Exemplo | Descrição | +| ------------- | -------- | --------------------------------- | +| `buf_version` | `v1.0.0` | The version of `buf` | +| `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 + +[buf] +symbol = "🦬 " +``` + ## Caractere -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` module shows a character (usually an arrow) beside where the text is entered in your terminal. -O caractere vai te dizer se o ultimo comando foi bem sucedido ou não. Você pode fazer isto de duas maneiras: +The character will tell you whether the last command was successful or not. It can do this in two ways: -- alterando a cor (`red`/`green`) -- alterando a forma (`❯`/`✖`) +- changing color (`red`/`green`) +- changing 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 - -`error_symbol` não é suportado pelo nu shell. - -::: +By default it only changes color. If you also want to change its shape take a look at [this example](#with-custom-error-shape). ::: atenção @@ -451,19 +491,19 @@ Por padrão ele apenas muda de cor. Se você deseja alterar o formato de uma olh ### Opções -| Opções | Padrão | Descrição | -| ---------------- | ------------------- | ------------------------------------------------------------------------------------------- | -| `format` | `"$symbol"` | O formato da string usado antes da entrada dos textos. | -| `success_symbol` | `"[❯](bold green)"` | O formato da string usado antes da entrada de texto se o comando anterior for bem-sucedido. | -| `error_symbol` | `"[❯](bold red)"` | O formato de string usado antes da entrada de texto se o comando anterior tiver falhado. | -| `vicmd_symbol` | `"[❮](bold green)"` | O fromato de string usado antes da entrada de texto se o shell esta no vim normal mode. | -| `disabled` | `false` | Desabilita o módulo `character`. | +| Opções | Padrão | Descrição | +| ---------------- | ------------------- | -------------------------------------------------------------------------------- | +| `format` | `"$symbol "` | 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. | ### Variáveis -| Variável | Exemplo | Descrição | -| -------- | ------- | ---------------------------------------------------------------- | -| symbol | | Um espelho de `success_symbol`, `error_symbol` ou `vicmd_symbol` | +| Variável | Exemplo | Descrição | +| -------- | ------- | --------------------------------------------------------------------- | +| symbol | | A mirror of either `success_symbol`, `error_symbol` or `vicmd_symbol` | ### Exemplos @@ -498,10 +538,10 @@ vicmd_symbol = "[V](bold green) " ## CMake -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 `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 diretorio atual cotem um arquivo `CMakeLists.txt` -- O diretorio atual tem um arquivo `CMakeCache.txt` +- The current directory contains a `CMakeLists.txt` file +- The current directory contains a `CMakeCache.txt` file ### Opções @@ -509,84 +549,84 @@ O módulo `cmake` exibe a versão instalada do [CMake](https://cmake.org/). Por | ------------------- | -------------------------------------- | ------------------------------------------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | | `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"△ "` | O simbolo usado antes 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 | +| `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 | | `style` | `"bold blue"` | O estilo do módulo. | -| `disabled` | `false` | Desabilita o módulo `cmake`. | +| `disabled` | `false` | Disables the `cmake` module. | ### Variáveis -| Variável | Exemplo | Descrição | -| --------- | --------- | ---------------------------------- | -| version | `v3.17.3` | A versão do cmake | -| symbol | | Espelha o valor da opção `símbolo` | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| --------- | --------- | --------------------------------- | +| version | `v3.17.3` | The version of cmake | +| 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 ## COBOL / GNUCOBOL -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 `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 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` +- The current directory contains any files ending in `.cob` or `.COB` +- The current directory contains any files ending in `.cbl` or `.CBL` ### Opções | Opções | Padrão | Descrição | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ | -| `symbol` | `"⚙️ "` | O simbolo usado antes de exibir a versão do COBOL. | +| `symbol` | `"⚙️ "` | The symbol used before displaying the version of 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` | Desabilita o módulo `cobol`. | +| `disabled` | `false` | Disables the `cobol` module. | ### Variáveis -| Variável | Exemplo | Descrição | -| --------- | ---------- | ---------------------------------- | -| version | `v3.1.2.0` | A versão do `cobol` | -| symbol | | Espelha o valor da opção `símbolo` | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| --------- | ---------- | --------------------------------- | +| version | `v3.1.2.0` | The version of `cobol` | +| 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 ## Tempo de execução do comando -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. +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. -::: warning Não utilize o DEBUG-trap no Bash +::: warning Do not hook the DEBUG trap in Bash -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. +If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. ::: -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. +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. ### Opções | Opções | Padrão | Descrição | | ---------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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. | +| `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) "` | O formato do módulo. | | `style` | `"bold yellow"` | O estilo do módulo. | -| `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). | +| `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. | ### Variáveis -| Variável | Exemplo | Descrição | -| --------- | -------- | ----------------------------------------- | -| duration | `16m40s` | O tempo que levou para executar o comando | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| --------- | -------- | --------------------------------------- | +| duration | `16m40s` | The time it took to execute the command | +| style\* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo @@ -597,37 +637,37 @@ Usuários do bash que precisam de funções pre-executadas podem usar [rcaloras' [cmd_duration] min_time = 500 -format = "levou [$duration](bold yellow)" +format = "underwent [$duration](bold yellow)" ``` ## Conda -O módulo `conda` exibe o ambiente atual do [Conda](https://docs.conda.io/en/latest/), se o `$CONDA_DEFAULT_ENV` estiver definido. +The `conda` module shows the current [Conda](https://docs.conda.io/en/latest/) environment, if `$CONDA_DEFAULT_ENV` is set. ::: tip -Isso não suprime o modificador de prompt do conda, você pode executar `conda config --set changeps1 False`. +This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. ::: ### Opções -| 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`. | +| 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. | ### Variáveis -| Variável | Exemplo | Descrição | -| ----------- | ------------ | ---------------------------------- | -| environment | `astronauts` | O environment atual do conda | -| symbol | | Espelha o valor da opção `símbolo` | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| ----------- | ------------ | --------------------------------- | +| environment | `astronauts` | The current conda 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 @@ -646,20 +686,20 @@ The `container` module displays a symbol and container name, if inside a contain ### Opções -| Opções | Padrão | Descrição | -| ---------- | ------------------------------------ | ----------------------------------------- | -| `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` | Desabilita o módulo `container`. | +| Opções | Padrão | Descrição | +| ---------- | -------------------------------------- | ----------------------------------------- | +| `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. | ### Variáveis -| Variável | Exemplo | Descrição | -| --------- | ------------------- | ---------------------------------- | -| name | `fedora-toolbox:35` | The name of the container | -| symbol | | Espelha o valor da opção `símbolo` | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| --------- | ------------------- | --------------------------------- | +| name | `fedora-toolbox:35` | The name of the container | +| 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 @@ -674,31 +714,31 @@ format = "[$symbol \\[$name\\]]($style) " ## Crystal -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 `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 diretório atual contem um arquivo `shard.yml` -- O diretório atual contem um arquivo `.cr` +- The current directory contains a `shard.yml` file +- The current directory contains a `.cr` file ### Opções | Opções | Padrão | Descrição | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ | -| `symbol` | `"🔮 "` | O símbolo usado antes de exibir a versão do crystal. | +| `symbol` | `"🔮 "` | The symbol used before displaying the version of 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` | Desabilita o módulo `crystal`. | +| `disabled` | `false` | Disables the `crystal` module. | ### Variáveis -| Variável | Exemplo | Descrição | -| --------- | --------- | ---------------------------------- | -| version | `v0.32.1` | A versão do `crystal` | -| symbol | | Espelha o valor da opção `símbolo` | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| --------- | --------- | --------------------------------- | +| version | `v0.32.1` | The version of `crystal` | +| 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 @@ -713,11 +753,11 @@ format = "via [✨ $version](bold blue) " ## Dart -O módulo `dart` exibe a versão atual instalada do [Dart](https://dart.dev/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: +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 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` +- 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 ### Opções @@ -725,20 +765,20 @@ O módulo `dart` exibe a versão atual instalada do [Dart](https://dart.dev/). P | ------------------- | ------------------------------------------------- | ------------------------------------------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | | `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"🎯 "` | Um formato de string que representa o simbolo do Dart | +| `symbol` | `"🎯 "` | A format string representing the symbol of 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` | Desabilita o módulo `dart`. | +| `disabled` | `false` | Disables the `dart` module. | ### Variáveis -| Variável | Exemplo | Descrição | -| --------- | -------- | ---------------------------------- | -| version | `v2.8.4` | The version of `dart` | -| symbol | | Espelha o valor da opção `símbolo` | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| --------- | -------- | --------------------------------- | +| version | `v2.8.4` | The version of `dart` | +| 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 @@ -753,9 +793,9 @@ format = "via [🔰 $version](bold red) " ## Deno -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 `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 diretório atual tenha um arquivo `deno.json`, `deno.jsonc`, `mod.ts`, `mod.js`, `deps.ts` or `deps.js` +- The current directory contains a `deno.json`, `deno.jsonc`, `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file ### Opções @@ -763,20 +803,20 @@ O módulo `deno` exibe a versão instalada atual do [Deno](https://deno.land/). | ------------------- | ----------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | | `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"🦕 "` | Um formato de string que representa o simbolo do Deno | +| `symbol` | `"🦕 "` | A format string representing the symbol of 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` | Desabilita o módulo `deno`. | +| `disabled` | `false` | Disables the `deno` module. | ### Variáveis -| Variável | Exemplo | Descrição | -| --------- | -------- | ---------------------------------- | -| version | `v1.8.3` | A versão do `deno` | -| symbol | | Espelha o valor da opção `símbolo` | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| --------- | -------- | --------------------------------- | +| version | `v1.8.3` | The version of `deno` | +| symbol | | Espelha o valor da opção `symbol` | +| style\* | | Espelha o valor da opção `style` | ### Exemplo @@ -789,39 +829,39 @@ format = "via [🦕 $version](green bold) " ## Diretório -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. +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. -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. +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. -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`. +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`. ### Opções | Opções | Padrão | Descrição | | ------------------- | ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `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. | +| `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) "` | O formato do módulo. | | `style` | `"bold cyan"` | O estilo do módulo. | -| `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: "…/" | +| `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` | `"~"` | O simbolo para indicar o diretório home. | +| `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) |
-Este módulo tem algumas configurações avançadas que controlam como o diretório é exibido. +This module has a few advanced configuration options that control how the directory is displayed. -| 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. | +| 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. | -`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. +`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. ```toml [directory.substitutions] @@ -829,7 +869,7 @@ Por exemplo, dado `~/Dev/Nix/nixpkgs/pkgs` onde `nixpkgs` é o repositório raiz "src/com/long/java/path" = "mypath" ``` -`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`. +`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`.
@@ -837,7 +877,7 @@ Por exemplo, dado `~/Dev/Nix/nixpkgs/pkgs` onde `nixpkgs` é o repositório raiz | Variável | Exemplo | Descrição | | --------- | --------------------- | -------------------------------- | -| path | `"D:/Projetos"` | O caminho do diretório atual | +| path | `"D:/Projects"` | The current directory path | | 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 @@ -869,28 +909,28 @@ truncation_symbol = "…/" ## Docker Context -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). +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). ### Opções -| 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`. | +| 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. | ### Variáveis -| Variável | Exemplo | Descrição | -| --------- | -------------- | ---------------------------------- | -| context | `test_context` | O contexto atual do docker | -| symbol | | Espelha o valor da opção `símbolo` | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| --------- | -------------- | --------------------------------- | +| context | `test_context` | The current docker context | +| 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 @@ -905,9 +945,9 @@ format = "via [🐋 $context](blue bold)" ## Dotnet -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. +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. -Por padrão o módulo vai apenas exibir no seu prompt quando um ou mais dos seguintes arquivos estiverem presente no diretório: +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` @@ -918,11 +958,11 @@ Por padrão o módulo vai apenas exibir no seu prompt quando um ou mais dos segu - `*.fsproj` - `*.xproj` -Você também precisa do .NET Core SDK instalado para usá-lo corretamente. +You'll also need the .NET Core SDK installed in order to use it correctly. -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. +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. -O módulo também vai exibir o Target Framework Moniker () quando o diretório atual tiver o arquivo csproj. +The module will also show the Target Framework Moniker () when there is a csproj file in the current directory. ### Opções @@ -930,22 +970,22 @@ O módulo também vai exibir o Target Framework Moniker ([\\w-]+)/.*" = "$var_cluster" -# Contexto do GKE, AWS e outras provedores de nuvem normalmente carregam mais informações, como a region/zone. -# A entrada a seguir corresponde o formato GKE (`gke_projectname_zone_cluster-name`) -# e renomeia cada kube context em um formato mais legível (`gke-cluster-name`): +# 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`): "gke_.*_(?P[\\w-]+)" = "gke-$var_cluster" ``` -## Quebra de linha +## Line Break -O módulo `line_break` separa o prompt em duas linhas. +The `line_break` module separates the prompt into two lines. ### Opções -| Opções | Padrão | Descrição | -| ---------- | ------- | ----------------------------------------------------------------------------------- | -| `disabled` | `false` | Desabilita o módulo `line_break`, fazendo com que o prompt seja em uma unica linha. | +| Opções | Padrão | Descrição | +| ---------- | ------- | ------------------------------------------------------------------ | +| `disabled` | `false` | Disables the `line_break` module, making the prompt a single line. | ### Exemplo @@ -1902,7 +1977,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` | Desabilita o módulo `localip`. | +| `disabled` | `true` | Disables the `localip` module. | ### Variáveis @@ -1926,11 +2001,11 @@ disabled = false ## Lua -O módulo `lua` exibe a versão atual instalada do [Lua](http://www.lua.org/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: +The `lua` module shows the currently installed version of [Lua](http://www.lua.org/). By default the module will be shown if any of the following conditions are met: -- 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` +- 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 ### Opções @@ -1938,21 +2013,21 @@ O módulo `lua` exibe a versão atual instalada do [Lua](http://www.lua.org/). P | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | | `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"🌙 "` | Uma string que representa o simbolo do Lua. | +| `symbol` | `"🌙 "` | A format string representing the symbol of Lua. | | `detect_extensions` | `["lua"]` | Quais extensões devem ativar este módulo. | | `detect_files` | `[".lua-version"]` | Quais nomes de arquivos devem ativar este módulo. | | `detect_folders` | `["lua"]` | Quais pastas devem ativar este módulo. | | `style` | `"bold blue"` | O estilo do módulo. | -| `lua_binary` | `"lua"` | Configura o binário lua que o Starship executa para pegar a versão. | -| `disabled` | `false` | Desabilita o módulo `lua`. | +| `lua_binary` | `"lua"` | Configures the lua binary that Starship executes when getting the version. | +| `disabled` | `false` | Disables the `lua` module. | ### Variáveis -| Variável | Exemplo | Descrição | -| --------- | -------- | ---------------------------------- | -| version | `v5.4.0` | A versão do `lua` | -| symbol | | Espelha o valor da opção `símbolo` | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| --------- | -------- | --------------------------------- | +| version | `v5.4.0` | The version of `lua` | +| 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 @@ -1965,40 +2040,40 @@ O módulo `lua` exibe a versão atual instalada do [Lua](http://www.lua.org/). P format = "via [🌕 $version](bold blue) " ``` -## Uso de Memória +## Memory Usage -O módulo `memory_usage` exibe o uso atual de memoria e swap. +The `memory_usage` module shows current system memory and swap usage. -Por padrão o uso do swap é exibido se o total de swap do sistema é diferente de zero. +By default the swap usage is displayed if the total system swap is non-zero. ::: tip -Este módulo é desabilitado por padrão. Para habilitar, defina `disabled` para `false` no seu arquivo de configuração. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### Opções -| Opções | Padrão | Descrição | -| ----------- | ----------------------------------------------- | ------------------------------------------------------------- | -| `threshold` | `75` | Esconde o uso de memoria a menos que exceda esta porcentagem. | -| `format` | `"via $symbol [${ram}( \| ${swap})]($style) "` | O formato do módulo. | -| `symbol` | `"🐏"` | O simbolo usado antes de exibir o uso de memoria. | -| `style` | `"bold dimmed white"` | O estilo do módulo. | -| `disabled` | `true` | Desabilita o módulo `memory_usage`. | +| Opções | Padrão | Descrição | +| ----------- | ----------------------------------------------- | -------------------------------------------------------- | +| `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. | +| `format` | `"via $symbol [${ram}( \| ${swap})]($style) "` | O formato do módulo. | +| `symbol` | `"🐏"` | The symbol used before displaying the memory usage. | +| `style` | `"bold dimmed white"` | O estilo do módulo. | +| `disabled` | `true` | Disables the `memory_usage` module. | ### Variáveis -| Variável | Exemplo | Descrição | -| ---------------- | ------------- | ------------------------------------------------- | -| ram | `31GiB/65GiB` | O uso/total de memoria RAM atual do sistema. | -| ram_pct | `48%` | A porcentagem de uso atual da memoria do sistema. | -| swap\*\* | `1GiB/4GiB` | O tamanho atual do swap do sistema. | -| swap_pct\*\* | `77%` | A porcentagem atual de uso do swap. | -| symbol | `🐏` | Espelha o valor da opção `símbolo` | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| ---------------- | ------------- | ------------------------------------------------------------------ | +| ram | `31GiB/65GiB` | The usage/total RAM of the current system memory. | +| ram_pct | `48%` | The percentage of the current system memory. | +| swap\*\* | `1GiB/4GiB` | The swap memory size of the current system swap memory file. | +| swap_pct\*\* | `77%` | The swap memory percentage of the current system swap memory file. | +| symbol | `🐏` | Espelha o valor da opção `symbol` | +| style\* | | Espelha o valor da opção `style` | -*: Esta variável só pode ser usada como parte de uma string de estilo *\*: As informações do arquivo SWAP são exibidas apenas se detectadas no sistema atual +*: This variable can only be used as a part of a style string *\*: The SWAP file information is only displayed if detected on the current system ### Exemplo @@ -2014,26 +2089,26 @@ style = "bold dimmed green" ## Mercurial Branch -O módulo `hg_branch` exibe o braço atual do repositório no diretório atual. +The `hg_branch` module shows the active branch of the repo in your current directory. ### Opções -| Opções | Padrão | Descrição | -| ------------------- | -------------------------------- | --------------------------------------------------------------------------------------- | -| `symbol` | `" "` | O simbolo usado ante do marcador hg ou nome do braço do repositório no diretório atual. | -| `style` | `"bold purple"` | O estilo do módulo. | -| `format` | `"on [$symbol$branch]($style) "` | O formato do módulo. | -| `truncation_length` | `2^63 - 1` | Trunca o nome do braço hg para `N` caracteres | -| `truncation_symbol` | `"…"` | O simbolo usado para indicar que o nome braço foi truncado. | -| `disabled` | `true` | Desabilita o módulo `hg_branch`. | +| Opções | Padrão | Descrição | +| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------- | +| `symbol` | `" "` | The symbol used before the hg bookmark or branch name of the repo in your current directory. | +| `style` | `"bold purple"` | O estilo do módulo. | +| `format` | `"on [$symbol$branch]($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. | ### Variáveis -| Variável | Exemplo | Descrição | -| --------- | -------- | ---------------------------------- | -| branch | `master` | O braço mercurial ativo | -| symbol | | Espelha o valor da opção `símbolo` | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| --------- | -------- | --------------------------------- | +| branch | `master` | The active mercurial branch | +| symbol | | Espelha o valor da opção `symbol` | +| style\* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo @@ -2050,33 +2125,33 @@ truncation_symbol = "" ## Nim -O módulo `nim` exibe a versão atual instalada do [Nim](https://nim-lang.org/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: +The `nim` module shows the currently installed version of [Nim](https://nim-lang.org/). By default the module will be shown if any of the following conditions are met: -- 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` +- 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 ### Opções | Opções | Padrão | Descrição | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ | -| `format` | `"via [$symbol($version )]($style)"` | O formato do módulo | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module | | `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"👑 "` | O símbolo usado antes de exibir a versão do Nim. | +| `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. | | `detect_extensions` | `["nim", "nims", "nimble"]` | Quais extensões devem ativar este módulo. | | `detect_files` | `["nim.cfg"]` | Quais nomes de arquivos devem ativar este módulo. | | `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | | `style` | `"bold yellow"` | O estilo do módulo. | -| `disabled` | `false` | Desabilita o módulo `nim`. | +| `disabled` | `false` | Disables the `nim` module. | ### Variáveis -| Variável | Exemplo | Descrição | -| --------- | -------- | ---------------------------------- | -| version | `v1.2.0` | A versão do `nimc` | -| symbol | | Espelha o valor da opção `símbolo` | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| --------- | -------- | --------------------------------- | +| version | `v1.2.0` | The version of `nimc` | +| 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 @@ -2092,27 +2167,27 @@ symbol = "🎣 " ## Nix-shell -O módulo `nix_shell` exibe o ambiente [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html). O módulo vai exibir quando estiver dentro de um ambiente nix-shell. +The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html) environment. The module will be shown when inside a nix-shell environment. ### Opções -| Opções | Padrão | Descrição | -| ------------ | ---------------------------------------------- | ------------------------------------------------- | -| `format` | `'via [$symbol$state( \($name\))]($style) '` | O formato do módulo. | -| `symbol` | `"❄️ "` | Uma string que representa o simbolo do nix-shell. | -| `style` | `"bold blue"` | O estilo do módulo. | -| `impure_msg` | `"impure"` | Uma string que exibe quando o shell é impuro. | -| `pure_msg` | `"pure"` | Uma string que exibe quando o shell é puro. | -| `disabled` | `false` | Desabilita o módulo `nix_shell`. | +| Opções | Padrão | Descrição | +| ------------ | ---------------------------------------------- | ----------------------------------------------------- | +| `format` | `'via [$symbol$state( \($name\))]($style) '` | O formato do módulo. | +| `symbol` | `"❄️ "` | A format string representing the symbol of nix-shell. | +| `style` | `"bold blue"` | O estilo do módulo. | +| `impure_msg` | `"impure"` | A format string shown when the shell is impure. | +| `pure_msg` | `"pure"` | A format string shown when the shell is pure. | +| `disabled` | `false` | Disables the `nix_shell` module. | ### Variáveis -| Variável | Exemplo | Descrição | -| --------- | ------- | ---------------------------------- | -| state | `pure` | O estado do nix-shell | -| name | `lorri` | O nome do nix-shell | -| symbol | | Espelha o valor da opção `símbolo` | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| --------- | ------- | --------------------------------- | +| state | `pure` | The state of the nix-shell | +| name | `lorri` | The name of the nix-shell | +| symbol | | Espelha o valor da opção `symbol` | +| style\* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo @@ -2130,36 +2205,36 @@ format = 'via [☃️ $state( \($name\))](bold blue) ' ## Node.js -O módulo `nodejs` exibe a versão atual instalada do [Node.js](https://nodejs.org/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: +The `nodejs` module shows the currently installed version of [Node.js](https://nodejs.org/). By default the module will be shown if any of the following conditions are met: -- 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` -- O diretório atual tenha um arquivo com a extensão `.ts` +- 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 ### Opções -| Opções | Padrão | Descrição | -| ------------------- | ------------------------------------ | -------------------------------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | -| `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `" "` | Uma string que representa o simbolo do Node.js. | -| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Quais extensões devem ativar este módulo. | -| `detect_files` | `["package.json", ".node-version"]` | Quais nomes de arquivos devem ativar este módulo. | -| `detect_folders` | `["node_modules"]` | Quais pastas devem ativar este módulo. | -| `style` | `"bold green"` | O estilo do módulo. | -| `disabled` | `false` | Desabilita o módulo `nodejs`. | -| `not_capable_style` | `bold red` | O estilo para o módulo quando a propriedade engine no package.json não coincide com a versão do Node.js. | +| Opções | Padrão | Descrição | +| ------------------- | ------------------------------------------ | ----------------------------------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | +| `version_format` | `"v${raw}"` | 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. | ### Variáveis -| Variável | Exemplo | Descrição | -| --------- | ---------- | ---------------------------------- | -| version | `v13.12.0` | A versão do `node` | -| symbol | | Espelha o valor da opção `símbolo` | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| --------- | ---------- | --------------------------------- | +| version | `v13.12.0` | The version of `node` | +| 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 @@ -2174,14 +2249,14 @@ format = "via [🤖 $version](bold green) " ## OCaml -O módulo `ocaml` exibe a versão atual instalada do [OCaml](https://ocaml.org/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: +The `ocaml` module shows the currently installed version of [OCaml](https://ocaml.org/). By default the module will be shown if any of the following conditions are met: -- 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` +- 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 ### Opções @@ -2189,24 +2264,24 @@ O módulo `ocaml` exibe a versão atual instalada do [OCaml](https://ocaml.org/) | ------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | | `format` | `"via [$symbol($version )(\($switch_indicator$switch_name\) )]($style)"` | A string de formato do módulo. | | `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"🐫 "` | O simbolo usado antes de exibir a versão do OCaml. | -| `global_switch_indicator` | `""` | A string usada para representar a mudança global OPAM. | -| `local_switch_indicator` | `"*"` | A string usada para representar as mudanças locais do OPAM. | +| `symbol` | `"🐫 "` | The symbol used before displaying the version of OCaml. | +| `global_switch_indicator` | `""` | The format string used to represent global OPAM switch. | +| `local_switch_indicator` | `"*"` | The format string used to represent local OPAM switch. | | `detect_extensions` | `["opam", "ml", "mli", "re", "rei"]` | Quais extensões devem ativar este módulo. | | `detect_files` | `["dune", "dune-project", "jbuild", "jbuild-ignore", ".merlin"]` | Quais nomes de arquivos devem ativar este módulo. | | `detect_folders` | `["_opam", "esy.lock"]` | Quais pastas devem ativar este módulo. | | `style` | `"bold yellow"` | O estilo do módulo. | -| `disabled` | `false` | Desabilita o módulo `ocaml`. | +| `disabled` | `false` | Disables the `ocaml` module. | ### Variáveis -| Variável | Exemplo | Descrição | -| ---------------- | ------------ | ---------------------------------------------------------------- | -| version | `v4.10.0` | A versão do `ocaml` | -| switch_name | `my-project` | O switch OPAM ativo | -| switch_indicator | | Espelha o valor do `indicator` para o switch ativo atual do OPAM | -| symbol | | Espelha o valor da opção `símbolo` | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| ---------------- | ------------ | ----------------------------------------------------------------- | +| version | `v4.10.0` | The version of `ocaml` | +| switch_name | `my-project` | The active OPAM switch | +| switch_indicator | | Mirrors the value of `indicator` for currently active OPAM switch | +| symbol | | Espelha o valor da opção `symbol` | +| style\* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo @@ -2221,25 +2296,25 @@ format = "via [🐪 $version]($style) " ## OpenStack -O módulo `openstack` exibe o OpenStack cloud e projeto atual. O módulo apenas ativa quando a env var `OS_CLOUD` esta definida, neste caso ele vai ler o arquivo `clouds.yaml` de qualquer um dos [default locations](https://docs.openstack.org/python-openstackclient/latest/configuration/index.html#configuration-files). para buscar o projeto atual em uso. +The `openstack` module shows the current OpenStack cloud and project. The module only active when the `OS_CLOUD` env var is set, in which case it will read `clouds.yaml` file from any of the [default locations](https://docs.openstack.org/python-openstackclient/latest/configuration/index.html#configuration-files). to fetch the current project in use. ### Opções -| Opções | Padrão | Descrição | -| ---------- | --------------------------------------------------- | ---------------------------------------------------- | -| `format` | `"on [$symbol$cloud(\\($project\\))]($style) "` | O formato do módulo. | -| `symbol` | `"☁️ "` | O simbolo usado para exibir o OpenStack cloud atual. | -| `style` | `"bold yellow"` | O estilo do módulo. | -| `disabled` | `false` | Desabilita o módulo `openstack`. | +| Opções | Padrão | Descrição | +| ---------- | --------------------------------------------------- | -------------------------------------------------------------- | +| `format` | `"on [$symbol$cloud(\\($project\\))]($style) "` | O formato do módulo. | +| `symbol` | `"☁️ "` | The symbol used before displaying the current OpenStack cloud. | +| `style` | `"bold yellow"` | O estilo do módulo. | +| `disabled` | `false` | Disables the `openstack` module. | ### Variáveis -| Variável | Exemplo | Descrição | -| --------- | ------- | ---------------------------------- | -| cloud | `corp` | O OpenStack cloud atual | -| project | `dev` | O projeto OpenStack atual | -| symbol | | Espelha o valor da opção `símbolo` | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| --------- | ------- | --------------------------------- | +| cloud | `corp` | The current OpenStack cloud | +| project | `dev` | The current OpenStack project | +| symbol | | Espelha o valor da opção `symbol` | +| style\* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo @@ -2254,26 +2329,26 @@ style = "bold yellow" symbol = "☁️ " ``` -## Versionamento de Pacotes +## Package Version -O módulo `package` é exibido quando o diretório atual é um repositorio para um pacote e exibe sua versão atual. O módulo atualmente suporta pacotes `npm`, `nimble`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards` e `dart`. +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. -- [**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 +- [**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 > ⚠️ A versão exibida é a que esta presente no código fonte do diretório atual e não do gerenciador de pacotes. @@ -2282,19 +2357,19 @@ O módulo `package` é exibido quando o diretório atual é um repositorio para | Opções | Padrão | Descrição | | ----------------- | --------------------------------- | ------------------------------------------------------------------------------------ | | `format` | `"is [$symbol$version]($style) "` | O formato do módulo. | -| `symbol` | `"📦 "` | O símbolo usado antes de exibir a versão do pacote. | +| `symbol` | `"📦 "` | The symbol used before displaying the version the package. | | `version_format` | `"v${raw}"` | 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` | Habilita a exibição da versão para os pacotes marcados como privado. | -| `disabled` | `false` | Desabilita o módulo `package`. | +| `display_private` | `false` | Enable displaying version for packages marked as private. | +| `disabled` | `false` | Disables the `package` module. | ### Variáveis -| Variável | Exemplo | Descrição | -| --------- | -------- | ---------------------------------- | -| version | `v1.0.0` | A versão do seu pacote | -| symbol | | Espelha o valor da opção `símbolo` | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| --------- | -------- | --------------------------------- | +| version | `v1.0.0` | The version of your package | +| symbol | | Espelha o valor da opção `symbol` | +| style\* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo @@ -2309,13 +2384,13 @@ format = "via [🎁 $version](208 bold) " ## Perl -O módulo `perl` exibe a versão atual instalada do [Perl](https://www.perl.org/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: +The `perl` module shows the currently installed version of [Perl](https://www.perl.org/). By default the module will be shown if any of the following conditions are met: -- 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` +- 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` ### Opções @@ -2323,20 +2398,20 @@ O módulo `perl` exibe a versão atual instalada do [Perl](https://www.perl.org/ | ------------------- | -------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | A string de formato do módulo. | | `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"🐪 "` | O símbolo usado antes de exibir a versão do Perl. | +| `symbol` | `"🐪 "` | The symbol used before displaying the version of Perl | | `detect_extensions` | `["pl", "pm", "pod"]` | Quais extensões devem ativar este módulo. | | `detect_files` | `["Makefile.PL", "Build.PL", "cpanfile", "cpanfile.snapshot", "META.json", "META.yml", ".perl-version"]` | Quais nomes de arquivos devem ativar este módulo. | | `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | | `style` | `"bold 149"` | O estilo do módulo. | -| `disabled` | `false` | Desabilita o módulo `perl`. | +| `disabled` | `false` | Disables the `perl` module. | ### Variáveis -| Variável | Exemplo | Descrição | -| --------- | --------- | ---------------------------------- | -| version | `v5.26.1` | A versão do `perl` | -| symbol | | Espelha o valor da opção `símbolo` | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| --------- | --------- | --------------------------------- | +| version | `v5.26.1` | The version of `perl` | +| symbol | | Espelha o valor da opção `symbol` | +| style\* | | Espelha o valor da opção `style` | ### Exemplo @@ -2349,11 +2424,11 @@ format = "via [🦪 $version]($style) " ## PHP -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 `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 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` +- The current directory contains a `composer.json` file +- The current directory contains a `.php-version` file +- The current directory contains a `.php` extension ### Opções @@ -2361,20 +2436,20 @@ O módulo `php` exibe a versão atual instalada do [PHP](https://www.php.net/). | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | | `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"🐘 "` | O simbolo usado antes de exibir a versão do PHP. | +| `symbol` | `"🐘 "` | The symbol used before displaying the version of 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` | Desabilita o módulo `php`. | +| `disabled` | `false` | Disables the `php` module. | ### Variáveis -| Variável | Exemplo | Descrição | -| --------- | -------- | ---------------------------------- | -| version | `v7.3.8` | A versão do `php` | -| symbol | | Espelha o valor da opção `símbolo` | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| --------- | -------- | --------------------------------- | +| version | `v7.3.8` | The version of `php` | +| 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 @@ -2393,14 +2468,14 @@ The `pulumi` module shows the current username, selected [Pulumi Stack](https:// ::: tip -Por padrão a versão do Pulumi não é exibida, pois leva um tempo maior para ser carregada. Em média a maioria dos plugins leva (~70ms). Se você ainda deseja ativa-la, [siga o exemplo abaixo](#with-pulumi-version). +By default the Pulumi version is not shown, since it takes an order of magnitude longer to load then most plugins (~70ms). If you still want to enable it, [follow the example shown below](#with-pulumi-version). ::: -Por padrão o módulo vai exibir se uma das condições a seguir for atendida: +By default the module will be shown if any of the following conditions are met: -- 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` +- The current directory contains either `Pulumi.yaml` or `Pulumi.yml` +- A parent directory contains either `Pulumi.yaml` or `Pulumi.yml` ### Opções @@ -2408,19 +2483,19 @@ Por padrão o módulo vai exibir se uma das condições a seguir for atendida: | ---------------- | -------------------------------------------- | ------------------------------------------------------------------------------------ | | `format` | `"via [$symbol($username@)$stack]($style) "` | A string de formato do módulo. | | `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `" "` | Uma string que é exibida antes do Pulumi stack. | +| `symbol` | `" "` | A format string shown before the Pulumi stack. | | `style` | `"bold 5"` | O estilo do módulo. | -| `disabled` | `false` | Desabilita o módulo `pulumi`. | +| `disabled` | `false` | Disables the `pulumi` module. | ### Variáveis -| Variável | Exemplo | Descrição | -| --------- | ---------- | ---------------------------------- | -| version | `v0.12.24` | A versão do `pulumi` | -| stack | `dev` | A stack Pulumi atual | -| username | `alice` | The current Pulumi username | -| symbol | | Espelha o valor da opção `símbolo` | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| --------- | ---------- | --------------------------------- | +| version | `v0.12.24` | The version of `pulumi` | +| stack | `dev` | The current Pulumi stack | +| username | `alice` | The current Pulumi username | +| symbol | | Espelha o valor da opção `symbol` | +| style\* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo @@ -2446,10 +2521,10 @@ format = "[$symbol$stack]($style) " ## PureScript -O módulo `purescript` exibe a versão atual instalada do [PureScript](https://www.purescript.org/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: +The `purescript` module shows the currently installed version of [PureScript](https://www.purescript.org/) version. By default the module will be shown if any of the following conditions are met: -- O diretório atual contem um arquivo `spago.dhall` -- O diretório atual tenha um arquivo com a extensão `.purs` +- The current directory contains a `spago.dhall` file +- The current directory contains a file with the `.purs` extension ### Opções @@ -2457,20 +2532,20 @@ O módulo `purescript` exibe a versão atual instalada do [PureScript](https://w | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | | `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"<=> "` | O símbolo usado antes de exibir a versão do PureScript. | +| `symbol` | `"<=> "` | The symbol used before displaying the version of PureScript. | | `detect_extensions` | `["purs"]` | Quais extensões devem ativar este módulo. | | `detect_files` | `["spago.dhall"]` | Quais nomes de arquivos devem ativar este módulo. | | `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | | `style` | `"bold white"` | O estilo do módulo. | -| `disabled` | `false` | Desabilita o módulo `purescript`. | +| `disabled` | `false` | Disables the `purescript` module. | ### Variáveis -| Variável | Exemplo | Descrição | -| --------- | -------- | ---------------------------------- | -| version | `0.13.5` | A versão do `purescript` | -| symbol | | Espelha o valor da opção `símbolo` | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| --------- | -------- | --------------------------------- | +| version | `0.13.5` | The version of `purescript` | +| 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 @@ -2485,55 +2560,55 @@ format = "via [$symbol$version](bold white)" ## Python -O módulo `python` exibe a versão atual instalada do [Python](https://www.python.org/) e o [Python virtual environment](https://docs.python.org/tutorial/venv.html) se algum estiver ativo. +The `python` module shows the currently installed version of [Python](https://www.python.org/) and the current [Python virtual environment](https://docs.python.org/tutorial/venv.html) if one is activated. -Se o `pyenv_version_name` estiver definido como `true`, será exibido o nome da versão do pyenv. Caso contrario, ele exibirá o número da versão do `python --version`. +If `pyenv_version_name` is set to `true`, it will display the pyenv version name. Otherwise, it will display the version number from `python --version`. -Por padrão o módulo vai exibir se uma das condições a seguir for atendida: +By default the module will be shown if any of the following conditions are met: -- 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 +- 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 ### Opções -| Opções | Padrão | Descrição | -| -------------------- | ------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------ | -| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | O formato do módulo. | -| `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"🐍 "` | Uma string que representa o simbolo do Python | -| `style` | `"yellow bold"` | O estilo do módulo. | -| `pyenv_version_name` | `false` | Usa pyenv para pegar a versão do Python | -| `pyenv_prefix` | `pyenv` | Prefixo antes da versão do pyenv, apenas usado se pyenv for usado | -| `python_binary` | `["python", "python3", "python2"]` | Configura o binário python que o Starship vai executar para obter a versão. | -| `detect_extensions` | `["py"]` | Quais extensões devem acionar este módulo | -| `detect_files` | `[".python-version", "Pipfile", "__init__.py", "pyproject.toml", "requirements.txt", "setup.py", "tox.ini"]` | [] | -| `detect_folders` | `[]` | Quais pastas devem ativar este módulo | -| `disabled` | `false` | Desabilita o módulo `python`. | +| Opções | Padrão | Descrição | +| -------------------- | ------------------------------------------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- | +| `format` | `'via [${symbol}${pyenv_prefix}(${version} )(\($virtualenv\) )]($style)'` | O formato do módulo. | +| `version_format` | `"v${raw}"` | 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. | ::: tip -A variável `python_binary` aceita uma string ou uma lista de strings. O Starship vai tentar executar cada binário até obter um resultado. Note que você pode apenas alterar o binário em que o Starship executa para pegar a versão do Python não os argumentos que são utilizados. +The `python_binary` variable accepts either a string or a list of strings. Starship will try executing each binary until it gets a result. Note you can only change the binary that Starship executes to get the version of Python not the arguments that are used. -O valor padrão e a ordem para o `python_binary` foram escolhidos para identificar primeiro uma versão do Python em um ambiente virtualenv/conda (que atualmente adiciona um `python`, não importa se ele aponta pro `python3` ou `python2`). Este tem efeito de lado, se você tenha um sistema com Python 2 instalado, pode ser usado antes de qualquer Python 3 (pelo menos nas Distros Linux que sempre fazem um symlink `/usr/bin/python` para Python 2). 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. +The default values and order for `python_binary` was chosen to first identify the Python version in a virtualenv/conda environments (which currently still add a `python`, no matter if it points to `python3` or `python2`). This has the side effect that if you still have a system Python 2 installed, it may be picked up before any Python 3 (at least on Linux Distros that always symlink `/usr/bin/python` to Python 2). If you do not work with Python 2 anymore but cannot remove the system Python 2, changing this to `"python3"` will hide any Python version 2, see example below. ::: ### Variáveis -| Variável | Exemplo | Descrição | -| ------------ | --------------- | --------------------------------------- | -| version | `"v3.8.1"` | A versão do `python` | -| symbol | `"🐍 "` | Espelha o valor da opção `símbolo` | -| style | `"yellow bold"` | Espelha o valor da opção `style` | -| pyenv_prefix | `"pyenv "` | Espelha o valor da opção `pyenv_prefix` | -| virtualenv | `"venv"` | O nome atual do `virtualenv` | +| Variável | Exemplo | Descrição | +| ------------ | --------------- | ------------------------------------------ | +| version | `"v3.8.1"` | The version of `python` | +| symbol | `"🐍 "` | Espelha o valor da opção `symbol` | +| style | `"yellow bold"` | Espelha o valor da opção `style` | +| pyenv_prefix | `"pyenv "` | Mirrors the value of option `pyenv_prefix` | +| virtualenv | `"venv"` | The current `virtualenv` name | ### Exemplo @@ -2549,7 +2624,7 @@ pyenv_version_name = true # ~/.config/starship.toml [python] -# Apenas use o binário `python3` para pegar a versão. +# Only use the `python3` binary to get the version. python_binary = "python3" ``` @@ -2557,7 +2632,7 @@ python_binary = "python3" # ~/.config/starship.toml [python] -#Não acione arquivos com a extensão py +# Don't trigger for files with the py extension detect_extensions = [] ``` @@ -2565,24 +2640,24 @@ detect_extensions = [] # ~/.config/starship.toml [python] -# Exibe a versão do python dentro de um local venv. +# Display the version of python from inside a local venv. # -# 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? +# Note this will only work when the venv is inside the project and it will only +# work in the directory that contains the venv dir but maybe this is ok? python_binary = ["./venv/bin/python", "python", "python3", "python2"] ``` ## R -O módulo `rlang` 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 `rlang` module shows the currently installed version of [R](https://www.r-project.org/). The module will be shown if any of the following conditions are met: -- O diretório atual tenha um arquivo com a extensão `.R`. -- O diretório atual tenha um arquivo com a extensão `.Rd`. -- 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` +- 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 ### Opções @@ -2590,20 +2665,20 @@ O módulo `rlang` exibe a versão atual instalada do [R](https://www.r-project.o | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | | `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"📐"` | Uma string que representa o simbolo do R. | +| `symbol` | `"📐"` | A format string representing the symbol of R. | | `style` | `"blue bold"` | O estilo do módulo. | -| `detect_extensions` | `["R", "Rd", "Rmd", "Rproj", "Rsx"]` | Quais extensões devem acionar este módulo | -| `detect_files` | `[".Rprofile"]` | [] | -| `detect_folders` | `[".Rproj.user"]` | Quais pastas devem ativar este módulo | -| `disabled` | `false` | Desabilita o módulo `r`. | +| `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. | ### Variáveis -| Variável | Exemplo | Descrição | -| -------- | ------------- | ---------------------------------- | -| version | `v4.0.5` | A versão do `R` | -| symbol | | Espelha o valor da opção `símbolo` | -| style | `"blue bold"` | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| -------- | ------------- | --------------------------------- | +| version | `v4.0.5` | The version of `R` | +| symbol | | Espelha o valor da opção `symbol` | +| style | `"blue bold"` | Espelha o valor da opção `style` | ### Exemplo @@ -2616,9 +2691,9 @@ format = "with [📐 $version](blue bold) " ## Red -Por padrão o módulo `red` exibe a versão atual instalada do [Red](https://www.red-lang.org/). O módulo vai exibir se algumas das condições a seguir for atendida: +By default the `red` module shows the currently installed version of [Red](https://www.red-lang.org/). O módulo será mostrado se alguma das seguintes condições for atendida: -- O diretório atual contenha um arquivo com a extensão `.red` or `.reds` +- The current directory contains a file with `.red` or `.reds` extension ### Opções @@ -2626,20 +2701,20 @@ Por padrão o módulo `red` exibe a versão atual instalada do [Red](https://www | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | | `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"🔺 "` | Uma string que representa o simbolo do Red. | +| `symbol` | `"🔺 "` | A format string representing the symbol of Red. | | `detect_extensions` | `["red"]` | Quais extensões devem ativar este módulo. | | `detect_files` | `[]` | Quais nomes de arquivos devem ativar este módulo. | | `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | | `style` | `"red bold"` | O estilo do módulo. | -| `disabled` | `false` | Desabilita o módulo `red`. | +| `disabled` | `false` | Disables the `red` module. | ### Variáveis -| Variável | Exemplo | Descrição | -| --------- | -------- | ---------------------------------- | -| version | `v2.5.1` | A versão do `red` | -| symbol | | Espelha o valor da opção `símbolo` | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| --------- | -------- | --------------------------------- | +| version | `v2.5.1` | The version of `red` | +| 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 @@ -2654,14 +2729,14 @@ symbol = "🔴 " ## Ruby -Por padrão o módulo `ruby` vai exibir a versão atual instalada do [Ruby](https://www.ruby-lang.org/). O módulo vai exibir se algumas das condições a seguir for atendida: +By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). O módulo será mostrado se alguma das seguintes condições for atendida: -- 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 +- 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 Starship pega a versão atual do Ruby rodando `ruby -v`. +Starship gets the current Ruby version by running `ruby -v`. ### Opções @@ -2669,21 +2744,21 @@ O Starship pega a versão atual do Ruby rodando `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` | `"💎 "` | Uma string que representa o simbolo do Ruby. | +| `symbol` | `"💎 "` | A format string representing the symbol of Ruby. | | `detect_extensions` | `["rb"]` | Quais extensões devem ativar este módulo. | | `detect_files` | `["Gemfile", ".ruby-version"]` | Quais nomes de arquivos devem ativar este módulo. | | `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | -| `detect_variables` | `["RUBY_VERSION", "RBENV_VERSION"]` | Quais variáveis de ambiente devem ativar este módulo. | +| `detect_variables` | `["RUBY_VERSION", "RBENV_VERSION"]` | Which environment variables should trigger this module. | | `style` | `"bold red"` | O estilo do módulo. | -| `disabled` | `false` | Desabilita o módulo `ruby`. | +| `disabled` | `false` | Disables the `ruby` module. | ### Variáveis -| Variável | Exemplo | Descrição | -| --------- | -------- | ---------------------------------- | -| version | `v2.5.1` | A versão do `ruby` | -| symbol | | Espelha o valor da opção `símbolo` | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| --------- | -------- | --------------------------------- | +| version | `v2.5.1` | The version of `ruby` | +| 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 @@ -2698,10 +2773,10 @@ symbol = "🔺 " ## Rust -Por padrão o módulo `rust` vai exibir a versão atual instalada do [Rust](https://www.rust-lang.org/). O módulo vai exibir se algumas das condições a seguir for atendida: +By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). O módulo será mostrado se alguma das seguintes condições for atendida: -- O diretório atual contem um arquivo `Cargo.toml` -- O diretório atual tenha um arquivo com a extensão `.rs` +- The current directory contains a `Cargo.toml` file +- The current directory contains a file with the `.rs` extension ### Opções @@ -2709,20 +2784,20 @@ Por padrão o módulo `rust` vai exibir a versão atual instalada do [Rust](http | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | | `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"🦀 "` | Uma string que representa o simbolo do Rust | +| `symbol` | `"🦀 "` | A format string representing the symbol of Rust | | `detect_extensions` | `["rs"]` | Quais extensões devem ativar este módulo. | | `detect_files` | `["Cargo.toml"]` | Quais nomes de arquivos devem ativar este módulo. | | `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | | `style` | `"bold red"` | O estilo do módulo. | -| `disabled` | `false` | Desabilita o módulo `rust`. | +| `disabled` | `false` | Disables the `rust` module. | ### Variáveis -| Variável | Exemplo | Descrição | -| --------- | ----------------- | ---------------------------------- | -| version | `v1.43.0-nightly` | A versão do `rustc` | -| symbol | | Espelha o valor da opção `símbolo` | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| --------- | ----------------- | --------------------------------- | +| version | `v1.43.0-nightly` | The version of `rustc` | +| 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 @@ -2737,11 +2812,11 @@ format = "via [⚙️ $version](red bold)" ## Scala -O módulo `scala` exibe a versão atual instalada do [Scala](https://www.scala-lang.org/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: +The `scala` module shows the currently installed version of [Scala](https://www.scala-lang.org/). By default the module will be shown if any of the following conditions are met: -- 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` +- 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` ### Opções @@ -2752,17 +2827,17 @@ O módulo `scala` exibe a versão atual instalada do [Scala](https://www.scala-l | `detect_extensions` | `["sbt", "scala"]` | Quais extensões devem ativar este módulo. | | `detect_files` | `[".scalaenv", ".sbtenv", "build.sbt"]` | Quais nomes de arquivos devem ativar este módulo. | | `detect_folders` | `[".metals"]` | Quais pastas devem ativar este módulo. | -| `symbol` | `"🆂 "` | Uma string que representa o simbolo do Scala. | +| `symbol` | `"🆂 "` | A format string representing the symbol of Scala. | | `style` | `"red dimmed"` | O estilo do módulo. | -| `disabled` | `false` | Desabilita o módulo `scala`. | +| `disabled` | `false` | Disables the `scala` module. | ### Variáveis -| Variável | Exemplo | Descrição | -| --------- | -------- | ---------------------------------- | -| version | `2.13.5` | A versão do `scala` | -| symbol | | Espelha o valor da opção `símbolo` | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| --------- | -------- | --------------------------------- | +| version | `2.13.5` | The version of `scala` | +| 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 @@ -2777,39 +2852,39 @@ symbol = "🌟 " ## Shell -O módulo de `shell` exibe um indicador para o shell que esta sendo usado. +The `shell` module shows an indicator for currently used shell. ::: tip -Este módulo é desabilitado por padrão. Para habilitar, defina `disabled` para `false` no seu arquivo de configuração. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### Opções -| Opções | Padrão | Descrição | -| ---------------------- | ------------------------- | ------------------------------------------------------- | -| `bash_indicator` | `bsh` | Uma string para representar o bash. | -| `fish_indicator` | `fsh` | Uma string usada para representar o fish. | -| `zsh_indicator` | `zsh` | Uma string usada para representar o zsh. | -| `powershell_indicator` | `psh` | Uma string usada para representar o powershell. | -| `ion_indicator` | `ion` | Uma string usada para representar o ion. | -| `elvish_indicator` | `esh` | Uma string usada para representar o elvish. | -| `tcsh_indicator` | `tsh` | Uma string usada para representar o tcsh. | -| `xonsh_indicator` | `xsh` | Uma string usada para representar o xonsh. | -| `cmd_indicator` | `cmd` | 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`. | +| Opções | Padrão | Descrição | +| ---------------------- | ------------------------- | ------------------------------------------------------------ | +| `bash_indicator` | `bsh` | A format string used to represent bash. | +| `fish_indicator` | `fsh` | A format string used to represent fish. | +| `zsh_indicator` | `zsh` | A format string used to represent zsh. | +| `powershell_indicator` | `psh` | A format string used to represent powershell. | +| `ion_indicator` | `ion` | A format string used to represent ion. | +| `elvish_indicator` | `esh` | A format string used to represent elvish. | +| `tcsh_indicator` | `tsh` | A format string used to represent tcsh. | +| `xonsh_indicator` | `xsh` | A format string used to represent xonsh. | +| `cmd_indicator` | `cmd` | A format string used to represent cmd. | +| `nu_indicator` | `nu` | A format string used to represent nu. | +| `unknown_indicator` | | The default value to be displayed when the shell is unknown. | +| `format` | `"[$indicator]($style) "` | O formato do módulo. | +| `style` | `"white bold"` | O estilo do módulo. | +| `disabled` | `true` | Disables the `shell` module. | ### Variáveis -| Variável | Padrão | Descrição | -| --------- | ------ | ------------------------------------------------------------- | -| indicator | | Espelha o valor do `indicator` para o shell usado atualmente. | -| style\* | | Espelha o valor da opção `style`. | +| Variável | Padrão | Descrição | +| --------- | ------ | ---------------------------------------------------------- | +| indicator | | Mirrors the value of `indicator` for currently used shell. | +| style\* | | Mirrors the value of option `style`. | *: Esta variável só pode ser usada como parte de uma string de estilo @@ -2828,26 +2903,26 @@ disabled = false ## SHLVL -O módulo `shlvl` exibe o atual [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ("shell level") variável de ambiente, se estiver definido um número e coincidir ou exceder o limite especificado. +The `shlvl` module shows the current [`SHLVL`](https://tldp.org/LDP/abs/html/internalvariables.html#SHLVLREF) ("shell level") environment variable, if it is set to a number and meets or exceeds the specified threshold. ### Opções -| Opções | Padrão | Descrição | -| ----------- | ---------------------------- | ----------------------------------------------------------------- | -| `threshold` | `2` | Limite de exibição. | -| `format` | `"[$symbol$shlvl]($style) "` | O formato do módulo. | -| `symbol` | `"↕️ "` | O simbolo usado para representar o `SHLVL`. | -| `repeat` | `false` | Caso o `symbol` deva se repetir de acordo com o total do `SHLVL`. | -| `style` | `"bold yellow"` | O estilo do módulo. | -| `disabled` | `true` | Desabilita o módulo `shlvl`. | +| Opções | Padrão | Descrição | +| ----------- | ---------------------------- | ------------------------------------------------------------- | +| `threshold` | `2` | Display threshold. | +| `format` | `"[$symbol$shlvl]($style) "` | O formato do módulo. | +| `symbol` | `"↕️ "` | The symbol used to represent the `SHLVL`. | +| `repeat` | `false` | Causes `symbol` to be repeated by the current `SHLVL` amount. | +| `style` | `"bold yellow"` | O estilo do módulo. | +| `disabled` | `true` | Disables the `shlvl` module. | ### Variáveis -| Variável | Exemplo | Descrição | -| --------- | ------- | ---------------------------------- | -| shlvl | `3` | O valor atual do `SHLVL` | -| symbol | | Espelha o valor da opção `símbolo` | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| --------- | ------- | --------------------------------- | +| shlvl | `3` | The current value of `SHLVL` | +| 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 @@ -2864,24 +2939,24 @@ threshold = 3 ## Singularidade -O módulo `singularity` exibe a imagem atual do [Singularity](https://sylabs.io/singularity/), se dentro de um contêiner e definido `$SINGULARITY_NAME`. +The `singularity` module shows the current [Singularity](https://sylabs.io/singularity/) image, if inside a container and `$SINGULARITY_NAME` is set. ### Opções -| Opções | Padrão | Descrição | -| ---------- | -------------------------------- | ------------------------------------------- | -| `format` | `'[$symbol\[$env\]]($style) '` | O formato do módulo. | -| `symbol` | `""` | Uma string exibida antes do nome da imagem. | -| `style` | `"bold dimmed blue"` | O estilo do módulo. | -| `disabled` | `false` | Desabilita o módulo `singularity`. | +| Opções | Padrão | Descrição | +| ---------- | -------------------------------- | ------------------------------------------------ | +| `format` | `'[$symbol\[$env\]]($style) '` | O formato do módulo. | +| `symbol` | `""` | A format string displayed before the image name. | +| `style` | `"bold dimmed blue"` | O estilo do módulo. | +| `disabled` | `false` | Disables the `singularity` module. | ### Variáveis -| Variável | Exemplo | Descrição | -| --------- | ------------ | ---------------------------------- | -| env | `centos.img` | A imagem atual do Singularity | -| symbol | | Espelha o valor da opção `símbolo` | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| --------- | ------------ | --------------------------------- | +| env | `centos.img` | The current Singularity image | +| 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 @@ -2896,49 +2971,47 @@ format = '[📦 \[$env\]]($style) ' ## Status -O módulo `status` exibe o código de saída do comando anterior. O módulo será exibido apenas se o código de saída não for `0`. The status code will cast to a signed 32-bit integer. +The `status` module displays the exit code of the previous command. If $success_symbol is empty (default), the module will be shown only if the exit code is not `0`. The status code will cast to a signed 32-bit integer. ::: tip -Este módulo é desabilitado por padrão. Para habilitar, defina `disabled` para `false` no seu arquivo de configuração. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: -::: warning Este módulo não é suportado pelo nu shell. ::: - ### Opções | Opções | Padrão | Descrição | | ----------------------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------- | | `format` | `"[$symbol$status]($style) "` | O formato do módulo | -| `symbol` | `"✖"` | O simbolo exibido no erro de programa | -| `success_symbol` | `"✔️"` | O simbolo exibido no sucesso de programa | -| `not_executable_symbol` | `"🚫"` | O simbolo exibido quando o arquivo não é executável | -| `not_found_symbol` | `"🔍"` | O simbolo exibido quando o comando não é encontrado | -| `sigint_symbol` | `"🧱"` | O simbolo exibido no SIGINT (Ctrl + c) | -| `signal_symbol` | `"⚡"` | O simbolo exibido em qualquer sinal | +| `symbol` | `"✖"` | The symbol displayed on program error | +| `success_symbol` | `""` | The symbol displayed on program success | +| `not_executable_symbol` | `"🚫"` | The symbol displayed when file isn't executable | +| `not_found_symbol` | `"🔍"` | The symbol displayed when the command can't be found | +| `sigint_symbol` | `"🧱"` | The symbol displayed on SIGINT (Ctrl + c) | +| `signal_symbol` | `"⚡"` | The symbol displayed on any signal | | `style` | `"bold red"` | O estilo do módulo. | -| `recognize_signal_code` | `true` | Habilita o mapeamento de sinais para códigos de saída | -| `map_symbol` | `false` | Habilita o mapeamento de símbolos para códigos de saída | -| `pipestatus` | `false` | Habilita o relatório de pipestatus | +| `recognize_signal_code` | `true` | Enable signal mapping from exit code | +| `map_symbol` | `false` | Enable symbols mapping from exit code | +| `pipestatus` | `false` | Enable pipestatus reporting | | `pipestatus_separator` | `|` | | -| `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`. | +| `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. | ### Variáveis -| Variável | Exemplo | Descrição | -| -------------- | ------- | -------------------------------------------------------------------------------------------------------- | -| status | `127` | O codígo de saída do último comando | -| hex_status | `0x7F` | O codígo de saída do último comando em hex | -| int | `127` | O codígo de saída do último comando | -| common_meaning | `ERROR` | Significa que o código não é um sinal | -| signal_number | `9` | Número do sinal correspondente ao código de saída, apenas se sinalizado | -| signal_name | `KILL` | Nome do sinal correspondente ao código de saída, apenas se for sinalizado | -| maybe_int | `7` | Contém o código de saída quando nenhum significado for encontrado | -| pipestatus | | Exibição do pipeline de programas com os códigos de saída, este é apenas disponível no pipestatus_format | -| symbol | | Espelha o valor da opção `símbolo` | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| -------------- | ------- | ------------------------------------------------------------------------------------------- | +| status | `127` | The exit code of the last command | +| hex_status | `0x7F` | The exit code of the last command in hex | +| int | `127` | The exit code of the last command | +| common_meaning | `ERROR` | Meaning of the code if not a signal | +| signal_number | `9` | Signal number corresponding to the exit code, only if signalled | +| signal_name | `KILL` | Name of the signal corresponding to the exit code, only if signalled | +| maybe_int | `7` | Contains the exit code number when no meaning has been found | +| pipestatus | | Rendering of in pipeline programs's exit codes, this is only available in pipestatus_format | +| symbol | | Espelha o valor da opção `symbol` | +| style\* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo @@ -2949,38 +3022,39 @@ Este módulo é desabilitado por padrão. Para habilitar, defina `disabled` para [status] style = "bg:blue" -symbol = "🔴" -format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) ' +symbol = "🔴 " +success_symbol = "🟢 SUCCESS" +format = '[\[$symbol$common_meaning$signal_name$maybe_int\]]($style) ' map_symbol = true disabled = false ``` ## Sudo -O módulo `sudo` é exibido se uma credencial sudo estiver em cache. O módulo vai ser exibido somente se as credenciais estiverem em cache. +The `sudo` module displays if sudo credentials are currently cached. The module will only be shown if credentials are cached. ::: tip -Este módulo é desabilitado por padrão. Para habilitar, defina `disabled` para `false` no seu arquivo de configuração. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### Opções -| Opções | Padrão | Descrição | -| --------------- | ----------------------- | -------------------------------------------------------------------------- | -| `format` | `[as $symbol]($style)"` | O formato do módulo | -| `symbol` | `"🧙 "` | O simbolo exibido quando as credenciais estão em cache | -| `style` | `"bold blue"` | O estilo do módulo. | -| `allow_windows` | `false` | Desde que o Windows não tem um padrão sudo, o valor padrão é desabilitado. | -| `disabled` | `true` | Desabilita o módulo `sudo`. | +| Opções | Padrão | Descrição | +| --------------- | ----------------------- | ------------------------------------------------------- | +| `format` | `[as $symbol]($style)"` | 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. | ### Variáveis -| Variável | Exemplo | Descrição | -| --------- | ------- | ---------------------------------- | -| symbol | | Espelha o valor da opção `símbolo` | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| --------- | ------- | --------------------------------- | +| 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 @@ -2996,7 +3070,7 @@ disabled = false ``` ```toml -# No windows +# On windows # $HOME\.starship\config.toml [sudo] @@ -3006,10 +3080,10 @@ disabled = false ## Swift -Por padrão o módulo `swift` vai exibir a versão atual instalada do [Swift](https://swift.org/). O módulo vai exibir se algumas das condições a seguir for atendida: +By default the `swift` module shows the currently installed version of [Swift](https://swift.org/). O módulo será mostrado se alguma das seguintes condições for atendida: -- O diretório atual tenha um arquivo `Package.swift` -- O diretório atual tenha um arquivo com a extensão `.swift` +- The current directory contains a `Package.swift` file +- The current directory contains a file with the `.swift` extension ### Opções @@ -3017,20 +3091,20 @@ Por padrão o módulo `swift` vai exibir a versão atual instalada do [Swift](ht | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | | `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"🐦 "` | Uma string que representa o simbolo do Swift | +| `symbol` | `"🐦 "` | A format string representing the symbol of Swift | | `detect_extensions` | `["swift"]` | Quais extensões devem ativar este módulo. | | `detect_files` | `["Package.swift"]` | Quais nomes de arquivos devem ativar este módulo. | | `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | | `style` | `"bold 202"` | O estilo do módulo. | -| `disabled` | `false` | Desabilita o módulo `swift`. | +| `disabled` | `false` | Disables the `swift` module. | ### Variáveis -| Variável | Exemplo | Descrição | -| --------- | -------- | ---------------------------------- | -| version | `v5.2.4` | A versão do `swift` | -| symbol | | Espelha o valor da opção `símbolo` | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| --------- | -------- | --------------------------------- | +| version | `v5.2.4` | The version of `swift` | +| 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 @@ -3045,18 +3119,18 @@ format = "via [🏎 $version](red bold)" ## Terraform -O módulo `terraform` exibe o [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) selecionado e sua versão. +The `terraform` module shows the currently selected [Terraform workspace](https://www.terraform.io/docs/language/state/workspaces.html) and version. ::: tip -Por padrão a versão do Terraform não é exibida, desde que é lento recuperar a versão atual quando muitos plugins estão em uso. Se você deseja habilitar,, [Siga o exemplo abaixo](#with-terraform-version). +By default the Terraform version is not shown, since this is slow for current versions of Terraform when a lot of plugins are in use. If you still want to enable it, [follow the example shown below](#with-terraform-version). ::: -Por padrão o módulo vai exibir se uma das condições a seguir for atendida: +By default the module will be shown if any of the following conditions are met: -- O diretório atual tenha uma pasta `.terraform` -- O diretório atual tenha arquivos com as extensões `.tf`, `.tfplan` or `.tfstate` +- The current directory contains a `.terraform` folder +- Current directory contains a file with the `.tf`, `.tfplan` or `.tfstate` extensions ### Opções @@ -3064,21 +3138,21 @@ Por padrão o módulo vai exibir se uma das condições a seguir for atendida: | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ | | `format` | `"via [$symbol$workspace]($style) "` | A string de formato do módulo. | | `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"💠"` | Uma string que é exibida antes do workspace terraform. | +| `symbol` | `"💠"` | A format string shown before the terraform workspace. | | `detect_extensions` | `["tf", "tfplan", "tfstate"]` | Quais extensões devem ativar este módulo. | | `detect_files` | `[]` | Quais nomes de arquivos devem ativar este módulo. | | `detect_folders` | `[".terraform"]` | Quais pastas devem ativar este módulo. | | `style` | `"bold 105"` | O estilo do módulo. | -| `disabled` | `false` | Desabilita o módulo `terraform`. | +| `disabled` | `false` | Disables the `terraform` module. | ### Variáveis -| Variável | Exemplo | Descrição | -| --------- | ---------- | ---------------------------------- | -| version | `v0.12.24` | A versão do `terraform` | -| workspace | `default` | O workspace atual do Terraform | -| symbol | | Espelha o valor da opção `símbolo` | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| --------- | ---------- | --------------------------------- | +| version | `v0.12.24` | The version of `terraform` | +| workspace | `default` | The current Terraform workspace | +| symbol | | Espelha o valor da opção `symbol` | +| style\* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo @@ -3104,33 +3178,33 @@ format = "[🏎💨 $workspace]($style) " ## Horário -O módulo `time` exibe a hora **local** atual. A configuração de `format` é usada pelo [`chrono`](https://crates.io/crates/chrono) para controlar qual hora é exibida. Dê uma olhada na [documentação do chrono strftime](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) para ver quais opções estão disponíveis. +The `time` module shows the current **local** time. The `format` configuration value is used by the [`chrono`](https://crates.io/crates/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) to see what options are available. ::: tip -Este módulo é desabilitado por padrão. Para habilitar, defina `disabled` para `false` no seu arquivo de configuração. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### Opções -| Opções | Padrão | Descrição | -| ----------------- | ----------------------- | --------------------------------------------------------------------------------------------------------------------------- | -| `format` | `"at [$time]($style) "` | A string de formato do módulo. | -| `use_12hr` | `false` | Habilita a formatação de 12 horas | -| `time_format` | veja abaixo | A string [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) usada para formatar a hora. | -| `style` | `"bold yellow"` | O estilo do módulo time | -| `utc_time_offset` | `"local"` | Define o UTC a ser usado. Intervalo de -24 < x < 24. Aceita floats para acomodar timezones 30/45. | -| `disabled` | `true` | Desabilita o módulo `time`. | -| `time_range` | `"-"` | Define o intervalo de tempo o qual o módulo será exibido. O horário deve ser especificado no formato de 24-hours | +| Opções | Padrão | Descrição | +| ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | +| `format` | `"at [$time]($style) "` | A string de formato do módulo. | +| `use_12hr` | `false` | Enables 12 hour formatting | +| `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. | +| `style` | `"bold yellow"` | The style for the module time | +| `utc_time_offset` | `"local"` | Sets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. | +| `disabled` | `true` | Disables the `time` module. | +| `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | -Se `use_12hr` é `true`, então `time_format` tem o padrão `"%r"`. Caso contrário, o padrão é `"%T"`. Ajustes manuais no `time_format` irão sobrescrever a configuração `use_12hr`. +If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Otherwise, it defaults to `"%T"`. Manually setting `time_format` will override the `use_12hr` setting. ### Variáveis | Variável | Exemplo | Descrição | | --------- | ---------- | -------------------------------- | -| time | `13:08:10` | A hora atual. | +| time | `13:08:10` | The current time. | | style\* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo @@ -3148,37 +3222,37 @@ utc_time_offset = "-5" time_range = "10:00:00-14:00:00" ``` -## Nome do usuário +## Username -O módulo `username` exibe o username do usuário ativo. O módulo vai exibir se algumas das condições a seguir for atendida: +The `username` module shows active user's username. O módulo será mostrado se alguma das seguintes condições for atendida: -- O usuário atual é root -- 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 +- 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 ::: tip -Conexões SSH são detectadas checando as variáveis de ambiente `SSH_CONNECTION`, `SSH_CLIENT`, and `SSH_TTY`. Se seu host SSH não tem estas variáveis configuradas, uma alternativa é definir uma delas com valor burro. +SSH connection is detected by checking environment variables `SSH_CONNECTION`, `SSH_CLIENT`, and `SSH_TTY`. If your SSH host does not set up these variables, one workaround is to set one of them with a dummy value. ::: ### Opções -| Opções | Padrão | Descrição | -| ------------- | ----------------------- | --------------------------------------- | -| `style_root` | `"bold red"` | O estilo usado quando o usuário é root. | -| `style_user` | `"bold yellow"` | O estilo usado para usuários não root. | -| `format` | `"[$user]($style) in "` | O formato do módulo. | -| `show_always` | `false` | Sempre exibe o módulo `username`. | -| `disabled` | `false` | Desabilita o módulo `username`. | +| Opções | Padrão | Descrição | +| ------------- | ----------------------- | ------------------------------------- | +| `style_root` | `"bold red"` | The style used when the user is root. | +| `style_user` | `"bold yellow"` | The style used for non-root users. | +| `format` | `"[$user]($style) in "` | O formato do módulo. | +| `show_always` | `false` | Always shows the `username` module. | +| `disabled` | `false` | Disables the `username` module. | ### Variáveis -| Variável | Exemplo | Descrição | -| -------- | ------------ | -------------------------------------------------------------------------------------- | -| `style` | `"red bold"` | Espelha o valor da opção `style_root` quando o root esta logado e `style_user` se não. | -| `user` | `"matchai"` | O ID do usuário logado atualmente. | +| Variável | Exemplo | Descrição | +| -------- | ------------ | ------------------------------------------------------------------------------------------- | +| `style` | `"red bold"` | Mirrors the value of option `style_root` when root is logged in and `style_user` otherwise. | +| `user` | `"matchai"` | The currently logged-in user ID. | ### Exemplo @@ -3195,9 +3269,9 @@ show_always = true ## Vagrant -O módulo `vagrant` exibe a versão atual instalada do [Vagrant](https://www.vagrantup.com/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: +The `vagrant` module shows the currently installed version of [Vagrant](https://www.vagrantup.com/). By default the module will be shown if any of the following conditions are met: -- O diretório atual contem um arquivo `Vagrantfile` +- The current directory contains a `Vagrantfile` file ### Opções @@ -3205,20 +3279,20 @@ O módulo `vagrant` exibe a versão atual instalada do [Vagrant](https://www.vag | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | | `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"⍱ "` | Um formato de string que representa o simbolo do Vagrant. | +| `symbol` | `"⍱ "` | A format string representing the symbol of Vagrant. | | `detect_extensions` | `[]` | Quais extensões devem ativar este módulo. | | `detect_files` | `["Vagrantfile"]` | Quais nomes de arquivos devem ativar este módulo. | | `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | | `style` | `"cyan bold"` | O estilo do módulo. | -| `disabled` | `false` | Desabilita o módulo `vagrant`. | +| `disabled` | `false` | Disables the `vagrant` module. | ### Variáveis -| Variável | Exemplo | Descrição | -| --------- | ---------------- | ---------------------------------- | -| version | `Vagrant 2.2.10` | A versão do `Vagrant` | -| symbol | | Espelha o valor da opção `símbolo` | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| --------- | ---------------- | --------------------------------- | +| version | `Vagrant 2.2.10` | The version of `Vagrant` | +| symbol | | Espelha o valor da opção `symbol` | +| style\* | | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo @@ -3233,10 +3307,10 @@ format = "via [⍱ $version](bold white) " ## V -O módulo `vlang` exibe a versão atual instalada do [V](https://vlang.io/). Por padrão o módulo vai exibir se uma das condições a seguir for atendida: +The `vlang` module shows you your currently installed version of [V](https://vlang.io/). By default the module will be shown if any of the following conditions are met: -- 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` +- The current directory contains a file with `.v` extension +- The current directory contains a `v.mod`, `vpkg.json` or `.vpkg-lock.json` file ### Opções @@ -3244,20 +3318,20 @@ O módulo `vlang` exibe a versão atual instalada do [V](https://vlang.io/). Por | ------------------- | -------------------------------------------- | ------------------------------------------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | | `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"V "` | Um formato de string que representa o simbolo do V | +| `symbol` | `"V "` | A format string representing the symbol of V | | `detect_extensions` | `["v"]` | Quais extensões devem ativar este módulo. | | `detect_files` | `["v.mod", "vpkg.json", ".vpkg-lock.json" ]` | Quais nomes de arquivos devem ativar este módulo. | | `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | | `style` | `"blue bold"` | O estilo do módulo. | -| `disabled` | `false` | Desabilita o módulo `vlang`. | +| `disabled` | `false` | Disables the `vlang` module. | ### Variáveis -| Variável | Exemplo | Descrição | -| --------- | ------- | ---------------------------------- | -| version | `v0.2` | A versão do `v` | -| symbol | | Espelha o valor da opção `símbolo` | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| --------- | ------- | --------------------------------- | +| version | `v0.2` | The version of `v` | +| symbol | | Espelha o valor da opção `symbol` | +| style\* | | Espelha o valor da opção `style` | ### Exemplo @@ -3269,24 +3343,24 @@ format = "via [V $version](blue bold) " ## VCSH -O módulo `vcsh` exibe o repositório [VCSH](https://github.com/RichiH/vcsh) atual ativo. O módulo vai ser exibido apenas se um repositório estiver em uso. +The `vcsh` module displays the current active [VCSH](https://github.com/RichiH/vcsh) repository. The module will be shown only if a repository is currently in use. ### Opções | Opções | Padrão | Descrição | | ---------- | -------------------------------- | ------------------------------------------------------ | -| `symbol` | | O simbolo usado antes de exibir o nome do repositório. | +| `symbol` | | The symbol used before displaying the repository name. | | `style` | `"bold yellow"` | O estilo do módulo. | | `format` | `"vcsh [$symbol$repo]($style) "` | O formato do módulo. | -| `disabled` | `false` | Desabilita o módulo `vcsh`. | +| `disabled` | `false` | Disables the `vcsh` module. | ### Variáveis -| Variável | Exemplo | Descrição | -| --------- | ------------------------------------------- | ---------------------------------- | -| repo | `dotfiles` if in a VCSH repo named dotfiles | O nome do repositório ativo | -| symbol | | Espelha o valor da opção `símbolo` | -| style\* | `black bold dimmed` | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| --------- | ------------------------------------------- | --------------------------------- | +| repo | `dotfiles` if in a VCSH repo named dotfiles | The active repository name | +| symbol | | Espelha o valor da opção `symbol` | +| style\* | `black bold dimmed` | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo @@ -3301,9 +3375,9 @@ format = "[🆅 $repo](bold blue) " ## Zig -Por padrão o módulo `zig` exibe a versão atual instalada do [Zig](https://ziglang.org/). O módulo vai exibir se algumas das condições a seguir for atendida: +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: -- O diretório atual contém arquivo com a extensão `.zig` +- The current directory contains a `.zig` file ### Opções @@ -3311,20 +3385,20 @@ Por padrão o módulo `zig` exibe a versão atual instalada do [Zig](https://zig | ------------------- | ------------------------------------ | ------------------------------------------------------------------------------------ | | `format` | `"via [$symbol($version )]($style)"` | O formato do módulo. | | `version_format` | `"v${raw}"` | O formato da versão. As variáveis disponíveis são `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"↯ "` | O simbolo usado antes de exibir a versão do Zig. | +| `symbol` | `"↯ "` | The symbol used before displaying the version of Zig. | | `style` | `"bold yellow"` | O estilo do módulo. | -| `disabled` | `false` | Desabilita o módulo `zig`. | +| `disabled` | `false` | Disables the `zig` module. | | `detect_extensions` | `["zig"]` | Quais extensões devem ativar este módulo. | | `detect_files` | `[]` | Quais nomes de arquivos devem ativar este módulo. | | `detect_folders` | `[]` | Quais pastas devem ativar este módulo. | ### Variáveis -| Variável | Exemplo | Descrição | -| --------- | -------- | ---------------------------------- | -| version | `v0.6.0` | A versão do `zig` | -| symbol | | Espelha o valor da opção `símbolo` | -| style\* | | Espelha o valor da opção `style` | +| Variável | Exemplo | Descrição | +| --------- | -------- | --------------------------------- | +| version | `v0.6.0` | The version of `zig` | +| 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 @@ -3337,97 +3411,97 @@ Por padrão o módulo `zig` exibe a versão atual instalada do [Zig](https://zig symbol = "⚡️ " ``` -## Comandos Personalizados +## Custom commands -O módulo `custom` exibe a saída de alguns comandos arbitrários. +The `custom` modules show the output of some arbitrary commands. -Este módulo vai ser exibir se algumas das condições a seguir for atendida: +These modules will be shown if any of the following conditions are met: -- O diretório atual tenha um arquivo cujo o nome esta em `files` -- O diretório atual tenha um diretório cujo o nome esta em `directories` -- O diretório atual tenha um arquivo com extensão que esteja em `extensions` -- O comando `when` retorna 0 -- O sistema operacional (std::env::consts::OS) corresponde com o `os` se definido. +- 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. ::: tip -Vários módulos personalizados podem ser definidos usando `.`. +Multiple custom modules can be defined by using a `.`. ::: ::: tip -A ordem em que o módulo custom é exibido pode ser definido individualmente incluindo `${custom.foo}` em nilve superior `format` (pois inclui um ponto, você precisa usar `${...}`). Por padrão, o módulo `custom` mostrará todos os módulos personalizados na ordem em que eles foram definidos. +The order in which custom modules are shown can be individually set by including `${custom.foo}` in the top level `format` (as it includes a dot, you need to use `${...}`). By default, the `custom` module will simply show all custom modules in the order they were defined. ::: ::: tip -A [Issue #1252](https://github.com/starship/starship/discussions/1252) contém exemplos de módulos personalizados. Se você tem um exemplo interessante que não esta coberto lá, sinta-se livre para compartilha-lo! +[Issue #1252](https://github.com/starship/starship/discussions/1252) contains examples of custom modules. If you have an interesting example not covered there, feel free to share it there! ::: -::: warning A saída do comando é exibido unescaped no prompt +::: warning Command output is printed unescaped to the prompt -Seja qual for a saída o comando irá gerar uma saída sem modificações no prompt. Isto siguinifica que a saída tenha sequencias especiais estas serão interpretadas pelo seu shell, elas serão expandidas quando exibidas. Estas sequencias especiais são especificas da shell, ex: você pode escrever um módulo de comando que escreve uma sequencia de bash, ex:. `\h`, mas este módulo não irá funcionar no shell fish ou zsh. +Whatever output the command generates is printed unmodified in the prompt. This means if the output contains special sequences that are interpreted by your shell they will be expanded when displayed. These special sequences are shell specific, e.g. you can write a command module that writes bash sequences, e.g. `\h`, but this module will not work in a fish or zsh shell. -Strings de formatação também podem conter sequencias de prompt especificas de shell, ex: [Bash](https://www.gnu.org/software/bash/manual/html_node/Controlling-the-Prompt.html), [Zsh](https://zsh.sourceforge.io/Doc/Release/Prompt-Expansion.html). +Format strings can also contain shell specific prompt sequences, e.g. [Bash](https://www.gnu.org/software/bash/manual/html_node/Controlling-the-Prompt.html), [Zsh](https://zsh.sourceforge.io/Doc/Release/Prompt-Expansion.html). ::: ### Opções -| Opções | Padrão | Descrição | -| ------------- | ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `command` | `""` | O comando cuja a saída deve ser exibida. O comando será passado no stdin para o shell. | -| `when` | | Um comando de shell usado como condição para exibir o módulo. O módulo será exibido se o comando retornar `0` como código de status. | -| `shell` | | [Veja abaixo](#custom-command-shell) | -| `description` | `""` | A descrição do módulo, isto será exibido quando executar `starship explain`. | -| `files` | `[]` | Os arquivos que serão buscados por correspondência no diretório atual. | -| `directories` | `[]` | Os diretórios que serão buscados por correspondência no diretório atual. | -| `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). | +| 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). | ### Variáveis -| Variável | Descrição | -| --------- | ---------------------------------- | -| output | A saída do comando no `shell` | -| symbol | Espelha o valor da opção `símbolo` | -| style\* | Espelha o valor da opção `style` | +| Variável | Descrição | +| --------- | -------------------------------------- | +| output | The output of shell command in `shell` | +| symbol | Espelha o valor da opção `symbol` | +| style\* | Espelha o valor da opção `style` | *: Esta variável só pode ser usada como parte de uma string de estilo #### Comandos personalizados de shell -`shell` aceita uma lista não vazia de string, onde: +`shell` accepts a non-empty list of strings, where: -- A primeira string é o caminho para o shell que executará o comando. -- Outros argumentos que serão passados para o shell. +- The first string is the path to the shell to use to execute the command. +- Other following arguments are passed to the shell. -Se não definido, ele retornará para o STARSHIP_SHELl e então para o "sh" no Linux e "cmd/C" no Windows. +If unset, it will fallback to STARSHIP_SHELL and then to "sh" on Linux, and "cmd /C" on Windows. -O `command` será passado no stdin. +The `command` will be passed in on stdin. -Se o `shell` não for dado ou apenas conter um elemento e o Starship detectar PowerShell ele será usado, os seguintes argumentos serão automaticamente adicionados: `-NoProfile -Command -`. Este comportamento pode ser evitado passando explicitamente argumento para o shell, ex. +If `shell` is not given or only contains one element and Starship detects PowerShell will be used, the following arguments will automatically be added: `-NoProfile -Command -`. This behavior can be avoided by explicitly passing arguments to the shell, e.g. ```toml shell = ["pwsh", "-Command", "-"] ``` -::: warning Tenha certeza que tenha uma configuração de shell +::: warning Make sure your custom shell configuration exits gracefully -Se você definir um comando personalizado, tenha certeza que o shell padrão usado pelo starship execute este comando com uma saída graciosa (via the `shell` option). +If you set a custom command, make sure that the default Shell used by starship will properly execute the command with a graceful exit (via the `shell` option). -Por exemplo, PowerShell requer o parâmetro `-Command` para executar um liner. Omitindo este parâmetro pode ser que o starship entre em um loop recursivo, onde o shell tente carrega um ambiente completo de perfil com o próprio starship novamente e portanto execute novamente o comando, entrando em um loop sem fim. +For example, PowerShell requires the `-Command` parameter to execute a one liner. Omitting this parameter might throw starship into a recursive loop where the shell might try to load a full profile environment with starship itself again and hence re-execute the custom command, getting into a never ending loop. -Parâmetros similares ao `-NoProfile` no PowerShell são recomendados para outras shells, bem como para evitar um tempo de carregamento maior toda vez que o starship for chamado. +Parameters similar to `-NoProfile` in PowerShell are recommended for other shells as well to avoid extra loading time of a custom profile on every starship invocation. -Detecção automática de shell e adição de parâmetros estão sendo implementados atualmente, mas é possível que nem todas as shells sejam cobertas. [Por favor abra uma issue](https://github.com/starship/starship/issues/new/choose) com detalhes do shell e configurações do starship se você acertar algum cenário. +Automatic detection of shells and proper parameters addition are currently implemented, but it's possible that not all shells are covered. [Please open an issue](https://github.com/starship/starship/issues/new/choose) with shell details and starship configuration if you hit such scenario. ::: diff --git a/docs/pt-BR/faq/README.md b/docs/pt-BR/faq/README.md index 8887da16..23522422 100644 --- a/docs/pt-BR/faq/README.md +++ b/docs/pt-BR/faq/README.md @@ -1,4 +1,4 @@ -# FAQ +# Frequently Asked Questions ## Qual é a configuração usada no GIF de demonstração? @@ -58,7 +58,7 @@ curl -sS https://starship.rs/install.sh | sh -s -- --platform unknown-linux-musl ## Porque eu vejo alertas de `Executing command "..." timed out.`? -O Starship executa comandos diferentes para recuperar as informações para exibir no prompt, por exemplo a versão de um programa ou o status atual do git. Para ter certeza de que o starship não travou durante uma execução destes comandos nos definimos um limite de tempo, se um comando ultrapassar este limite o starship vai parar a execução do comando e exibe o alerta acima, esse é um comportamento esperado. Este limite de tempo é configurado usando a [chave](/config/#prompt) `command_timeout` então se você quiser você pode aumentar este limite. Você pode também seguir os passos para debugar para ver qual comando esta demorando e se você pode otimizar ele. Finalmente você pode definir a variável de ambiente `STARSHIP_LOG` para `error` para esconder estes alertas. +O Starship executa comandos diferentes para recuperar as informações para exibir no prompt, por exemplo a versão de um programa ou o status atual do git. Para ter certeza de que o starship não travou durante uma execução destes comandos nos definimos um limite de tempo, se um comando ultrapassar este limite o starship vai parar a execução do comando e exibe o alerta acima, esse é um comportamento esperado. Este limite de tempo é configurado usando o [`command_timeout`key](/config/#prompt) então se você quiser você pode aumentar este limite. Você pode também seguir os passos para debugar para ver qual comando esta demorando e se você pode otimizar ele. Finalmente você pode definir a variável de ambiente `STARSHIP_LOG` para `error` para esconder estes alertas. ## Eu vejo símbolos que não entendo ou não esperado, o que isso significa? diff --git a/docs/pt-BR/guide/README.md b/docs/pt-BR/guide/README.md index 78eb0b10..4ab0a2d8 100644 --- a/docs/pt-BR/guide/README.md +++ b/docs/pt-BR/guide/README.md @@ -139,11 +139,13 @@ />

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

Starship com iTerm2 e o tema Snazzy @@ -158,7 +160,7 @@ - **Fácil:**Instalação rápida – comece a usar em minutos.

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

@@ -171,12 +173,12 @@ ### 1º passo. Instalar o Starship -Selecione seu sistema operacional na lista abaixo para ver as instruções de instalação: +Select your operating system from the list below to view installation instructions:
Android -Instale o Starship usando qualquer um dos seguintes gerenciadores de pacotes: +Install Starship using any of the following package managers: | Repositório | Instruções | | --------------------------------------------------------------------------------- | ---------------------- | @@ -187,7 +189,7 @@ Instale o Starship usando qualquer um dos seguintes gerenciadores de pacotes:
BSD -Instale o Starship usando qualquer um dos seguintes gerenciadores de pacotes: +Install Starship using any of the following package managers: | Distribuição | Repositório | Instruções | | -------------- | -------------------------------------------------------- | --------------------------------- | @@ -200,13 +202,13 @@ Instale o Starship usando qualquer um dos seguintes gerenciadores de pacotes:
Linux -Instale a versão mais recente no seu sistema: +Install the latest version for your system: ```sh curl -sS https://starship.rs/install.sh | sh ``` -Ou instale o Starship usando qualquer um dos seguintes gerenciadores de pacotes: +Alternatively, install Starship using any of the following package managers: | Distribuição | Repositório | Instruções | | ------------------ | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | @@ -229,13 +231,13 @@ Ou instale o Starship usando qualquer um dos seguintes gerenciadores de pacotes:
macOS -Instale a versão mais recente no seu sistema: +Install the latest version for your system: ```sh curl -sS https://starship.rs/install.sh | sh ``` -Ou instale o Starship usando qualquer um dos seguintes gerenciadores de pacotes: +Alternatively, install Starship using any of the following package managers: | Repositório | Instruções | | -------------------------------------------------------- | --------------------------------------- | @@ -249,7 +251,7 @@ Ou instale o Starship usando qualquer um dos seguintes gerenciadores de pacotes:
Windows -Instale o Starship usando qualquer um dos seguintes gerenciadores de pacotes: +Install Starship using any of the following package managers: | Repositório | Instruções | | -------------------------------------------------------------------------------- | --------------------------------------- | @@ -262,7 +264,7 @@ Instale o Starship usando qualquer um dos seguintes gerenciadores de pacotes: ### 2º passo. Configure seu shell para usar o Starship -Configure seu shell para inicializar o starship. Selecione o seu na lista abaixo: +Configure your shell to initialize starship. Select yours from the list below:
Bash @@ -278,7 +280,7 @@ eval "$(starship init bash)"
Cmd -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: +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: ```lua load(io.popen('starship init cmd'):read("*a"))() @@ -295,7 +297,7 @@ Adicione o comando a seguir ao final do arquivo `~/.elvish/rc.elv`: eval (starship init elvish) ``` -Nota: Somente o Elvish v0.17 + é suportado +Note: Only Elvish v0.17+ is supported
@@ -324,23 +326,28 @@ eval $(starship init ion)
Nushell -Adicione o seguinte no final da sua configuração Nushell (encontre executando o `config path`): +Run the following: -```toml -startup = [ - "mkdir ~/.cache/starship", - "starship init nu | save ~/.cache/starship/init.nu", - "source ~/.cache/starship/init.nu", -] -prompt = "starship_prompt" +```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`): + +```sh +starship init nu | save ~/.cache/starship/init.nu +source ~/.cache/starship/init.nu +``` + +Note: Only Nushell v0.60+ is supported +
PowerShell -Adicione o seguinte no final da sua configuração PowerShell (encontre executando `$PROFILE`): +Add the following to the end of your PowerShell configuration (find it by running `$PROFILE`): ```powershell Invoke-Expression (&starship init powershell) @@ -383,9 +390,9 @@ eval "$(starship init zsh)" ### 3º passo. Configurar o Starship -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! +Start a new shell instance, and you should see your beautiful new shell prompt. If you're happy with the defaults, enjoy! -Se você estiver procurando personalizar ainda mais a Starship: +If you're looking to further customize Starship: - **[Configuração](https://starship.rs/config/)** – saiba como configurar o Starship para ajustar seu prompt ao seu gosto @@ -393,15 +400,15 @@ Se você estiver procurando personalizar ainda mais a Starship: ## 🤝 Contribuindo -Nós estamos sempre procurando contribuidores de **todos os níveis de conhecimento**! Se você deseja facilitar seu caminho para o projeto, experimente uma [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). +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). -Se você é fluente em um idioma diferente do inglês, agradecemos qualquer ajuda para manter nossos documentos traduzidos e atualizados em outros idiomas. Se você quiser ajudar, as traduções podem ser contribuídas no [Crowdin do Starship](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. If you would like to help, translations can be contributed on the [Starship Crowdin](https://translate.starship.rs/). -Se você estiver interessado em ajudar a contribuir com starship, dê uma olhada em 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 do Discord](https://discord.gg/8Jzqu3T) e diga oi. 👋 +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. 👋 ## 💭 Inspirado por -Por favor, confira esses trabalhos anteriores que ajudaram a inspirar a criação do starship. 🙏 +Please check out these previous works that helped inspire the creation of starship. 🙏 - **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** – Um prompt ZSH para astronautas. @@ -411,9 +418,9 @@ Por favor, confira esses trabalhos anteriores que ajudaram a inspirar a criaçã


- Ícone de foguete do Starship + Starship rocket icon

## 📝 Licença -Copyright © 2019-presente, [Colaboradores Starship](https://github.com/starship/starship/graphs/contributors).
Este projeto é licenciado pelo [ISC](https://github.com/starship/starship/blob/master/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. diff --git a/docs/pt-BR/installing/README.md b/docs/pt-BR/installing/README.md index 88e80dc6..fb18a784 100644 --- a/docs/pt-BR/installing/README.md +++ b/docs/pt-BR/installing/README.md @@ -1,4 +1,4 @@ -# 🚀 Instalação avançada +# Advanced Installation 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 7ce417f5..9a9e1872 100644 --- a/docs/pt-BR/migrating-to-0.45.0/README.md +++ b/docs/pt-BR/migrating-to-0.45.0/README.md @@ -85,7 +85,7 @@ format = "took [$duration]($style) " | `style_success` | `success_symbol` | | `style_failure` | `error_symbol` | -**Alterações na Configuração Padrão** +**Alterações na configuração padrão** ```diff [character] @@ -109,7 +109,7 @@ Para configurar o prompt para usar a configuração antiga `use_symbol_for_statu error_symbol = "[✖](bold red)" ``` -_Nota:_ O elemento `charactere` adiciona automaticamente um espaço depois, portanto, ao contrário das outras strings de `format`, nós não adicionamos nos exemplos acima. +_Nota:_ O elemento `charactere` adiciona automaticamente um espaço depois do mesmo, portanto ao contrario strings `format`, nós não adicionamos o espaço nos exemplos acima. #### Tempo de execução do comando @@ -252,12 +252,12 @@ behind = "⇣${count}" #### Comandos Personalizados -| Remover Propriedade | Substituição | -| ------------------- | ------------ | -| `prefix` | `format` | -| `suffix` | `format` | +| Propriedades Removidas | Substituição | +| ---------------------- | ------------ | +| `prefix` | `format` | +| `suffix` | `format` | -**Alterações na configuração padrão** +**Alterações na Configuração Padrão** ```diff [custom.example] diff --git a/docs/pt-BR/presets/README.md b/docs/pt-BR/presets/README.md index 2a2fa3e3..5c9cd20a 100644 --- a/docs/pt-BR/presets/README.md +++ b/docs/pt-BR/presets/README.md @@ -4,32 +4,38 @@ Aqui tem uma coleção de predefinições de configuração criadas pela comunid To get details on how to use a preset, simply click on the image. -## [Símbolos Nerd Font](./nerd-font) +## [Símbolos Nerd Font](./nerd-font.md) This preset changes the symbols for each module to use Nerd Font symbols. [![Captura de tela da predefinição Nerd Font Symbols](/presets/img/nerd-font-symbols.png "Click to view Nerd Font Symbols preset")](./nerd-font) -## [Seguimentos entre colchetes](./bracketed-segments) +## [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.). [![Captura de tela de segmentos predefinidos](/presets/img/bracketed-segments.png "Click to view Bracketed Segments preset")](./bracketed-segments) -## [Símbolos de texto simples](./plain-text) +## [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. [![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) -## [No Runtime Versions](./no-runtimes) +## [No Runtime Versions](./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) -## [Pure Prompt](./pure-preset) +## [Pure Prompt](./pure-preset.md) Essa configuraçã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) + +## [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. + +[![Screenshot of Pastel Powerline preset](/presets/img/pastel-powerline.png "Click to view Pure Prompt preset")](./pastel-powerline) diff --git a/docs/pt-BR/presets/bracketed-segments.md b/docs/pt-BR/presets/bracketed-segments.md index 94d7d6a2..f767fdb3 100644 --- a/docs/pt-BR/presets/bracketed-segments.md +++ b/docs/pt-BR/presets/bracketed-segments.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#bracketed-segments) +[Return to Presets](./README.md#bracketed-segments) # Bracketed Segments Preset diff --git a/docs/pt-BR/presets/nerd-font.md b/docs/pt-BR/presets/nerd-font.md index fa583e0f..7e751610 100644 --- a/docs/pt-BR/presets/nerd-font.md +++ b/docs/pt-BR/presets/nerd-font.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#nerd-font-symbols) +[Return to Presets](./README.md#nerd-font-symbols) # Nerd Font Symbols Preset diff --git a/docs/pt-BR/presets/no-runtimes.md b/docs/pt-BR/presets/no-runtimes.md index 66f7935f..60d66062 100644 --- a/docs/pt-BR/presets/no-runtimes.md +++ b/docs/pt-BR/presets/no-runtimes.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#no-runtime-versions) +[Return to Presets](./README.md#no-runtime-versions) # No Runtime Versions Preset diff --git a/docs/pt-BR/presets/pastel-powerline.md b/docs/pt-BR/presets/pastel-powerline.md new file mode 100644 index 00000000..40f08d6d --- /dev/null +++ b/docs/pt-BR/presets/pastel-powerline.md @@ -0,0 +1,17 @@ +[Return to Presets](./README.md#pastel-powerline) + +# Pastel Powerline Preset + +This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). It also shows how path substitution works in starship. + +![Screenshot of Pastel Powerline preset](/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) + +### Configuração + +[Click to download 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 cac36123..b0f57986 100644 --- a/docs/pt-BR/presets/plain-text.md +++ b/docs/pt-BR/presets/plain-text.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#plain-text-symbols) +[Return to Presets](./README.md#plain-text-symbols) ## Plain Text Symbols Preset diff --git a/docs/pt-BR/presets/pure-preset.md b/docs/pt-BR/presets/pure-preset.md index bd97a656..6246c1e5 100644 --- a/docs/pt-BR/presets/pure-preset.md +++ b/docs/pt-BR/presets/pure-preset.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#pure) +[Return to Presets](./README.md#pure) # Pure Preset diff --git a/docs/pt-PT/README.md b/docs/pt-PT/README.md index 61f8dcec..3cd24a56 100644 --- a/docs/pt-PT/README.md +++ b/docs/pt-PT/README.md @@ -144,17 +144,19 @@ description: Starship is the minimal, blazing fast, and extremely customizable p #### Nushell - ::: warning This will change in the future. Only nu version v0.33 or higher is supported. ::: Add the following to your nu config file. You can check the location of this file by running `config path` in nu. - - ```toml - startup = [ - "mkdir ~/.cache/starship", - "starship init nu | save ~/.cache/starship/init.nu", - "source ~/.cache/starship/init.nu", - ] - prompt = "starship_prompt" + ::: warning This will change in the future. Only Nushell v0.60+ is supported. ::: Run the following: + ```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`): + + ```sh + mkdir ~/.cache/starship + starship init nu | save ~/.cache/starship/init.nu + source ~/.cache/starship/init.nu + ``` #### Xonsh diff --git a/docs/pt-PT/config/README.md b/docs/pt-PT/config/README.md index 5a2bd8a1..db6eac3f 100644 --- a/docs/pt-PT/config/README.md +++ b/docs/pt-PT/config/README.md @@ -198,6 +198,7 @@ $git_status\ $hg_branch\ $docker_context\ $package\ +$buf\ $cmake\ $cobol\ $container\ @@ -208,6 +209,7 @@ $elixir\ $elm\ $erlang\ $golang\ +$haskell\ $helm\ $java\ $julia\ @@ -261,7 +263,7 @@ format = "$all$directory$character" ## AWS -The `aws` module shows the current AWS region and profile when credentials or a `credential_process` 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. 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. @@ -278,6 +280,7 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL | `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. | @@ -308,6 +311,8 @@ symbol = "🅰 " [aws.region_aliases] ap-southeast-2 = "au" us-east-1 = "va" +[aws.profile_aliases] +CompanyGroupFrobozzOnCallAccess = 'Frobozz' ``` #### Display region @@ -333,6 +338,8 @@ us-east-1 = "va" format = "on [$symbol$profile]($style) " style = "bold blue" symbol = "🅰 " +[aws.profile_aliases] +Enterprise_Naming_Scheme-voidstars = 'void**' ``` ## Azure @@ -426,6 +433,45 @@ discharging_symbol = "💦" # when capacity is over 30%, the battery indicator will not be displayed ``` +## 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: + +- 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. + +### Options + +| Option | Default | Description | +| ------------------- | ------------------------------------------------------------ | ----------------------------------------------------- | +| `format` | `'with [$symbol($version \(Buf $buf_version\) )]($style)'` | The format for the `buf` module. | +| `version_format` | `"v${raw}"` | The version format. | +| `symbol` | `"🦬 "` | The symbol used before displaying the version of Buf. | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["buf.yaml", "buf.gen.yaml", "buf.work.yaml"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `style` | `"bold blue"` | The style for the module. | +| `disabled` | `false` | Disables the `elixir` module. | + +### Variables + +| Variable | Example | Description | +| ------------- | -------- | ------------------------------------ | +| `buf_version` | `v1.0.0` | The version of `buf` | +| `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 + +[buf] +symbol = "🦬 " +``` + ## Character The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. @@ -439,12 +485,6 @@ By default it only changes color. If you also want to change its shape take a lo ::: warning -`error_symbol` is not supported on nu shell. - -::: - -::: warning - `vicmd_symbol` is only supported in cmd, fish and zsh. ::: @@ -646,12 +686,12 @@ The `container` module displays a symbol and container name, if inside a contain ### Options -| Option | Default | Description | -| ---------- | ------------------------------------ | ----------------------------------------- | -| `symbol` | `"⬢"` | The symbol shown, when inside a container | -| `style` | `"bold red dimmed"` | The style for the module. | -| `format` | "[$symbol \\[$name\\]]($style) " | The format for the module. | -| `disabled` | `false` | Disables the `container` module. | +| Option | Default | Description | +| ---------- | -------------------------------------- | ----------------------------------------- | +| `symbol` | `"⬢"` | The symbol shown, when inside a container | +| `style` | `"bold red dimmed"` | The style for the module. | +| `format` | `"[$symbol \\[$name\\]]($style) "` | The format for the module. | +| `disabled` | `false` | Disables the `container` module. | ### Variables @@ -1007,7 +1047,7 @@ The `elm` module shows the currently installed version of [Elm](https://elm-lang - 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 -- The current directory contains a `*.elm` files +- The current directory contains `*.elm` files ### Options @@ -1259,6 +1299,7 @@ The `git_branch` module shows the active branch of the repo in your current dire | `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | | `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. | | `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | +| `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for "master" or "main". | | `disabled` | `false` | Disables the `git_branch` module. | ### Variables @@ -1282,6 +1323,7 @@ The `git_branch` module shows the active branch of the repo in your current dire symbol = "🌱 " truncation_length = 4 truncation_symbol = "" +ignore_branches = ["master", "main"] ``` ## Git Commit @@ -1547,6 +1589,39 @@ The `golang` module shows the currently installed version of [Go](https://golang format = "via [🏎💨 $version](bold cyan) " ``` +## Haskell + +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 +- The current directory contains any `.hs`, `.cabal`, or `.hs-boot` file + +### Options + +| Option | Default | Description | +| ------------------- | ------------------------------------ | -------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `symbol` | `"λ "` | A format string representing the symbol of Haskell | +| `detect_extensions` | `["hs", "cabal", "hs-boot"]` | Which extensions should trigger this module. | +| `detect_files` | `["stack.yaml", "cabal.project"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"bold purple"` | The style for the module. | +| `disabled` | `false` | Disables the `haskell` module. | + +### Variables + +| Variable | Example | Description | +| -------------- | ----------- | --------------------------------------------------------------------------------------- | +| version | | `ghc_version` or `snapshot` depending on whether the current project is a Stack project | +| snapshot | `lts-18.12` | Currently selected Stack snapshot | +| ghc\_version | `9.2.1` | Currently installed GHC version | +| 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 + ## 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: @@ -2137,21 +2212,21 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n - 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` extension +- The current directory contains a file with the `.ts`, `.mts` or `.cts` extension ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `" "` | A format string representing the symbol of Node.js. | -| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this module. | -| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. | -| `style` | `"bold green"` | The style for the module. | -| `disabled` | `false` | Disables the `nodejs` module. | -| `not_capable_style` | `bold red` | The style for the module when an engines property in package.json does not match the Node.js version. | +| Option | Default | Description | +| ------------------- | ------------------------------------------ | ----------------------------------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `" "` | A format string representing the symbol of Node.js. | +| `detect_extensions` | `["js", "mjs", "cjs", "ts", "mts", "cts"]` | Which extensions should trigger this module. | +| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. | +| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. | +| `style` | `"bold green"` | The style for the module. | +| `disabled` | `false` | Disables the `nodejs` module. | +| `not_capable_style` | `bold red` | The style for the module when an engines property in package.json does not match the Node.js version. | ### Variables @@ -2896,7 +2971,7 @@ format = '[📦 \[$env\]]($style) ' ## Status -The `status` module displays the exit code of the previous command. The module will be shown only if the exit code is not `0`. The status code will cast to a signed 32-bit integer. +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 @@ -2904,15 +2979,13 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y ::: -::: warning This module is not supported on nu shell. ::: - ### Options | Option | Default | Description | | ----------------------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------- | | `format` | `"[$symbol$status]($style) "` | The format of the module | | `symbol` | `"✖"` | The symbol displayed on program error | -| `success_symbol` | `"✔️"` | The symbol displayed on program success | +| `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) | @@ -2949,8 +3022,9 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y [status] style = "bg:blue" -symbol = "🔴" -format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) ' +symbol = "🔴 " +success_symbol = "🟢 SUCCESS" +format = '[\[$symbol$common_meaning$signal_name$maybe_int\]]($style) ' map_symbol = true disabled = false ``` diff --git a/docs/pt-PT/faq/README.md b/docs/pt-PT/faq/README.md index 19d26683..c3c797e7 100644 --- a/docs/pt-PT/faq/README.md +++ b/docs/pt-PT/faq/README.md @@ -1,4 +1,4 @@ -# FAQ +# Frequently Asked Questions ## What is the configuration used in the demo GIF? diff --git a/docs/pt-PT/guide/README.md b/docs/pt-PT/guide/README.md index b2f60db7..c2975840 100644 --- a/docs/pt-PT/guide/README.md +++ b/docs/pt-PT/guide/README.md @@ -139,6 +139,8 @@ />

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

Nushell -Add the following to the end of your Nushell configuration (find it by running `config path`): +Run the following: -```toml -startup = [ - "mkdir ~/.cache/starship", - "starship init nu | save ~/.cache/starship/init.nu", - "source ~/.cache/starship/init.nu", -] -prompt = "starship_prompt" +```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`): + +```sh +starship init nu | save ~/.cache/starship/init.nu +source ~/.cache/starship/init.nu +``` + +Note: Only Nushell v0.60+ is supported +
diff --git a/docs/pt-PT/installing/README.md b/docs/pt-PT/installing/README.md index c9957706..0ae67ad1 100644 --- a/docs/pt-PT/installing/README.md +++ b/docs/pt-PT/installing/README.md @@ -1,4 +1,4 @@ -# 🚀 Advanced Installation +# Advanced Installation To install starship, you need to do two things: diff --git a/docs/pt-PT/presets/README.md b/docs/pt-PT/presets/README.md index 12f5d20b..26c2314b 100644 --- a/docs/pt-PT/presets/README.md +++ b/docs/pt-PT/presets/README.md @@ -4,32 +4,38 @@ Here is a collection of community-submitted configuration presets for Starship. To get details on how to use a preset, simply click on the image. -## [Nerd Font Symbols](./nerd-font) +## [Nerd Font Symbols](./nerd-font.md) This preset changes the symbols for each module to use Nerd Font symbols. [![Screenshot of Nerd Font Symbols preset](/presets/img/nerd-font-symbols.png "Click to view Nerd Font Symbols preset")](./nerd-font) -## [Bracketed Segments](./bracketed-segments) +## [Bracketed Segments](./bracketed-segments.md) This preset changes the format of all the built-in modules to show their segment in brackets instead of using the default Starship wording ("via", "on", etc.). [![Screenshot of Bracketed Segments preset](/presets/img/bracketed-segments.png "Click to view Bracketed Segments preset")](./bracketed-segments) -## [Plain Text Symbols](./plain-text) +## [Plain Text Symbols](./plain-text.md) This preset changes the symbols for each module into plain text. Great if you don't have access to Unicode. [![Screenshot of Plain Text Symbols preset](/presets/img/plain-text-symbols.png "Click to view Plain Text Symbols preset")](./plain-text) -## [No Runtime Versions](./no-runtimes) +## [No Runtime Versions](./no-runtimes.md) This preset hides the version of language runtimes. If you work in containers or virtualized environments, this one is for you! [![Screenshot of Hide Runtime Versions preset](/presets/img/no-runtime-versions.png "Click to view No Runtime Versions preset")](./no-runtimes) -## [Pure Prompt](./pure-preset) +## [Pure Prompt](./pure-preset.md) This preset emulates the look and behavior of [Pure](https://github.com/sindresorhus/pure). [![Screenshot of Pure preset](/presets/img/pure-preset.png "Click to view Pure Prompt preset")](./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. + +[![Screenshot of Pastel Powerline preset](/presets/img/pastel-powerline.png "Click to view Pure Prompt preset")](./pastel-powerline) diff --git a/docs/pt-PT/presets/bracketed-segments.md b/docs/pt-PT/presets/bracketed-segments.md index 9b236714..9271a036 100644 --- a/docs/pt-PT/presets/bracketed-segments.md +++ b/docs/pt-PT/presets/bracketed-segments.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#bracketed-segments) +[Return to Presets](./README.md#bracketed-segments) # Bracketed Segments Preset diff --git a/docs/pt-PT/presets/nerd-font.md b/docs/pt-PT/presets/nerd-font.md index 82cedb19..c5810eff 100644 --- a/docs/pt-PT/presets/nerd-font.md +++ b/docs/pt-PT/presets/nerd-font.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#nerd-font-symbols) +[Return to Presets](./README.md#nerd-font-symbols) # Nerd Font Symbols Preset diff --git a/docs/pt-PT/presets/no-runtimes.md b/docs/pt-PT/presets/no-runtimes.md index 1815872d..fd305051 100644 --- a/docs/pt-PT/presets/no-runtimes.md +++ b/docs/pt-PT/presets/no-runtimes.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#no-runtime-versions) +[Return to Presets](./README.md#no-runtime-versions) # No Runtime Versions Preset diff --git a/docs/pt-PT/presets/pastel-powerline.md b/docs/pt-PT/presets/pastel-powerline.md new file mode 100644 index 00000000..4f067ac8 --- /dev/null +++ b/docs/pt-PT/presets/pastel-powerline.md @@ -0,0 +1,17 @@ +[Return to Presets](./README.md#pastel-powerline) + +# Pastel Powerline Preset + +This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). It also shows how path substitution works in starship. + +![Screenshot of Pastel Powerline preset](/presets/img/pastel-powerline.png) + +### Prerequisites + +- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (the example uses Caskaydia Cove Nerd Font) + +### Configuration + +[Click to download TOML](/presets/toml/pastel-powerline.toml) + +<<< @/.vuepress/public/presets/toml/pastel-powerline.toml diff --git a/docs/pt-PT/presets/plain-text.md b/docs/pt-PT/presets/plain-text.md index 12cb453e..49607e9a 100644 --- a/docs/pt-PT/presets/plain-text.md +++ b/docs/pt-PT/presets/plain-text.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#plain-text-symbols) +[Return to Presets](./README.md#plain-text-symbols) ## Plain Text Symbols Preset diff --git a/docs/pt-PT/presets/pure-preset.md b/docs/pt-PT/presets/pure-preset.md index 96a1b6a2..ad61b499 100644 --- a/docs/pt-PT/presets/pure-preset.md +++ b/docs/pt-PT/presets/pure-preset.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#pure) +[Return to Presets](./README.md#pure) # Pure Preset diff --git a/docs/ru-RU/README.md b/docs/ru-RU/README.md index f258cba0..dca0f4a9 100644 --- a/docs/ru-RU/README.md +++ b/docs/ru-RU/README.md @@ -144,17 +144,19 @@ description: Starship - минимальная, быстрая и бесконе #### Nushell - ::: warning Это будет изменено. Поддерживается только nu версии v0.33 или выше. ::: Добавьте следующее в свой конфигурационный файл nu. Вы можете узнать расположение этого файла, выполнив `config path` в nu. - - ```toml - startup = [ - "mkdir ~/.cache/starship", - "starship init nu | save ~/.cache/starship/init.nu", - "source ~/.cache/starship/init.nu", - ] - prompt = "starship_prompt" + ::: warning Это будет изменено. Only Nushell v0.60+ is supported. ::: Run the following: + ```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`): + + ```sh + mkdir ~/.cache/starship + starship init nu | save ~/.cache/starship/init.nu + source ~/.cache/starship/init.nu + ``` #### Xonsh diff --git a/docs/ru-RU/config/README.md b/docs/ru-RU/config/README.md index cc11a4b7..45f47dd9 100644 --- a/docs/ru-RU/config/README.md +++ b/docs/ru-RU/config/README.md @@ -198,6 +198,7 @@ $git_status\ $hg_branch\ $docker_context\ $package\ +$buf\ $cmake\ $cobol\ $container\ @@ -208,6 +209,7 @@ $elixir\ $elm\ $erlang\ $golang\ +$haskell\ $helm\ $java\ $julia\ @@ -261,7 +263,7 @@ format = "$all$directory$character" ## AWS -The `aws` module shows the current AWS region and profile when credentials or a `credential_process` 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. Основано на `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. @@ -278,9 +280,10 @@ 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` | Отключение модуля `AWS`. | +| `disabled` | `false` | Disables the `AWS` module. | ### Переменные @@ -308,6 +311,8 @@ symbol = "🅰 " [aws.region_aliases] ap-southeast-2 = "au" us-east-1 = "va" +[aws.profile_aliases] +CompanyGroupFrobozzOnCallAccess = 'Frobozz' ``` #### Отобразить регион @@ -333,6 +338,8 @@ us-east-1 = "va" format = "on [$symbol$profile]($style) " style = "bold blue" symbol = "🅰 " +[aws.profile_aliases] +Enterprise_Naming_Scheme-voidstars = 'void**' ``` ## Azure @@ -426,11 +433,50 @@ discharging_symbol = "💦" # when capacity is over 30%, the battery indicator will not be displayed ``` +## 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: + +- 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. + +### Опции + +| Параметр | По умолчанию | Описание | +| ------------------- | ------------------------------------------------------------ | ----------------------------------------------------- | +| `format` | `'with [$symbol($version \(Buf $buf_version\) )]($style)'` | The format for the `buf` module. | +| `version_format` | `"v${raw}"` | The version format. | +| `symbol` | `"🦬 "` | The symbol used before displaying the version of Buf. | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["buf.yaml", "buf.gen.yaml", "buf.work.yaml"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `style` | `"bold blue"` | Стиль модуля. | +| `disabled` | `false` | Disables the `elixir` module. | + +### Переменные + +| Переменная | Пример | Описание | +| ------------- | -------- | ------------------------------------ | +| `buf_version` | `v1.0.0` | The version of `buf` | +| `symbol` | | Отражает значение параметра `symbol` | +| `style`* | | Отражает значение параметра `style` | + +*: Эта переменная может использоваться только в качестве части строки style + +### Пример + +```toml +# ~/.config/starship.toml + +[buf] +symbol = "🦬 " +``` + ## Символ -Модуль `character` показывает символ (обычно, стрелка) рядом с вводимым текстом в терминале. +The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. -Символ показывает, была ли последняя команда успешной или нет. It can do this in two ways: +The character will tell you whether the last command was successful or not. It can do this in two ways: - changing color (`red`/`green`) - changing shape (`❯`/`✖`) @@ -439,12 +485,6 @@ By default it only changes color. If you also want to change its shape take a lo ::: warning -`error_symbol` is not supported on nu shell. - -::: - -::: warning - `vicmd_symbol` is only supported in cmd, fish and zsh. ::: @@ -457,7 +497,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` | Отключает модуль `character`. | +| `disabled` | `false` | Disables the `character` module. | ### Переменные @@ -558,25 +598,25 @@ The `cobol` module shows the currently installed version of COBOL. By default, t ## Длительность команды -Модуль `cmd_duration` показывает время исполнения последней команды. Модуль будет показан только, если команда заняла более двух секунд, или если задан параметр `min_time`. +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. -::: предупреждение Не подключайте ловушку DEBUG к Bash +::: warning Do not hook the DEBUG trap in Bash -Если вы испоьзуете Starship в `bash`, не подключайте ловушку `DEBUG` после запуска `eval $(starship init $0)`, иначе этот модуль сломается. +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, которым нужна функциональность, подобная preexec, могут использовать [фреймворк bash_preexec от rcaloras](https://github.com/rcaloras/bash-preexec). Просто определите массивы `preexec_functions` и `precmd_functions` перед запуском `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. ### Опции | Параметр | По умолчанию | Описание | | ---------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `min_time` | `2_000` | Кратчайшая продолжительность для показа времени (в миллисекундах). | -| `show_milliseconds` | `false` | Показывать миллисекунды в дополнение к секундам в продолжительности. | +| `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) "` | Формат модуля. | | `style` | `"bold yellow"` | Стиль модуля. | -| `disabled` | `false` | Отключает модуль `cmd_duration`. | +| `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. | @@ -600,26 +640,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 -Это не подавляет модификатор командной строки самой conda. Возможно, вы захотите запустить `conda config --set changeps1 False`. +This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. ::: ### Опции -| Параметр | По умолчанию | Описание | -| ------------------- | -------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -| `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`. | +| Параметр | По умолчанию | Описание | +| ------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| `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. | ### Переменные @@ -646,12 +686,12 @@ 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"` | Стиль модуля. | -| `format` | "[$symbol \\[$name\\]]($style) " | Формат модуля. | -| `disabled` | `false` | Disables the `container` module. | +| Параметр | По умолчанию | Описание | +| ---------- | -------------------------------------- | ----------------------------------------- | +| `symbol` | `"⬢"` | The symbol shown, when inside a container | +| `style` | `"bold red dimmed"` | Стиль модуля. | +| `format` | `"[$symbol \\[$name\\]]($style) "` | Формат модуля. | +| `disabled` | `false` | Disables the `container` module. | ### Переменные @@ -676,21 +716,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: -- Текущий каталог содержит файл `shard.yml` -- Текущий каталог содержит файл `.cr` +- The current directory contains a `shard.yml` file +- The current directory contains a `.cr` file ### Опции | Параметр | По умолчанию | Описание | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `symbol` | `"🔮 "` | Символ, используемый перед отображением версии crystal. | +| `symbol` | `"🔮 "` | The symbol used before displaying the version of 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` | Отключает модуль `crystal`. | +| `disabled` | `false` | Disables the `crystal` module. | ### Переменные @@ -789,21 +829,21 @@ format = "via [🦕 $version](green bold) " ## Каталог -Модуль `directory` показывает путь к вашей текущей директории, усеченной до трех родительских папок. Ваш каталог также будет отсечен до корня git репозитория, в котором вы находитесь. +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. -При использовании стиля оболочки fish, вместо скрытия усеченного каталога, вы увидите укороченное имя каталога, зависимое от числа символов вы установите для этой опции. +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. -Например, возьмем `~/Dev/Nix/nixpkgs/pkgs` где `nixpkgs` является корневым репозиторием, и в опции установлено `1`. Вы увидите `~/D/N/nixpkgs/pkgs`, а до этого было бы `nixpkgs/pkgs`. +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`. ### Опции | Параметр | По умолчанию | Описание | | ------------------- | ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `truncation_length` | `3` | Количество родительских папок, к которым должен быть усечен текущий каталог. | -| `truncate_to_repo` | `true` | Следует или нет обрезать до корня репозитория git, в котором вы находитесь. | +| `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) "` | Формат модуля. | | `style` | `"bold cyan"` | Стиль модуля. | -| `disabled` | `false` | Отключает модуль `directory`. | +| `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: "…/" | @@ -813,12 +853,12 @@ format = "via [🦕 $version](green bold) " | `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` | Количество символов, используемых при использовании логики создания пути из fish. | +| `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. | `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. @@ -829,7 +869,7 @@ format = "via [🦕 $version](green bold) " "src/com/long/java/path" = "mypath" ``` -`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`. +`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`.
@@ -867,7 +907,7 @@ truncation_length = 8 truncation_symbol = "…/" ``` -## Контекст Docker +## 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). @@ -905,7 +945,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. Если SDK был закреплен в текущей директории, будет показана закрепленная версия. В противном случае модуль отображает последнюю установленную версию SDK. +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. 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: @@ -920,7 +960,7 @@ 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. -Внутренне этот модуль использует свой собственный механизм определения версий. Обычно он в два раза быстрее, чем `dotnet --version`, но он может показывать неправильную версию, если ваш .NET проект имеет необычный формат каталога. Если точность важнее, чем скорость, вы можете отключить механизм опцией `heuristic = false` в настройках модуля. +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. @@ -930,13 +970,13 @@ The module will also show the Target Framework Moniker ([\\w-]+)" = "gke-$var_cluster" ``` -## Перевод Строки +## Line Break -Модуль `line_break` разделяет командную строку на две строки. +The `line_break` module separates the prompt into two lines. ### Опции -| Параметр | По умолчанию | Описание | -| ---------- | ------------ | ------------------------------------------------------------------------ | -| `disabled` | `false` | Отключает модуль `line_break`, отображая командную строку в одну строку. | +| Параметр | По умолчанию | Описание | +| ---------- | ------------ | ------------------------------------------------------------------ | +| `disabled` | `false` | Disables the `line_break` module, making the prompt a single line. | ### Пример @@ -1965,27 +2040,27 @@ The `lua` module shows the currently installed version of [Lua](http://www.lua.o format = "via [🌕 $version](bold blue) " ``` -## Использование памяти +## Memory Usage -Модуль `memory_usage` отображает текущую системную память и использование подкачки. +The `memory_usage` module shows current system memory and swap usage. -По умолчанию использование подкачки отображается, если общая сумма подкачки системы не равна нулю. +By default the swap usage is displayed if the total system swap is non-zero. -::: tip Подсказка +::: tip -По умолчанию этот модуль отключен. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### Опции -| Параметр | По умолчанию | Описание | -| ----------- | ----------------------------------------------- | ------------------------------------------------------------------ | -| `threshold` | `75` | Скрывать использование памяти, если она не превышает этот процент. | -| `format` | `"via $symbol [${ram}( \| ${swap})]($style) "` | Формат модуля. | -| `symbol` | `"🐏"` | Символ, используемый перед отображением использования памяти. | -| `style` | `"bold dimmed white"` | Стиль модуля. | -| `disabled` | `true` | Отключает модуль `memory_usage`. | +| Параметр | По умолчанию | Описание | +| ----------- | ----------------------------------------------- | -------------------------------------------------------- | +| `threshold` | `75` | Hide the memory usage unless it exceeds this percentage. | +| `format` | `"via $symbol [${ram}( \| ${swap})]($style) "` | Формат модуля. | +| `symbol` | `"🐏"` | The symbol used before displaying the memory usage. | +| `style` | `"bold dimmed white"` | Стиль модуля. | +| `disabled` | `true` | Disables the `memory_usage` module. | ### Переменные @@ -2012,20 +2087,20 @@ symbol = " " style = "bold dimmed green" ``` -## Ветка Mercurial +## Mercurial Branch -Модуль `hg_branch` показывает активную ветку репозитория в вашем текущем каталоге. +The `hg_branch` module shows the active branch of the repo in your current directory. ### Опции -| Параметр | По умолчанию | Описание | -| ------------------- | -------------------------------- | ---------------------------------------------------------------------------------------- | -| `symbol` | `" "` | Символ, используемый перед закладкой hg или именем ветки репозитория в текущем каталоге. | -| `style` | `"bold purple"` | Стиль модуля. | -| `format` | `"on [$symbol$branch]($style) "` | Формат модуля. | -| `truncation_length` | `2^63 - 1` | Truncates the hg branch name to `N` graphemes | -| `truncation_symbol` | `"…"` | Символ, используемый для обозначения усечения названия ветки. | -| `disabled` | `true` | Отключает модуль `hg_branch`. | +| Параметр | По умолчанию | Описание | +| ------------------- | -------------------------------- | -------------------------------------------------------------------------------------------- | +| `symbol` | `" "` | The symbol used before the hg bookmark or branch name of the repo in your current directory. | +| `style` | `"bold purple"` | Стиль модуля. | +| `format` | `"on [$symbol$branch]($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. | ### Переменные @@ -2052,7 +2127,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: -- Текущий каталог содержит файл `nim.cfg` +- 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 @@ -2061,7 +2136,7 @@ The `nim` module shows the currently installed version of [Nim](https://nim-lang | Параметр | По умолчанию | Описание | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | Формат модуля | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `symbol` | `"👑 "` | The symbol used before displaying the version of Nim. | | `detect_extensions` | `["nim", "nims", "nimble"]` | Which extensions should trigger this module. | @@ -2092,7 +2167,7 @@ symbol = "🎣 " ## Nix-shell -The `nix_shell` module shows the [nix-shell](https://nixos.org/guides/nix-pills/developing-with-nix-shell.html) environment. Модуль будет показываться внутри среды nix-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. ### Опции @@ -2103,7 +2178,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` | Отключает модуль `nix_shell`. | +| `disabled` | `false` | Disables the `nix_shell` module. | ### Переменные @@ -2132,26 +2207,26 @@ 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: -- Текущий каталог содержит файл `package.json` +- The current directory contains a `package.json` file - The current directory contains a `.node-version` file - The current directory contains a `.nvmrc` file -- Текущий каталог содержит каталог `node_modules` +- 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` extension +- The current directory contains a file with the `.ts`, `.mts` or `.cts` extension ### Опции -| Параметр | По умолчанию | Описание | -| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | -| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `" "` | A format string representing the symbol of Node.js. | -| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this module. | -| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. | -| `style` | `"bold green"` | Стиль модуля. | -| `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. | +| Параметр | По умолчанию | Описание | +| ------------------- | ------------------------------------------ | ----------------------------------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `" "` | A format string representing the symbol of Node.js. | +| `detect_extensions` | `["js", "mjs", "cjs", "ts", "mts", "cts"]` | Which extensions should trigger this module. | +| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. | +| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. | +| `style` | `"bold green"` | Стиль модуля. | +| `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. | ### Переменные @@ -2254,9 +2329,9 @@ style = "bold yellow" symbol = "☁️ " ``` -## Версия пакета +## Package Version -Модуль `package` отображается, когда текущий каталог является репозиторием для пакета и показывает его текущую версию. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `composer`, `gradle`, `julia`, `mix`, `helm`, `shards` and `dart` packages. +The `package` module is shown when the current directory is the repository for a package, and shows its current version. The module currently supports `npm`, `nimble`, `cargo`, `poetry`, `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 @@ -2282,11 +2357,11 @@ symbol = "☁️ " | Параметр | По умолчанию | Описание | | ----------------- | --------------------------------- | ------------------------------------------------------------------------- | | `format` | `"is [$symbol$version]($style) "` | Формат модуля. | -| `symbol` | `"📦 "` | Символ, используемый перед отображением версии пакета. | +| `symbol` | `"📦 "` | The symbol used before displaying the version the package. | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `style` | `"bold 208"` | Стиль модуля. | | `display_private` | `false` | Enable displaying version for packages marked as private. | -| `disabled` | `false` | Отключает модуль `package`. | +| `disabled` | `false` | Disables the `package` module. | ### Переменные @@ -2351,8 +2426,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: -- Текущий каталог содержит файл `composer.json` -- Текущий каталог содержит файл `.php-version` +- The current directory contains a `composer.json` file +- The current directory contains a `.php-version` file - The current directory contains a `.php` extension ### Опции @@ -2361,12 +2436,12 @@ The `php` module shows the currently installed version of [PHP](https://www.php. | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | | `format` | `"via [$symbol($version )]($style)"` | Формат модуля. | | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `"🐘 "` | Символ, используемый перед отображением версии PHP. | +| `symbol` | `"🐘 "` | The symbol used before displaying the version of PHP. | | `detect_extensions` | `["php"]` | Which extensions should trigger this module. | | `detect_files` | `["composer.json", ".php-version"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"147 bold"` | Стиль модуля. | -| `disabled` | `false` | Отключает модуль `php`. | +| `disabled` | `false` | Disables the `php` module. | ### Переменные @@ -2391,7 +2466,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). @@ -2414,13 +2489,13 @@ By default the module will be shown if any of the following conditions are met: ### Переменные -| Переменная | Пример | Описание | -| ---------------- | ---------- | ------------------------------------ | -| version | `v0.12.24` | The version of `pulumi` | -| stack | `dev` | The current Pulumi stack | -| имя пользователя | `alice` | The current Pulumi username | -| symbol | | Отражает значение параметра `symbol` | -| style\* | | Отражает значение параметра `style` | +| Переменная | Пример | Описание | +| ---------- | ---------- | ------------------------------------ | +| version | `v0.12.24` | The version of `pulumi` | +| stack | `dev` | The current Pulumi stack | +| username | `alice` | The current Pulumi username | +| symbol | | Отражает значение параметра `symbol` | +| style\* | | Отражает значение параметра `style` | *: Эта переменная может использоваться только в качестве части строки style @@ -2448,7 +2523,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: -- Текущий каталог содержит файл `spago.dhall` +- The current directory contains a `spago.dhall` file - The current directory contains a file with the `.purs` extension ### Опции @@ -2491,15 +2566,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: -- Текущий каталог содержит файл `.python-version` -- Текущий каталог содержит файл `Pipfile` +- The current directory contains a `.python-version` file +- The current directory contains a `Pipfile` file - The current directory contains a `__init__.py` file -- Текущий каталог содержит файл `pyproject.toml` -- Текущий каталог содержит файл `requirements.txt` -- Текущий каталог содержит файл `setup.py` -- Текущий каталог содержит файл `tox.ini` -- Текущий каталог содержит файл с расширением `.py`. -- Виртуальная среда в данный момент активирована +- 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 ### Опции @@ -2509,7 +2584,7 @@ By default the module will be shown if any of the following conditions are met: | `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | | `symbol` | `"🐍 "` | A format string representing the symbol of Python | | `style` | `"yellow bold"` | Стиль модуля. | -| `pyenv_version_name` | `false` | Использовать pyenv для получения версии Python | +| `pyenv_version_name` | `false` | Use pyenv to get Python version | | `pyenv_prefix` | `pyenv` | Prefix before pyenv version display, only used if pyenv is used | | `python_binary` | `["python", "python3", "python2"]` | Configures the python binaries that Starship should executes when getting the version. | | `detect_extensions` | `["py"]` | Which extensions should trigger this module | @@ -2517,7 +2592,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. @@ -2656,9 +2731,9 @@ symbol = "🔴 " By default the `ruby` module shows the currently installed version of [Ruby](https://www.ruby-lang.org/). Модуль будет показан, если любое из следующих условий соблюдено: -- Текущий каталог содержит файл `Gemfile` -- Текущий каталог содержит файл `.ruby-version` -- Текущий каталог содержит файл `.rb` +- 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 Starship gets the current Ruby version by running `ruby -v`. @@ -2675,7 +2750,7 @@ Starship gets the current Ruby version by running `ruby -v`. | `detect_folders` | `[]` | Which folders should trigger this module. | | `detect_variables` | `["RUBY_VERSION", "RBENV_VERSION"]` | Which environment variables should trigger this module. | | `style` | `"bold red"` | Стиль модуля. | -| `disabled` | `false` | Отключает модуль `ruby`. | +| `disabled` | `false` | Disables the `ruby` module. | ### Переменные @@ -2700,8 +2775,8 @@ symbol = "🔺 " By default the `rust` module shows the currently installed version of [Rust](https://www.rust-lang.org/). Модуль будет показан, если любое из следующих условий соблюдено: -- Текущий каталог содержит файл `Cargo.toml` -- Текущий каталог содержит файл с расширением `.rs` +- The current directory contains a `Cargo.toml` file +- The current directory contains a file with the `.rs` extension ### Опции @@ -2714,7 +2789,7 @@ By default the `rust` module shows the currently installed version of [Rust](htt | `detect_files` | `["Cargo.toml"]` | Which filenames should trigger this module. | | `detect_folders` | `[]` | Which folders should trigger this module. | | `style` | `"bold red"` | Стиль модуля. | -| `disabled` | `false` | Отключает модуль `rust`. | +| `disabled` | `false` | Disables the `rust` module. | ### Переменные @@ -2779,9 +2854,9 @@ symbol = "🌟 " The `shell` module shows an indicator for currently used shell. -::: tip Подсказка +::: tip -По умолчанию этот модуль отключен. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -2809,7 +2884,7 @@ The `shell` module shows an indicator for currently used shell. | Переменная | По умолчанию | Описание | | ---------- | ------------ | ---------------------------------------------------------- | | indicator | | Mirrors the value of `indicator` for currently used shell. | -| style\* | | Отражает значение параметра `style`. | +| style\* | | Mirrors the value of option `style`. | *: Эта переменная может использоваться только в качестве части строки style @@ -2896,23 +2971,21 @@ format = '[📦 \[$env\]]($style) ' ## Status -The `status` module displays the exit code of the previous command. The module will be shown only if the exit code is not `0`. The status code will cast to a signed 32-bit integer. +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 -По умолчанию этот модуль отключен. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: -::: warning This module is not supported on nu shell. ::: - ### Опции | Параметр | По умолчанию | Описание | | ----------------------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------- | | `format` | `"[$symbol$status]($style) "` | The format of the module | | `symbol` | `"✖"` | The symbol displayed on program error | -| `success_symbol` | `"✔️"` | The symbol displayed on program success | +| `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) | @@ -2949,8 +3022,9 @@ The `status` module displays the exit code of the previous command. The module w [status] style = "bg:blue" -symbol = "🔴" -format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) ' +symbol = "🔴 " +success_symbol = "🟢 SUCCESS" +format = '[\[$symbol$common_meaning$signal_name$maybe_int\]]($style) ' map_symbol = true disabled = false ``` @@ -2959,9 +3033,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 -По умолчанию этот модуль отключен. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: @@ -3047,7 +3121,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). @@ -3055,7 +3129,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: -- Текущий каталог содержит папку `.terraform` +- The current directory contains a `.terraform` folder - Current directory contains a file with the `.tf`, `.tfplan` or `.tfstate` extensions ### Опции @@ -3069,7 +3143,7 @@ By default the module will be shown if any of the following conditions are met: | `detect_files` | `[]` | Which filenames should trigger this module. | | `detect_folders` | `[".terraform"]` | Which folders should trigger this module. | | `style` | `"bold 105"` | Стиль модуля. | -| `disabled` | `false` | Отключает модуль `terraform`. | +| `disabled` | `false` | Disables the `terraform` module. | ### Переменные @@ -3104,33 +3178,33 @@ format = "[🏎💨 $workspace]($style) " ## Время -Модуль `time` показывает текущее **локальное** время. Значение конфигурации `format` используется пакетом [`chrono`](https://crates.io/crates/chrono) для контроля того, как отображается время. Ознакомьтесь с [документацией chrono strftime](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html), чтобы увидеть доступные параметры. +The `time` module shows the current **local** time. The `format` configuration value is used by the [`chrono`](https://crates.io/crates/chrono) crate to control how the time is displayed. Take a look [at the chrono strftime docs](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) to see what options are available. -::: tip Подсказка +::: tip -По умолчанию этот модуль отключен. Чтобы включить его, установите `disabled` на `false` в файле конфигурации. +This module is disabled by default. To enable it, set `disabled` to `false` in your configuration file. ::: ### Опции -| Параметр | По умолчанию | Описание | -| ----------------- | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `format` | `"at [$time]($style) "` | The format string for the module. | -| `use_12hr` | `false` | Включить 12-часовое форматирование | -| `time_format` | см. ниже | [Строка формата chrono](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html), используемая для форматирования времени. | -| `style` | `"bold yellow"` | Стиль модуля времени | -| `utc_time_offset` | `"local"` | Устанавливает смещение UTC. Range from -24 < x < 24. Разрешает числам с плавающей точкой встраивать 30/45-минутное смещение временной зоны. | -| `disabled` | `true` | Отключает модуль `time`. | -| `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | +| Параметр | По умолчанию | Описание | +| ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------- | +| `format` | `"at [$time]($style) "` | The format string for the module. | +| `use_12hr` | `false` | Enables 12 hour formatting | +| `time_format` | see below | The [chrono format string](https://docs.rs/chrono/0.4.7/chrono/format/strftime/index.html) used to format the time. | +| `style` | `"bold yellow"` | The style for the module time | +| `utc_time_offset` | `"local"` | Sets the UTC offset to use. Range from -24 < x < 24. Allows floats to accommodate 30/45 minute timezone offsets. | +| `disabled` | `true` | Disables the `time` module. | +| `time_range` | `"-"` | Sets the time range during which the module will be shown. Times must be specified in 24-hours format | -If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Иначе по умолчанию используется `"%T"`. Manually setting `time_format` will override the `use_12hr` setting. +If `use_12hr` is `true`, then `time_format` defaults to `"%r"`. Otherwise, it defaults to `"%T"`. Manually setting `time_format` will override the `use_12hr` setting. ### Переменные | Переменная | Пример | Описание | | ---------- | ---------- | ----------------------------------- | -| время | `13:08:10` | The current time. | +| time | `13:08:10` | The current time. | | style\* | | Отражает значение параметра `style` | *: Эта переменная может использоваться только в качестве части строки style @@ -3148,16 +3222,16 @@ utc_time_offset = "-5" time_range = "10:00:00-14:00:00" ``` -## Имя пользователя +## Username -Модуль `username` показывает имя активного пользователя. Модуль будет показан, если любое из следующих условий соблюдено: +The `username` module shows active user's username. Модуль будет показан, если любое из следующих условий соблюдено: -- Текущий пользователь - root -- Текущий пользователь отличается от залогиненного -- Пользователь подключен к SSH-сессии -- Переменная `show_always` равна true +- 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 -::: 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. @@ -3165,13 +3239,13 @@ SSH connection is detected by checking environment variables `SSH_CONNECTION`, ` ### Опции -| Параметр | По умолчанию | Описание | -| ------------- | ----------------------- | ------------------------------------------------------- | -| `style_root` | `"bold red"` | Стиль, используемый для пользователя root. | -| `style_user` | `"bold yellow"` | Стиль, используемый для всех пользователей, кроме root. | -| `format` | `"[$user]($style) in "` | Формат модуля. | -| `show_always` | `false` | Всегда показывать модуль `username`. | -| `disabled` | `false` | Отключает модуль `username`. | +| Параметр | По умолчанию | Описание | +| ------------- | ----------------------- | ------------------------------------- | +| `style_root` | `"bold red"` | The style used when the user is root. | +| `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. | ### Переменные @@ -3349,19 +3423,19 @@ These modules will be shown if any of the following conditions are met: - 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! @@ -3382,7 +3456,7 @@ Format strings can also contain shell specific prompt sequences, e.g. [Bash](htt | `command` | `""` | The command whose output should be printed. The command will be passed on stdin to the shell. | | `when` | | 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) | -| `описание` | `""` | The description of the module that is shown when running `starship explain`. | +| `description` | `""` | The description of the module that is shown when running `starship explain`. | | `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. | diff --git a/docs/ru-RU/faq/README.md b/docs/ru-RU/faq/README.md index 15892486..b8c56ab1 100644 --- a/docs/ru-RU/faq/README.md +++ b/docs/ru-RU/faq/README.md @@ -1,4 +1,4 @@ -# FAQ +# Frequently Asked Questions ## Какая конфигурация используется в демо-GIF? diff --git a/docs/ru-RU/guide/README.md b/docs/ru-RU/guide/README.md index 7242ec73..5282e706 100644 --- a/docs/ru-RU/guide/README.md +++ b/docs/ru-RU/guide/README.md @@ -2,7 +2,7 @@ Starship - меж-оболочная командная строка

@@ -10,7 +10,7 @@ Статус GitHub Actions Статус упаковки

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

Starship в iTerm2 с темой Snazzy @@ -158,7 +160,7 @@ - **Легкая:** быстрая установка - начните использовать ее в считанные минуты.

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

@@ -324,17 +326,22 @@ eval $(starship init ion)
Nushell -Add the following to the end of your Nushell configuration (find it by running `config path`): +Run the following: -```toml -startup = [ - "mkdir ~/.cache/starship", - "starship init nu | save ~/.cache/starship/init.nu", - "source ~/.cache/starship/init.nu", -] -prompt = "starship_prompt" +```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`): + +```sh +starship init nu | save ~/.cache/starship/init.nu +source ~/.cache/starship/init.nu +``` + +Note: Only Nushell v0.60+ is supported +
@@ -393,15 +400,15 @@ If you're looking to further customize Starship: ## 🤝 Помощь -Мы всегда ищем помощников **всех уровней навыков**! Если вы хотите облегчить свой путь к проекту, попробуйте [хорошие первые задачи](https://github.com/starship/starship/labels/🌱%20good%20first%20issue). +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). -Если Вы свободно владеете иностранным языком отличным от английского, мы высоко оценим любую помощь в переводе нашей документации на другие языки и поддержании ее в актуальном состоянии. Если вы хотите помочь, переводы могут быть сделаны на платформе [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. If you would like to help, translations can be contributed on the [Starship Crowdin](https://translate.starship.rs/). -Если вы хотите помочь в создании Starship, пожалуйста, ознакомьтесь с нашим [Руководством по содействию](https://github.com/starship/starship/blob/master/CONTRIBUTING.md). Кроме того, заходите на наш [Discord сервер](https://discord.gg/8Jzqu3T) и поздоровайтесь. 👋 +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. 🙏 +Please check out these previous works that helped inspire the creation of starship. 🙏 - **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** – A ZSH prompt for astronauts. @@ -411,9 +418,9 @@ If you're looking to further customize Starship:


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

## 📝 Лицензия -Авторское право © 2019-настоящее, [Starship Contributors](https://github.com/starship/starship/graphs/contributors).
Этот проект [ISC](https://github.com/starship/starship/blob/master/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. diff --git a/docs/ru-RU/installing/README.md b/docs/ru-RU/installing/README.md index aea64723..09aabc3a 100644 --- a/docs/ru-RU/installing/README.md +++ b/docs/ru-RU/installing/README.md @@ -1,4 +1,4 @@ -# 🚀 Advanced Installation +# Advanced Installation To install starship, you need to do two things: diff --git a/docs/ru-RU/presets/README.md b/docs/ru-RU/presets/README.md index a8cd5382..5c66c31e 100644 --- a/docs/ru-RU/presets/README.md +++ b/docs/ru-RU/presets/README.md @@ -4,32 +4,38 @@ To get details on how to use a preset, simply click on the image. -## [Символы Шрифта Nerd Font](./nerd-font) +## [Символы Шрифта Nerd Font](./nerd-font.md) This preset changes the symbols for each module to use Nerd Font symbols. [![Скриншот предустановки Nerd Font Symbols](/presets/img/nerd-font-symbols.png "Click to view Nerd Font Symbols preset")](./nerd-font) -## [Bracketed Segments](./bracketed-segments) +## [Bracketed Segments](./bracketed-segments.md) This preset changes the format of all the built-in modules to show their segment in brackets instead of using the default Starship wording ("via", "on", etc.). [![Screenshot of Bracketed Segments preset](/presets/img/bracketed-segments.png "Click to view Bracketed Segments preset")](./bracketed-segments) -## [Plain Text Symbols](./plain-text) +## [Plain Text Symbols](./plain-text.md) This preset changes the symbols for each module into plain text. Great if you don't have access to Unicode. [![Screenshot of Plain Text Symbols preset](/presets/img/plain-text-symbols.png "Click to view Plain Text Symbols preset")](./plain-text) -## [No Runtime Versions](./no-runtimes) +## [No Runtime Versions](./no-runtimes.md) This preset hides the version of language runtimes. If you work in containers or virtualized environments, this one is for you! [![Screenshot of Hide Runtime Versions preset](/presets/img/no-runtime-versions.png "Click to view No Runtime Versions preset")](./no-runtimes) -## [Pure Prompt](./pure-preset) +## [Pure Prompt](./pure-preset.md) This preset emulates the look and behavior of [Pure](https://github.com/sindresorhus/pure). [![Screenshot of Pure preset](/presets/img/pure-preset.png "Click to view Pure Prompt preset")](./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. + +[![Screenshot of Pastel Powerline preset](/presets/img/pastel-powerline.png "Click to view Pure Prompt preset")](./pastel-powerline) diff --git a/docs/ru-RU/presets/bracketed-segments.md b/docs/ru-RU/presets/bracketed-segments.md index b1ad4ab7..6385a091 100644 --- a/docs/ru-RU/presets/bracketed-segments.md +++ b/docs/ru-RU/presets/bracketed-segments.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#bracketed-segments) +[Return to Presets](./README.md#bracketed-segments) # Bracketed Segments Preset diff --git a/docs/ru-RU/presets/nerd-font.md b/docs/ru-RU/presets/nerd-font.md index 968633cc..0262fc4a 100644 --- a/docs/ru-RU/presets/nerd-font.md +++ b/docs/ru-RU/presets/nerd-font.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#nerd-font-symbols) +[Return to Presets](./README.md#nerd-font-symbols) # Nerd Font Symbols Preset diff --git a/docs/ru-RU/presets/no-runtimes.md b/docs/ru-RU/presets/no-runtimes.md index 38f34b2e..75ef519a 100644 --- a/docs/ru-RU/presets/no-runtimes.md +++ b/docs/ru-RU/presets/no-runtimes.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#no-runtime-versions) +[Return to Presets](./README.md#no-runtime-versions) # No Runtime Versions Preset diff --git a/docs/ru-RU/presets/pastel-powerline.md b/docs/ru-RU/presets/pastel-powerline.md new file mode 100644 index 00000000..962ddc5d --- /dev/null +++ b/docs/ru-RU/presets/pastel-powerline.md @@ -0,0 +1,17 @@ +[Return to Presets](./README.md#pastel-powerline) + +# Pastel Powerline Preset + +This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). It also shows how path substitution works in starship. + +![Screenshot of Pastel Powerline preset](/presets/img/pastel-powerline.png) + +### Обязательные требования + +- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (the example uses Caskaydia Cove Nerd Font) + +### Конфигурация + +[Click to download TOML](/presets/toml/pastel-powerline.toml) + +<<< @/.vuepress/public/presets/toml/pastel-powerline.toml diff --git a/docs/ru-RU/presets/plain-text.md b/docs/ru-RU/presets/plain-text.md index 424c169c..37a580b0 100644 --- a/docs/ru-RU/presets/plain-text.md +++ b/docs/ru-RU/presets/plain-text.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#plain-text-symbols) +[Return to Presets](./README.md#plain-text-symbols) ## Plain Text Symbols Preset diff --git a/docs/ru-RU/presets/pure-preset.md b/docs/ru-RU/presets/pure-preset.md index fae1b984..9c670638 100644 --- a/docs/ru-RU/presets/pure-preset.md +++ b/docs/ru-RU/presets/pure-preset.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#pure) +[Return to Presets](./README.md#pure) # Pure Preset diff --git a/docs/tr-TR/README.md b/docs/tr-TR/README.md index 3cf54f7f..a0d83e8b 100644 --- a/docs/tr-TR/README.md +++ b/docs/tr-TR/README.md @@ -144,17 +144,19 @@ description: Starship is the minimal, blazing fast, and extremely customizable p #### Nushell - ::: warning This will change in the future. Only nu version v0.33 or higher is supported. ::: Add the following to your nu config file. You can check the location of this file by running `config path` in nu. - - ```toml - startup = [ - "mkdir ~/.cache/starship", - "starship init nu | save ~/.cache/starship/init.nu", - "source ~/.cache/starship/init.nu", - ] - prompt = "starship_prompt" + ::: warning This will change in the future. Only Nushell v0.60+ is supported. ::: Run the following: + ```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`): + + ```sh + mkdir ~/.cache/starship + starship init nu | save ~/.cache/starship/init.nu + source ~/.cache/starship/init.nu + ``` #### Xonsh diff --git a/docs/tr-TR/config/README.md b/docs/tr-TR/config/README.md index 371370af..1c0a72fe 100644 --- a/docs/tr-TR/config/README.md +++ b/docs/tr-TR/config/README.md @@ -198,6 +198,7 @@ $git_status\ $hg_branch\ $docker_context\ $package\ +$buf\ $cmake\ $cobol\ $container\ @@ -208,6 +209,7 @@ $elixir\ $elm\ $erlang\ $golang\ +$haskell\ $helm\ $java\ $julia\ @@ -261,7 +263,7 @@ format = "$all$directory$character" ## AWS -The `aws` module shows the current AWS region and profile when credentials or a `credential_process` 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. 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. @@ -278,6 +280,7 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL | `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. | @@ -308,6 +311,8 @@ symbol = "🅰 " [aws.region_aliases] ap-southeast-2 = "au" us-east-1 = "va" +[aws.profile_aliases] +CompanyGroupFrobozzOnCallAccess = 'Frobozz' ``` #### Display region @@ -333,6 +338,8 @@ us-east-1 = "va" format = "on [$symbol$profile]($style) " style = "bold blue" symbol = "🅰 " +[aws.profile_aliases] +Enterprise_Naming_Scheme-voidstars = 'void**' ``` ## Azure @@ -426,6 +433,45 @@ discharging_symbol = "💦" # when capacity is over 30%, the battery indicator will not be displayed ``` +## 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: + +- 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. + +### Options + +| Option | Default | Description | +| ------------------- | ------------------------------------------------------------ | ----------------------------------------------------- | +| `format` | `'with [$symbol($version \(Buf $buf_version\) )]($style)'` | The format for the `buf` module. | +| `version_format` | `"v${raw}"` | The version format. | +| `symbol` | `"🦬 "` | The symbol used before displaying the version of Buf. | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["buf.yaml", "buf.gen.yaml", "buf.work.yaml"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `style` | `"bold blue"` | The style for the module. | +| `disabled` | `false` | Disables the `elixir` module. | + +### Variables + +| Variable | Example | Description | +| ------------- | -------- | ------------------------------------ | +| `buf_version` | `v1.0.0` | The version of `buf` | +| `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 + +[buf] +symbol = "🦬 " +``` + ## Character The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. @@ -439,12 +485,6 @@ By default it only changes color. If you also want to change its shape take a lo ::: uyarı -`error_symbol` is not supported on nu shell. - -::: - -::: uyarı - `vicmd_symbol` is only supported in cmd, fish and zsh. ::: @@ -646,12 +686,12 @@ The `container` module displays a symbol and container name, if inside a contain ### Options -| Option | Default | Description | -| ---------- | ------------------------------------ | ----------------------------------------- | -| `symbol` | `"⬢"` | The symbol shown, when inside a container | -| `style` | `"bold red dimmed"` | The style for the module. | -| `format` | "[$symbol \\[$name\\]]($style) " | The format for the module. | -| `disabled` | `false` | Disables the `container` module. | +| Option | Default | Description | +| ---------- | -------------------------------------- | ----------------------------------------- | +| `symbol` | `"⬢"` | The symbol shown, when inside a container | +| `style` | `"bold red dimmed"` | The style for the module. | +| `format` | `"[$symbol \\[$name\\]]($style) "` | The format for the module. | +| `disabled` | `false` | Disables the `container` module. | ### Variables @@ -1007,7 +1047,7 @@ The `elm` module shows the currently installed version of [Elm](https://elm-lang - 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 -- The current directory contains a `*.elm` files +- The current directory contains `*.elm` files ### Options @@ -1259,6 +1299,7 @@ The `git_branch` module shows the active branch of the repo in your current dire | `truncation_length` | `2^63 - 1` | Truncates a git branch to `N` graphemes. | | `truncation_symbol` | `"…"` | The symbol used to indicate a branch name was truncated. You can use `""` for no symbol. | | `only_attached` | `false` | Only show the branch name when not in a detached `HEAD` state. | +| `ignore_branches` | `[]` | A list of names to avoid displaying. Useful for "master" or "main". | | `disabled` | `false` | Disables the `git_branch` module. | ### Variables @@ -1282,6 +1323,7 @@ The `git_branch` module shows the active branch of the repo in your current dire symbol = "🌱 " truncation_length = 4 truncation_symbol = "" +ignore_branches = ["master", "main"] ``` ## Git Commit @@ -1547,6 +1589,39 @@ The `golang` module shows the currently installed version of [Go](https://golang format = "via [🏎💨 $version](bold cyan) " ``` +## Haskell + +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 +- The current directory contains any `.hs`, `.cabal`, or `.hs-boot` file + +### Options + +| Option | Default | Description | +| ------------------- | ------------------------------------ | -------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `symbol` | `"λ "` | A format string representing the symbol of Haskell | +| `detect_extensions` | `["hs", "cabal", "hs-boot"]` | Which extensions should trigger this module. | +| `detect_files` | `["stack.yaml", "cabal.project"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this module. | +| `style` | `"bold purple"` | The style for the module. | +| `disabled` | `false` | Disables the `haskell` module. | + +### Variables + +| Variable | Example | Description | +| -------------- | ----------- | --------------------------------------------------------------------------------------- | +| version | | `ghc_version` or `snapshot` depending on whether the current project is a Stack project | +| snapshot | `lts-18.12` | Currently selected Stack snapshot | +| ghc\_version | `9.2.1` | Currently installed GHC version | +| 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 + ## 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: @@ -2137,21 +2212,21 @@ The `nodejs` module shows the currently installed version of [Node.js](https://n - 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` extension +- The current directory contains a file with the `.ts`, `.mts` or `.cts` extension ### Options -| Option | Default | Description | -| ------------------- | ------------------------------------ | ----------------------------------------------------------------------------------------------------- | -| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | -| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | -| `symbol` | `" "` | A format string representing the symbol of Node.js. | -| `detect_extensions` | `["js", "mjs", "cjs", "ts"]` | Which extensions should trigger this module. | -| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. | -| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. | -| `style` | `"bold green"` | The style for the module. | -| `disabled` | `false` | Disables the `nodejs` module. | -| `not_capable_style` | `bold red` | The style for the module when an engines property in package.json does not match the Node.js version. | +| Option | Default | Description | +| ------------------- | ------------------------------------------ | ----------------------------------------------------------------------------------------------------- | +| `format` | `"via [$symbol($version )]($style)"` | The format for the module. | +| `version_format` | `"v${raw}"` | The version format. Available vars are `raw`, `major`, `minor`, & `patch` | +| `symbol` | `" "` | A format string representing the symbol of Node.js. | +| `detect_extensions` | `["js", "mjs", "cjs", "ts", "mts", "cts"]` | Which extensions should trigger this module. | +| `detect_files` | `["package.json", ".node-version"]` | Which filenames should trigger this module. | +| `detect_folders` | `["node_modules"]` | Which folders should trigger this module. | +| `style` | `"bold green"` | The style for the module. | +| `disabled` | `false` | Disables the `nodejs` module. | +| `not_capable_style` | `bold red` | The style for the module when an engines property in package.json does not match the Node.js version. | ### Variables @@ -2896,7 +2971,7 @@ format = '[📦 \[$env\]]($style) ' ## Status -The `status` module displays the exit code of the previous command. The module will be shown only if the exit code is not `0`. The status code will cast to a signed 32-bit integer. +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 @@ -2904,15 +2979,13 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y ::: -::: warning This module is not supported on nu shell. ::: - ### Options | Option | Default | Description | | ----------------------- | ------------------------------------------------------------------------------------ | ------------------------------------------------------- | | `format` | `"[$symbol$status]($style) "` | The format of the module | | `symbol` | `"✖"` | The symbol displayed on program error | -| `success_symbol` | `"✔️"` | The symbol displayed on program success | +| `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) | @@ -2949,8 +3022,9 @@ This module is disabled by default. To enable it, set `disabled` to `false` in y [status] style = "bg:blue" -symbol = "🔴" -format = '[\[$symbol $common_meaning$signal_name$maybe_int\]]($style) ' +symbol = "🔴 " +success_symbol = "🟢 SUCCESS" +format = '[\[$symbol$common_meaning$signal_name$maybe_int\]]($style) ' map_symbol = true disabled = false ``` diff --git a/docs/tr-TR/faq/README.md b/docs/tr-TR/faq/README.md index 19d26683..c3c797e7 100644 --- a/docs/tr-TR/faq/README.md +++ b/docs/tr-TR/faq/README.md @@ -1,4 +1,4 @@ -# FAQ +# Frequently Asked Questions ## What is the configuration used in the demo GIF? diff --git a/docs/tr-TR/guide/README.md b/docs/tr-TR/guide/README.md index 0441395f..f4086033 100644 --- a/docs/tr-TR/guide/README.md +++ b/docs/tr-TR/guide/README.md @@ -139,6 +139,8 @@ />

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

Nushell -Add the following to the end of your Nushell configuration (find it by running `config path`): +Run the following: -```toml -startup = [ - "mkdir ~/.cache/starship", - "starship init nu | save ~/.cache/starship/init.nu", - "source ~/.cache/starship/init.nu", -] -prompt = "starship_prompt" +```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`): + +```sh +starship init nu | save ~/.cache/starship/init.nu +source ~/.cache/starship/init.nu +``` + +Note: Only Nushell v0.60+ is supported +
diff --git a/docs/tr-TR/installing/README.md b/docs/tr-TR/installing/README.md index 207fe063..d4bed53b 100644 --- a/docs/tr-TR/installing/README.md +++ b/docs/tr-TR/installing/README.md @@ -1,4 +1,4 @@ -# 🚀 Gelişmiş Kurulum +# Advanced Installation Starship'i kurmak için, 2 şeye ihtiyacınız var: @@ -11,7 +11,7 @@ Birçok platform var ki ana sisteme uymuyorlar. README.md belgesi ile diğer pla ## [Chocolatey ](https://chocolatey.org) -### Ön gereklilikler +### Ön koşullar [Chocolatey kurulum sayfasına](https://chocolatey.org/install) gidin ve Chocolatey'i yüklemek için talimatları izleyin. @@ -23,7 +23,7 @@ choco install starship ## [termux](https://termux.com) -### Ön gereklilikler +### Ön koşullar ```sh pkg install getconf diff --git a/docs/tr-TR/presets/README.md b/docs/tr-TR/presets/README.md index 2189df30..77ce8192 100644 --- a/docs/tr-TR/presets/README.md +++ b/docs/tr-TR/presets/README.md @@ -4,32 +4,38 @@ Topluluk tarafından gönderilen Starship için yapılandırma ön ayarları kol To get details on how to use a preset, simply click on the image. -## [Nerd Yazı Tipi Sembolleri](./nerd-font) +## [Nerd Yazı Tipi Sembolleri](./nerd-font.md) This preset changes the symbols for each module to use Nerd Font symbols. [![Screenshot of Nerd Font Symbols preset](/presets/img/nerd-font-symbols.png "Click to view Nerd Font Symbols preset")](./nerd-font) -## [Bracketed Segments](./bracketed-segments) +## [Bracketed Segments](./bracketed-segments.md) This preset changes the format of all the built-in modules to show their segment in brackets instead of using the default Starship wording ("via", "on", etc.). [![Screenshot of Bracketed Segments preset](/presets/img/bracketed-segments.png "Click to view Bracketed Segments preset")](./bracketed-segments) -## [Plain Text Symbols](./plain-text) +## [Plain Text Symbols](./plain-text.md) This preset changes the symbols for each module into plain text. Great if you don't have access to Unicode. [![Screenshot of Plain Text Symbols preset](/presets/img/plain-text-symbols.png "Click to view Plain Text Symbols preset")](./plain-text) -## [No Runtime Versions](./no-runtimes) +## [No Runtime Versions](./no-runtimes.md) This preset hides the version of language runtimes. If you work in containers or virtualized environments, this one is for you! [![Screenshot of Hide Runtime Versions preset](/presets/img/no-runtime-versions.png "Click to view No Runtime Versions preset")](./no-runtimes) -## [Pure Prompt](./pure-preset) +## [Pure Prompt](./pure-preset.md) This preset emulates the look and behavior of [Pure](https://github.com/sindresorhus/pure). [![Screenshot of Pure preset](/presets/img/pure-preset.png "Click to view Pure Prompt preset")](./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. + +[![Screenshot of Pastel Powerline preset](/presets/img/pastel-powerline.png "Click to view Pure Prompt preset")](./pastel-powerline) diff --git a/docs/tr-TR/presets/bracketed-segments.md b/docs/tr-TR/presets/bracketed-segments.md index 699ef7d6..ff38ba87 100644 --- a/docs/tr-TR/presets/bracketed-segments.md +++ b/docs/tr-TR/presets/bracketed-segments.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#bracketed-segments) +[Return to Presets](./README.md#bracketed-segments) # Bracketed Segments Preset diff --git a/docs/tr-TR/presets/nerd-font.md b/docs/tr-TR/presets/nerd-font.md index d9a062e4..50ef5d4f 100644 --- a/docs/tr-TR/presets/nerd-font.md +++ b/docs/tr-TR/presets/nerd-font.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#nerd-font-symbols) +[Return to Presets](./README.md#nerd-font-symbols) # Nerd Font Symbols Preset diff --git a/docs/tr-TR/presets/no-runtimes.md b/docs/tr-TR/presets/no-runtimes.md index 0d4e308f..aadb9ff7 100644 --- a/docs/tr-TR/presets/no-runtimes.md +++ b/docs/tr-TR/presets/no-runtimes.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#no-runtime-versions) +[Return to Presets](./README.md#no-runtime-versions) # No Runtime Versions Preset diff --git a/docs/tr-TR/presets/pastel-powerline.md b/docs/tr-TR/presets/pastel-powerline.md new file mode 100644 index 00000000..643ff1d3 --- /dev/null +++ b/docs/tr-TR/presets/pastel-powerline.md @@ -0,0 +1,17 @@ +[Return to Presets](./README.md#pastel-powerline) + +# Pastel Powerline Preset + +This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). It also shows how path substitution works in starship. + +![Screenshot of Pastel Powerline preset](/presets/img/pastel-powerline.png) + +### Ön koşullar + +- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (the example uses Caskaydia Cove Nerd Font) + +### Yapılandırma + +[Click to download TOML](/presets/toml/pastel-powerline.toml) + +<<< @/.vuepress/public/presets/toml/pastel-powerline.toml diff --git a/docs/tr-TR/presets/plain-text.md b/docs/tr-TR/presets/plain-text.md index d094fb6a..5397b921 100644 --- a/docs/tr-TR/presets/plain-text.md +++ b/docs/tr-TR/presets/plain-text.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#plain-text-symbols) +[Return to Presets](./README.md#plain-text-symbols) ## Plain Text Symbols Preset diff --git a/docs/tr-TR/presets/pure-preset.md b/docs/tr-TR/presets/pure-preset.md index 2bf100f3..79306c33 100644 --- a/docs/tr-TR/presets/pure-preset.md +++ b/docs/tr-TR/presets/pure-preset.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#pure) +[Return to Presets](./README.md#pure) # Pure Preset diff --git a/docs/vi-VN/README.md b/docs/vi-VN/README.md index 5d7a5114..3dd37d2f 100644 --- a/docs/vi-VN/README.md +++ b/docs/vi-VN/README.md @@ -100,7 +100,7 @@ description: Starship là prompt nhỏ, cực nhanh, và khả năng tuỳ biế #### Powershell - Thêm vào cuối tệp tin `Microsoft.PowerShell_profile.ps1`. Bạn có thể kiểm tra vị trí tệp tin này bằng việc truy xuất biến `$PROFILE` trong PowerShell. Thông thường, đường dẫn là `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` hoặc `~/.config/powershell/Microsoft.PowerShell_profile.ps1` trên -Nix. + Thêm đoạn sau vào cuối tệp tin `Microsoft.PowerShell_profile.ps1`. Bạn có thể kiểm tra vị trí tệp tin này bằng việc truy xuất biến `$PROFILE` trong PowerShell. Thông thường, đường dẫn là `~\Documents\PowerShell\Microsoft.PowerShell_profile.ps1` hoặc `~/.config/powershell/Microsoft.PowerShell_profile.ps1` trên -Nix. ```sh Invoke-Expression (&starship init powershell) @@ -109,12 +109,12 @@ description: Starship là prompt nhỏ, cực nhanh, và khả năng tuỳ biế #### Ion - Thêm vào cuối tệp tin `~/.config/ion/initrc`: + Thêm đoạn sau vào cuối tệp tin `~/.config/ion/initrc`: ```sh # ~/.config/ion/initrc -eval $(starship init ion) + eval $(starship init ion) ``` @@ -133,7 +133,7 @@ eval $(starship init ion) #### Tcsh - Thêm đoạn dưới vào cuối file `~/.tcshrc`: + Thêm đoạn sau vào cuối tệp tin `~/.tcshrc`: ```sh # ~/.tcshrc @@ -144,17 +144,19 @@ eval $(starship init ion) #### Nushell - ::: warning This will change in the future. Chỉ có nu phiên bản v. 033 hoặc cao hơn được hỗ trợ. ::: Add the following to your nu config file. Bạn có thể kiểm tra vị trí của cái file này bằng cách chạy `đường dẫn cấu hình` trong nu. - - ```toml - startup = [ - "mkdir ~/.cache/starship", - "starship init nu | save ~/.cache/starship/init.nu", - "source ~/.cache/starship/init.nu", - ] - prompt = "starship_prompt" + ::: warning This will change in the future. Only Nushell v0.60+ is supported. ::: Run the following: + ```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`): + + ```sh + mkdir ~/.cache/starship + starship init nu | save ~/.cache/starship/init.nu + source ~/.cache/starship/init.nu + ``` #### Xonsh diff --git a/docs/vi-VN/config/README.md b/docs/vi-VN/config/README.md index fd665dd5..43fa7000 100644 --- a/docs/vi-VN/config/README.md +++ b/docs/vi-VN/config/README.md @@ -198,6 +198,7 @@ $git_status\ $hg_branch\ $docker_context\ $package\ +$buf\ $cmake\ $cobol\ $container\ @@ -208,6 +209,7 @@ $elixir\ $elm\ $erlang\ $golang\ +$haskell\ $helm\ $java\ $julia\ @@ -261,7 +263,7 @@ format = "$all$directory$character" ## AWS -The `aws` module shows the current AWS region and profile when credentials or a `credential_process` 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. 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. @@ -278,9 +280,10 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL | `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. | +| `disabled` | `false` | Disables the `AWS` module. | ### Các biến @@ -294,7 +297,7 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL *: Biến này có thể chỉ được sử dụng như một phần của style string -### Các vị dụ +### Các ví dụ #### Hiển thị mọi thứ @@ -308,6 +311,8 @@ symbol = "🅰 " [aws.region_aliases] ap-southeast-2 = "au" us-east-1 = "va" +[aws.profile_aliases] +CompanyGroupFrobozzOnCallAccess = 'Frobozz' ``` #### Hiển thị region @@ -333,6 +338,8 @@ us-east-1 = "va" format = "on [$symbol$profile]($style) " style = "bold blue" symbol = "🅰 " +[aws.profile_aliases] +Enterprise_Naming_Scheme-voidstars = 'void**' ``` ## Azure @@ -426,22 +433,55 @@ discharging_symbol = "💦" # when capacity is over 30%, the battery indicator will not be displayed ``` +## 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: + +- 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. + +### Các tuỳ chọn + +| Tuỳ chọn | Mặc định | Mô tả | +| ------------------- | ------------------------------------------------------------ | ----------------------------------------------------- | +| `format` | `'with [$symbol($version \(Buf $buf_version\) )]($style)'` | The format for the `buf` module. | +| `version_format` | `"v${raw}"` | The version format. | +| `symbol` | `"🦬 "` | The symbol used before displaying the version of Buf. | +| `detect_extensions` | `[]` | Những tiện ích mở rộng nào sẽ kích hoạt mô-đun này. | +| `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. | + +### Các biến + +| Biến | Ví dụ | Mô tả | +| ------------- | -------- | -------------------------------- | +| `buf_version` | `v1.0.0` | The version of `buf` | +| `symbol` | | Giá trị ghi đè tuỳ chọn `symbol` | +| `style`* | | Giá trị ghi đè của `style` | + +*: Biến này có thể chỉ được sử dụng như một phần của style string + +### Ví dụ + +```toml +# ~/.config/starship.toml + +[buf] +symbol = "🦬 " +``` + ## Character -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` module shows a character (usually an arrow) beside where the text is entered in your terminal. -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: +The character will tell you whether the last command was successful or not. It can do this in two ways: -- thay đổi màu(`đỏ`/`xanh lá`) -- thay đổi hình dạng (`❯`/`✖`) +- changing color (`red`/`green`) +- changing 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 - -`error_symbol` is not supported on nu shell. - -::: +By default it only changes color. If you also want to change its shape take a look at [this example](#with-custom-error-shape). ::: cảnh báo @@ -451,21 +491,21 @@ Mặc định, nó chỉ thay đổi màu. If you also want to change its shape ### Các tuỳ chọn -| Tuỳ chọn | Mặc định | Mô tả | -| ---------------- | ------------------- | ------------------------------------------------------------------------------------ | -| `format` | `"$symbol "` | Định dạng chuỗi sử dụng trước văn bản nhập vào. | -| `success_symbol` | `"[❯](bold green)"` | Định dạng chuỗi sửa dụng trước văn bản nhập vào nếu câu lệnh trước đó đã thành công. | -| `error_symbol` | `"[❯](bold red)"` | Định dạng chuỗi sửa dụng trước văn bản nhập vào nếu câu lệnh trước đó đã thất bại. | -| `vicmd_symbol` | `"[❮](bold green)"` | Định dạng chuỗi sửa dụng trước văn bản nhập vào nếu shell trong chế độ vim normal. | -| `disabled` | `false` | Vô hiệu module `character`. | +| Tuỳ chọn | Mặc định | Mô tả | +| ---------------- | ------------------- | -------------------------------------------------------------------------------- | +| `format` | `"$symbol "` | 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. | ### Các biến -| Biến | Ví dụ | Mô tả | -| ------ | ----- | ----------------------------------------------------------------------------- | -| symbol | | Một phản ánh của một trong `success_symbol`, `error_symbol` or `vicmd_symbol` | +| Biến | Ví dụ | Mô tả | +| ------ | ----- | --------------------------------------------------------------------- | +| symbol | | A mirror of either `success_symbol`, `error_symbol` or `vicmd_symbol` | -### Các vị dụ +### Các ví dụ #### Có tuỳ chỉnh hình dạng lỗi @@ -498,10 +538,10 @@ vicmd_symbol = "[V](bold green) " ## CMake -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 `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: -- Đườ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` +- The current directory contains a `CMakeLists.txt` file +- The current directory contains a `CMakeCache.txt` file ### Các tuỳ chọn @@ -509,18 +549,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` | `"△ "` | 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 | +| `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 | | `style` | `"bold blue"` | Kiểu cho module. | -| `disabled` | `false` | Vô hiệu module `cmake`. | +| `disabled` | `false` | Disables the `cmake` module. | ### Các biến | Biến | Ví dụ | Mô tả | | --------- | --------- | -------------------------------- | -| version | `v3.17.3` | Phiên bản của cmake | +| version | `v3.17.3` | The version of cmake | | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | @@ -558,35 +598,35 @@ The `cobol` module shows the currently installed version of COBOL. By default, t ## Command Duration -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. +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. -::: cảnh báo Không thể hook DEBUG trap trong Bash +::: warning Do not hook the DEBUG trap in Bash -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. +If you are running Starship in `bash`, do not hook the `DEBUG` trap after running `eval $(starship init $0)`, or this module **will** break. ::: -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. +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. ### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ---------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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. | +| `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) "` | Định dạng cho module. | | `style` | `"bold yellow"` | Kiểu cho module. | -| `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). | +| `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. | ### Các biến -| 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 | Ví dụ | Mô tả | +| --------- | -------- | --------------------------------------- | +| duration | `16m40s` | The time it took to execute the command | +| 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 @@ -604,9 +644,9 @@ format = "underwent [$duration](bold yellow)" The `conda` module shows the current [Conda](https://docs.conda.io/en/latest/) environment, if `$CONDA_DEFAULT_ENV` is set. -::: thử thuật +::: tip -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`. +This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. ::: @@ -614,20 +654,20 @@ Cái này không loại bỏ conda's prompt mà nó sở hữu, bạn có thể | Tuỳ chọn | Mặc định | Mô tả | | ------------------- | -------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `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. | +| `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"` | Kiểu cho module. | | `format` | `"via [$symbol$environment]($style) "` | Định dạng cho 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`. | +| `ignore_base` | `true` | Ignores `base` environment when activated. | +| `disabled` | `false` | Disables the `conda` module. | ### Các biến -| 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 | 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 này có thể chỉ được sử dụng như một phần của style string @@ -646,12 +686,12 @@ The `container` module displays a symbol and container name, if inside a contain ### Các tuỳ chọn -| Tuỳ chọn | Mặc định | Mô tả | -| ---------- | ------------------------------------ | ----------------------------------------- | -| `symbol` | `"⬢"` | The symbol shown, when inside a container | -| `style` | `"bold red dimmed"` | Kiểu cho module. | -| `format` | "[$symbol \\[$name\\]]($style) " | Định dạng cho module. | -| `disabled` | `false` | Disables the `container` module. | +| Tuỳ chọn | Mặc định | Mô tả | +| ---------- | -------------------------------------- | ----------------------------------------- | +| `symbol` | `"⬢"` | The symbol shown, when inside a container | +| `style` | `"bold red dimmed"` | Kiểu cho module. | +| `format` | `"[$symbol \\[$name\\]]($style) "` | Định dạng cho module. | +| `disabled` | `false` | Disables the `container` module. | ### Các biến @@ -674,29 +714,29 @@ format = "[$symbol \\[$name\\]]($style) " ## Crystal -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 `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: -- Đườ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` +- The current directory contains a `shard.yml` file +- The current directory contains a `.cr` file ### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ------------------- | ------------------------------------ | ------------------------------------------------------------------------- | -| `symbol` | `"🔮 "` | Kí hiệu sử dụng trước phiên bản hiển thị của crystal. | +| `symbol` | `"🔮 "` | The symbol used before displaying the version of 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` | Vô hiệu hoá module `crystal`. | +| `disabled` | `false` | Disables the `crystal` module. | ### Các biến | Biến | Ví dụ | Mô tả | | --------- | --------- | -------------------------------- | -| version | `v0.32.1` | Phiên bản của `crystal` | +| version | `v0.32.1` | The version of `crystal` | | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | @@ -713,11 +753,11 @@ format = "via [✨ $version](bold blue) " ## Dart -The `dart` module shows the currently installed version of [Dart](https://dart.dev/). Mặc định module sẽ được hiển thị nếu có bất kì điều kiện nào dưới đây thoả mãn: +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: -- Đườ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` +- 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 ### Các tuỳ chọn @@ -725,18 +765,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` | `"🎯 "` | Một chuỗi định dạng hiển thị biểu tượng của Dart | +| `symbol` | `"🎯 "` | A format string representing the symbol of 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` | Vô hiệu `dart` module. | +| `disabled` | `false` | Disables the `dart` module. | ### Các biến | Biến | Ví dụ | Mô tả | | --------- | -------- | -------------------------------- | -| version | `v2.8.4` | Phiên bản của `dart` | +| version | `v2.8.4` | The version of `dart` | | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | @@ -753,7 +793,7 @@ format = "via [🔰 $version](bold red) " ## Deno -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 `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 current directory contains a `deno.json`, `deno.jsonc`, `mod.ts`, `mod.js`, `deps.ts` or `deps.js` file @@ -789,33 +829,33 @@ format = "via [🦕 $version](green bold) " ## Đường dẫn -`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. +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. -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. +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. -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`. +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`. ### Các tuỳ chọn | Tuỳ chọn | Mặc định | Mô tả | | ------------------- | ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `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. | +| `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) "` | Định dạng cho module. | | `style` | `"bold cyan"` | Kiểu cho module. | -| `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ụ: "…/" | +| `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` | `"~"` | Biểu tượng nhận biết thư mục home. | +| `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) |
-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ị. +This module has a few advanced configuration options that control how the directory is displayed. -| Tùy chọn nâng cao | Mặc định | Mô tả | +| Advanced Option | 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. | @@ -837,7 +877,7 @@ Cho ví dụ, `~/Dev/Nix/nixpkgs/pkgs` nơi `nixpkgs` là gốc của repo, và | Biến | Ví dụ | Mô tả | | --------- | --------------------- | -------------------------- | -| path | `"D:/Projects"` | Đường dẫn thư mục hiện tại | +| path | `"D:/Projects"` | The current directory path | | 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 @@ -873,22 +913,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` | `"🐳 "` | 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`. | +| 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. | ### Các biến | Biến | Ví dụ | Mô tả | | --------- | -------------- | -------------------------------- | -| context | `test_context` | Docker context hiện tại | +| context | `test_context` | The current docker context | | symbol | | Giá trị ghi đè tuỳ chọn `symbol` | | style\* | | Giá trị ghi đè của `style` | @@ -905,9 +945,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. 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. +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. -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: +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` @@ -918,11 +958,11 @@ Mặc định, mô đun này sẽ chỉ được hiển thị trong dấu nhắc - `*.fsproj` - `*.xproj` -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. +You'll also need the .NET Core SDK installed in order to use it correctly. -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. +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 cũng sẽ hiện Target Framework Moniker () khi có một tệp tin csproj trong thư mục hiện tại. +The module will also show the Target Framework Moniker () when there is a csproj file in the current directory. ### Các tuỳ chọn @@ -930,22 +970,22 @@ Mô đun cũng sẽ hiện Target Framework Moniker ("` | The description of the module that is shown when running `starship explain`. | +| `description` | `""` | The description of the module that is shown when running `starship explain`. | | `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. | diff --git a/docs/vi-VN/faq/README.md b/docs/vi-VN/faq/README.md index 1e726cf4..3a313d7d 100644 --- a/docs/vi-VN/faq/README.md +++ b/docs/vi-VN/faq/README.md @@ -1,4 +1,4 @@ -# CÂU HỎI THƯỜNG GẶP +# Frequently Asked Questions ## Cấu hình sử dụng trong demo GIF là gì? diff --git a/docs/vi-VN/guide/README.md b/docs/vi-VN/guide/README.md index 97172f84..6cea74be 100644 --- a/docs/vi-VN/guide/README.md +++ b/docs/vi-VN/guide/README.md @@ -139,11 +139,13 @@ />

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

Starship với iTerm2 and chủ đề Snazzy @@ -158,7 +160,7 @@ - **Dễ dàng:** cài đặt nhanh chóng – bắt đầu sử dụng nó trong vài phút.

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

@@ -313,7 +315,7 @@ starship init fish | source
Ion -Thêm vào cuối tệp tin `~/.config/ion/initrc`: +Thêm đoạn sau vào cuối tệp tin `~/.config/ion/initrc`: ```sh eval $(starship init ion) @@ -324,17 +326,22 @@ eval $(starship init ion)
Nushell -Add the following to the end of your Nushell configuration (find it by running `config path`): +Run the following: -```toml -startup = [ - "mkdir ~/.cache/starship", - "starship init nu | save ~/.cache/starship/init.nu", - "source ~/.cache/starship/init.nu", -] -prompt = "starship_prompt" +```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`): + +```sh +starship init nu | save ~/.cache/starship/init.nu +source ~/.cache/starship/init.nu +``` + +Note: Only Nushell v0.60+ is supported +
@@ -351,7 +358,7 @@ Invoke-Expression (&starship init powershell)
Tcsh -Thêm đoạn dưới vào cuối file `~/.tcshrc`: +Thêm đoạn sau vào cuối tệp tin `~/.tcshrc`: ```sh eval `starship init tcsh` @@ -393,15 +400,15 @@ If you're looking to further customize Starship: ## 🤝 Đóng góp -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). +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ế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 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í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. 👋 +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. 👋 ## Cảm hứng -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. 🙏 +Please check out these previous works that helped inspire the creation of starship. 🙏 - **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** – A ZSH prompt for astronauts. @@ -416,4 +423,4 @@ Xin hãy xem qua những công việc này trước đây, những thứ đã gi ## 📝 Giấy phép -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. +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. diff --git a/docs/vi-VN/installing/README.md b/docs/vi-VN/installing/README.md index 00eb3a95..e93980e6 100644 --- a/docs/vi-VN/installing/README.md +++ b/docs/vi-VN/installing/README.md @@ -1,4 +1,4 @@ -# 🚀 Cài đặt nâng cao +# Advanced Installation Để cài đặt starship, bạn cần làm 2 thứ: diff --git a/docs/vi-VN/migrating-to-0.45.0/README.md b/docs/vi-VN/migrating-to-0.45.0/README.md index 02ae96a0..db30a56f 100644 --- a/docs/vi-VN/migrating-to-0.45.0/README.md +++ b/docs/vi-VN/migrating-to-0.45.0/README.md @@ -10,7 +10,7 @@ Từ trước đế v0.45.0, `prompt_order` sẽ chấp nhận một mảng các Starship v0.45.0 thay vì chấp nhận một giá trị `format`, nó cho phép tùy biến dấu nhắc lệnh bên ngoài chính các mô đun đó. -**Ví dụcủa cấu hình pre-v0.45.0** +**Ví dụ của cấu hình pre-v0.45.0** ```toml prompt_order = [ @@ -31,7 +31,7 @@ prompt_order = [ ] ``` -**Ví dụcủa cấu hình v0.45.0** +**Ví dụ của cấu hình v0.45.0** ```toml format = """\ @@ -58,14 +58,14 @@ Từ trước tới v0.45.0, một vài mô đun sẽ chấp nhận `prefix` và Starship v0.45.0 thay vì chấp nhận một giá trị `format`, nó cho phép tùy biến dấu nhắc lệnh bên ngoài chính các mô đun đó. Thay vì định nghĩa một tiền tố và hậu tố cho các giá trị context-based, các giá trị bây giờ có thể được thay thế với một format string, cái đại diện cho đầu ra của module. -**Ví dụ của cấu hình pre-v0.45.0** +**Ví dụcủa cấu hình pre-v0.45.0** ```toml [cmd_duration] prefix = "took " ``` -**Ví dụ của cấu hình v0.45.0** +**Ví dụcủa cấu hình v0.45.0** ```toml [cmd_duration] diff --git a/docs/vi-VN/presets/README.md b/docs/vi-VN/presets/README.md index f2817ee4..7b37c28b 100644 --- a/docs/vi-VN/presets/README.md +++ b/docs/vi-VN/presets/README.md @@ -4,32 +4,38 @@ To get details on how to use a preset, simply click on the image. -## [Những kí tự Nerd Font](./nerd-font) +## [Những kí tự Nerd Font](./nerd-font.md) This preset changes the symbols for each module to use Nerd Font symbols. [![Bản chụp màn hình của Nerd Font Symbols preset](/presets/img/nerd-font-symbols.png "Click to view Nerd Font Symbols preset")](./nerd-font) -## [Bracketed Segments](./bracketed-segments) +## [Bracketed Segments](./bracketed-segments.md) This preset changes the format of all the built-in modules to show their segment in brackets instead of using the default Starship wording ("via", "on", etc.). [![Screenshot of Bracketed Segments preset](/presets/img/bracketed-segments.png "Click to view Bracketed Segments preset")](./bracketed-segments) -## [Plain Text Symbols](./plain-text) +## [Plain Text Symbols](./plain-text.md) This preset changes the symbols for each module into plain text. Great if you don't have access to Unicode. [![Screenshot of Plain Text Symbols preset](/presets/img/plain-text-symbols.png "Click to view Plain Text Symbols preset")](./plain-text) -## [No Runtime Versions](./no-runtimes) +## [No Runtime Versions](./no-runtimes.md) This preset hides the version of language runtimes. If you work in containers or virtualized environments, this one is for you! [![Screenshot of Hide Runtime Versions preset](/presets/img/no-runtime-versions.png "Click to view No Runtime Versions preset")](./no-runtimes) -## [Pure Prompt](./pure-preset) +## [Pure Prompt](./pure-preset.md) This preset emulates the look and behavior of [Pure](https://github.com/sindresorhus/pure). [![Screenshot of Pure preset](/presets/img/pure-preset.png "Click to view Pure Prompt preset")](./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. + +[![Screenshot of Pastel Powerline preset](/presets/img/pastel-powerline.png "Click to view Pure Prompt preset")](./pastel-powerline) diff --git a/docs/vi-VN/presets/bracketed-segments.md b/docs/vi-VN/presets/bracketed-segments.md index 8fe3addf..6f5ab8a6 100644 --- a/docs/vi-VN/presets/bracketed-segments.md +++ b/docs/vi-VN/presets/bracketed-segments.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#bracketed-segments) +[Return to Presets](./README.md#bracketed-segments) # Bracketed Segments Preset diff --git a/docs/vi-VN/presets/nerd-font.md b/docs/vi-VN/presets/nerd-font.md index 19f7a4bd..f333b1ba 100644 --- a/docs/vi-VN/presets/nerd-font.md +++ b/docs/vi-VN/presets/nerd-font.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#nerd-font-symbols) +[Return to Presets](./README.md#nerd-font-symbols) # Nerd Font Symbols Preset diff --git a/docs/vi-VN/presets/no-runtimes.md b/docs/vi-VN/presets/no-runtimes.md index 850516cf..351bed7c 100644 --- a/docs/vi-VN/presets/no-runtimes.md +++ b/docs/vi-VN/presets/no-runtimes.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#no-runtime-versions) +[Return to Presets](./README.md#no-runtime-versions) # No Runtime Versions Preset diff --git a/docs/vi-VN/presets/pastel-powerline.md b/docs/vi-VN/presets/pastel-powerline.md new file mode 100644 index 00000000..c8570b4d --- /dev/null +++ b/docs/vi-VN/presets/pastel-powerline.md @@ -0,0 +1,17 @@ +[Return to Presets](./README.md#pastel-powerline) + +# Pastel Powerline Preset + +This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). It also shows how path substitution works in starship. + +![Screenshot of Pastel Powerline preset](/presets/img/pastel-powerline.png) + +### Yêu cầu + +- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (the example uses Caskaydia Cove Nerd Font) + +### Cấu hình + +[Click to download TOML](/presets/toml/pastel-powerline.toml) + +<<< @/.vuepress/public/presets/toml/pastel-powerline.toml diff --git a/docs/vi-VN/presets/plain-text.md b/docs/vi-VN/presets/plain-text.md index 1f4828e1..0ed3d690 100644 --- a/docs/vi-VN/presets/plain-text.md +++ b/docs/vi-VN/presets/plain-text.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#plain-text-symbols) +[Return to Presets](./README.md#plain-text-symbols) ## Plain Text Symbols Preset diff --git a/docs/vi-VN/presets/pure-preset.md b/docs/vi-VN/presets/pure-preset.md index 27447c36..375adea3 100644 --- a/docs/vi-VN/presets/pure-preset.md +++ b/docs/vi-VN/presets/pure-preset.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#pure) +[Return to Presets](./README.md#pure) # Pure Preset diff --git a/docs/zh-CN/README.md b/docs/zh-CN/README.md index df0cdf3e..890e7d47 100644 --- a/docs/zh-CN/README.md +++ b/docs/zh-CN/README.md @@ -144,17 +144,19 @@ description: Starship is the minimal, blazing fast, and extremely customizable p #### Nushell - ::: warning This will change in the future. 仅支持 nu 版本 v0.33 或更高版本。 ::: Add the following to your nu config file. 您可以用 nu 运行 `config path` 来检查此 文件的位置。 - - ```toml - startup = [ - "mkdir ~/.cache/starship", - "starship init nu | save ~/.cache/starship/init.nu", - "source ~/.cache/starship/init.nu", - ] - prompt = "starship_prompt" + ::: warning This will change in the future. Only Nushell v0.60+ is supported. ::: Run the following: + ```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`): + + ```sh + mkdir ~/.cache/starship + starship init nu | save ~/.cache/starship/init.nu + source ~/.cache/starship/init.nu + ``` #### Xonsh @@ -169,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. 将以下文件添加到文件 `starship.lua` 中，并将此文件放置在 Clink脚本目录中： + 您需要使用 [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: ```lua -- starship.lua diff --git a/docs/zh-CN/advanced-config/README.md b/docs/zh-CN/advanced-config/README.md index 5f0f94bd..bd0f5b67 100644 --- a/docs/zh-CN/advanced-config/README.md +++ b/docs/zh-CN/advanced-config/README.md @@ -32,7 +32,7 @@ end load(io.popen('starship init cmd'):read("*a"))() ``` -## 在 Cmd 中自定义预提示和执行前命令 +## 在 Bash 中自定义预提示和预执行命令 Bash 并没有类似大多数其它 shell 的正式预执行/预命令框架。 因此，很难在 `bash` 中提供完全可自定义的 hook 机制。 然而，Starship 确实能使您有限地在提示符渲染过程中插入自己的函数执行： diff --git a/docs/zh-CN/config/README.md b/docs/zh-CN/config/README.md index e3893343..40a30799 100644 --- a/docs/zh-CN/config/README.md +++ b/docs/zh-CN/config/README.md @@ -198,6 +198,7 @@ $git_status\ $hg_branch\ $docker_context\ $package\ +$buf\ $cmake\ $cobol\ $container\ @@ -208,6 +209,7 @@ $elixir\ $elm\ $erlang\ $golang\ +$haskell\ $helm\ $java\ $julia\ @@ -261,7 +263,7 @@ format = "$all$directory$character" ## AWS -The `aws` module shows the current AWS region and profile when credentials or a `credential_process` 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. 各组件基于 `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. @@ -278,9 +280,10 @@ 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` | 禁用 `AWS` 组件。 | +| `disabled` | `false` | Disables the `AWS` module. | ### Variables @@ -308,6 +311,8 @@ symbol = "🅰 " [aws.region_aliases] ap-southeast-2 = "au" us-east-1 = "va" +[aws.profile_aliases] +CompanyGroupFrobozzOnCallAccess = 'Frobozz' ``` #### Display region @@ -333,6 +338,8 @@ us-east-1 = "va" format = "on [$symbol$profile]($style) " style = "bold blue" symbol = "🅰 " +[aws.profile_aliases] +Enterprise_Naming_Scheme-voidstars = 'void**' ``` ## Azure @@ -426,11 +433,50 @@ discharging_symbol = "💦" # when capacity is over 30%, the battery indicator will not be displayed ``` +## 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: + +- 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. + +### 配置项 + +| Option | 默认值 | 描述 | +| ------------------- | ------------------------------------------------------------ | ----------------------------------------------------- | +| `format` | `'with [$symbol($version \(Buf $buf_version\) )]($style)'` | The format for the `buf` module. | +| `version_format` | `"v${raw}"` | The version format. | +| `symbol` | `"🦬 "` | The symbol used before displaying the version of Buf. | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["buf.yaml", "buf.gen.yaml", "buf.work.yaml"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `style` | `"bold blue"` | 此组件的样式。 | +| `disabled` | `false` | Disables the `elixir` module. | + +### Variables + +| 字段 | 示例 | 描述 | +| ------------- | -------- | -------------------- | +| `buf_version` | `v1.0.0` | The version of `buf` | +| `symbol` | | `symbol`对应值 | +| `style`* | | `style`对应值 | + +*: This variable can only be used as a part of a style string + +### 示例 + +```toml +# ~/.config/starship.toml + +[buf] +symbol = "🦬 " +``` + ## Character -`character` 组件用于在您输入终端的文本旁显示一个字符（通常是一个箭头）。 +The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. -这个字符可以告诉您最后一个命令是否执行成功。 It can do this in two ways: +The character will tell you whether the last command was successful or not. It can do this in two ways: - changing color (`red`/`green`) - changing shape (`❯`/`✖`) @@ -439,12 +485,6 @@ By default it only changes color. If you also want to change its shape take a lo ::: warning -`error_symbol` is not supported on nu shell. - -::: - -::: warning - `vicmd_symbol` is only supported in cmd, fish and zsh. ::: @@ -457,7 +497,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` | 禁用 `character` 组件。 | +| `disabled` | `false` | Disables the `character` module. | ### Variables @@ -558,25 +598,25 @@ The `cobol` module shows the currently installed version of COBOL. By default, t ## Command Duration -`cmd_duration` 组件显示上一个命令执行的时间。 此组件只在命令执行时间长于两秒时显示，或者当其 `min_time` 字段被设置时，按此值为执行时间的显示下限。 +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. -::: warning 不要在 Bash 里捕获 DEBUG 信号 +::: warning Do not hook the DEBUG trap in Bash -如果您正在 `bash` 上使用 Starship，在运行 `eval $(starship)` 后，不要捕获 `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 用户可以使用 [rcaloras 的 bash_preexec 框架](https://github.com/rcaloras/bash-preexec)。 只需要在执行 `eval $(starship init $0)` 前简单地定义 `preexec_functions` 和 `precmd_functions` 两个列表，就可以照常运行了。 +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. ### 配置项 | Option | 默认值 | 描述 | | ---------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| `min_time` | `2_000` | 显示此组件所需的最短执行时长（单位：毫秒）。 | -| `show_milliseconds` | `false` | 除了秒数外在执行时长中额外显示毫秒。 | +| `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) "` | 组件格式化模板。 | | `style` | `"bold yellow"` | 此组件的样式。 | -| `disabled` | `false` | 禁用 `cmd_duration` 组件。 | +| `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. | @@ -606,20 +646,20 @@ The `conda` module shows the current [Conda](https://docs.conda.io/en/latest/) e ::: tip -此组件没有禁用 conda 自带的提示符修改，您可能需要执行 `conda config --set changeps1 False`。 +This does not suppress conda's own prompt modifier, you may want to run `conda config --set changeps1 False`. ::: ### 配置项 -| 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` 组件。 | +| 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. | ### Variables @@ -646,12 +686,12 @@ The `container` module displays a symbol and container name, if inside a contain ### 配置项 -| Option | 默认值 | 描述 | -| ---------- | ------------------------------------ | ----------------------------------------- | -| `symbol` | `"⬢"` | The symbol shown, when inside a container | -| `style` | `"bold red dimmed"` | 此组件的样式。 | -| `format` | "[$symbol \\[$name\\]]($style) " | 组件格式化模板。 | -| `disabled` | `false` | Disables the `container` module. | +| Option | 默认值 | 描述 | +| ---------- | -------------------------------------- | ----------------------------------------- | +| `symbol` | `"⬢"` | The symbol shown, when inside a container | +| `style` | `"bold red dimmed"` | 此组件的样式。 | +| `format` | `"[$symbol \\[$name\\]]($style) "` | 组件格式化模板。 | +| `disabled` | `false` | Disables the `container` module. | ### Variables @@ -676,7 +716,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: -- 当前目录包含 `shard.yml` 文件 +- The current directory contains a `shard.yml` file - The current directory contains a `.cr` file ### 配置项 @@ -717,7 +757,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 -- 当前目录包含 `pubspec.yaml`，`pubspec.yml` 或 `pubspec.lock` 文件 +- The current directory contains a `pubspec.yaml`, `pubspec.yml` or `pubspec.lock` file ### 配置项 @@ -789,21 +829,21 @@ format = "via [🦕 $version](green bold) " ## Directory -`directory` 组件显示当前目录的路径，显示的路径会截断到三个父目录以内。 如果您处于一个 git 仓库中，显示的路径则最多会截断到该仓库的根目录。 +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. -当使用 fish 风格的当前目录显示样式时，您会看到基于您的设置的每个上级目录的短名称，而不是隐藏被截断的上级目录。 +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. -例如，对于 `~/Dev/Nix/nixpkgs/pkgs`，其中 `nixpkgs` 是 git 仓库根目录，fish 风格相关选项设置为 `1`。 您将会看到 `~/D/N/nixpkgs/pkgs`，而在设置 fish 风格之前，当前路径将显示成 `nixpkgs/pkgs`。 +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`. ### 配置项 | Option | 默认值 | 描述 | | ------------------- | ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `truncation_length` | `3` | 当前目录路径被截断后最多保留的父目录数量。 | -| `truncate_to_repo` | `true` | 是否只截断到您当前处于的 git 仓库根目录下。 | +| `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) "` | 组件格式化模板。 | | `style` | `"bold cyan"` | 此组件的样式。 | -| `disabled` | `false` | 禁用 `directory` 组件。 | +| `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: "…/" | @@ -813,12 +853,12 @@ format = "via [🦕 $version](green bold) " | `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` | 使用 fish shell 当前目录路径逻辑时每个省略目录名使用的字符数。 | +| `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. | `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. @@ -905,7 +945,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. 如果当前目录已被绑定了一个版本的 SDK，则显示被帮定的版本。 否则此组件将显示最新安装的 SDK 版本。 +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. 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: @@ -920,7 +960,7 @@ 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. -在内部，此组件使用自己的版本检测机制。 一般来说此组件是直接执行 `dotnet --version` 的两倍快，但当你的 .NET 项目使用了不常见的目录布局时此组件可能显示一个错误的版本。 如果相比于速度您更需要正确的版本号，您可以在组件设置中设置 `heuristic = false` 来禁用该机制。 +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. @@ -930,13 +970,13 @@ The module will also show the Target Framework Moniker ("` | The description of the module that is shown when running `starship explain`. | +| `description` | `""` | The description of the module that is shown when running `starship explain`. | | `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. | diff --git a/docs/zh-CN/faq/README.md b/docs/zh-CN/faq/README.md index 12b21ab6..ee882916 100644 --- a/docs/zh-CN/faq/README.md +++ b/docs/zh-CN/faq/README.md @@ -1,4 +1,4 @@ -# 常见问题 +# Frequently Asked Questions ## 主页示例图中的效果用的是什么配置？ diff --git a/docs/zh-CN/guide/README.md b/docs/zh-CN/guide/README.md index 118bcfc5..8925ad4c 100644 --- a/docs/zh-CN/guide/README.md +++ b/docs/zh-CN/guide/README.md @@ -139,11 +139,13 @@ />

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

使用 iTerm 和 Snazz 主题的 Starship @@ -158,7 +160,7 @@ - **易用：** 安装快速 —— 几分钟就可上手。

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

@@ -171,12 +173,12 @@ ### 步骤 1. 安装 Starship -从下面的列表中选择您的操作系统以查看安装指令： +Select your operating system from the list below to view installation instructions:
Android -使用下列软件包管理器安装Starship： +Install Starship using any of the following package managers: | 软件包来源 | 指令 | | --------------------------------------------------------------------------------- | ---------------------- | @@ -187,7 +189,7 @@
BSD -使用下列软件包管理器安装Starship： +Install Starship using any of the following package managers: | 发行版 | 软件包来源 | 指令 | | ----------- | -------------------------------------------------------- | --------------------------------- | @@ -200,13 +202,13 @@
Linux -安装最新版本： +Install the latest version for your system: ```sh curl -sS https://starship.rs/install.sh | sh ``` -或者，使用以下任一软件包管理器安装Starship： +Alternatively, install Starship using any of the following package managers: | 发行版 | 软件包来源 | 指令 | | ------------------ | ----------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------ | @@ -229,13 +231,13 @@ curl -sS https://starship.rs/install.sh | sh
macOS -安装最新版本： +Install the latest version for your system: ```sh curl -sS https://starship.rs/install.sh | sh ``` -或者，使用以下任一软件包管理器安装Starship： +Alternatively, install Starship using any of the following package managers: | 软件包来源 | 指令 | | -------------------------------------------------------- | --------------------------------------- | @@ -249,7 +251,7 @@ curl -sS https://starship.rs/install.sh | sh
Windows -使用下列软件包管理器安装Starship： +Install Starship using any of the following package managers: | 软件包来源 | 指令 | | -------------------------------------------------------------------------------- | --------------------------------------- | @@ -262,7 +264,7 @@ curl -sS https://starship.rs/install.sh | sh ### 步骤 2. 设置你的终端以使用 Starship -配置你的终端来初始化 starship。 请从下面列表选择你的终端： +Configure your shell to initialize starship. Select yours from the list below:
Bash @@ -278,7 +280,7 @@ eval "$(starship init bash)"
Cmd -您需要使用 [Clink](https://chrisant996.github.io/clink/clink.html) (v1.2.30+) 与 Cmd. 在路径 `%LocalAppData%\clink\starship.lua` 下创建文件，输入以下内容 +您需要使用 [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: ```lua load(io.popen('starship init cmd'):read("*a"))() @@ -295,7 +297,7 @@ load(io.popen('starship init cmd'):read("*a"))() eval (starship init elvish) ``` -注意：仅支持 v0.17 及以上版本的 Elvish +Note: Only Elvish v0.17+ is supported
@@ -324,23 +326,28 @@ eval $(starship init ion)
Nushell -将以下内容添加到您 Nushell 配置文件的末尾(通过运行 `config path` 来获取配置文件的路径)： +Run the following: -```toml -startup = [ - "mkdir ~/.cache/starship", - "starship init nu | save ~/.cache/starship/init.nu", - "source ~/.cache/starship/init.nu", -] -prompt = "starship_prompt" +```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`): + +```sh +starship init nu | save ~/.cache/starship/init.nu +source ~/.cache/starship/init.nu +``` + +Note: Only Nushell v0.60+ is supported +
PowerShell -将以下内容添加到您 PowerShell 配置文件的末尾（通过运行 `$PROFILE` 来获取配置文件的路径） +Add the following to the end of your PowerShell configuration (find it by running `$PROFILE`): ```powershell Invoke-Expression (&starship init powershell) @@ -381,11 +388,11 @@ eval "$(starship init zsh)"
-### 步骤 3. 配置 StarShip +### 步骤 3. 配置 Starship -打开一个新的 Shell 实例，你应该就能看到漂亮的 Shell 新提示符了。 如果你对默认配置感到满意，就可以开始享用了！ +Start a new shell instance, and you should see your beautiful new shell prompt. If you're happy with the defaults, enjoy! -如果你想进一步配置 Starship，查阅下列内容： +If you're looking to further customize Starship: - **[配置](https://starship.rs/config/)**：学习如何配置 Starship 来调节提示符到你喜欢的样子。 @@ -393,15 +400,15 @@ eval "$(starship init zsh)" ## 🤝 贡献 -我们期待着 **所有技能等级** 的参与者！ 如果你想让自己参与项目的路径轻松一些，可以先试试某个 [good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue)。 +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). -如果你熟练掌握某个非英语语言，我们非常感谢任何帮助翻译与同步文档到其他语言的贡献。 如果你想要帮忙，可以在 [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. If you would like to help, translations can be contributed on the [Starship Crowdin](https://translate.starship.rs/). -如果你有兴趣贡献 Starship 这个项目，请先看看我们的 [贡献指南](https://github.com/starship/starship/blob/master/CONTRIBUTING.md)。 也欢迎加入我们的 [Discord 服务器](https://discord.gg/8Jzqu3T) 和大家打个招呼。 👋 +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 项目。 🙏 +Please check out these previous works that helped inspire the creation of starship. 🙏 - **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** – A ZSH prompt for astronauts. @@ -411,7 +418,7 @@ eval "$(starship init zsh)"


- Starship 图标 + Starship rocket icon

## 📝 License diff --git a/docs/zh-CN/installing/README.md b/docs/zh-CN/installing/README.md index ee3259fe..d672c9ea 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-CN/presets/README.md b/docs/zh-CN/presets/README.md index 9bd07e8e..2d46eaf1 100644 --- a/docs/zh-CN/presets/README.md +++ b/docs/zh-CN/presets/README.md @@ -4,32 +4,38 @@ To get details on how to use a preset, simply click on the image. -## [Nerd 字体符号](./nerd-font) +## [Nerd 字体符号](./nerd-font.md) This preset changes the symbols for each module to use Nerd Font symbols. [![Screenshot of Nerd Font Symbols preset](/presets/img/nerd-font-symbols.png "Click to view Nerd Font Symbols preset")](./nerd-font) -## [Bracketed Segments](./bracketed-segments) +## [Bracketed Segments](./bracketed-segments.md) This preset changes the format of all the built-in modules to show their segment in brackets instead of using the default Starship wording ("via", "on", etc.). [![Screenshot of Bracketed Segments preset](/presets/img/bracketed-segments.png "Click to view Bracketed Segments preset")](./bracketed-segments) -## [纯文本符号](./plain-text) +## [纯文本符号](./plain-text.md) This preset changes the symbols for each module into plain text. Great if you don't have access to Unicode. [![Screenshot of Plain Text Symbols preset](/presets/img/plain-text-symbols.png "Click to view Plain Text Symbols preset")](./plain-text) -## [No Runtime Versions](./no-runtimes) +## [No Runtime Versions](./no-runtimes.md) 此预设隐藏语言运行时版本。 如果你在容器或虚拟环境中使用，这个适合你！ [![Screenshot of Hide Runtime Versions preset](/presets/img/no-runtime-versions.png "Click to view No Runtime Versions preset")](./no-runtimes) -## [Pure Prompt](./pure-preset) +## [Pure Prompt](./pure-preset.md) 此预设模拟 [Pure](https://github.com/sindresorhus/pure) 的外观和行为。 [![Screenshot of Pure preset](/presets/img/pure-preset.png "Click to view Pure Prompt preset")](./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. + +[![Screenshot of Pastel Powerline preset](/presets/img/pastel-powerline.png "Click to view Pure Prompt preset")](./pastel-powerline) diff --git a/docs/zh-CN/presets/bracketed-segments.md b/docs/zh-CN/presets/bracketed-segments.md index 040aac67..38a4b4af 100644 --- a/docs/zh-CN/presets/bracketed-segments.md +++ b/docs/zh-CN/presets/bracketed-segments.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#bracketed-segments) +[Return to Presets](./README.md#bracketed-segments) # Bracketed Segments Preset diff --git a/docs/zh-CN/presets/nerd-font.md b/docs/zh-CN/presets/nerd-font.md index a37242e8..7b060f0d 100644 --- a/docs/zh-CN/presets/nerd-font.md +++ b/docs/zh-CN/presets/nerd-font.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#nerd-font-symbols) +[Return to Presets](./README.md#nerd-font-symbols) # Nerd Font Symbols Preset diff --git a/docs/zh-CN/presets/no-runtimes.md b/docs/zh-CN/presets/no-runtimes.md index ce1e219b..ab24642e 100644 --- a/docs/zh-CN/presets/no-runtimes.md +++ b/docs/zh-CN/presets/no-runtimes.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#no-runtime-versions) +[Return to Presets](./README.md#no-runtime-versions) # No Runtime Versions Preset diff --git a/docs/zh-CN/presets/pastel-powerline.md b/docs/zh-CN/presets/pastel-powerline.md new file mode 100644 index 00000000..658dbe79 --- /dev/null +++ b/docs/zh-CN/presets/pastel-powerline.md @@ -0,0 +1,17 @@ +[Return to Presets](./README.md#pastel-powerline) + +# Pastel Powerline Preset + +This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). It also shows how path substitution works in starship. + +![Screenshot of Pastel Powerline preset](/presets/img/pastel-powerline.png) + +### 前置要求 + +- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (the example uses Caskaydia Cove Nerd Font) + +### 配置 + +[Click to download TOML](/presets/toml/pastel-powerline.toml) + +<<< @/.vuepress/public/presets/toml/pastel-powerline.toml diff --git a/docs/zh-CN/presets/plain-text.md b/docs/zh-CN/presets/plain-text.md index 7e3896e9..34fab10b 100644 --- a/docs/zh-CN/presets/plain-text.md +++ b/docs/zh-CN/presets/plain-text.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#plain-text-symbols) +[Return to Presets](./README.md#plain-text-symbols) ## Plain Text Symbols Preset diff --git a/docs/zh-CN/presets/pure-preset.md b/docs/zh-CN/presets/pure-preset.md index 2f61f388..fb8e3f23 100644 --- a/docs/zh-CN/presets/pure-preset.md +++ b/docs/zh-CN/presets/pure-preset.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#pure) +[Return to Presets](./README.md#pure) # Pure Preset diff --git a/docs/zh-TW/README.md b/docs/zh-TW/README.md index 2ae1503a..4690e3f5 100644 --- a/docs/zh-TW/README.md +++ b/docs/zh-TW/README.md @@ -144,21 +144,23 @@ description: Starship 是適合任何 shell 的最小、極速、高度客製化 #### Nushell - ::: warning 這項設定可能在未來改變 只支援 nu v0.33 以上的版本。 ::: 將以下內容放到你的 nu 設定檔裡， 你可以透過在 nu 執行 `config path` 指令來取得設定檔的位置。 - - ```toml - startup = [ - "mkdir ~/.cache/starship", - "starship init nu | save ~/.cache/starship/init.nu", - "source ~/.cache/starship/init.nu", - ] - prompt = "starship_prompt" + ::: warning 這項設定可能在未來改變 Only Nushell v0.60+ is supported. ::: Run the following: + ```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`): + + ```sh + mkdir ~/.cache/starship + starship init nu | save ~/.cache/starship/init.nu + source ~/.cache/starship/init.nu + ``` #### Xonsh - 將以下內容放到 `~/.xonshrc` 的結尾： + 將以下內容加到 `~/.xonshrc` 的結尾： ```sh # ~/.xonshrc diff --git a/docs/zh-TW/config/README.md b/docs/zh-TW/config/README.md index 88dc980c..b8e270a6 100644 --- a/docs/zh-TW/config/README.md +++ b/docs/zh-TW/config/README.md @@ -198,6 +198,7 @@ $git_status\ $hg_branch\ $docker_context\ $package\ +$buf\ $cmake\ $cobol\ $container\ @@ -208,6 +209,7 @@ $elixir\ $elm\ $erlang\ $golang\ +$haskell\ $helm\ $java\ $julia\ @@ -261,7 +263,7 @@ format = "$all$directory$character" ## AWS -The `aws` module shows the current AWS region and profile when credentials or a `credential_process` 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. 這是根據 `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. @@ -278,9 +280,10 @@ When using [AWSume](https://awsu.me) the profile is read from the `AWSUME_PROFIL | `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` 模組。 | +| `disabled` | `false` | Disables the `AWS` module. | ### Variables @@ -308,6 +311,8 @@ symbol = "🅰 " [aws.region_aliases] ap-southeast-2 = "au" us-east-1 = "va" +[aws.profile_aliases] +CompanyGroupFrobozzOnCallAccess = 'Frobozz' ``` #### Display region @@ -333,6 +338,8 @@ us-east-1 = "va" format = "on [$symbol$profile]($style) " style = "bold blue" symbol = "🅰 " +[aws.profile_aliases] +Enterprise_Naming_Scheme-voidstars = 'void**' ``` ## Azure @@ -426,11 +433,50 @@ discharging_symbol = "💦" # when capacity is over 30%, the battery indicator will not be displayed ``` +## 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: + +- 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. + +### 選項 + +| Option | 預設 | 說明 | +| ------------------- | ------------------------------------------------------------ | ----------------------------------------------------- | +| `format` | `'with [$symbol($version \(Buf $buf_version\) )]($style)'` | The format for the `buf` module. | +| `version_format` | `"v${raw}"` | The version format. | +| `symbol` | `"🦬 "` | The symbol used before displaying the version of Buf. | +| `detect_extensions` | `[]` | Which extensions should trigger this module. | +| `detect_files` | `["buf.yaml", "buf.gen.yaml", "buf.work.yaml"]` | Which filenames should trigger this module. | +| `detect_folders` | `[]` | Which folders should trigger this modules. | +| `style` | `"bold blue"` | 這個模組的風格。 | +| `disabled` | `false` | Disables the `elixir` module. | + +### Variables + +| 變數 | 範例 | 說明 | +| ------------- | -------- | ------------------------------------ | +| `buf_version` | `v1.0.0` | The version of `buf` | +| `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 + +[buf] +symbol = "🦬 " +``` + ## 字元 -`character` 模組在你的文字輸入處旁顯示一個字元 (通常是箭頭)。 +The `character` module shows a character (usually an arrow) beside where the text is entered in your terminal. -這個字元會告訴你最後的指令是成功還是失敗。 It can do this in two ways: +The character will tell you whether the last command was successful or not. It can do this in two ways: - changing color (`red`/`green`) - changing shape (`❯`/`✖`) @@ -439,12 +485,6 @@ By default it only changes color. If you also want to change its shape take a lo ::: warning -`error_symbol` is not supported on nu shell. - -::: - -::: warning - `vicmd_symbol` is only supported in cmd, fish and zsh. ::: @@ -457,7 +497,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` | 停用 `character` 模組。 | +| `disabled` | `false` | Disables the `character` module. | ### Variables @@ -558,25 +598,25 @@ The `cobol` module shows the currently installed version of COBOL. By default, t ## 指令持續時間 -`cmd_duration` 模組顯示最後一個指令執行所花費的時間。 這個模組只會在指令花費超過兩秒或是有設定 `min_time` 時，超過設定值時出現。 +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. -::: warning 不要在 Bash 中設置 DEBUG trap +::: warning Do not hook the DEBUG trap in Bash -如果你在 `bash` 中使用 Starship，不要在執行 `eval $(starship init $0)` 之後設置 `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. ::: -想使用類似 preexec 功能的 Bash 使用者可以 [rcaloras 的 bash_preexec 框架](https://github.com/rcaloras/bash-preexec)。 只要在 `eval $(starship init $0)` 之前簡單地定義 `preexec_functions` 與 `precmd_functions` 兩個陣列，然後就可以照常進行。 +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. ### 選項 | Option | 預設 | 說明 | | ---------------------- | ----------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `min_time` | `2_000` | Shortest duration to show time for (in milliseconds). | -| `show_milliseconds` | `false` | 顯示時間除了以秒為單位外，亦以毫秒顯示 | +| `show_milliseconds` | `false` | Show milliseconds in addition to seconds for the duration. | | `format` | `"took [$duration]($style) "` | The format for the module. | | `style` | `"bold yellow"` | 這個模組的風格。 | -| `disabled` | `false` | 停用 `cmd_duration` 模組。 | +| `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. | @@ -612,14 +652,14 @@ This does not suppress conda's own prompt modifier, you may want to run `conda c ### 選項 -| 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` 模組。 | +| 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. | ### Variables @@ -646,12 +686,12 @@ The `container` module displays a symbol and container name, if inside a contain ### 選項 -| Option | 預設 | 說明 | -| ---------- | ------------------------------------ | ----------------------------------------- | -| `symbol` | `"⬢"` | The symbol shown, when inside a container | -| `style` | `"bold red dimmed"` | 這個模組的風格。 | -| `format` | "[$symbol \\[$name\\]]($style) " | The format for the module. | -| `disabled` | `false` | Disables the `container` module. | +| Option | 預設 | 說明 | +| ---------- | -------------------------------------- | ----------------------------------------- | +| `symbol` | `"⬢"` | The symbol shown, when inside a container | +| `style` | `"bold red dimmed"` | 這個模組的風格。 | +| `format` | `"[$symbol \\[$name\\]]($style) "` | The format for the module. | +| `disabled` | `false` | Disables the `container` module. | ### Variables @@ -676,8 +716,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: -- 現在資料夾中含有一個 `shard.yml` 檔案 -- 現在資料夾中含有一個`.cr`檔案 +- The current directory contains a `shard.yml` file +- The current directory contains a `.cr` file ### 選項 @@ -717,7 +757,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 -- 現在資料夾中包含一個 `pubspec.yaml`、`pubspec.yml` 或 `pubspec.lock` 檔案 +- The current directory contains a `pubspec.yaml`, `pubspec.yml` or `pubspec.lock` file ### 選項 @@ -789,21 +829,21 @@ format = "via [🦕 $version](green bold) " ## 資料夾 -`directory` 模組顯示到現在資料夾的路徑，並裁減到前三層資料夾。 你的資料夾也會被裁減到你所在的 git 儲存庫的根目錄。 +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. -如果正在使用 fish 風格的 pwd 選項，將不會隱藏被裁減的資料夾，而是會根據你在選項中設定的數字看到每一層資料夾的縮寫。 +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. -例如，給定一個右列的路徑 `~/Dev/Nix/nixpkgs/pkgs` 其中 `nixpkgs` 是儲存庫的根目錄，而且該選項被設定為 `1`。 你會看到 `~/D/N/nixpkgs/pkgs`，而在這個設定之前則是 `nixpkgs/pkgs`。 +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`. ### 選項 | Option | 預設 | 說明 | | ------------------- | ----------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | -| `truncation_length` | `3` | 到達現在資料夾的路徑中，要被裁減掉的資料夾數目。 | -| `truncate_to_repo` | `true` | 是否要裁減到你現在所在的 git 儲存庫的根目錄。 | +| `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) "` | The format for the module. | | `style` | `"bold cyan"` | 這個模組的風格。 | -| `disabled` | `false` | 停用 `directory` 模組。 | +| `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: "…/" | @@ -813,12 +853,12 @@ format = "via [🦕 $version](green bold) " | `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` | 當使用 fish shell 的 pwd 路徑邏輯時使用的字元數量。 | +| `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. | `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. @@ -905,7 +945,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. 如果這個資料夾已經選定一個 SDK，則顯示這個 SDK 的版本。 如果沒有的話，則顯示最新安裝的 SDK 版本。 +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. 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: @@ -920,7 +960,7 @@ 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. -這個模組內部是使用它自己的機制來偵測版本。 一般來說這個模組有 `dotnet --version` 的兩倍快，但是它可能會在你的 .NET 專案有不尋常的資料夾結構時顯示不正確的版本。 如果精確度比速度更重要的話，你可以藉由設定模組中的 `heuristic = false` 選項來停用這個功能。 +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. @@ -930,13 +970,13 @@ The module will also show the Target Framework Moniker ("` | The description of the module that is shown when running `starship explain`. | +| `description` | `""` | The description of the module that is shown when running `starship explain`. | | `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. | diff --git a/docs/zh-TW/faq/README.md b/docs/zh-TW/faq/README.md index 4d0fe411..b68bc85d 100644 --- a/docs/zh-TW/faq/README.md +++ b/docs/zh-TW/faq/README.md @@ -1,4 +1,4 @@ -# 常見問答 +# Frequently Asked Questions ## 主頁示例圖中的效果是使用哪些配置達成的？ diff --git a/docs/zh-TW/guide/README.md b/docs/zh-TW/guide/README.md index 58ba7056..84200007 100644 --- a/docs/zh-TW/guide/README.md +++ b/docs/zh-TW/guide/README.md @@ -139,6 +139,8 @@ />

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

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

@@ -324,17 +326,22 @@ eval $(starship init ion)
Nushell -Add the following to the end of your Nushell configuration (find it by running `config path`): +Run the following: -```toml -startup = [ - "mkdir ~/.cache/starship", - "starship init nu | save ~/.cache/starship/init.nu", - "source ~/.cache/starship/init.nu", -] -prompt = "starship_prompt" +```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`): + +```sh +starship init nu | save ~/.cache/starship/init.nu +source ~/.cache/starship/init.nu +``` + +Note: Only Nushell v0.60+ is supported +
@@ -362,7 +369,7 @@ eval `starship init tcsh`
Xonsh -將以下內容放到 `~/.xonshrc` 的結尾： +將以下內容加到 `~/.xonshrc` 的結尾： ```python execx($(starship init xonsh)) @@ -393,15 +400,15 @@ If you're looking to further customize Starship: ## 🤝 貢獻 -我們歡迎具有**各式各樣能力**的貢獻者！ 如果你正在尋找容易加入的方法，試試看標註為「[good first issue](https://github.com/starship/starship/labels/🌱%20good%20first%20issue)」的 issue。 +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). -如果您精通非英語語言，並能協助我們在文檔上的翻譯保持最新狀態，我們會非常感謝！ 如果你想要提供翻譯，可以到 [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. If you would like to help, translations can be contributed on the [Starship Crowdin](https://translate.starship.rs/). -如果你對貢獻 Starship 有興趣，請看我們的 [貢獻指南](https://github.com/starship/starship/blob/master/CONTRIBUTING.md) 。 另外，請不用客氣加入我們的 [Discord 伺服器](https://discord.gg/8Jzqu3T) 並來問候一下。 👋 +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 的前任作品。 🙏 +Please check out these previous works that helped inspire the creation of starship. 🙏 - **[denysdovhan/spaceship-prompt](https://github.com/denysdovhan/spaceship-prompt)** – A ZSH prompt for astronauts. @@ -416,4 +423,4 @@ If you're looking to further customize Starship: ## 📝 許可 -Copyright © 2019-present, [Starship Contributors](https://github.com/starship/starship/graphs/contributors).
這個專案使用 [ISC](https://github.com/starship/starship/blob/master/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. diff --git a/docs/zh-TW/installing/README.md b/docs/zh-TW/installing/README.md index bc971f6b..a26f9726 100644 --- a/docs/zh-TW/installing/README.md +++ b/docs/zh-TW/installing/README.md @@ -1,4 +1,4 @@ -# 🚀 進階安裝 +# Advanced Installation 要安裝 starship，你必須做兩件事： diff --git a/docs/zh-TW/presets/README.md b/docs/zh-TW/presets/README.md index cc30f8b8..8ac78edb 100644 --- a/docs/zh-TW/presets/README.md +++ b/docs/zh-TW/presets/README.md @@ -4,32 +4,38 @@ To get details on how to use a preset, simply click on the image. -## [Nerd Font 符號](./nerd-font) +## [Nerd Font 符號](./nerd-font.md) This preset changes the symbols for each module to use Nerd Font symbols. [![Nerd Font 預設樣式的截圖](/presets/img/nerd-font-symbols.png "Click to view Nerd Font Symbols preset")](./nerd-font) -## [括號片段](./bracketed-segments) +## [括號片段](./bracketed-segments.md) 這個預設樣式使所有模組使用括號片段內的格式顯示，而非使用 Starship 預設（"via", "on", etc.）。 [![括號片段預設樣式的截圖](/presets/img/bracketed-segments.png "Click to view Bracketed Segments preset")](./bracketed-segments) -## [純文字符號](./plain-text) +## [純文字符號](./plain-text.md) This preset changes the symbols for each module into plain text. Great if you don't have access to Unicode. [![純文字符號預設樣式的截圖](/presets/img/plain-text-symbols.png "Click to view Plain Text Symbols preset")](./plain-text) -## [No Runtime Versions](./no-runtimes) +## [No Runtime Versions](./no-runtimes.md) 這個預設樣式隱藏了各個語言的執行環境版本。 如果你在容器或者虛擬環境中工作，那麼這個樣式是為你設計的！ [![隱藏運行版本預設樣式的截圖](/presets/img/no-runtime-versions.png "Click to view No Runtime Versions preset")](./no-runtimes) -## [Pure Prompt](./pure-preset) +## [Pure Prompt](./pure-preset.md) This preset emulates the look and behavior of [Pure](https://github.com/sindresorhus/pure). [![Screenshot of Pure preset](/presets/img/pure-preset.png "Click to view Pure Prompt preset")](./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. + +[![Screenshot of Pastel Powerline preset](/presets/img/pastel-powerline.png "Click to view Pure Prompt preset")](./pastel-powerline) diff --git a/docs/zh-TW/presets/bracketed-segments.md b/docs/zh-TW/presets/bracketed-segments.md index 7e759706..8a3c64f0 100644 --- a/docs/zh-TW/presets/bracketed-segments.md +++ b/docs/zh-TW/presets/bracketed-segments.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#bracketed-segments) +[Return to Presets](./README.md#bracketed-segments) # Bracketed Segments Preset diff --git a/docs/zh-TW/presets/nerd-font.md b/docs/zh-TW/presets/nerd-font.md index 8ca2b680..9da4eb19 100644 --- a/docs/zh-TW/presets/nerd-font.md +++ b/docs/zh-TW/presets/nerd-font.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#nerd-font-symbols) +[Return to Presets](./README.md#nerd-font-symbols) # Nerd Font Symbols Preset diff --git a/docs/zh-TW/presets/no-runtimes.md b/docs/zh-TW/presets/no-runtimes.md index a4d6afc6..c0775455 100644 --- a/docs/zh-TW/presets/no-runtimes.md +++ b/docs/zh-TW/presets/no-runtimes.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#no-runtime-versions) +[Return to Presets](./README.md#no-runtime-versions) # No Runtime Versions Preset diff --git a/docs/zh-TW/presets/pastel-powerline.md b/docs/zh-TW/presets/pastel-powerline.md new file mode 100644 index 00000000..f8dd7d56 --- /dev/null +++ b/docs/zh-TW/presets/pastel-powerline.md @@ -0,0 +1,17 @@ +[Return to Presets](./README.md#pastel-powerline) + +# Pastel Powerline Preset + +This preset is inspired by [M365Princess](https://github.com/JanDeDobbeleer/oh-my-posh/blob/main/themes/M365Princess.omp.json). It also shows how path substitution works in starship. + +![Screenshot of Pastel Powerline preset](/presets/img/pastel-powerline.png) + +### 先決要求 + +- A [Nerd Font](https://www.nerdfonts.com/) installed and enabled in your terminal (the example uses Caskaydia Cove Nerd Font) + +### 設定 + +[Click to download TOML](/presets/toml/pastel-powerline.toml) + +<<< @/.vuepress/public/presets/toml/pastel-powerline.toml diff --git a/docs/zh-TW/presets/plain-text.md b/docs/zh-TW/presets/plain-text.md index e26e5e5f..ad4cece6 100644 --- a/docs/zh-TW/presets/plain-text.md +++ b/docs/zh-TW/presets/plain-text.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#plain-text-symbols) +[Return to Presets](./README.md#plain-text-symbols) ## Plain Text Symbols Preset diff --git a/docs/zh-TW/presets/pure-preset.md b/docs/zh-TW/presets/pure-preset.md index 34308917..3b006b53 100644 --- a/docs/zh-TW/presets/pure-preset.md +++ b/docs/zh-TW/presets/pure-preset.md @@ -1,4 +1,4 @@ -[Return to Presets](/presets/#pure) +[Return to Presets](./README.md#pure) # Pure Preset